QueryBuilder
in package
LibGuides QueryBuilder.
Tags
Table of Contents
- $widgetType : string
- LibGuides widget type
- build() : ParamBag
- Return LibGuides search parameters based on a user query and params.
- setDefaultWidgetType() : void
- Set the widget type for this QueryBuilder instance. See $widgetType.
- 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.
- queryToArray() : array<string|int, mixed>
- Convert a single Query object to a query string.
Properties
$widgetType
LibGuides widget type
protected
string
$widgetType
= '1'
1 = Research Guides 2 = Database A-Z List
Methods
build()
Return LibGuides 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 —setDefaultWidgetType()
Set the widget type for this QueryBuilder instance. See $widgetType.
public
setDefaultWidgetType(string $type) : void
Parameters
- $type : string
-
Widget type
Return values
void —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
Tags
Return values
array<string|int, mixed> —queryToArray()
Convert a single Query object to a query string.
protected
queryToArray(Query $query) : array<string|int, mixed>
Parameters
- $query : Query
-
Query to convert