IlsAwareTrait
ILS support for MARC and other types of records.
Tags
Table of Contents
- $holdLogic : Holds
- Hold logic
- $ils : Connection
- ILS connection
- $ilsBackends : array<string|int, string>
- Backends with ILS integration.
- $titleHoldLogic : TitleHolds
- Title hold logic
- attachILS() : void
- Attach an ILS connection and related logic to the driver
- getRealTimeHistory() : array<string|int, mixed>
- Get an array of information about record history, obtained in real-time from the ILS.
- getRealTimeHoldings() : array<string|int, mixed>
- Get an array of information about record holdings, obtained in real-time from the ILS.
- getRealTimeTitleHold() : mixed
- Get a link for placing a title level hold.
- getURLs() : array<string|int, mixed>
- Return an array of associative URL arrays with one or more of the following keys:
- setIlsBackends() : void
- Set the list of backends that support ILS integration.
- supportsAjaxStatus() : bool
- Returns true if the record supports real-time AJAX status lookups.
- hasILS() : bool
- Do we have an attached ILS connection?
Properties
$holdLogic
Hold logic
protected
Holds
$holdLogic
= null
$ils
ILS connection
protected
Connection
$ils
= null
$ilsBackends
Backends with ILS integration.
protected
array<string|int, string>
$ilsBackends
= []
$titleHoldLogic
Title hold logic
protected
TitleHolds
$titleHoldLogic
= null
Methods
attachILS()
Attach an ILS connection and related logic to the driver
public
attachILS(Connection $ils, Holds $holdLogic, TitleHolds $titleHoldLogic) : void
Parameters
- $ils : Connection
-
ILS connection
- $holdLogic : Holds
-
Hold logic handler
- $titleHoldLogic : TitleHolds
-
Title hold logic handler
Return values
void —getRealTimeHistory()
Get an array of information about record history, obtained in real-time from the ILS.
public
getRealTimeHistory() : array<string|int, mixed>
Return values
array<string|int, mixed> —getRealTimeHoldings()
Get an array of information about record holdings, obtained in real-time from the ILS.
public
getRealTimeHoldings() : array<string|int, mixed>
Return values
array<string|int, mixed> —getRealTimeTitleHold()
Get a link for placing a title level hold.
public
getRealTimeTitleHold() : mixed
Return values
mixed —A url if a hold is possible, boolean false if not
getURLs()
Return an array of associative URL arrays with one or more of the following keys:
public
getURLs() : array<string|int, mixed>
- desc: URL description text to display (optional)
- url: fully-formed URL (required if 'route' is absent)
- route: VuFind route to build URL with (required if 'url' is absent)
- routeParams: Parameters for route (optional)
- queryString: Query params to append after building route (optional)
Return values
array<string|int, mixed> —setIlsBackends()
Set the list of backends that support ILS integration.
public
setIlsBackends(array<string|int, mixed> $backends) : void
Parameters
- $backends : array<string|int, mixed>
-
List of backends that support ILS integration
Return values
void —supportsAjaxStatus()
Returns true if the record supports real-time AJAX status lookups.
public
supportsAjaxStatus() : bool
Return values
bool —hasILS()
Do we have an attached ILS connection?
protected
hasILS() : bool