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

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 $size, string $sortOrder = BucketInterface::SORT_ORDER_MANUAL )	Constructor.
getSize ( ) : integer	Bucket size.
getSortOrder ( ) : string	Bucket sort order.
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 $size, string $sortOrder = BucketInterface::SORT_ORDER_MANUAL )
$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.
$size	integer	Bucket size.
$sortOrder	string	Bucket sort order.

getSize() public method

Bucket size.

public getSize ( ) : integer
return	integer

getSortOrder() public method

Bucket sort order.

public getSortOrder ( ) : string
return	string

getType() public method

{@inheritDoc}

public getType ( )