\ElasticaQuery

toArray()

toArray() : array

Converts all query params to an array.

Returns

Query array

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

__construct()

__construct(array|\Elastica\Query\AbstractQuery  $query = null) 

Creates a query object.

Parameters

create()

create(mixed  $query) : self

Transforms the argument to a query object.

For example, an empty argument will return a \Elastica\Query with a \Elastica\Query\MatchAll.

Parameters

Throws

\Elastica\Exception\InvalidException

For an invalid argument

Returns

setRawQuery()

setRawQuery(array  $query) : $this

Sets query as raw array. Will overwrite all already set arguments.

Parameters

Returns

setQuery()

setQuery(\Elastica\Query\AbstractQuery  $query) : $this

Sets the query.

Parameters

Returns

getQuery()

getQuery() : \Elastica\Query\AbstractQuery

Gets the query object.

Returns

setFrom()

setFrom(integer  $from) : $this

Sets the start from which the search results should be returned.

Parameters

Returns

setSort()

setSort(array  $sortArgs) : $this

Sets sort arguments for the query Replaces existing values.

Parameters

Returns

addSort()

addSort(mixed  $sort) : $this

Adds a sort param to the query.

Parameters

Returns

setTrackScores()

setTrackScores(boolean  $trackScores = true) : $this

Keep track of the scores when sorting results.

Parameters

Returns

setHighlight()

setHighlight(array  $highlightArgs) : $this

Sets highlight arguments for the query.

Parameters

Returns

addHighlight()

addHighlight(mixed  $highlight) : $this

Adds a highlight argument.

Parameters

Returns

setSize()

setSize(integer  $size = 10) : $this

Sets maximum number of results for this query.

Parameters

Returns

setExplain()

setExplain(boolean  $explain = true) : $this

Enables explain on the query.

Parameters

Returns

setVersion()

setVersion(boolean  $version = true) : $this

Enables version on the query.

Parameters

Returns

setStoredFields()

setStoredFields(array  $fields) : $this

Sets the fields to be returned by the search NOTICE php will encode modified(or named keys) array into object format in json format request so the fields array must a sequence(list) type of array.

Parameters

Returns

setFieldDataFields()

setFieldDataFields(array  $fieldDataFields) : $this

Sets the fields not stored to be returned by the search.

Parameters

Returns

setScriptFields()

setScriptFields(array|\Elastica\Script\ScriptFields  $scriptFields) : $this

Set script fields.

Parameters

Returns

addScriptField()

addScriptField(string  $name, \Elastica\Script\AbstractScript  $script) : $this

Adds a Script to the query.

Parameters

Returns

addAggregation()

addAggregation(\Elastica\Aggregation\AbstractAggregation  $agg) : $this

Adds an Aggregation to the query.

Parameters

Returns

setMinScore()

setMinScore(float  $minScore) : $this

Allows filtering of documents based on a minimum score.

Parameters

Throws

\Elastica\Exception\InvalidException

Returns

setSuggest()

setSuggest(\Elastica\Suggest  $suggest) : $this

Add a suggest term.

Parameters

Returns

setRescore()

setRescore(mixed  $rescore) : $this

Add a Rescore.

Parameters

Returns

setSource()

setSource(array|boolean  $params) : $this

Sets the _source field to be returned with every hit.

Parameters

Returns

setPostFilter()

setPostFilter(array|\Elastica\Query\AbstractQuery  $filter) : $this

Sets post_filter argument for the query. The filter is applied after the query has executed.

Parameters

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