PHP Interface Smile\ElasticsuiteCore\Search\RequestInterface

This extends the standard magento request interface to append support of the following features : - document types - hits filtering not applied to aggregations (ElasicSearch root filters) - sort order definition
Author: Aurelien FOUCRET ([email protected])
Inheritance: extends Magento\Framework\Search\RequestInterface
Show file Open project: smile-sa/elasticsuite Interface Usage Examples

Public Methods

Method Description
getFilter ( ) : Smile\ElasticsuiteCore\Search\Request\QueryInterface Hits filter (does not apply to aggregations).
getSortOrders ( ) : Smile\ElasticsuiteCore\Search\Request\SortOrderInterface[] Request sort order.
getType ( ) : string Searched doucument type.
isSpellchecked ( ) : boolean Indicates if the query has been spellchecked.

Method Details

getFilter() public method

Filter are actually using QueryInterface since there is no differences beetween queries and filters in Elasticsearch 2.x DSL.
public getFilter ( ) : Smile\ElasticsuiteCore\Search\Request\QueryInterface
return Smile\ElasticsuiteCore\Search\Request\QueryInterface

getSortOrders() public method

Request sort order.
public getSortOrders ( ) : Smile\ElasticsuiteCore\Search\Request\SortOrderInterface[]
return Smile\ElasticsuiteCore\Search\Request\SortOrderInterface[]

getType() public method

Searched doucument type.
public getType ( ) : string
return string

isSpellchecked() public method

Indicates if the query has been spellchecked.
public isSpellchecked ( ) : boolean
return boolean