COLLECTION
in package
Common methods for collections
A collection is a journal, edited book, CD etc. - something which has multiple resources within it.
Table of Contents
Methods
- __construct() : mixed
- COLLECTION
- browseMenuArray() : array<string|int, mixed>
- Return array of menu items to browse collections from under the Resource|Browse menu.
- checkExists() : mixed
- check to see if collection title already exists
- editMenuArray() : array<string|int, mixed>
- Return array of menu items to edit collections from under the Resource|BEdit menu.
- grabAll() : mixed
- Get collection from collection. Return associative array of id => collection
- removeHanging() : mixed
- Remove resource-less collections from collection list
- transferArrows() : array<string|int, mixed>
- Make the collection select transfer arrows to transfer collections between select boxes with onclick
Methods
__construct()
COLLECTION
public
__construct() : mixed
browseMenuArray()
Return array of menu items to browse collections from under the Resource|Browse menu.
public
browseMenuArray() : array<string|int, mixed>
Return values
array<string|int, mixed> —Array is empty if no collections
checkExists()
check to see if collection title already exists
public
checkExists(string $title, string $titleShort, string $type[, int $id = false ]) : mixed
Parameters
- $title : string
- $titleShort : string
- $type : string
- $id : int = false
-
Collection ID. Default is FALSE
Return values
mixed —FALSE or ID
editMenuArray()
Return array of menu items to edit collections from under the Resource|BEdit menu.
public
editMenuArray() : array<string|int, mixed>
Return values
array<string|int, mixed> —Array is empty if no collections
grabAll()
Get collection from collection. Return associative array of id => collection
public
grabAll([string $type = false ][, bool $userBib = false ][, mixed $typeArray = false ]) : mixed
Parameters
- $type : string = false
-
Default is FALSE
- $userBib : bool = false
-
Default is FALSE
- $typeArray : mixed = false
-
Default is FALSE
removeHanging()
Remove resource-less collections from collection list
public
removeHanging() : mixed
transferArrows()
Make the collection select transfer arrows to transfer collections between select boxes with onclick
public
transferArrows() : array<string|int, mixed>
Return values
array<string|int, mixed> —(toRightImage, toLeftImage)