QueryBuilder
in package
EDS API Querybuilder
Tags
Table of Contents
- $defaultQuery : string
- Default query (used when query string is empty). This should retrieve all records in the index, facilitating high-level facet-based browsing.
- __construct() : mixed
- Constructor
- build() : ParamBag
- Construct EdsApi search parameters based on a user query and params.
- abstractQueryToArray() : array<string|int, mixed>
- Convert an AbstractQuery object to a query string.
- queryGroupToArray() : array<string|int, mixed>
- Convert a QueryGroup object to a query string.
- queryToEdsQuery() : array<string|int, mixed>
- Convert a single Query object to an eds api query array
Properties
$defaultQuery
Default query (used when query string is empty). This should retrieve all records in the index, facilitating high-level facet-based browsing.
protected
string
$defaultQuery
= '(FT yes) OR (FT no)'
Methods
__construct()
Constructor
public
__construct() : mixed
Return values
mixed —build()
Construct EdsApi search parameters based on a user query and params.
public
build(AbstractQuery $query[, ParamBag|null $params = null ]) : ParamBag
Parameters
- $query : AbstractQuery
-
User query
- $params : ParamBag|null = null
-
Search backend parameters
Tags
Return values
ParamBag —abstractQueryToArray()
Convert an AbstractQuery object to a query string.
protected
abstractQueryToArray(AbstractQuery $query) : array<string|int, mixed>
Parameters
- $query : AbstractQuery
-
Query to convert
Return values
array<string|int, mixed> —queryGroupToArray()
Convert a QueryGroup object to a query string.
protected
queryGroupToArray(QueryGroup $query) : array<string|int, mixed>
Parameters
- $query : QueryGroup
-
QueryGroup to convert
Return values
array<string|int, mixed> —queryToEdsQuery()
Convert a single Query object to an eds api query array
protected
queryToEdsQuery(Query $query[, string $operator = 'AND' ]) : array<string|int, mixed>
Parameters
- $query : Query
-
Query to convert
- $operator : string = 'AND'
-
Operator to apply