PHP Interface Smile\ElasticsuiteCore\Search\Request\BucketInterface

- Define new usable bucket types in ElasticSuite (histogrrams) - Additional methods to handle nested and filtered aggregations
Author: Aurelien FOUCRET ([email protected])
Inheritance: extends Magento\Framework\Search\Request\BucketInterface
Show file Open project: smile-sa/elasticsuite Interface Usage Examples

Public Methods

Method Description
getFilter ( ) : Smile\ElasticsuiteCore\Search\Request\QueryInterface | null Optional filter for filtered aggregations.
getNestedFilter ( ) : Smile\ElasticsuiteCore\Search\Request\QueryInterface | null Optional filter for nested filters (eg. filter by customer group for price).
getNestedPath ( ) : string Nested path for nested aggregations.
isNested ( ) Indicates if the aggregation is nested.

Method Details

getFilter() public method

Optional filter for filtered aggregations.
public getFilter ( ) : Smile\ElasticsuiteCore\Search\Request\QueryInterface | null
return Smile\ElasticsuiteCore\Search\Request\QueryInterface | null

getNestedFilter() public method

Optional filter for nested filters (eg. filter by customer group for price).
public getNestedFilter ( ) : Smile\ElasticsuiteCore\Search\Request\QueryInterface | null
return Smile\ElasticsuiteCore\Search\Request\QueryInterface | null

getNestedPath() public method

Nested path for nested aggregations.
public getNestedPath ( ) : string
return string

isNested() public method

Indicates if the aggregation is nested.
public isNested ( )