IlsRecords
extends AbstractPlugin
in package
Uses
SummaryTrait
Action helper to perform ILS record related actions
Tags
Table of Contents
- $config : Config
- VuFind configuration
- $loader : Loader
- Record loader
- __construct() : mixed
- Constructor
- collectRequestStats() : array<string|int, mixed>
- Collect up to date status information for ajax account notifications.
- getDrivers() : array<string|int, AbstractBase>
- Get record driver objects corresponding to an array of record arrays returned by an ILS driver's methods such as getMyHolds / getMyTransactions.
- getFineSummary() : array<string|int, mixed>
- Get a status summary for an array of fines
- getRequestSummary() : array<string|int, mixed>
- Get a status summary for an array of requests
- getTransactionSummary() : array<string|int, mixed>
- Get a status summary for an array of checkouts
Properties
$config
VuFind configuration
protected
Config
$config
$loader
Record loader
protected
Loader
$loader
Methods
__construct()
Constructor
public
__construct(Config $config, Loader $loader) : mixed
Parameters
- $config : Config
-
VuFind configuration
- $loader : Loader
-
Record loader
Return values
mixed —collectRequestStats()
Collect up to date status information for ajax account notifications.
public
collectRequestStats(array<string|int, mixed> $records) : array<string|int, mixed>
This information is used to trigger a refresh for account notifications if necessary.
Parameters
- $records : array<string|int, mixed>
-
Records for holds, ILL requests or storage retrieval requests
Return values
array<string|int, mixed> —getDrivers()
Get record driver objects corresponding to an array of record arrays returned by an ILS driver's methods such as getMyHolds / getMyTransactions.
public
getDrivers(array<string|int, mixed> $records) : array<string|int, AbstractBase>
Parameters
- $records : array<string|int, mixed>
-
Record information
Return values
array<string|int, AbstractBase> —getFineSummary()
Get a status summary for an array of fines
protected
getFineSummary(iteratable<string|int, mixed> $fines, CurrencyFormatter $formatter) : array<string|int, mixed>
Parameters
- $fines : iteratable<string|int, mixed>
-
Fines
- $formatter : CurrencyFormatter
-
Currency formatter
Return values
array<string|int, mixed> —Associative array with keys total and display.
getRequestSummary()
Get a status summary for an array of requests
protected
getRequestSummary(iteratable<string|int, mixed> $requests) : array<string|int, mixed>
Parameters
- $requests : iteratable<string|int, mixed>
-
Requests
Return values
array<string|int, mixed> —Associative array with keys available, in_transit and other.
getTransactionSummary()
Get a status summary for an array of checkouts
protected
getTransactionSummary(iteratable<string|int, mixed> $transactions) : array<string|int, mixed>
Parameters
- $transactions : iteratable<string|int, mixed>
-
Checkouts
Return values
array<string|int, mixed> —Associative array with keys available, in_transit and other.