\Elastica\AggregationRange

Class Range.

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

Summary

Methods

Properties

Constants

setField()
setScript()
toArray()
__construct()
setName()
getName()
getAggs()
addAggregation()
setParam()
setParams()
addParam()
getParam()
hasParam()
getParams()
addRange()
setKeyedResponse()

No public properties found

No constants found

_convertArrayable()
_getBaseName()
_setRawParam()

$_name
$_aggs
$_params
$_rawParams

N/A

No private methods found

No private properties found

N/A

Properties

$_name

$_name : string

Type

string — The name of this aggregation

$_aggs

$_aggs : array

Type

array — Subaggregations belonging to this aggregation

$_params

$_params : array

Params.

Type

array

$_rawParams

$_rawParams : array

Raw Params.

Type

array

Methods

setField()

setField(string  $field) : $this

Set the field for this aggregation.

Parameters

string

$field

the name of the document field on which to perform this aggregation

Returns

$this

setScript()

setScript(string|\Elastica\Script\AbstractScript  $script) : $this

Set a script for this aggregation.

Parameters

string|\Elastica\Script\AbstractScript

$script

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

__construct()

__construct(string  $name)

Parameters

string

$name

the name of this aggregation

setName()

setName(string  $name) : $this

Set the name of this aggregation.

Parameters

string

$name

Returns

$this

getName()

getName() : string

Retrieve the name of this aggregation.

Returns

string

getAggs()

getAggs() : array

Retrieve all subaggregations belonging to this aggregation.

Returns

array

addAggregation()

addAggregation(\Elastica\Aggregation\AbstractAggregation  $aggregation) : $this

Add a sub-aggregation.

Parameters

\Elastica\Aggregation\AbstractAggregation

$aggregation

Throws

\Elastica\Exception\InvalidException

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

addRange()

addRange(integer|float  $fromValue = null, integer|float  $toValue = null, string  $key = null) : $this

Add a range to this aggregation.

Parameters

integer\|float	$fromValue	low end of this range, exclusive (greater than or equal to)
integer\|float	$toValue	high end of this range, exclusive (less than)
string	$key	customized key value

Throws

\Elastica\Exception\InvalidException

Returns

$this

setKeyedResponse()

setKeyedResponse(boolean  $keyed = true) : $this

If set to true, a unique string key will be associated with each bucket, and ranges will be returned as an associative array.

Parameters

boolean

$keyed

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