PHP Class Smile\ElasticsuiteCore\Search\Request\Aggregation\Bucket\Histogram

Author: Aurelien FOUCRET ([email protected])

Inheritance: extends AbstractBucket

Show file Open project: smile-sa/elasticsuite

Public Methods

Method	Description
__construct ( string $name, string $field, array $metrics, string $nestedPath = null, Smile\ElasticsuiteCore\Search\Request\QueryInterface $filter = null, Smile\ElasticsuiteCore\Search\Request\QueryInterface $nestedFilter = null, integer $interval = 1, integer $minDocCount )	Constructor.
getInterval ( ) : integer	Histogram interval.
getMinDocCount ( ) : integer	Histograms min doc count.
getType ( )	{@inheritDoc}

Method Details

__construct() public method

Constructor.

public __construct ( string $name, string $field, array $metrics, string $nestedPath = null, Smile\ElasticsuiteCore\Search\Request\QueryInterface $filter = null, Smile\ElasticsuiteCore\Search\Request\QueryInterface $nestedFilter = null, integer $interval = 1, integer $minDocCount )
$name	string	Bucket name.
$field	string	Bucket field.
$metrics	array	Bucket metrics.
$nestedPath	string	Nested path for nested bucket.
$filter	Smile\ElasticsuiteCore\Search\Request\QueryInterface	Bucket filter.
$nestedFilter	Smile\ElasticsuiteCore\Search\Request\QueryInterface	Nested filter for the bucket.
$interval	integer	Histogram interval.
$minDocCount	integer	Histogram min doc count.

getInterval() public method

Histogram interval.

public getInterval ( ) : integer
return	integer

getMinDocCount() public method

Histograms min doc count.

public getMinDocCount ( ) : integer
return	integer

getType() public method

{@inheritDoc}

public getType ( )