PHP Class Smile\ElasticsuiteCore\Search\Adapter\Elasticsuite\Response\QueryResponse

Author: Aurelien FOUCRET ([email protected])
Inheritance: implements Magento\Framework\Search\ResponseInterface
Datei anzeigen Open project: smile-sa/elasticsuite Class Usage Examples

Protected Properties

Property Type Description
$aggregations Magento\Framework\Api\Search\AggregationInterface Aggregation Collection
$count integer
$documents Document[] Document Collection

Public Methods

Method Description
__construct ( DocumentFactory $documentFactory, AggregationFactory $aggregationFactory, array $searchResponse ) Constructor
count ( ) {@inheritDoc}
getAggregations ( ) {@inheritDoc}
getIterator ( ) {@inheritDoc}

Private Methods

Method Description
prepareAggregations ( array $searchResponse, AggregationFactory $aggregationFactory ) : void Build buckets from raw search response.
prepareDocuments ( array $searchResponse, DocumentFactory $documentFactory ) : void Build document list from the engine raw search response.

Method Details

__construct() public method

Constructor
public __construct ( DocumentFactory $documentFactory, AggregationFactory $aggregationFactory, array $searchResponse )
$documentFactory DocumentFactory Document factory.
$aggregationFactory AggregationFactory Aggregation factory.
$searchResponse array Engine raw response.

count() public method

{@inheritDoc}
public count ( )

getAggregations() public method

{@inheritDoc}
public getAggregations ( )

getIterator() public method

{@inheritDoc}
public getIterator ( )

Property Details

$aggregations protected_oe property

Aggregation Collection
protected AggregationInterface,Magento\Framework\Api\Search $aggregations
return Magento\Framework\Api\Search\AggregationInterface

$count protected_oe property

protected int $count
return integer

$documents protected_oe property

Document Collection
protected Document[],Smile\ElasticsuiteCore\Search\Adapter\Elasticsuite\Response $documents
return Document[]