VuFind API Documentation

MultiBackend extends AbstractMultiDriver
in package

ILSdrivers

Uses LoggerAwareTrait

Multiple Backend Driver.

This driver allows to use multiple backends determined by a record id or user id prefix (e.g. source.12345).

HOLD_ID_FIELDS

ID fields in holds


    public
        mixed
    HOLD_ID_FIELDS
    = ['id', 'item_id', 'cat_username']

$config

Driver configuration


    protected
        array<string|int, mixed>
    $config
     = []

$configLoader

Configuration loader


    protected
        PluginManager
    $configLoader

$defaultDriver

The default driver to use


    protected
        string
    $defaultDriver

$driverCache

The array of cached drivers


    protected
        array<string|int, object>
    $driverCache
     = []

$driverManager

ILS driver manager


    protected
        PluginManager
    $driverManager

$drivers

The array of configured driver names.


    protected
        array<string|int, string>
    $drivers
     = []

$driversConfigPath

The path to the driver configurations relative to the config path


    protected
        string
    $driversConfigPath

$ilsAuth

ILS authenticator


    protected
        ILSAuthenticator
    $ilsAuth

$methodsWithNoSourceSpecificParameters

Methods that don't have parameters that allow the correct source to be determined. These methods are only supported for the default driver.


    protected
        mixed
    $methodsWithNoSourceSpecificParameters
     = ['findReserves', 'getCourses', 'getDepartments', 'getFunds', 'getInstructors', 'getNewItems', 'getOfflineMode', 'getSuppressedAuthorityRecords', 'getSuppressedRecords', 'loginIsHidden']

$sourceCheckFields

An array of methods that should determine source from a specific parameter field


    protected
        array<string|int, mixed>
    $sourceCheckFields
     = ['cancelHolds' => 'cat_username', 'cancelILLRequests' => 'cat_username', 'cancelStorageRetrievalRequests' => 'cat_username', 'changePassword' => 'cat_username', 'getCancelHoldDetails' => 'cat_username', 'getCancelILLRequestDetails' => 'cat_username', 'getCancelStorageRetrievalRequestDetails' => 'cat_username', 'getMyFines' => 'cat_username', 'getMyProfile' => 'cat_username', 'getMyTransactionHistory' => 'cat_username', 'getMyTransactions' => 'cat_username', 'renewMyItems' => 'cat_username']

__call()

Default method -- pass along calls to the driver if a source can be determined and a driver is available. Throws ILSException otherwise.


    public
                    __call(string $methodName, array<string|int, mixed> $params) : mixed

Parameters

$methodName : string: The name of the called method
$params : array<string|int, mixed>: Array of passed parameters

Return values

mixed —

Varies by method

__construct()

Constructor


    public
                    __construct(PluginManager $configLoader, ILSAuthenticator $ilsAuth, PluginManager $dm) : mixed

Parameters

$configLoader : PluginManager: Configuration loader
$ilsAuth : ILSAuthenticator: ILS authenticator
$dm : PluginManager: ILS driver manager

Return values

mixed —

checkILLRequestIsValid()

Check whether an ILL request is valid


    public
                    checkILLRequestIsValid(string $id, array<string|int, mixed> $data, array<string|int, mixed> $patron) : mixed

This is responsible for determining if an item is requestable

Parameters

$id : string: The Bib ID
$data : array<string|int, mixed>: An Array of item data
$patron : array<string|int, mixed>: An array of patron data

Return values

mixed —

An array of data on the request including whether or not it is valid and a status message. Alternatively a boolean true if request is valid, false if not.

checkRequestIsValid()

Check whether a hold or recall request is valid


    public
                    checkRequestIsValid(string $id, array<string|int, mixed> $data, array<string|int, mixed> $patron) : mixed

This is responsible for determining if an item is requestable

Parameters

$id : string: The Bib ID
$data : array<string|int, mixed>: An Array of item data
$patron : array<string|int, mixed>: An array of patron data

