VuFind API Documentation

AbstractBase
in package
implements HttpServiceAwareInterface, LoggerAwareInterface Uses LoggerAwareTrait, HttpServiceAwareTrait

Abstract base for content loader plug-ins.

Tags
category

VuFind

author

Demian Katz demian.katz@villanova.edu

license

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

link

Wiki

Interfaces, Classes, Traits and Enums

HttpServiceAwareInterface
LoggerAwareInterface

Table of Contents

loadByIsbn()  : array<string|int, mixed>|string
Load results for a particular API key and ISBN.
debug()  : void
Log a debug message.
getHttpClient()  : Client
Get an HTTP client
getIsbn10()  : string
Attempt to get an ISBN-10; revert to ISBN-13 only when ISBN-10 representation is impossible.
log()  : void
Send a message to the logger.
logError()  : void
Log an error message.
logWarning()  : void
Log a warning message.

Methods

loadByIsbn()

Load results for a particular API key and ISBN.

public abstract loadByIsbn(string $key, ISBN $isbnObj) : array<string|int, mixed>|string
Parameters
$key : string

API key

$isbnObj : ISBN

ISBN object

Return values
array<string|int, mixed>|string —

For array of strings returned, they all are escaped in the template and presented as list. If string is returned it is considered as raw HTML and is NOT escaped.

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 —

getHttpClient()

Get an HTTP client

protected getHttpClient([string $url = null ]) : Client
Parameters
$url : string = null

URL for client to use

Tags
throws
Exception
Return values
Client —

getIsbn10()

Attempt to get an ISBN-10; revert to ISBN-13 only when ISBN-10 representation is impossible.

protected getIsbn10(ISBN $isbnObj) : string
Parameters
$isbnObj : ISBN

ISBN object to convert

Return values
string —

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 —

Search results