\Elastica\QueryBuilder

toArray()

toArray() 

{@inheritdoc}

setParam()

setParam(string  $key, mixed  $value) : $this

Sets (overwrites) the value at the given key.

Parameters

Returns

setParams()

setParams(array  $params) : $this

Sets (overwrites) all params of this object.

Parameters

Returns

addParam()

addParam(string  $key, mixed  $value) : $this

Adds a param to the list.

This function can be used to add an array of params

Parameters

Returns

getParam()

getParam(string  $key) : mixed

Returns a specific param.

Parameters

Throws

\Elastica\Exception\InvalidException

If requested key is not set

Returns

Key value

hasParam()

hasParam(string  $key) : boolean

Test if a param is set.

Parameters

Returns

True if the param is set, false otherwise

getParams()

getParams() : array

Returns the params array.

Returns

Params

factory()

factory(string  $string = null) : self

Factory method.

Parameters

Returns

__construct()

__construct(string  $string = null) 

Constructor.

Parameters

__toString()

__toString() : string

Output the query string.

Returns

allowLeadingWildcard()

allowLeadingWildcard(boolean  $bool = true) : $this

Allow wildcards (*, ?) as the first character in a query.

Parameters

Returns

analyzeWildcard()

analyzeWildcard(boolean  $bool = true) : $this

Enable best effort analysis of wildcard terms.

Parameters

Returns

analyzer()

analyzer(string  $analyzer) : $this

Set the analyzer name used to analyze the query string.

Parameters

Returns

autoGeneratePhraseQueries()

autoGeneratePhraseQueries(boolean  $bool = true) : $this

Autogenerate phrase queries.

Parameters

Returns

bool()

bool() : $this

Bool Query.

A query that matches documents matching boolean combinations of other queries.

The bool query maps to Lucene BooleanQuery.

It is built using one or more boolean clauses, each clause with a typed occurrence.

The occurrence types are: must, should, must_not.

Returns

boolClose()

boolClose() : $this

Close a 'bool' block.

Alias of close() for ease of reading in source.

Returns

boost()

boost(float  $boost = 1.0) : $this

Sets the boost value of the query.

Parameters

Returns

close()

close() : $this

Close a previously opened brace.

Returns

constantScore()

constantScore() : $this

Constant Score Query.

A query that wraps a filter or another query and simply returns a constant score equal to the query boost for every document in the filter.

Maps to Lucene ConstantScoreQuery.

Returns

constantScoreClose()

constantScoreClose() : $this

Close a 'constant_score' block.

Alias of close() for ease of reading in source.

Returns

defaultField()

defaultField(string  $field = '_all') : $this

The default field for query terms if no prefix field is specified.

Parameters

Returns

defaultOperator()

defaultOperator(string  $operator = 'OR') : $this

The default operator used if no explicit operator is specified.

For example, with a default operator of OR, the query "capital of Hungary" is translated to "capital OR of OR Hungary", and with default operator of AND, the same query is translated to "capital AND of AND Hungary".

Parameters

Returns

disMax()

disMax() : $this

Dis Max Query.

A query that generates the union of documents produced by its subqueries, and that scores each document with the maximum score for that document as produced by any subquery, plus a tie breaking increment for any additional matching subqueries.

Returns

disMaxClose()

disMaxClose() : $this

Close a 'dis_max' block.

Alias of close() for ease of reading in source.

Returns

enablePositionIncrements()

enablePositionIncrements(boolean  $bool = true) : $this

Enable position increments in result queries.

Parameters

Returns

explain()

explain(boolean  $value = true) : $this

Enables explanation for each hit on how its score was computed.

Parameters

Returns

field()

field(string  $name, mixed  $value) : $this

Add a specific field / value entry.

Parameters

Returns

fieldClose()

fieldClose() : $this

Close a field block.

Alias of close() for ease of reading in source. Passed parameters will be ignored, however they can be useful in source for seeing which field is being closed.

Builder::factory() ->query() ->range() ->fieldOpen('created') ->gte('2011-07-18 00:00:00') ->lt('2011-07-19 00:00:00') ->fieldClose('created') ->rangeClose() ->queryClose();

Returns

fieldOpen()

fieldOpen(string  $name) : $this

Open a node for the specified name.

Parameters

Returns

fields()

fields(array  $fields) : $this

Explicitly define fields to return.

Parameters

Returns

filter()

filter() : $this

Open a 'filter' block.

Returns

filterClose()

filterClose() : $this

Close a filter block.

Returns

filteredQuery()

filteredQuery() : $this

Query.

Returns

filteredQueryClose()

filteredQueryClose() : $this

Close a 'filtered_query' block.

Alias of close() for ease of reading in source.

Returns

from()

from(integer  $value) : $this

Set the from parameter (offset).

Parameters

Returns

fuzzyMinSim()

