PHP Class Elastica\Aggregation\DateHistogram

See link: https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-datehistogram-aggregation.html

Inheritance: extends Histogram

Show file Open project: ruflin/elastica Class Usage Examples

Public Methods

Method	Description
setExtendedBounds ( string $min = '', string $max = '' )	Set extended bounds option.
setFactor ( integer $factor )	Adjust for granularity of date data.
setFormat ( string $format )	Set the format for returned bucket key_as_string values.
setOffset ( $offset )	Set offset option.
setTimezone ( $timezone )	Set time_zone option.

Method Details

setExtendedBounds() public method

Set extended bounds option.

See link: https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-histogram-aggregation.html#search-aggregations-bucket-histogram-aggregation-extended-bounds

public setExtendedBounds ( string $min = '', string $max = '' )
$min	string	see link for formatting options
$max	string	see link for formatting options

setFactor() public method

Adjust for granularity of date data.

public setFactor ( integer $factor )
$factor	integer	set to 1000 if date is stored in seconds rather than milliseconds

setFormat() public method

Set the format for returned bucket key_as_string values.

See link: https://www.elastic.co/guide/en/elasticsearch/reference/master/search-aggregations-bucket-daterange-aggregation.html#date-format-pattern

public setFormat ( string $format )
$format	string	see link for formatting options

setOffset() public method

Set offset option.

public setOffset ( $offset )

setTimezone() public method

Set time_zone option.

public setTimezone ( $timezone )