TitleHolds
in package
Title 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
- getHold() : string|bool
- Public method for getting title level holds
- checkOverrideMode() : string
- Support method for getHold to determine if we should override the configured holds mode.
- driverHold() : mixed
- Protected method for driver defined title holds
- generateHold() : mixed
- Protected method for vufind (i.e. User) defined holds
- getHoldDetails() : array<string|int, mixed>
- Get Hold Link
- getHoldings() : array<string|int, mixed>
- Get holdings for a particular record.
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 —getHold()
Public method for getting title level holds
public
getHold(string $id) : string|bool
Parameters
- $id : string
-
A Bib ID
Tags
Return values
string|bool —URL to place hold, or false if hold option unavailable
checkOverrideMode()
Support method for getHold to determine if we should override the configured holds mode.
protected
checkOverrideMode(string $id, string $mode) : string
Parameters
- $id : string
-
Record ID to check
- $mode : string
-
Current mode
Return values
string —driverHold()
Protected method for driver defined title holds
protected
driverHold(string $id, array<string|int, mixed> $patron) : mixed
Parameters
- $id : string
-
A Bib ID
- $patron : array<string|int, mixed>
-
An Array of patron data
Return values
mixed —A url on success, boolean false on failure
generateHold()
Protected method for vufind (i.e. User) defined holds
protected
generateHold(string $id, string $type, array<string|int, mixed> $patron) : mixed
Parameters
- $id : string
-
A Bib ID
- $type : string
-
The holds mode to be applied from: (disabled, always, availability, driver)
- $patron : array<string|int, mixed>
-
Patron
Return values
mixed —A url on success, boolean false on failure
getHoldDetails()
Get Hold Link
protected
getHoldDetails(array<string|int, mixed> $data, array<string|int, mixed> $HMACKeys) : array<string|int, mixed>
Supplies the form details required to place a hold
Parameters
- $data : array<string|int, mixed>
-
An array of item data
- $HMACKeys : array<string|int, mixed>
-
An array of keys to hash
Return values
array<string|int, mixed> —Details for generating URL
getHoldings()
Get holdings for a particular record.
protected
getHoldings(string $id) : array<string|int, mixed>
Parameters
- $id : string
-
ID to retrieve