QueryBuilder
in package
Summon QueryBuilder.
Tags
Table of Contents
- $luceneHelper : LuceneSyntaxHelper
- Lucene syntax helper
- build() : ParamBag
- Return Summon search parameters based on a user query and params.
- getLuceneHelper() : LuceneSyntaxHelper
- Get Lucene syntax helper
- setLuceneHelper() : void
- Set Lucene syntax helper
- abstractQueryToString() : string
- Convert an AbstractQuery object to a query string.
- queryGroupToString() : string
- Convert a QueryGroup object to a query string.
- queryToString() : string
- Convert a single Query object to a query string.
Properties
$luceneHelper
Lucene syntax helper
protected
LuceneSyntaxHelper
$luceneHelper
= null
Methods
build()
Return Summon 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 —getLuceneHelper()
Get Lucene syntax helper
public
getLuceneHelper() : LuceneSyntaxHelper
Return values
LuceneSyntaxHelper —setLuceneHelper()
Set Lucene syntax helper
public
setLuceneHelper(LuceneSyntaxHelper $helper) : void
Parameters
- $helper : LuceneSyntaxHelper
-
Lucene syntax helper
Return values
void —abstractQueryToString()
Convert an AbstractQuery object to a query string.
protected
abstractQueryToString(AbstractQuery $query) : string
Parameters
- $query : AbstractQuery
-
Query to convert
Return values
string —queryGroupToString()
Convert a QueryGroup object to a query string.
protected
queryGroupToString(QueryGroup $query) : string
Parameters
- $query : QueryGroup
-
QueryGroup to convert
Return values
string —queryToString()
Convert a single Query object to a query string.
protected
queryToString(Query $query) : string
Parameters
- $query : Query
-
Query to convert