\COLLECTION

Common methods for collections

A collection is a journal, edited book, CD etc. - something which has multiple resources within it.

Summary

Methods
Properties
Constants
__construct()
grabAll()
browseMenuArray()
editMenuArray()
checkExists()
removeHanging()
transferArrows()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Methods

__construct()

__construct() : 

COLLECTION

Returns

grabAll()

grabAll(  type = FALSE,   userBib = FALSE,   typeArray = FALSE,   metadata = FALSE) : 

Get collection from WKX_collection. Return associative array of id => collection

Parameters

type

Default is FALSE

userBib

Default is FALSE

typeArray

Default is FALSE

metadata

Default is FALSE

Returns

browseMenuArray()

browseMenuArray() : mixed||string|int

Return array of menu items to browse collections from under the Resource|Browse menu.

Returns

mixed||string|int —

Array is empty if no collections

editMenuArray()

editMenuArray() : mixed||string|int

Return array of menu items to edit collections from under the Resource|BEdit menu.

Returns

mixed||string|int —

Array is empty if no collections

checkExists()

checkExists(  id = FALSE,   title,   titleShort,   type) : 

check to see if collection title already exists

Parameters

id

Collection ID. Default is FALSE

title
titleShort
type

Returns

FALSE or ID

removeHanging()

removeHanging() : 

Remove resource-less collections from collection list

Returns

transferArrows()

transferArrows() : mixed||string|int

Make the collection select transfer arrows to transfer collections between select boxes with onclick

Returns

mixed||string|int —

(toRightImage, toLeftImage)