Elastica
\
Elastica
Aggregation
Bulk
Action
Cluster
Health
Connection
Strategy
Exception
Bulk
Response
Connection
Filter
Index
Multi
Node
Query
QueryBuilder
DSL
Version
Rescore
ResultSet
Script
Suggest
CandidateGenerator
Tool
Transport
Type

\Elastica\FilterBool

Bool Filter.

This class is for backward compatibility reason for all php < 7 versions. For PHP 7 and above use BoolFilter as Bool is reserved.

Summary

Methods
Properties
Constants
addShould()
addMust()
addMustNot()
toArray()
setCached()
setCacheKey()
setName()
setParam()
setParams()
addParam()
getParam()
hasParam()
getParams()
No public properties found
No constants found
_addFilter()
_convertArrayable()
_getBaseName()
_setRawParam()
$_must
$_should
$_mustNot
$_params
$_rawParams
N/A
No private methods found
No private properties found
N/A

Properties

$_must

$_must : array

Must.

Type

array

$_should

$_should : array

Should.

Type

array

$_mustNot

$_mustNot : array

Must not.

Type

array

$_params

$_params : array

Params.

Type

array

$_rawParams

$_rawParams : array

Raw Params.

Type

array

Methods

addShould()

addShould(array|\Elastica\Filter\AbstractFilter  $args) : $this

Adds should filter.

Parameters

array|\Elastica\Filter\AbstractFilter $args

Filter data

Returns

$this

addMust()

addMust(array|\Elastica\Filter\AbstractFilter  $args) : $this

Adds must filter.

Parameters

array|\Elastica\Filter\AbstractFilter $args

Filter data

Returns

$this

addMustNot()

addMustNot(array|\Elastica\Filter\AbstractFilter  $args) : $this

Adds mustNot filter.

Parameters

array|\Elastica\Filter\AbstractFilter $args

Filter data

Returns

$this

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

array —

Filter array

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

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

_addFilter()

_addFilter(string  $type, array|\Elastica\Filter\AbstractFilter  $args) : $this

Adds general filter based on type.

Parameters

string $type

Filter type
array|\Elastica\Filter\AbstractFilter $args

Filter data

Throws

\Elastica\Exception\InvalidException

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