\Elastica\AggregationScriptedMetric

Class ScriptedMetric.

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

Summary

Methods

Properties

Constants

__construct()
setName()
getName()
getAggs()
addAggregation()
toArray()
setParam()
setParams()
addParam()
getParam()
hasParam()
getParams()
setCombineScript()
setInitScript()
setMapScript()
setReduceScript()

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

__construct()

__construct(string  $name, string|null  $initScript = null, string|null  $mapScript = null, string|null  $combineScript = null, string|null  $reduceScript = null)

Parameters

string	$name	the name if this aggregation
string\|null	$initScript	Executed prior to any collection of documents
string\|null	$mapScript	Executed once per document collected
string\|null	$combineScript	Executed once on each shard after document collection is complete
string\|null	$reduceScript	Executed once on the coordinating node after all shards have returned their results

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

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

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

setCombineScript()

setCombineScript(string  $script) : $this

Executed once on each shard after document collection is complete.

Allows the aggregation to consolidate the state returned from each shard. If a combine_script is not provided the combine phase will return the aggregation variable.

Parameters

string

$script

Returns

$this

setInitScript()

setInitScript(string  $script) : $this

Executed prior to any collection of documents.

Allows the aggregation to set up any initial state.

Parameters

string

$script

Returns

$this

setMapScript()

setMapScript(string  $script) : $this

Executed once per document collected.

This is the only required script. If no combine_script is specified, the resulting state needs to be stored in an object named _agg.

Parameters

string

$script

Returns

$this

setReduceScript()

setReduceScript(string  $script) : $this

Executed once on the coordinating node after all shards have returned their results.

The script is provided with access to a variable _aggs which is an array of the result of the combine_script on each shard. If a reduce_script is not provided the reduce phase will return the _aggs variable.

Parameters

string

$script

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