Return values

mixed —

An array of data on the request including whether or not it is valid and a status message. Alternatively a boolean true if request is valid, false if not.

checkStorageRetrievalRequestIsValid()

Check whether a storage retrieval request is valid


    public
                    checkStorageRetrievalRequestIsValid(string $id, array<string|int, mixed> $data, array<string|int, mixed> $patron) : mixed

This is responsible for determining if an item is requestable

Parameters

$id : string: The Bib ID
$data : array<string|int, mixed>: An Array of item data
$patron : array<string|int, mixed>: An array of patron data

Return values

mixed —

An array of data on the request including whether or not it is valid and a status message. Alternatively a boolean true if request is valid, false if not.

findReserves()

Find Reserves


    public
                    findReserves(string $course, string $inst, string $dept) : mixed

Obtain information on course reserves.

Parameters

$course : string: ID from getCourses (empty string to match all)
$inst : string: ID from getInstructors (empty string to match all)
$dept : string: ID from getDepartments (empty string to match all)

Return values

mixed —

An array of associative arrays representing reserve items

getAccountBlocks()

Check whether the patron has any blocks on their account.


    public
                    getAccountBlocks(array<string|int, mixed> $patron) : mixed

Parameters

$patron : array<string|int, mixed>: Patron data from patronLogin().

Return values

mixed —

A boolean false if no blocks are in place and an array of block reasons if blocks are in place

getCancelHoldDetails()

Get Cancel Hold Details


    public
                    getCancelHoldDetails(array<string|int, mixed> $hold[, array<string|int, mixed> $patron = [] ]) : string

In order to cancel a hold, the ILS requires some information on the hold. This function returns the required information, which is then submitted as form data in Hold.php. This value is then extracted by the CancelHolds function.

Parameters

$hold : array<string|int, mixed>: A single hold array from getMyHolds
$patron : array<string|int, mixed> = []: Patron information from patronLogin

Return values

string —

Data for use in a form field

getConfig()

Function which specifies renew, hold and cancel settings.


    public
                    getConfig(string $function[, array<string|int, mixed> $params = [] ]) : array<string|int, mixed>

Parameters

$function : string: The name of the feature to be checked
$params : array<string|int, mixed> = []: Optional feature-specific parameters (array)

Return values

array<string|int, mixed> —

An array with key-value pairs.

getCourses()

Get Courses


    public
                    getCourses() : array<string|int, mixed>

Obtain a list of courses for use in limiting the reserves list.

Return values

array<string|int, mixed> —

An associative array with key = ID, value = name.

getDefaultLoginDriver()

Get default login driver


    public
                    getDefaultLoginDriver() : string

Return values

string —

Default login driver or empty string

getDefaultPickUpLocation()

Get Default Pick Up Location


    public
                    getDefaultPickUpLocation([array<string|int, mixed> $patron = false ][, array<string|int, mixed> $holdDetails = null ]) : string

Returns the default pick up location

Parameters

$patron : array<string|int, mixed> = false: Patron information returned by the patronLogin method.
$holdDetails : array<string|int, mixed> = null: Optional array, only passed in when getting a list in the context of placing a hold; contains most of the same values passed to placeHold, minus the patron data. May be used to limit the pickup options or may be ignored.

Return values

string —

A location ID

getDefaultRequestGroup()

Get Default Request Group


    public
                    getDefaultRequestGroup(array<string|int, mixed> $patron[, array<string|int, mixed> $holdDetails = null ]) : string

Returns the default request group

Parameters

$patron : array<string|int, mixed>: Patron information returned by the patronLogin method.
$holdDetails : array<string|int, mixed> = null: Optional array, only passed in when getting a list in the context of placing a hold; contains most of the same values passed to placeHold, minus the patron data. May be used to limit the request group options or may be ignored.

Return values

string —

A location ID

