\Elastica\QueryBoolQuery

Bool query.

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

Summary

Methods

Properties

Constants

toArray()
setParam()
setParams()
addParam()
getParam()
hasParam()
getParams()
addShould()
addMust()
addMustNot()
addFilter()
setBoost()
setMinimumNumberShouldMatch()
setMinimumShouldMatch()

No public properties found

No constants found

_convertArrayable()
_getBaseName()
_setRawParam()
_addQuery()

$_params
$_rawParams

N/A

No private methods found

No private properties found

N/A

File: Query/BoolQuery.php
Package: Default
Class hierarchy: \Elastica\Param

\Elastica\Query\AbstractQuery

\Elastica\Query\BoolQuery
See also: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-bool-query.html

Properties

$_params

$_params : array

Params.

Type

array

$_rawParams

$_rawParams : array

Raw Params.

Type

array

Methods

toArray()

toArray() : array

Converts array to an object in case no queries are added.

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

addShould()

addShould(\Elastica\Query\AbstractQuery|array  $args) : $this

Add should part to query.

Parameters

\Elastica\Query\AbstractQuery|array

$args

Should query

Returns

$this

addMust()

addMust(\Elastica\Query\AbstractQuery|array  $args) : $this

Add must part to query.

Parameters

\Elastica\Query\AbstractQuery|array

$args

Must query

Returns

$this

addMustNot()

addMustNot(\Elastica\Query\AbstractQuery|array  $args) : $this

Add must not part to query.

Parameters

\Elastica\Query\AbstractQuery|array

$args

Must not query

Returns

$this

addFilter()

addFilter(\Elastica\Query\AbstractQuery  $filter) : $this

Sets the filter.

Parameters

\Elastica\Query\AbstractQuery

$filter

Filter object

Returns

$this

setBoost()

setBoost(float  $boost) : $this

Sets boost value of this query.

Parameters

float

$boost

Boost value

Returns

$this

setMinimumNumberShouldMatch()

setMinimumNumberShouldMatch(integer  $minimumNumberShouldMatch) : $this

Set the minimum number of of should match.

Parameters

integer

$minimumNumberShouldMatch

Should match minimum

Returns

$this

setMinimumShouldMatch()

setMinimumShouldMatch(integer|string  $minimum) : $this

Sets the minimum number of should clauses to match.

Parameters

integer|string

$minimum

Minimum value

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

_addQuery()

_addQuery(string  $type, \Elastica\Query\AbstractQuery|array  $args) : $this

Adds a query to the current object.

Parameters

string	$type	Query type
\Elastica\Query\AbstractQuery\|array	$args	Query

Throws

\Elastica\Exception\InvalidException: If not valid query

Returns

$this