LISTCOMMON common functions for listing, searching, selecting etc.

resources

version 1
package wikindx4\core\lists
author Mark Grimshaw

 Methods

LISTCOMMON

__construct() 

Produce a list of resources

display(string $sql, string $listType) 

Parameters

$sql

string

$listType

string

Default is FALSE

Print radio buttons ascending, descending for ordering

displayAscDesc(string $type) : string

Parameters

$type

string

Returns

string

Ordering options for select and quicksearch

displayOrder(string $type, boolean $reorder) : string

Parameters

$type

string

$reorder

boolean

Default is FALSE

Returns

string

Set the paging object if paging is alphabetic or not

pagingStyle(string $sql, string $listType, string $order, string $queryString, string $alphaQuery) 

Parameters

$sql

string

$listType

string

$order

string

$queryString

string

$alphaQuery

string

Default is FALSE

Check there are resources to display

resourcesExist() : boolean

Returns

boolean

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

createAddToBox(int $bibUserId, array $bibs, string $listType) : string

Parameters

$bibUserId

int

$bibs

array

$listType

string

Returns

string

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

displayListInfo(string $listType, boolean $resourcesExist) 

Parameters

$listType

string

$resourcesExist

boolean

Check for user bibliographies

getUserBib() : array

Returns

array(usingBib, bibUserId, bibs)

list only attachments

listAttachments(object $recordset, string $listType) 

Parameters

$recordset

object

$listType

string

Get metadata for this resource when selecting or searching metadata

listMetadataText(int $resourceId) : array

Parameters

$resourceId

int

Returns

array

Display some information about the search/select/list parameters

listParams(string $listType) : string

Parameters

$listType

string

Returns

string

 Properties

 

$browse 
 

$keepHighlight 
 

$listQuarantined 
   

$metadataKeyword 
 

$metadataPaging 
 

$metadataText 
 

$metadataTextCite 
 

$metadataTextCond 
 

$metadataTextJoin 
 

$navigate 
 

$pagingObject 
 

$patterns 
 

$quickSearch 
 

$bibStyle 
 

$cite 
 

$coins 
 

$commonBib 
 

$config 
 

$db 
 

$form 
 

$html 
 

$icons 
 

$languageClass 
 

$messages 
 

$resCommon 
   

$session 
 

$stats 
 

$template 
 

$user 
 

$vars