getDepartments()

Get Departments


    public
                    getDepartments() : array<string|int, mixed>

Obtain a list of departments for use in limiting the reserves list.

Return values

array<string|int, mixed> —

An associative array with key = dept. ID, value = dept. name.

getHolding()

Get Holding


    public
                    getHolding(string $id[, array<string|int, mixed> $patron = null ][, array<string|int, mixed> $options = [] ]) : array<string|int, mixed>

This is responsible for retrieving the holding information of a certain record.

Parameters

$id : string: The record id to retrieve the holdings for
$patron : array<string|int, mixed> = null: Patron data
$options : array<string|int, mixed> = []: Extra options (not currently used)

Return values

array<string|int, mixed> —

On success, an associative array with the following keys: id, availability (boolean), status, location, reserve, callnumber, duedate, number, barcode.

getILLPickupLibraries()

Get ILL Pickup Libraries


    public
                    getILLPickupLibraries(string $id, array<string|int, mixed> $patron) : bool|array<string|int, mixed>

This is responsible for getting information on the possible pickup libraries

Parameters

$id : string: Record ID
$patron : array<string|int, mixed>: Patron

Return values

bool|array<string|int, mixed> —

False if request not allowed, or an array of associative arrays with libraries.

getILLPickupLocations()

Get ILL Pickup Locations


    public
                    getILLPickupLocations(string $id, string $pickupLib, array<string|int, mixed> $patron) : bool|array<string|int, mixed>

This is responsible for getting a list of possible pickup locations for a library

Parameters

$id : string: Record ID
$pickupLib : string: Pickup library ID
$patron : array<string|int, mixed>: Patron

Return values

bool|array<string|int, mixed> —

False if request not allowed, or an array of locations.

getInstructors()

Get Instructors


    public
                    getInstructors() : array<string|int, mixed>

Obtain a list of instructors for use in limiting the reserves list.

Return values

array<string|int, mixed> —

An associative array with key = ID, value = name.

getLoginDrivers()

Get available login targets (drivers enabled for login)


    public
                    getLoginDrivers() : array<string|int, string>

Return values

array<string|int, string> —

Source ID's

getMyHolds()

Get Patron Holds


    public
                    getMyHolds(array<string|int, mixed> $patron) : mixed

This is responsible for retrieving all holds by a specific patron.

Parameters

$patron : array<string|int, mixed>: The patron array from patronLogin

Return values

mixed —

Array of the patron's holds

getMyILLRequests()

Get Patron ILL Requests


    public
                    getMyILLRequests(array<string|int, mixed> $patron) : mixed

This is responsible for retrieving all ILL Requests by a specific patron.

Parameters

$patron : array<string|int, mixed>: The patron array from patronLogin

Return values

mixed —

Array of the patron's ILL requests

getMyProfile()

Get Patron Profile


    public
                    getMyProfile(array<string|int, mixed> $patron) : mixed

This is responsible for retrieving the profile for a specific patron.

Parameters

$patron : array<string|int, mixed>: The patron array

Return values

mixed —

Array of the patron's profile data

getMyStorageRetrievalRequests()

Get Patron Call Slips


    public
                    getMyStorageRetrievalRequests(array<string|int, mixed> $patron) : mixed

This is responsible for retrieving all call slips by a specific patron.

Parameters

$patron : array<string|int, mixed>: The patron array from patronLogin

Return values

mixed —

Array of the patron's holds

getNewItems()

Get New Items


    public
                    getNewItems(int $page, int $limit, int $daysOld[, int $fundId = null ]) : array<string|int, mixed>

Retrieve the IDs of items recently added to the catalog.

Parameters

