\Elastica\FilterIndices

setCached()

setCached(boolean  $cached = true) : $this

Sets the filter cache.

Parameters

Returns

setCacheKey()

setCacheKey(string  $cacheKey) : $this

Sets the filter cache key.

Parameters

Throws

\Elastica\Exception\InvalidException

If given key is empty

Returns

setName()

setName(string  $name) : $this

Sets the filter name.

Parameters

Returns

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(\Elastica\Filter\AbstractFilter  $filter, array<mixed,mixed>  $indices) 

Parameters

setIndices()

setIndices(array<mixed,mixed>  $indices) : $this

Set the indices on which this filter should be applied.

Parameters

Returns

addIndex()

addIndex(string|\Elastica\Index  $index) : $this

Adds one more index on which this filter should be applied.

Parameters

Returns

setFilter()

setFilter(\Elastica\Filter\AbstractFilter  $filter) : $this

Set the filter to be applied to docs in the specified indices.

Parameters

Returns

setNoMatchFilter()

setNoMatchFilter(\Elastica\Filter\AbstractFilter  $filter) : $this

Set the filter to be applied to docs in indices which do not match those specified in the "indices" parameter.

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