Elastica
\
Elastica
Aggregation
Bulk
Action
Cluster
Health
Collapse
Connection
Strategy
Exception
Bulk
Response
Connection
Index
Multi
Node
Processor
Query
QueryBuilder
DSL
Version
Rescore
ResultSet
Script
Suggest
CandidateGenerator
Transport

\ElasticaScroll

Scroll Iterator.

Summary

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

Properties

$expiryTime

$expiryTime : string

Type

string

$_nextScrollId

$_nextScrollId : string|null

Type

string|null

$_currentResultSet

$_currentResultSet : \Elastica\ResultSet|null

Type

\Elastica\ResultSet|null

$_options

$_options : array

0: scroll<br> 1: scroll id.

Type

array

$totalPages

$totalPages :

Type

$currentPage

$currentPage :

Type

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.

clear()

clear()

Cleares the search context on ES and marks this Scroll instance as finished.

_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.