Backend
extends AbstractBackend
in package
implements
RetrieveBatchInterface
Summon backend.
Tags
Interfaces, Classes, Traits and Enums
- RetrieveBatchInterface
- Optional backend feature: retrieve batch of records.
Table of Contents
- $collectionFactory : RecordCollectionFactoryInterface
- Record collection factory.
- $connector : Laminas
- Connector.
- $identifier : string
- Backend identifier.
- $queryBuilder : QueryBuilder
- Query builder.
- __construct() : void
- Constructor.
- getConnector() : Laminas
- Return the Summon connector.
- getIdentifier() : string
- Return backend identifier.
- getQueryBuilder() : QueryBuilder
- Return query builder.
- getRecordCollectionFactory() : RecordCollectionFactoryInterface
- Return the record collection factory.
- retrieve() : RecordCollectionInterface
- Retrieve a single document.
- retrieveBatch() : RecordCollectionInterface
- Retrieve a batch of documents.
- search() : RecordCollectionInterface
- Perform a search and return record collection.
- setIdentifier() : void
- Set the backend identifier.
- setQueryBuilder() : void
- Set the query builder.
- setRecordCollectionFactory() : void
- Set the record collection factory.
- createRecordCollection() : RecordCollectionInterface
- Create record collection.
- debug() : void
- Log a debug message.
- injectSourceIdentifier() : RecordCollectionInterface
- Inject source identifier in record collection and all contained records.
- log() : void
- Send a message to the logger.
- logError() : void
- Log an error message.
- logWarning() : void
- Log a warning message.
- paramBagToSummonQuery() : SerialsSolutions_Summon_Query
- Convert a ParamBag to a Summon query object.
Properties
$collectionFactory
Record collection factory.
protected
RecordCollectionFactoryInterface
$collectionFactory
= null
$connector
Connector.
protected
Laminas
$connector
$identifier
Backend identifier.
protected
string
$identifier
= null
$queryBuilder
Query builder.
protected
QueryBuilder
$queryBuilder
= null
Methods
__construct()
Constructor.
public
__construct(Laminas $connector[, RecordCollectionFactoryInterface $factory = null ]) : void
Parameters
- $connector : Laminas
-
Summon connector
- $factory : RecordCollectionFactoryInterface = null
-
Record collection factory (null for default)
Return values
void —getConnector()
Return the Summon connector.
public
getConnector() : Laminas
Return values
Laminas —getIdentifier()
Return backend identifier.
public
getIdentifier() : string
Return values
string —getQueryBuilder()
Return query builder.
public
getQueryBuilder() : QueryBuilder
Lazy loads an empty QueryBuilder if none was set.
Return values
QueryBuilder —getRecordCollectionFactory()
Return the record collection factory.
public
getRecordCollectionFactory() : RecordCollectionFactoryInterface
Lazy loads a generic collection factory.
Return values
RecordCollectionFactoryInterface —retrieve()
Retrieve a single document.
public
retrieve(string $id[, ParamBag $params = null ]) : RecordCollectionInterface
Parameters
- $id : string
-
Document identifier
- $params : ParamBag = null
-
Search backend parameters
Tags
Return values
RecordCollectionInterface —retrieveBatch()
Retrieve a batch of documents.
public
retrieveBatch(array<string|int, mixed> $ids[, ParamBag $params = null ]) : RecordCollectionInterface
Parameters
- $ids : array<string|int, mixed>
-
Array of document identifiers
- $params : ParamBag = null
-
Search backend parameters
Return values
RecordCollectionInterface —search()
Perform a search and return record collection.
public
search(AbstractQuery $query, int $offset, int $limit[, ParamBag $params = null ]) : RecordCollectionInterface
Parameters
- $query : AbstractQuery
-
Search query
- $offset : int
-
Search offset
- $limit : int
-
Search limit
- $params : ParamBag = null
-
Search backend parameters
Return values
RecordCollectionInterface —setIdentifier()
Set the backend identifier.
public
setIdentifier(string $identifier) : void
Parameters
- $identifier : string
-
Backend identifier
Return values
void —setQueryBuilder()
Set the query builder.
public
setQueryBuilder(QueryBuilder $queryBuilder) : void
Parameters
- $queryBuilder : QueryBuilder
-
Query builder
Return values
void —setRecordCollectionFactory()
Set the record collection factory.
public
setRecordCollectionFactory(RecordCollectionFactoryInterface $factory) : void
Parameters
- $factory : RecordCollectionFactoryInterface
-
Factory
Return values
void —createRecordCollection()
Create record collection.
protected
createRecordCollection(array<string|int, mixed> $records) : RecordCollectionInterface
Parameters
- $records : array<string|int, mixed>
-
Records to process
Return values
RecordCollectionInterface —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 —injectSourceIdentifier()
Inject source identifier in record collection and all contained records.
protected
injectSourceIdentifier(RecordCollectionInterface $response) : RecordCollectionInterface
Parameters
- $response : RecordCollectionInterface
-
Response
Return values
RecordCollectionInterface —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 —paramBagToSummonQuery()
Convert a ParamBag to a Summon query object.
protected
paramBagToSummonQuery(ParamBag $params) : SerialsSolutions_Summon_Query
Parameters
- $params : ParamBag
-
ParamBag to convert