fuzzyMinSim(float  $value = 0.5) : $this

Set the minimum similarity for fuzzy queries.

Parameters

Returns

fuzzyPrefixLength()

fuzzyPrefixLength(integer  $value) : $this

Set the prefix length for fuzzy queries.

Parameters

Returns

gt()

gt(mixed  $value) : $this

Add a greater than (gt) clause.

Used in range blocks.

Parameters

Returns

gte()

gte(mixed  $value) : $this

Add a greater than or equal to (gte) clause.

Used in range blocks.

Parameters

Returns

lowercaseExpandedTerms()

lowercaseExpandedTerms(boolean  $bool = true) : $this

Automatically lower-case terms of wildcard, prefix, fuzzy, and range queries.

Parameters

Returns

lt()

lt(mixed  $value) : $this

Add a less than (lt) clause.

Used in range blocks.

Parameters

Returns

lte()

lte(mixed  $value) : $this

Add a less than or equal to (lte) clause.

Used in range blocks.

Parameters

Returns

matchAll()

matchAll(float  $boost = null) : $this

Match All Query.

A query that matches all documents.

Maps to Lucene MatchAllDocsQuery.

Parameters

Returns

minimumNumberShouldMatch()

minimumNumberShouldMatch(integer  $minimum) : $this

The minimum number of should clauses to match.

Parameters

Returns

must()

must() : $this

The clause (query) must appear in matching documents.

Returns

mustClose()

mustClose() : $this

Close a 'must' block.

Alias of close() for ease of reading in source.

Returns

mustNot()

mustNot() : $this

The clause (query) must not appear in the matching documents.

Note that it is not possible to search on documents that only consists of a must_not clauses.

Returns

mustNotClose()

mustNotClose() : $this

Close a 'must_not' block.

Alias of close() for ease of reading in source.

Returns

open()

open() : $this

Add an opening brace.

Returns

phraseSlop()

phraseSlop(integer  $value) : $this

Sets the default slop for phrases.

If zero, then exact phrase matches are required.

Parameters

Returns

prefix()

prefix() : $this

Query.

Returns

prefixClose()

prefixClose() : $this

Close a 'prefix' block.

Alias of close() for ease of reading in source.

Returns

queries()

queries(array  $queries) : $this

Queries to run within a dis_max query.

Parameters

Returns

query()

query() : $this

Open a query block.

Returns

queryClose()

queryClose() : $this

Close a query block.

Alias of close() for ease of reading in source.

Returns

queryString()

queryString() : $this

Query String Query.

A query that uses a query parser in order to parse its content

Returns

queryStringClose()

queryStringClose() : $this

Close a 'query_string' block.

Alias of close() for ease of reading in source.

Returns

range()

range() : $this

Open a range block.

Returns

rangeClose()

rangeClose() : $this

Close a range block.

Alias of close() for ease of reading in source.

Returns

should()

should() : $this

The clause (query) should appear in the matching document.

A boolean query with no must clauses, one or more should clauses must match a document.

Returns

shouldClose()

shouldClose() : $this

Close a 'should' block.

Alias of close() for ease of reading in source.

Returns

size()

size(integer  $value = 10) : $this

Set the size parameter (number of records to return).

Parameters

Returns

sort()

sort() : $this

Allows to add one or more sort on specific fields.

Returns

sortClose()

sortClose() : $this

Close a sort block.

Alias of close() for ease of reading in source.

Returns

sortField()

sortField(string  $name, boolean  $reverse = false) : $this

Add a field to sort on.

Parameters

Returns

sortFields()

sortFields(array  $fields) : $this

Sort on multiple fields.

Parameters

Returns

term()

term() : $this

Term Query.

Matches documents that have fields that contain a term (not analyzed).

The term query maps to Lucene TermQuery.

Returns

termClose()

termClose() : $this

Close a 'term' block.

Alias of close() for ease of reading in source.

Returns

textPhrase()

textPhrase() : $this

Open a 'text_phrase' block.

Returns

textPhraseClose()

textPhraseClose() : $this

Close a 'text_phrase' block.

Returns

tieBreakerMultiplier()

tieBreakerMultiplier(float  $multiplier) : $this

When using dis_max, the disjunction max tie breaker.

Parameters

Returns

wildcard()

wildcard() : $this

Query.

Returns

wildcardClose()

wildcardClose() : $this

Close a 'wildcard' block.

Alias of close() for ease of reading in source.

Returns

_convertArrayable()

_convertArrayable(array  $array) : array

Cast objects to arrays.

Parameters

Returns

_getBaseName()

_getBaseName() : string

Param's name Picks the last part of the class name and makes it snake_case You can override this method if you want to change the name.

Returns

name

_setRawParam()

_setRawParam(string  $key, mixed  $value) : $this

Sets params not inside params array.

Parameters

Returns