WIKINDX API trunk

IDEASCOMMON
in package

IDEASCOMMON class

Common routines for IDEAS

Table of Contents

Methods

__construct()  : mixed
createLinks()  : array<string|int, mixed>
Create links for viewing, editing, deleting ideas
list()  : mixed
list available ideas from list, search, keywords, lastList,and basket.
pageList()  : mixed
Page through the list
previousNextLinks()  : array<string|int, mixed>
Show previous and next idea thread hyperlinks.
printListIdeas()  : array<string|int, mixed>
Print the main or sub-idea
reorderList()  : mixed
Reorder the list.
searchForm()  : mixed
Search ideas form
setCondition()  : bool
Set user/group ID conditions

Methods

Create links for viewing, editing, deleting ideas

public createLinks(array<string|int, mixed> $row[, bool $view = false ][, bool $edit = false ][, bool $delete = false ]) : array<string|int, mixed>
Parameters
$row : array<string|int, mixed>
$view : bool = false

Default = FALSE

$edit : bool = false

Default = FALSE

$delete : bool = false

Default = FALSE

Return values
array<string|int, mixed>

list()

list available ideas from list, search, keywords, lastList,and basket.

public list([string $listType = 'list' ]) : mixed

This function is called from separate routines that get and store AllIds in the session. Note that 'basket' operates on a set of ids in the basket rather than the AllIds array.

Parameters
$listType : string = 'list'

Default 'list' (list|search|keyword|lastList|basket)

pageList()

Page through the list

public pageList(string $listType) : mixed
Parameters
$listType : string

Show previous and next idea thread hyperlinks.

public previousNextLinks(int $thisId) : array<string|int, mixed>
Parameters
$thisId : int
Return values
array<string|int, mixed>

printListIdeas()

Print the main or sub-idea

public printListIdeas(array<string|int, mixed> $row, bool $multiUser) : array<string|int, mixed>
Parameters
$row : array<string|int, mixed>
$multiUser : bool
Return values
array<string|int, mixed>

reorderList()

Reorder the list.

public reorderList(string $listType) : mixed

We can simpy reverse $allIds since there is only order by timestamp

Parameters
$listType : string

searchForm()

Search ideas form

public searchForm([string $error = false ][, bool $returnString = false ]) : mixed
Parameters
$error : string = false

. Default is FALSE

$returnString : bool = false

. Default is FALSE

setCondition()

Set user/group ID conditions

public setCondition([bool $returnString = false ][, bool $useSearchTable = false ]) : bool
Parameters
$returnString : bool = false

Execute condition (FALSE) or return the condition string (TRUE). Default is FALSE

$useSearchTable : bool = false

Use search_ideas table (referenced in IDEASEARCH). Default is FALSE (use ideas table)

Return values
bool

        
On this page

Search results