\Elastica\FilterTerms

Terms filter.

This function can be used to handle params for queries, filter

Summary

Methods
Properties
Constants
setCached()
setCacheKey()
setName()
toArray()
setParam()
setParams()
addParam()
getParam()
hasParam()
getParams()
__construct()
setTerms()
setLookup()
addTerm()
setExecution()
No public properties found
No constants found
_convertArrayable()
_getBaseName()
_setRawParam()
$_params
$_rawParams
$_terms
$_key
N/A
No private methods found
No private properties found
N/A

Properties

$_params

$_params : array

Params.

Type

array

$_rawParams

$_rawParams : array

Raw Params.

Type

array

$_terms

$_terms : array

Terms.

Type

array — Terms

$_key

$_key : string

Terms key.

Type

string — Terms key

Methods

setCached()

setCached(boolean  $cached = true) : $this

Sets the filter cache.

Parameters

boolean $cached

Cached

Returns

$this

setCacheKey()

setCacheKey(string  $cacheKey) : $this

Sets the filter cache key.

Parameters

string $cacheKey

Cache key

Throws

\Elastica\Exception\InvalidException

If given key is empty

Returns

$this

setName()

setName(string  $name) : $this

Sets the filter name.

Parameters

string $name

Name

Returns

$this

toArray()

toArray() : array

Converts object to an array.

Throws

\Elastica\Exception\InvalidException

Returns

array

setParam()

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

Sets (overwrites) the value at the given key.

Parameters

string $key

Key to set

mixed $value

Key Value

Returns

$this

setParams()

setParams(array  $params) : $this

Sets (overwrites) all params of this object.

Parameters

array $params

Parameter list

Returns

$this

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

string $key

Param key

mixed $value

Value to set

Returns

$this

getParam()

getParam(string  $key) : mixed

Returns a specific param.

Parameters

string $key

Key to return

Throws

\Elastica\Exception\InvalidException

If requested key is not set

Returns

mixed —

Key value

hasParam()

hasParam(string  $key) : boolean

Test if a param is set.

Parameters

string $key

Key to test

Returns

boolean —

True if the param is set, false otherwise

getParams()

getParams() : array

Returns the params array.

Returns

array —

Params

__construct()

__construct(string  $key = '', array  $terms = array()) 

Creates terms filter.

Parameters

string $key

Terms key

array $terms

Terms values

setTerms()

setTerms(string  $key, array  $terms) : $this

Sets key and terms for the filter.

Parameters

string $key

Terms key

array $terms

Terms for the query.

Returns

$this

setLookup()

setLookup(string  $key, string|\Elastica\Type  $type, string  $id, string  $path, string|array|\Elastica\Index  $options = array()) : $this

Set the lookup parameters for this filter.

Parameters

string $key

terms key

string|\Elastica\Type $type

document type from which to fetch the terms values

string $id

id of the document from which to fetch the terms values

string $path

the field from which to fetch the values for the filter

string|array|\Elastica\Index $options

An array of options or the index from which to fetch the terms values. Defaults to the current index.

Returns

$this

addTerm()

addTerm(string  $term) : $this

Adds an additional term to the query.

Parameters

string $term

Filter term

Returns

$this

setExecution()

setExecution(string  $execution) : $this

Set execution mode.

Parameters

string $execution

Options: "bool", "and", "or", "plain" or "fielddata"

Returns

$this

_convertArrayable()

_convertArrayable(array  $array) : array

Cast objects to arrays.

Parameters

array $array

Returns

array

_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

string —

name

_setRawParam()

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

Sets params not inside params array.

Parameters

string $key
mixed $value

Returns

$this