\ElasticaScroll

Scroll Iterator.

Summary

Methods
Properties
Constants
__construct()
current()
next()
key()
valid()
rewind()
$expiryTime
No constants found
_setScrollId()
_saveOptions()
_revertOptions()
$_search
$_nextScrollId
$_currentResultSet
$_options
N/A
No private methods found
No private properties found
N/A

Properties

$expiryTime

$expiryTime : string

Type

string

$_nextScrollId

$_nextScrollId : null|string

Type

null|string

$_currentResultSet

$_currentResultSet : null|\Elastica\ResultSet

Type

null|\Elastica\ResultSet

$_options

$_options : array

0: scroll<br> 1: scroll id<br> 2: search type.

Type

array

Methods

__construct()

__construct(\Elastica\Search  $search, string  $expiryTime = '1m') 

Constructor.

Parameters

\Elastica\Search $search
string $expiryTime

current()

current() : \Elastica\ResultSet

Returns current result set.

Returns

\Elastica\ResultSet

next()

next() 

Next scroll search.

key()

key() : string

Returns scroll id.

Returns

string

valid()

valid() : boolean

Returns true if current result set contains at least one hit.

Returns

boolean

rewind()

rewind() 

Initial scroll search.

_setScrollId()

_setScrollId(\Elastica\ResultSet  $resultSet) 

Prepares Scroll for next request.

Parameters

\Elastica\ResultSet $resultSet

_saveOptions()

_saveOptions() 

Save all search options manipulated by Scroll.

_revertOptions()

_revertOptions() 

Revert search options to previously saved state.