$page : int: Page number of results to retrieve (counting starts at 1)
$limit : int: The size of each page of results to retrieve
$daysOld : int: The maximum age of records to retrieve in days (max. 30)
$fundId : int = null: optional fund ID to use for limiting results (use a value returned by getFunds, or exclude for no limit); note that "fund" may be a misnomer - if funds are not an appropriate way to limit your new item results, you can return a different set of values from getFunds. The important thing is that this parameter supports an ID returned by getFunds, whatever that may mean.

Return values

array<string|int, mixed> —

Associative array with 'count' and 'results' keys

getPickUpLocations()

Get Pick Up Locations


    public
                    getPickUpLocations([array<string|int, mixed> $patron = false ][, array<string|int, mixed> $holdDetails = null ]) : array<string|int, mixed>

This is responsible get a list of valid library locations for holds / recall retrieval

Parameters

$patron : array<string|int, mixed> = false: Patron information returned by the patronLogin method.
$holdDetails : array<string|int, mixed> = null: Optional array, only passed in when getting a list in the context of placing or editing a hold. When placing a hold, it contains most of the same values passed to placeHold, minus the patron data. When editing a hold it contains all the hold information returned by getMyHolds. May be used to limit the pickup options or may be ignored. The driver must not add new options to the return array based on this data or other areas of VuFind may behave incorrectly.

Return values

array<string|int, mixed> —

An array of associative arrays with locationID and locationDisplay keys

getPurchaseHistory()

Get Purchase History


    public
                    getPurchaseHistory(string $id) : array<string|int, mixed>

This is responsible for retrieving the acquisitions history data for the specific record (usually recently received issues of a serial).

Parameters

$id : string: The record id to retrieve the info for

Return values

array<string|int, mixed> —

An array with the acquisitions data on success.

getRequestBlocks()

Check whether the patron is blocked from placing requests (holds/ILL/SRR).


    public
                    getRequestBlocks(array<string|int, mixed> $patron) : mixed

Parameters

$patron : array<string|int, mixed>: Patron data from patronLogin().

Return values

mixed —

A boolean false if no blocks are in place and an array of block reasons if blocks are in place

getRequestGroups()

Get request groups


    public
                    getRequestGroups(int $id, array<string|int, mixed> $patron[, array<string|int, mixed> $holdDetails = null ]) : array<string|int, mixed>

Parameters

$id : int: BIB ID
$patron : array<string|int, mixed>: Patron information returned by the patronLogin method.
$holdDetails : array<string|int, mixed> = null: Optional array, only passed in when getting a list in the context of placing a hold; contains most of the same values passed to placeHold, minus the patron data. May be used to limit the request group options or may be ignored.

Return values

array<string|int, mixed> —

An array of associative arrays with requestGroupId and name keys

getStatus()

Get Status


    public
                    getStatus(string $id) : mixed

This is responsible for retrieving the status information of a certain record.

Parameters

$id : string: The record id to retrieve the holdings for

Return values

mixed —

On success, an associative array with the following keys: id, availability (boolean), status, location, reserve, callnumber.

getStatuses()

Get Statuses


    public
                    getStatuses(array<string|int, mixed> $ids) : array<string|int, mixed>

This is responsible for retrieving the status information for a collection of records.

Parameters

$ids : array<string|int, mixed>: The array of record ids to retrieve the status for

Return values

array<string|int, mixed> —

An array of getStatus() return values on success.

init()

Initialize the driver.


    public
                    init() : void

Validate configuration and perform all resource-intensive tasks needed to make the driver active.

Return values

void —

placeHold()

Place Hold


    public
                    placeHold(array<string|int, mixed> $holdDetails) : mixed

Attempts to place a hold or recall on a particular item and returns an array with result details

Parameters

$holdDetails : array<string|int, mixed>: An array of item and patron data

Return values

mixed —

An array of data on the request including whether or not it was successful and a system message (if available)

placeILLRequest()

Place ILL Request


    public
                    placeILLRequest(array<string|int, mixed> $details) : mixed

Attempts to place an ILL request on a particular item and returns an array with result details (or throws an exception on failure of support classes)

