BackendInterface
in
Search backend interface definition.
Tags
Table of Contents
- getIdentifier() : string
- Return backend identifier.
- retrieve() : RecordCollectionInterface
- Retrieve a single document.
- search() : RecordCollectionInterface
- Perform a search and return record collection.
- setIdentifier() : void
- Set the backend identifier.
Methods
getIdentifier()
Return backend identifier.
public
getIdentifier() : string
Return values
string —retrieve()
Retrieve a single document.
public
retrieve(string $id[, ParamBag $params = null ]) : RecordCollectionInterface
Parameters
- $id : string
-
Document identifier
- $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