QueryAdapter
extends QueryAdapter
in package
EDS API Query Adapter: search query parameters to AbstractQuery object
Tags
Table of Contents
- deminify() : Query|QueryGroup|WorkKeysQuery
- Return a Query or QueryGroup based on minified search arguments.
- display() : string
- Convert a Query or QueryGroup into a human-readable display query.
- fromRequest() : Query|QueryGroup|WorkKeysQuery
- Convert user request parameters into a query (currently for advanced searches and work keys searches only).
- minify() : array<string|int, mixed>
- Convert a Query or QueryGroup into minified search arguments.
- displayAdvanced() : string
- Support method for display() -- process advanced queries.
Methods
deminify()
Return a Query or QueryGroup based on minified search arguments.
public
deminify(array<string|int, mixed> $search) : Query|QueryGroup|WorkKeysQuery
Parameters
- $search : array<string|int, mixed>
-
Minified search arguments
Return values
Query|QueryGroup|WorkKeysQuery —display()
Convert a Query or QueryGroup into a human-readable display query.
public
display(AbstractQuery $query, callable $translate, callable $showName) : string
Parameters
- $query : AbstractQuery
-
Query to convert
- $translate : callable
-
Callback to translate strings
- $showName : callable
-
Callback to translate field names
Return values
string —fromRequest()
Convert user request parameters into a query (currently for advanced searches and work keys searches only).
public
fromRequest(Parameters $request, string $defaultHandler) : Query|QueryGroup|WorkKeysQuery
Parameters
- $request : Parameters
-
User-submitted parameters
- $defaultHandler : string
-
Default search handler
Return values
Query|QueryGroup|WorkKeysQuery —minify()
Convert a Query or QueryGroup into minified search arguments.
public
minify(AbstractQuery $query[, bool $topLevel = true ]) : array<string|int, mixed>
Parameters
- $query : AbstractQuery
-
Query to minify
- $topLevel : bool = true
-
Is this a top-level query? (Used for recursion)
Return values
array<string|int, mixed> —displayAdvanced()
Support method for display() -- process advanced queries.
protected
displayAdvanced(QueryGroup $query, callable $translate, callable $showName) : string
Parameters
- $query : QueryGroup
-
Query to convert
- $translate : callable
-
Callback to translate strings
- $showName : callable
-
Callback to translate field names