VuFind API Documentation

AbstractBase
in package
implements DriverInterface

Default ILS driver base class.

Tags
category

VuFind

author

Andrew S. Nagy vufind-tech@lists.sourceforge.net

license

http://opensource.org/licenses/gpl-2.0.php GNU General Public License

link

Wiki

SuppressWarnings

(PHPMD.NumberOfChildren)

Interfaces, Classes, Traits and Enums

DriverInterface
Catalog Specific Driver Class

Table of Contents

$config  : array<string|int, mixed>
Driver configuration
setConfig()  : void
Set configuration.
throwAsIlsException()  : never
Rethrow the provided exception as an ILS exception.

Properties

$config

Driver configuration

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

Methods

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

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)

Tags
throws
ILS
Return values
never

Search results