HoldingsILS
extends AbstractBase
in package
Holdings (ILS) tab
Tags
Table of Contents
- $accessPermission : string
- Permission that must be granted to access this module (null for no restriction)
- $catalog : Connection
- ILS connection (or null if not applicable)
- $driver : AbstractBase|null
- Record driver associated with the tab
- $hideWhenEmpty : bool
- Whether the holdings tab should be hidden when empty or not.
- $request : Request|bool
- User request associated with the tab (false for none)
- $template : string
- Name of template to use for rendering holdings.
- __construct() : mixed
- Constructor
- getDescription() : string
- Get the on-screen description for this tab.
- getPaginator() : Paginator
- Getting a paginator for the items list.
- getTemplate() : string
- Get name of template for rendering holdings.
- getUniqueCallNumbers() : array<string|int, mixed>
- Support method used by template -- extract all unique call numbers from an array of items.
- isActive() : bool
- Is this tab active?
- isVisible() : bool
- Is this tab initially visible?
- setRecordDriver() : AbstractBase
- Set the record driver
- setRequest() : AbstractBase
- Set the user request
- supportsAjax() : bool
- Can this tab be loaded via AJAX?
- getRecordDriver() : AbstractBase
- Get the record driver
- getRequest() : Request|bool
- Get the user request (or false if unavailable)
- getSimpleUniqueCallNumbers() : array<string|int, mixed>
- Support method used in getUniqueCallNumbers for templates when full details are not supported -- extract all unique call numbers from an array of items.
Properties
$accessPermission
Permission that must be granted to access this module (null for no restriction)
protected
string
$accessPermission
= null
$catalog
ILS connection (or null if not applicable)
protected
Connection
$catalog
$driver
Record driver associated with the tab
protected
AbstractBase|null
$driver
= null
$hideWhenEmpty
Whether the holdings tab should be hidden when empty or not.
protected
bool
$hideWhenEmpty
$request
User request associated with the tab (false for none)
protected
Request|bool
$request
= false
$template
Name of template to use for rendering holdings.
protected
string
$template
Methods
__construct()
Constructor
public
__construct([Connection|null $catalog = null ][, string|null $template = null ][, bool $hideWhenEmpty = false ]) : mixed
Parameters
- $catalog : Connection|null = null
-
ILS connection to use to check for holdings before displaying the tab; may be set to null if no check is needed.
- $template : string|null = null
-
Holdings template to use
- $hideWhenEmpty : bool = false
-
Whether the holdings tab should be hidden when empty or not
Return values
mixed —getDescription()
Get the on-screen description for this tab.
public
getDescription() : string
Return values
string —getPaginator()
Getting a paginator for the items list.
public
getPaginator(int $totalItemCount, int $page, int $itemLimit) : Paginator
Parameters
- $totalItemCount : int
-
Total count of items for a bib record
- $page : int
-
Currently selected page of the items paginator
- $itemLimit : int
-
Max. no of items per page
Return values
Paginator —getTemplate()
Get name of template for rendering holdings.
public
getTemplate() : string
Return values
string —getUniqueCallNumbers()
Support method used by template -- extract all unique call numbers from an array of items.
public
getUniqueCallNumbers(array<string|int, mixed> $items[, bool $fullDetails = false ]) : array<string|int, mixed>
Parameters
- $items : array<string|int, mixed>
-
Items to search through.
- $fullDetails : bool = false
-
Whether or not to return the full details about call numbers or only the simple legacy format.
Return values
array<string|int, mixed> —isActive()
Is this tab active?
public
isActive() : bool
Return values
bool —isVisible()
Is this tab initially visible?
public
isVisible() : 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 —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
Return values
Request|bool —getSimpleUniqueCallNumbers()
Support method used in getUniqueCallNumbers for templates when full details are not supported -- extract all unique call numbers from an array of items.
protected
getSimpleUniqueCallNumbers(array<string|int, mixed> $items) : array<string|int, mixed>
Parameters
- $items : array<string|int, mixed>
-
Items to search through.