Holds
in package
Hold Logic Class
Tags
Table of Contents
- $catalog : Connection
- Catalog connection object
- $config : Config
- VuFind configuration
- $hideHoldings : array<string|int, mixed>
- Holding locations to hide from display
- $hmac : HMAC
- HMAC generator
- $ilsAuth : ILSAuthenticator
- ILS authenticator
- __construct() : mixed
- Constructor
- getHoldings() : array<string|int, mixed>
- Public method for getting item holdings from the catalog and selecting which holding method to call
- getSuppressedLocations() : array<string|int, mixed>
- Get an array of suppressed location names.
- driverHoldings() : array<string|int, mixed>
- Protected method for driver defined holdings
- formatHoldings() : array<string|int, mixed>
- Support method to rearrange the holdings array for displaying convenience.
- generateHoldings() : array<string|int, mixed>
- Protected method for vufind (i.e. User) defined holdings
- getHoldingsGroupKey() : string
- Get a grouping key for a holdings item
- getRequestDetails() : array<string|int, mixed>
- Get Hold Form
- processILLRequests() : array<string|int, mixed>
- Process ILL request information in holdings and set the links accordingly.
- processStorageRetrievalRequests() : array<string|int, mixed>
- Process storage retrieval request information in holdings and set the links accordingly.
- standardHoldings() : array<string|int, mixed>
- Protected method for standard (i.e. No Holds) holdings
Properties
$catalog
Catalog connection object
protected
Connection
$catalog
$config
VuFind configuration
protected
Config
$config
$hideHoldings
Holding locations to hide from display
protected
array<string|int, mixed>
$hideHoldings
= []
$hmac
HMAC generator
protected
HMAC
$hmac
$ilsAuth
ILS authenticator
protected
ILSAuthenticator
$ilsAuth
Methods
__construct()
Constructor
public
__construct(ILSAuthenticator $ilsAuth, Connection $ils, HMAC $hmac, Config $config) : mixed
Parameters
- $ilsAuth : ILSAuthenticator
-
ILS authenticator
- $ils : Connection
-
A catalog connection
- $hmac : HMAC
-
HMAC generator
- $config : Config
-
VuFind configuration
Return values
mixed —getHoldings()
Public method for getting item holdings from the catalog and selecting which holding method to call
public
getHoldings(string $id[, array<string|int, mixed> $ids = null ][, array<string|int, mixed> $options = [] ]) : array<string|int, mixed>
Parameters
- $id : string
-
A Bib ID
- $ids : array<string|int, mixed> = null
-
A list of Source Records (if catalog is for a consortium)
- $options : array<string|int, mixed> = []
-
Optional options to pass on to getHolding()
Return values
array<string|int, mixed> —A sorted results set
getSuppressedLocations()
Get an array of suppressed location names.
public
getSuppressedLocations() : array<string|int, mixed>
Return values
array<string|int, mixed> —driverHoldings()
Protected method for driver defined holdings
protected
driverHoldings(array<string|int, mixed> $result, array<string|int, mixed> $holdConfig, bool $requestsBlocked) : array<string|int, mixed>
Parameters
- $result : array<string|int, mixed>
-
A result set returned from a driver
- $holdConfig : array<string|int, mixed>
-
Hold configuration from driver
- $requestsBlocked : bool
-
Are user requests blocked?
Return values
array<string|int, mixed> —A sorted results set
formatHoldings()
Support method to rearrange the holdings array for displaying convenience.
protected
formatHoldings(array<string|int, mixed> $holdings) : array<string|int, mixed>
Parameters
- $holdings : array<string|int, mixed>
-
An associative array of location => item array
Return values
array<string|int, mixed> —An associative array keyed by location with each entry being an array with 'notes', 'summary' and 'items' keys. The 'notes' and 'summary' arrays are note/summary information collected from within the items.
generateHoldings()
Protected method for vufind (i.e. User) defined holdings
protected
generateHoldings(array<string|int, mixed> $result, string $type, array<string|int, mixed> $holdConfig) : array<string|int, mixed>
Parameters
- $result : array<string|int, mixed>
-
A result set returned from a driver
- $type : string
-
The holds mode to be applied from: (all, holds, recalls, availability)
- $holdConfig : array<string|int, mixed>
-
Hold configuration from driver
Return values
array<string|int, mixed> —A sorted results set
getHoldingsGroupKey()
Get a grouping key for a holdings item
protected
getHoldingsGroupKey(array<string|int, mixed> $copy) : string
Parameters
- $copy : array<string|int, mixed>
-
Item information
Return values
string —Grouping key
getRequestDetails()
Get Hold Form
protected
getRequestDetails(array<string|int, mixed> $details, array<string|int, mixed> $HMACKeys, string $action) : array<string|int, mixed>
Supplies holdLogic with the form details required to place a request
Parameters
- $details : array<string|int, mixed>
-
An array of item data
- $HMACKeys : array<string|int, mixed>
-
An array of keys to hash
- $action : string
-
The action for which the details are built
Return values
array<string|int, mixed> —Details for generating URL
processILLRequests()
Process ILL request information in holdings and set the links accordingly.
protected
processILLRequests(array<string|int, mixed> $holdings, string $id, array<string|int, mixed> $patron, bool $requestsBlocked) : array<string|int, mixed>
Parameters
- $holdings : array<string|int, mixed>
-
Holdings
- $id : string
-
Record ID
- $patron : array<string|int, mixed>
-
Patron
- $requestsBlocked : bool
-
Are user requests blocked?
Return values
array<string|int, mixed> —Modified holdings
processStorageRetrievalRequests()
Process storage retrieval request information in holdings and set the links accordingly.
protected
processStorageRetrievalRequests(array<string|int, mixed> $holdings, string $id, array<string|int, mixed> $patron, bool $requestsBlocked) : array<string|int, mixed>
Parameters
- $holdings : array<string|int, mixed>
-
Holdings
- $id : string
-
Record ID
- $patron : array<string|int, mixed>
-
Patron
- $requestsBlocked : bool
-
Are user requests blocked?
Return values
array<string|int, mixed> —Modified holdings
standardHoldings()
Protected method for standard (i.e. No Holds) holdings
protected
standardHoldings(array<string|int, mixed> $result) : array<string|int, mixed>
Parameters
- $result : array<string|int, mixed>
-
A result set returned from a driver
Return values
array<string|int, mixed> —A sorted results set