\ElasticaResultSet

__construct()

__construct(\Elastica\Response  $response, \Elastica\Query  $query) 

Constructs ResultSet object.

Parameters

create()

create(\Elastica\Response  $response, \Elastica\Query  $query) : \Elastica\ResultSet

Creates a new ResultSet object. Can be configured to return a different implementation of the ResultSet class.

Parameters

Returns

setClass()

setClass(string  $class) 

Sets the class to be used for the static create method.

Parameters

getResults()

getResults() : array<mixed,\Elastica\Result>

Returns all results.

Returns

Results

getDocuments()

getDocuments() : array

Returns all Documents.

Returns

Documents \Elastica\Document

hasSuggests()

hasSuggests() : boolean

Returns true if the response contains suggestion results; false otherwise.

Returns

getSuggests()

getSuggests() : array

Return all suggests.

Returns

suggest results

hasAggregations()

hasAggregations() : boolean

Returns whether aggregations exist.

Returns

Aggregation existence

getAggregations()

getAggregations() : array

Returns all aggregation results.

Returns

getAggregation()

getAggregation(string  $name) : array

Retrieve a specific aggregation from this result set.

Parameters

Throws

\Elastica\Exception\InvalidException

if an aggregation by the given name cannot be found

Returns

getTotalHits()

getTotalHits() : integer

Returns the total number of found hits.

Returns

Total hits

getMaxScore()

getMaxScore() : float

Returns the max score of the results found.

Returns

Max Score

getTotalTime()

getTotalTime() : integer

Returns the total number of ms for this search to complete.

Returns

Total time

hasTimedOut()

hasTimedOut() : boolean

Returns true iff the query has timed out.

Returns

Timed out

getResponse()

getResponse() : \Elastica\Response

Returns response object.

Returns

Response object

getQuery()

getQuery() : \Elastica\Query

Returns

count()

count() : integer

Returns size of current set.

Returns

Size of set

countSuggests()

countSuggests() : integer

Returns size of current suggests.

Returns

Size of suggests

current()

current() : \Elastica\Result|boolean

Returns the current object of the set.

Returns

Set object or false if not valid (no more entries)

next()

next() 

Sets pointer (current) to the next item of the set.

key()

key() : integer

Returns the position of the current entry.

Returns

Current position

valid()

valid() : boolean

Check if an object exists at the current position.

Returns

True if object exists

rewind()

rewind() 

Resets position to 0, restarts iterator.

offsetExists()

offsetExists(integer  $offset) : boolean

Whether a offset exists.

Parameters

Returns

true on success or false on failure.

offsetGet()

offsetGet(integer  $offset) : \Elastica\Result|null

Offset to retrieve.

Parameters

Throws

\Elastica\Exception\InvalidException

If offset doesn't exist

Returns

offsetSet()

offsetSet(integer  $offset, \Elastica\Result  $value) 

Offset to set.

Parameters

Throws

\Elastica\Exception\InvalidException

offsetUnset()

offsetUnset(integer  $offset) 

Offset to unset.

Parameters

_init()

_init(\Elastica\Response  $response) 

Loads all data into the results object (initialisation).

Parameters