LISTCOMMON
in package
LISTCOMMON common functions for listing, searching, selecting etc. resources
Table of Contents
- $bibStyle : mixed
- object
- $browserTabID : mixed
- string
- $cite : mixed
- object
- $commonBib : mixed
- object
- $db : mixed
- object
- $icons : mixed
- object
- $messages : mixed
- object
- $resCommon : mixed
- object
- $rows : mixed
- array
- $session : mixed
- object
- $stats : mixed
- object
- $user : mixed
- object
- $vars : mixed
- array
- 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
- formatResources() : mixed
- Format resource according to bibliographic style when viewing a list, search results or a results prior to inserting a citation link into metadata
- getCreators() : object
- Get SQL resultset for creator details before formatting resources
- getUserBib() : array<string|int, mixed>
- Check for user bibliographies
- listAttachments() : mixed
- list only attachments
- listMetadata() : array<string|int, mixed>
- Get metadata for this resource when browsing a keyword
- listMetadataText() : array<string|int, mixed>
- Get metadata for this resource when selecting or searching metadata
- listParams() : false|string
- Display some information about the search/select/list parameters
Properties
$bibStyle
object
private
mixed
$bibStyle
$browserTabID
string
private
mixed
$browserTabID
= FALSE
$cite
object
private
mixed
$cite
$commonBib
object
private
mixed
$commonBib
$db
object
private
mixed
$db
$icons
object
private
mixed
$icons
$messages
object
private
mixed
$messages
$resCommon
object
private
mixed
$resCommon
$rows
array
private
mixed
$rows
= []
$session
object
private
mixed
$session
$stats
object
private
mixed
$stats
$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|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>
Return values
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
Return values
mixed —formatResources()
Format resource according to bibliographic style when viewing a list, search results or a results prior to inserting a citation link into metadata
private
formatResources(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>
-
Reference to $resources
Return values
mixed —getCreators()
Get SQL resultset for creator details before formatting resources
private
getCreators(array<string|int, mixed> $resourceIds) : object
Parameters
- $resourceIds : array<string|int, mixed>
Return values
object —SQL resultset
getUserBib()
Check for user bibliographies
private
getUserBib() : array<string|int, mixed>
Return values
array<string|int, mixed> —(usingBib, bibUserId, bibs)
listAttachments()
list only attachments
private
listAttachments(string $listType) : mixed
Parameters
- $listType : string
Return values
mixed —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> —listMetadataText()
Get metadata for this resource when selecting or searching metadata
private
listMetadataText(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