CollectionHierarchyTree
extends HierarchyTree
in package
HierarchyTree tab
Tags
Table of Contents
- $accessPermission : string
- Permission that must be granted to access this module (null for no restriction)
- $config : Config
- Configuration
- $driver : AbstractBase|null
- Record driver associated with the tab
- $loader : Loader
- Record loader
- $request : Request|bool
- User request associated with the tab (false for none)
- $treeList : array<string|int, mixed>
- Tree data
- __construct() : mixed
- Constructor
- getActiveRecord() : AbstractBase|null
- Get the current active record. Returns record driver if there is an active record or null otherwise.
- getActiveTree() : string|bool
- Get the ID of the active tree (false if none)
- getDescription() : string
- Get the on-screen description for this tab.
- getSearchLimit() : int
- Get the tree search result limit.
- getTreeList() : array<string|int, mixed>
- Get an array of tree data
- isActive() : bool
- Is this tab active?
- isFullHierarchyVisible() : bool
- Should we display the full tree, or just a partial tree?
- isVisible() : bool
- Is this tab initially visible?
- renderTree() : string
- Render a hierarchy tree
- searchActive() : bool
- Is tree searching active?
- setRecordDriver() : AbstractBase
- Set the record driver
- setRequest() : AbstractBase
- Set the user request
- supportsAjax() : bool
- Can this tab be loaded via AJAX?
- getConfig() : Config
- Get the VuFind configuration.
- getRecordDriver() : AbstractBase
- Get the record driver
- getRequest() : Request|bool
- Get the user request (or false if unavailable)
Properties
$accessPermission
Permission that must be granted to access this module (null for no restriction)
protected
string
$accessPermission
= null
$config
Configuration
protected
Config
$config
= null
$driver
Record driver associated with the tab
protected
AbstractBase|null
$driver
= null
$loader
Record loader
protected
Loader
$loader
$request
User request associated with the tab (false for none)
protected
Request|bool
$request
= false
$treeList
Tree data
protected
array<string|int, mixed>
$treeList
= null
Methods
__construct()
Constructor
public
__construct(Config $config, Loader $loader) : mixed
Parameters
- $config : Config
-
Configuration
- $loader : Loader
-
Record loader
Return values
mixed —getActiveRecord()
Get the current active record. Returns record driver if there is an active record or null otherwise.
public
getActiveRecord() : AbstractBase|null
Return values
AbstractBase|null —getActiveTree()
Get the ID of the active tree (false if none)
public
getActiveTree() : string|bool
Return values
string|bool —getDescription()
Get the on-screen description for this tab.
public
getDescription() : string
Return values
string —getSearchLimit()
Get the tree search result limit.
public
getSearchLimit() : int
Return values
int —getTreeList()
Get an array of tree data
public
getTreeList() : array<string|int, mixed>
Return values
array<string|int, mixed> —isActive()
Is this tab active?
public
isActive() : bool
Return values
bool —isFullHierarchyVisible()
Should we display the full tree, or just a partial tree?
public
isFullHierarchyVisible() : bool
Return values
bool —isVisible()
Is this tab initially visible?
public
isVisible() : bool
Return values
bool —renderTree()
Render a hierarchy tree
public
renderTree([string $id = null ][, string|null $context = null ][, array<string|int, mixed> $options = [] ]) : string
Parameters
- $id : string = null
-
Hierarchy ID (omit to use active tree)
- $context : string|null = null
-
Context for use by renderer or null for default
- $options : array<string|int, mixed> = []
-
Additional options (like previewElement)
Return values
string —searchActive()
Is tree searching active?
public
searchActive() : bool
Return values
bool —setRecordDriver()
Set the record driver
public
setRecordDriver(AbstractBase $driver) : AbstractBase
Parameters
- $driver : AbstractBase
-
Record driver
Return values
AbstractBase —setRequest()
Set the user request
public
setRequest(Request $request) : AbstractBase
Parameters
- $request : Request
-
Request
Return values
AbstractBase —supportsAjax()
Can this tab be loaded via AJAX?
public
supportsAjax() : bool
Return values
bool —getConfig()
Get the VuFind configuration.
protected
getConfig() : Config
Return values
Config —getRecordDriver()
Get the record driver
protected
getRecordDriver() : AbstractBase
Tags
Return values
AbstractBase —getRequest()
Get the user request (or false if unavailable)
protected
getRequest() : Request|bool