Explanation
in package
implements
LoggerAwareInterface
Uses
LoggerAwareTrait
Abstract explanation model.
This abstract class defines the methods for modeling an explanation in VuFind.
Tags
Interfaces, Classes, Traits and Enums
- LoggerAwareInterface
Table of Contents
- $config : Config
- Configuration
- $lookfor : string
- Search string used for query.
- $params : Params
- Search parameters object
- $recordId : string
- RecordId of title the explanation is built for.
- $searchIni : string
- Configuration file to read search settings from
- $searchService : Service
- Search Service
- __construct() : mixed
- Constructor
- getLookfor() : string
- Get the search string used for query.
- getParams() : Params
- Get the search parameters object.
- getRecordId() : string
- Get the record id of title the explanation is built for.
- performRequest() : void
- Performing request and creating explanation.
- debug() : void
- Log a debug message.
- log() : void
- Send a message to the logger.
- logError() : void
- Log an error message.
- logWarning() : void
- Log a warning message.
Properties
$config
Configuration
protected
Config
$config
$lookfor
Search string used for query.
protected
string
$lookfor
$params
Search parameters object
protected
Params
$params
$recordId
RecordId of title the explanation is built for.
protected
string
$recordId
$searchIni
Configuration file to read search settings from
protected
string
$searchIni
= 'searches'
$searchService
Search Service
protected
Service
$searchService
Methods
__construct()
Constructor
public
__construct(Params $params, Service $searchService, PluginManager $configLoader) : mixed
Parameters
- $params : Params
-
Search Parameter
- $searchService : Service
-
Search Service
- $configLoader : PluginManager
-
Config Loader
Return values
mixed —getLookfor()
Get the search string used for query.
public
getLookfor() : string
Return values
string —getParams()
Get the search parameters object.
public
getParams() : Params
Return values
Params —getRecordId()
Get the record id of title the explanation is built for.
public
getRecordId() : string
Return values
string —performRequest()
Performing request and creating explanation.
public
abstract performRequest(string $recordId) : void
Parameters
- $recordId : string
-
Record Id
Tags
Return values
void —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 —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?