\CATEGORY

Common methods for categories

Summary

Methods
Properties
Constants
__construct()
grabAll()
grabSubAll()
transferArrowsCat()
transferArrowsSubcat()
transferArrowsCatUpDown()
transferArrowsSubcatUpDown()
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() : 

CATEGORY

Returns

grabAll()

grabAll(  userBib = FALSE,   extant = FALSE,   typeArray = FALSE,   withGeneral = TRUE) : 

Get category names from WKX_category. Return associative array of id => category.

Parameters

userBib

FALSE (default) or TRUE (return only resource types within current user bibliography)

extant

FALSE (default) or TRUE (return only categories for which resources exist)

typeArray

FALSE (default) or limits categories to those belonging to these types

withGeneral

FALSE (default) or include 'General' category in returned array

Returns

associative array or FALSE

grabSubAll()

grabSubAll(  withCategory = FALSE,   userBib = FALSE,   matchCategoryIds = FALSE,   extant = FALSE) : 

Get subcategory names from WKX_subcategory. Return associative array of id => subcategory.

Parameters

withCategory

FALSE (default) or TRUE (return list of subcategories repended by their relevant category name)

userBib

FALSE (default) or TRUE (return only resource types within current user bibliography)

matchCategoryIds

FALSE (default) or array of category IDs (returned subcategories must belong to those categories)

extant

FALSE (default) or TRUE (return only subcategories for which resources exist)

Returns

associative array or FALSE

transferArrowsCat()

transferArrowsCat() : mixed||string|int

Make the category select transfer arrows to transfer categories between select boxes with onclick

Returns

mixed||string|int —

(toRightImage, toLeftImage)

transferArrowsSubcat()

transferArrowsSubcat() : mixed||string|int

Make the subcategory select transfer arrows to transfer subcategories between select boxes with onclick

Returns

mixed||string|int —

(toRightImage, toLeftImage)

transferArrowsCatUpDown()

transferArrowsCatUpDown() : mixed||string|int

Make the category select transfer arrows to transfer categories between select boxes with onclick (Up and Down)

Returns

mixed||string|int —

(toRightImage, toLeftImage)

transferArrowsSubcatUpDown()

transferArrowsSubcatUpDown() : mixed||string|int

Make the subcategory select transfer arrows to transfer subcategories between select boxes with onclick (Up and Down)

Returns

mixed||string|int —

(toRightImage, toLeftImage)