WIKINDX API trunk

LISTCOMMON
in package

LISTCOMMON common functions for listing, searching, selecting etc. resources

Table of Contents

Properties

$addToBox  : mixed
string
$bibCite  : mixed
object
$browserTabID  : mixed
string
$BT  : mixed
string
$commonBib  : mixed
object
$commonBrowse  : mixed
object
$db  : mixed
object
$exportList  : mixed
bool
$finalSql  : mixed
string
$icons  : mixed
object
$listSession  : mixed
object
$noResourcesFound  : mixed
bool
$pagingObject  : mixed
object
$quickListAll  : mixed
bool
$resCommon  : mixed
object
$rows  : mixed
array
$session  : mixed
object
$stats  : mixed
object
$store  : mixed
object
$ua  : mixed
object
$user  : mixed
object
$vars  : mixed
array

Methods

createAddToBox()  : false|string
Create select box allowing users to add to categories, keywords etc.
createLinks()  : mixed
Create links for viewing, editing deleting etc. resources
displayListInfo()  : mixed
Display list information and userBib, category and keyword select box to add items to
displaySearchFormIcon()  : array<string|int, mixed>
Toggle display advsearch or qsearch form with a button—create the action icon
initPaging()  : mixed
Initialize paging system
listAttachments()  : mixed
list only attachments
listMetadata()  : array<string|int, mixed>
Get metadata for this resource when browsing a keyword
listParameters()  : false|string
Display some information about the search/select/list parameters
pagingAlphaCondition()  : bool
Set SQL conditions for title and creator order when using pagingAlpha
pagingDictCondition()  : bool
Set SQL conditions for title and creator order when using pagingDict
pagingStyle()  : mixed
Set the paging object re numeric, alphabetical, or dictionary paging
reorderFilter()  : string
Create reorder and filter blocks.

Properties

$browserTabID

string

private mixed $browserTabID = \FALSE

$commonBrowse

object

private mixed $commonBrowse

$exportList

bool

private mixed $exportList = \FALSE

$noResourcesFound

bool

private mixed $noResourcesFound = \FALSE

$pagingObject

object

private mixed $pagingObject = \FALSE

$quickListAll

bool

private mixed $quickListAll = \FALSE

Methods

createAddToBox()

Create select box allowing users to add to categories, keywords etc.

private createAddToBox(string $listType) : false|string
Parameters
$listType : string
Return values
false|string

createLinks()

Create links for viewing, editing deleting etc. resources

private createLinks(string $listType, array<string|int, mixed> &$resourceList, array<string|int, mixed> $resources) : mixed
Parameters
$listType : string

Type of list to format

$resourceList : array<string|int, mixed>

Reference to $resourceList

$resources : array<string|int, mixed>

displayListInfo()

Display list information and userBib, category and keyword select box to add items to

private displayListInfo(string $listType[, bool $resourcesExist = TRUE ]) : mixed
Parameters
$listType : string
$resourcesExist : bool = TRUE

displaySearchFormIcon()

Toggle display advsearch or qsearch form with a button—create the action icon

private displaySearchFormIcon([string $type = 'qsearch' ]) : array<string|int, mixed>
Parameters
$type : string = 'qsearch'

= 'qsearch' ('advsearch' is the other option)

Return values
array<string|int, mixed>

initPaging()

Initialize paging system

private initPaging(array<string|int, mixed> $ids, string $listType, string $order, string $queryString, mixed $total) : mixed
Parameters
$ids : array<string|int, mixed>
$listType : string
$order : string
$queryString : string
$total : mixed

listAttachments()

list only attachments

private listAttachments(string $listType) : mixed
Parameters
$listType : string

listMetadata()

Get metadata for this resource when browsing a keyword

private listMetadata(int $resourceId) : array<string|int, mixed>
Parameters
$resourceId : int
Return values
array<string|int, mixed>

listParameters()

Display some information about the search/select/list parameters

private listParameters(string $listType) : false|string
Parameters
$listType : string
Return values
false|string

pagingAlphaCondition()

Set SQL conditions for title and creator order when using pagingAlpha

private pagingAlphaCondition(string $order) : bool
Parameters
$order : string
Return values
bool

pagingDictCondition()

Set SQL conditions for title and creator order when using pagingDict

private pagingDictCondition(string $order) : bool
Parameters
$order : string
Return values
bool

pagingStyle()

Set the paging object re numeric, alphabetical, or dictionary paging

private pagingStyle(string $order) : mixed
Parameters
$order : string

reorderFilter()

Create reorder and filter blocks.

private reorderFilter(string $listType, string $action[, string $extraHidden = '' ]) : string

All search/list scripts using this must have reorder() and filter() methods

Parameters
$listType : string
$action : string
$extraHidden : string = ''

= ''

Return values
string 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results