\Elastica\AggregationDateRange

Class DateRange.

Summary

Methods

Properties

Constants

addRange()
setKeyedResponse()
setField()
setScript()
toArray()
setFormat()

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

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

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}

setFormat()

setFormat(string  $format) : $this

Set the formatting for the returned date values.

Parameters

string

$format

see documentation for formatting options

Returns

$this