Parameters

$details : array<string|int, mixed>: An array of item and patron data

Return values

mixed —

An array of data on the request including whether or not it was successful and a system message (if available)

placeStorageRetrievalRequest()

Place Storage Retrieval Request


    public
                    placeStorageRetrievalRequest(array<string|int, mixed> $details) : mixed

Attempts to place a storage retrieval request on a particular item and returns an array with result details

Parameters

$details : array<string|int, mixed>: An array of item and patron data

Return values

mixed —

An array of data on the request including whether or not it was successful and a system message (if available)

setConfig()

Set configuration.


    public
                    setConfig(array<string|int, mixed> $config) : void

Set the configuration for the driver.

Parameters

$config : array<string|int, mixed>: Configuration array (usually loaded from a VuFind .ini file whose name corresponds with the driver class name).

Return values

void —

supportsMethod()

Helper method to determine whether or not a certain method can be called on this driver. Required method for any smart drivers.


    public
                    supportsMethod(string $method, array<string|int, mixed> $params) : bool

Parameters

$method : string: The name of the called method.
$params : array<string|int, mixed>: Array of passed parameters.

Return values

bool —

True if the method can be called with the given parameters, false otherwise.

addIdPrefixes()

Change local ID's to global ID's in the given array


    protected
                    addIdPrefixes(mixed $data, string $source[, array<string|int, mixed> $modifyFields = ['id', 'cat_username'] ]) : mixed

Parameters

$data : mixed: The data to be modified, normally array or array of arrays
$source : string: Source code
$modifyFields : array<string|int, mixed> = ['id', 'cat_username']: Fields to be modified in the array

Return values

mixed —

Modified array or empty/null if that input was empty/null

callMethodIfSupported()

Check that the requested method is supported and call it.


    protected
                    callMethodIfSupported(string $source, string $method, array<string|int, mixed> $params[, bool $stripPrefixes = true ][, bool $addPrefixes = true ]) : mixed

Parameters

$source : string: Source ID or null to determine from parameters
$method : string: Method name
$params : array<string|int, mixed>: Method parameters
$stripPrefixes : bool = true: Whether to strip ID prefixes from all input parameters
$addPrefixes : bool = true: Whether to add ID prefixes to the call result

Return values

mixed —

createDriver()

Create a driver with the given name.


    protected
                    createDriver(string $name) : mixed

Parameters

$name : string: Name of the driver.

Return values

mixed —

On success a driver object, otherwise null.

debug()

Log a debug message.


    protected
                    debug(string $msg[, array<string|int, mixed> $context = [] ][, bool $prependClass = true ]) : void

Parameters

$msg : string: Log message
$context : array<string|int, mixed> = []: Log context
$prependClass : bool = true: Prepend class name to message?

Return values

void —

driverSupportsMethod()

Check whether the given driver supports the given method


    protected
                    driverSupportsMethod(object $driver, string $method[, array<string|int, mixed> $params = null ]) : bool

Parameters

$driver : object: ILS Driver
$method : string: Method name
$params : array<string|int, mixed> = null: Array of passed parameters

Return values

bool —

driverSupportsSource()

Check if the given ILS driver supports the source of a record


    protected
                    driverSupportsSource(string $driverSource, string $id) : bool

Parameters

$driverSource : string: Driver's source identifier
$id : string: Prefixed identifier to compare with

Return values

bool —

getDriver()

Find the correct driver for the correct configuration file for the given source and cache an initialized copy of it.


    protected
                    getDriver(string $source) : mixed

Parameters

$source : string: The source name of the driver to get.

Return values

mixed —

On success a driver object, otherwise null.

getDriverConfig()

Get configuration for the ILS driver. We will load an .ini file named after the driver class and number if it exists; otherwise we will return an empty array.


    protected
                    getDriverConfig(string $name) : array<string|int, mixed>

Parameters

