LISTCOMMON
in package
LISTCOMMON common functions for listing, searching, selecting etc. resources
Table of Contents
Properties
- $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
- $pagingObject : mixed
- object
- $quickListAll : mixed
- bool
- $resCommon : mixed
- object
- $rows : mixed
- array
- $session : mixed
- object
- $stats : mixed
- object
- $store : 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
- getUserBib() : array<string|int, mixed>
- Check for user bibliographies
- initPaging() : mixed
- Initialize paging system
- listAttachments() : mixed
- list only attachments
- listMetadata() : array<string|int, mixed>
- Get metadata for this resource when browsing a keyword
- listParams() : 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
Properties
$bibCite
object
private
mixed
$bibCite
$browserTabID
string
private
mixed
$browserTabID
= \FALSE
$BT
string
private
mixed
$BT
= ''
$commonBib
object
private
mixed
$commonBib
$commonBrowse
object
private
mixed
$commonBrowse
$db
object
private
mixed
$db
$exportList
bool
private
mixed
$exportList
= \FALSE
$finalSql
string
private
mixed
$finalSql
$icons
object
private
mixed
$icons
$listSession
object
private
mixed
$listSession
$pagingObject
object
private
mixed
$pagingObject
= \FALSE
$quickListAll
bool
private
mixed
$quickListAll
= \FALSE
$resCommon
object
private
mixed
$resCommon
$rows
array
private
mixed
$rows
= []
$session
object
private
mixed
$session
$stats
object
private
mixed
$stats
$store
object
private
mixed
$store
$user
object
private
mixed
$user
$vars
array
private
mixed
$vars
Methods
createAddToBox()
Create select box allowing users to add to categories, keywords etc.
private
createAddToBox(int $bibUserId, array<string|int, mixed> $bibs, string $listType) : false|string
Parameters
- $bibUserId : int
- $bibs : array<string|int, mixed>
- $listType : string
Return values
false|stringcreateLinks()
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
getUserBib()
Check for user bibliographies
private
getUserBib() : array<string|int, mixed>
Return values
array<string|int, mixed> —(usingBib, bibUserId, bibs)
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>listParams()
Display some information about the search/select/list parameters
private
listParams(string $listType) : false|string
Parameters
- $listType : string
Return values
false|stringpagingAlphaCondition()
Set SQL conditions for title and creator order when using pagingAlpha
private
pagingAlphaCondition(string $order) : bool
Parameters
- $order : string
Return values
boolpagingDictCondition()
Set SQL conditions for title and creator order when using pagingDict
private
pagingDictCondition(string $order) : bool
Parameters
- $order : string
Return values
boolpagingStyle()
Set the paging object re numeric, alphabetical, or dictionary paging
private
pagingStyle(string $order) : mixed
Parameters
- $order : string