\Elastica\AggregationPercentiles

Class Percentiles.

Summary

Methods
Properties
Constants
setField()
setScript()
toArray()
__construct()
setCompression()
setHdr()
setKeyed()
setPercents()
addPercent()
setMissing()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

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() 

{@inheritdoc}

__construct()

__construct(string  $name, string  $field = null) 

Parameters

string $name

the name of this aggregation

string $field

the field on which to perform this aggregation

setCompression()

setCompression(float  $value) : $this

Set compression parameter.

Parameters

float $value

Returns

$this

setHdr()

setHdr(string  $key, float  $value) : $this

Set hdr parameter.

Parameters

string $key
float $value

Returns

$this

setKeyed()

setKeyed(boolean  $keyed = true) : $this

the keyed flag is set to true which associates a unique string key with each bucket and returns the ranges as a hash rather than an array.

Parameters

boolean $keyed

Returns

$this

setPercents()

setPercents(array<mixed,float>  $percents) : $this

Set which percents must be returned.

Parameters

array<mixed,float> $percents

Returns

$this

addPercent()

addPercent(float  $percent) : $this

Add yet another percent to result.

Parameters

float $percent

Returns

$this

setMissing()

setMissing(float  $missing) : $this

Defines how documents that are missing a value should be treated.

Parameters

float $missing

Returns

$this