Symbiote\ElasticSearch\ElasticaResultSet
A result set that provides access to results of a solr query, either as a data object set, or as more specific solr items
- Author: Marcus Nyeholt <marcus@silverstripe.com.au>
- License: http://silverstripe.org/bsd-license/
Synopsis
class ElasticaResultSet
{
- // members
- protected String $query;
- protected $searchService;
- protected String $response;
- protected StdClass $result;
- protected DataObjectSet $dataObjects;
- protected StdClass $queryParameters;
- protected Int $totalResults;
- protected $returnedFacets;
- // methods
- public void __construct()
- public void getErrors()
- public void getQueryParameters()
- public void getResult()
- public Int getTotalResults()
- public DataObjectSet getDataObjects()
- public array getFacets()
- public Int getTimeTaken()
Members
protected
- $dataObjects
—
Symbiote\ElasticSearch\DataObjectSet
The list of data objects that is represented by this search result set - $query
—
Symbiote\ElasticSearch\String
The raw lucene query issued - $queryParameters
—
Symbiote\ElasticSearch\StdClass
The query parameters that were used for the query - $response
—
Symbiote\ElasticSearch\String
The raw result from elastic - $result
—
Symbiote\ElasticSearch\StdClass
The actual decoded search result - $returnedFacets
- $searchService
- $totalResults
—
Symbiote\ElasticSearch\Int
The total number of results found in this query
Methods
public
- __construct() — Create a new result set object
- getDataObjects() — Return all the dataobjects that were found in this query
- getErrors()
- getFacets() — Gets the details about facets found in this query
- getQueryParameters() — Get all the parameters used in this query
- getResult() — Gets the raw result set as an object graph.
- getTimeTaken() — Gets the query's elapsed time.
- getTotalResults() — The number of results found for the given parameters.