$name : string: The $name to use for determining the configuration file

Return values

array<string|int, mixed> —

The configuration of the driver

getLocalId()

Extract local ID from the given prefixed ID


    protected
                    getLocalId(string $id) : string

Parameters

$id : string: The id to be split

Return values

string —

Local ID

getSource()

Extract source from the given ID


    protected
                    getSource(string $id) : string

Parameters

$id : string: The id to be split

Return values

string —

Source

getSourceForMethod()

Get source for a method and parameters


    protected
                    getSourceForMethod(string $method, array<string|int, mixed> $params) : string

Parameters

$method : string: Method
$params : array<string|int, mixed>: Parameters

Return values

string —

getSourceFromParams()

Get source from method parameters


    protected
                    getSourceFromParams(array<string|int, mixed> $params[, array<string|int, mixed> $allowedKeys = [0, 'id', 'cat_username'] ]) : string

Parameters

$params : array<string|int, mixed>: Parameters of a driver method call
$allowedKeys : array<string|int, mixed> = [0, 'id', 'cat_username']: Keys to use for source identification

Return values

string —

Source id or empty string if not found

log()

Send a message to the logger.


    protected
                    log(string $level, string $message[, array<string|int, mixed> $context = [] ][, bool $prependClass = false ]) : void

Parameters

$level : string: Log level
$message : string: Log message
$context : array<string|int, mixed> = []: Log context
$prependClass : bool = false: Prepend class name to message?

Return values

void —

logError()

Log an error message.


    protected
                    logError(string $msg[, array<string|int, mixed> $context = [] ][, bool $prependClass = true ]) : void

Parameters

$msg : string: Log message
$context : array<string|int, mixed> = []: Log context
$prependClass : bool = true: Prepend class name to message?

Return values

void —

logWarning()

Log a warning message.


    protected
                    logWarning(string $msg[, array<string|int, mixed> $context = [] ][, bool $prependClass = true ]) : void

Parameters

$msg : string: Log message
$context : array<string|int, mixed> = []: Log context
$prependClass : bool = true: Prepend class name to message?

Return values

void —

stripIdPrefixes()

Change global ID's to local ID's in the given array


    protected
                    stripIdPrefixes(mixed $data, string $source[, array<string|int, mixed> $modifyFields = ['id', 'cat_username'] ][, array<string|int, mixed> $ignoreFields = [] ]) : mixed

Parameters

$data : mixed: The data to be modified, normally array or array of arrays
$source : string: Source code
$modifyFields : array<string|int, mixed> = ['id', 'cat_username']: Fields to be modified in the array
$ignoreFields : array<string|int, mixed> = []: Fields to be ignored during recursive processing

Return values

mixed —

Modified array or empty/null if that input was empty/null

throwAsIlsException()

Rethrow the provided exception as an ILS exception.


    protected
                    throwAsIlsException(Throwable $exception[, string $msg = null ]) : never

Parameters

$exception : Throwable: Exception to rethrow
$msg : string = null: Override exception message (optional)

Return values

never —

MultiBackend extends AbstractMultiDriver in package ILSdrivers Uses LoggerAwareTrait

Tags

Table of Contents

Constants

HOLD_ID_FIELDS

Properties

$config

$configLoader

$defaultDriver

$driverCache

$driverManager

$drivers

$driversConfigPath

$ilsAuth

$methodsWithNoSourceSpecificParameters

$sourceCheckFields

Methods

__call()

Parameters

Tags

Return values

__construct()

Parameters

Return values

checkILLRequestIsValid()

Parameters

Return values

checkRequestIsValid()

Parameters

Return values

checkStorageRetrievalRequestIsValid()

Parameters

Return values

findReserves()

Parameters

Return values

getAccountBlocks()

Parameters

Return values

getCancelHoldDetails()

MultiBackend extends AbstractMultiDriver
in package

ILSdrivers

Uses LoggerAwareTrait