Elastica
\
Elastica
Aggregation
Bulk
Action
Cluster
Health
Connection
Strategy
Exception
Bulk
Response
Connection
Filter
Index
Multi
Node
Query
QueryBuilder
DSL
Version
Rescore
Script
Suggest
CandidateGenerator
Tool
Transport
Type

\Elastica\MultiResultSet

Elastica multi search result set List of result sets for each search request.

Summary

Methods
Properties
Constants
__construct()
getResultSets()
getResponse()
hasError()
current()
next()
key()
valid()
rewind()
count()
offsetExists()
offsetGet()
offsetSet()
offsetUnset()
No public properties found
No constants found
_init()
$_resultSets
$_position
$_response
N/A
No private methods found
No private properties found
N/A

Properties

$_resultSets

$_resultSets : array|array<mixed,\Elastica\ResultSet>

Result Sets.

Type

array|array<mixed,\Elastica\ResultSet> — Result Sets

$_position

$_position : integer

Current position.

Type

integer — Current position

$_response

$_response : \Elastica\Response

Response.

Type

\Elastica\Response — Response object

Methods

__construct()

__construct(\Elastica\Response  $response, array|array<mixed,\Elastica\Search>  $searches)

Constructs ResultSet object.

Parameters

\Elastica\Response $response
array|array<mixed,\Elastica\Search> $searches

getResultSets()

getResultSets() : array|array<mixed,\Elastica\ResultSet>

Returns

array|array<mixed,\Elastica\ResultSet>

getResponse()

getResponse() : \Elastica\Response

Returns response object.

Returns

\Elastica\Response —

Response object

hasError()

hasError() : boolean

There is at least one result set with error.

Returns

boolean

next()

next()

key()

key() : integer

Returns

integer

valid()

valid() : boolean

Returns

boolean

rewind()

rewind()

count()

count() : integer

Returns

integer

offsetExists()

offsetExists(string|integer  $offset) : boolean

Parameters

string|integer $offset

Returns

boolean —

true on success or false on failure.

offsetGet()

offsetGet(mixed  $offset) : mixed

Parameters

mixed $offset

Returns

mixed —

Can return all value types.

offsetSet()

offsetSet(mixed  $offset, mixed  $value)

Parameters

mixed $offset
mixed $value

offsetUnset()

offsetUnset(mixed  $offset)

Parameters

mixed $offset

_init()

_init(\Elastica\Response  $response, array|array<mixed,\Elastica\Search>  $searches)

Parameters

\Elastica\Response $response
array|array<mixed,\Elastica\Search> $searches

Throws

\Elastica\Exception\InvalidException