\Elastica\QueryMatch

toArray()

toArray() : array

Converts the params to an array. A default implementation exist to create the an array out of the class name (last part of the class name) and the params.

Returns

Filter 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(string  $field = null, mixed  $values = null) 

Parameters

setField()

setField(string  $field, mixed  $values) : $this

Sets a param for the message array.

Parameters

Returns

setFieldParam()

setFieldParam(string  $field, string  $key, string  $value) : $this

Sets a param for the given field.

Parameters

Returns

setFieldQuery()

setFieldQuery(string  $field, string  $query) : $this

Sets the query string.

Parameters

Returns

setFieldType()

setFieldType(string  $field, string  $type) : $this

Set field type.

Parameters

Returns

setFieldOperator()

setFieldOperator(string  $field, string  $operator) : $this

Set field operator.

Parameters

Returns

setFieldAnalyzer()

setFieldAnalyzer(string  $field, string  $analyzer) : $this

Set field analyzer.

Parameters

Returns

setFieldBoost()

setFieldBoost(string  $field, float  $boost = 1.0) : $this

Set field boost value.

If not set, defaults to 1.0.

Parameters

Returns

setFieldMinimumShouldMatch()

setFieldMinimumShouldMatch(string  $field, integer|string  $minimumShouldMatch) : $this

Set field minimum should match.

Parameters

Returns

setFieldFuzziness()

setFieldFuzziness(string  $field, mixed  $fuzziness) : $this

Set field fuzziness.

Parameters

Returns

setFieldFuzzyRewrite()

setFieldFuzzyRewrite(string  $field, string  $fuzzyRewrite) : $this

Set field fuzzy rewrite.

Parameters

Returns

setFieldPrefixLength()

setFieldPrefixLength(string  $field, integer  $prefixLength) : $this

Set field prefix length.

Parameters

Returns

setFieldMaxExpansions()

setFieldMaxExpansions(string  $field, integer  $maxExpansions) : $this

Set field max expansions.

Parameters

Returns

setFieldZeroTermsQuery()

setFieldZeroTermsQuery(string  $field, string  $zeroTermQuery = 'none') : $this

Set zero terms query.

If not set, default to 'none'

Parameters

Returns

setFieldCutoffFrequency()

setFieldCutoffFrequency(string  $field, float  $cutoffFrequency) : $this

Set cutoff frequency.

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