Syndetics
extends AbstractSyndetics
in package
Syndetics author notes content loader.
Tags
Table of Contents
- $sourceList : array<string|int, mixed>
- List of data sources for author notes.
- $timeout : int
- HTTP timeout for API calls (in seconds)
- $usePlus : bool
- Use Syndetics plus?
- $useSSL : bool
- Use SSL URLs?
- __construct() : mixed
- Constructor
- loadByIsbn() : array<string|int, mixed>
- This method is responsible for connecting to Syndetics and abstracting author notes.
- 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.
- getIsbnUrl() : string
- Get the Syndetics URL for making a request.
- log() : void
- Send a message to the logger.
- logError() : void
- Log an error message.
- logWarning() : void
- Log a warning message.
- xmlToDOMDocument() : DOMDocument|bool
- Turn an XML response into a DOMDocument object.
Properties
$sourceList
List of data sources for author notes.
protected
array<string|int, mixed>
$sourceList
= ['ANOTES' => ['title' => 'Author Notes', 'file' => 'ANOTES.XML', 'div' => '<div id="syn_anotes"></div>']]
$timeout
HTTP timeout for API calls (in seconds)
protected
int
$timeout
$usePlus
Use Syndetics plus?
protected
bool
$usePlus
$useSSL
Use SSL URLs?
protected
bool
$useSSL
Methods
__construct()
Constructor
public
__construct([bool $useSSL = false ][, bool $usePlus = false ][, int $timeout = 10 ]) : mixed
Parameters
- $useSSL : bool = false
-
Use SSL URLs?
- $usePlus : bool = false
-
Use Syndetics Plus?
- $timeout : int = 10
-
HTTP timeout for API calls (in seconds)
Return values
mixed —loadByIsbn()
This method is responsible for connecting to Syndetics and abstracting author notes.
public
loadByIsbn(string $key, ISBN $isbnObj) : array<string|int, mixed>
It first queries the master url for the ISBN entry seeking a note URL. If a note URL is found, the script will then use HTTP request to retrieve the script. The script will then parse the note according to US MARC (I believe). It will provide a link to the URL master HTML page for more information. Configuration: Sources are processed in order - refer to $sourceList above.
Parameters
- $key : string
-
API key
- $isbnObj : ISBN
-
ISBN object
Tags
Return values
array<string|int, mixed> —Returns array with author note data.
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
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 —getIsbnUrl()
Get the Syndetics URL for making a request.
protected
getIsbnUrl(string $isbn, string $id[, string $file = 'index.xml' ][, string $type = 'rw12,h7' ]) : string
Parameters
- $isbn : string
-
ISBN to load
- $id : string
-
Client ID
- $file : string = 'index.xml'
-
File to request
- $type : string = 'rw12,h7'
-
Type parameter
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 —xmlToDOMDocument()
Turn an XML response into a DOMDocument object.
protected
xmlToDOMDocument(string $xml) : DOMDocument|bool
Parameters
- $xml : string
-
XML to load.
Return values
DOMDocument|bool —Document on success, false on failure.