PHP Класс Elastica\Scroll

См. ссылку: https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-scroll.html
Автор: Manuel Andreo Garcia ([email protected])
Наследование: implements Iterator
Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство Тип Описание
$expiryTime string

Защищенные свойства (Protected)

Свойство Тип Описание
$_currentResultSet null | ResultSet
$_nextScrollId null | string
$_options array 0: scroll
1: scroll id
2: search type.
$_search Search

Открытые методы

Метод Описание
__construct ( Search $search, string $expiryTime = '1m' ) Constructor.
current ( ) : ResultSet Returns current result set.
key ( ) : string Returns scroll id.
next ( ) Next scroll search.
rewind ( ) Initial scroll search.
valid ( ) : boolean Returns true if current result set contains at least one hit.

Защищенные методы

Метод Описание
_revertOptions ( ) Revert search options to previously saved state.
_saveOptions ( ) Save all search options manipulated by Scroll.
_setScrollId ( ResultSet $resultSet ) Prepares Scroll for next request.

Описание методов

__construct() публичный Метод

Constructor.
public __construct ( Search $search, string $expiryTime = '1m' )
$search Search
$expiryTime string

_revertOptions() защищенный Метод

Revert search options to previously saved state.
protected _revertOptions ( )

_saveOptions() защищенный Метод

Save all search options manipulated by Scroll.
protected _saveOptions ( )

_setScrollId() защищенный Метод

Prepares Scroll for next request.
protected _setScrollId ( ResultSet $resultSet )
$resultSet ResultSet

current() публичный Метод

Returns current result set.
См. ссылку: http://php.net/manual/en/iterator.current.php
public current ( ) : ResultSet
Результат ResultSet

key() публичный Метод

Returns scroll id.
См. ссылку: http://php.net/manual/en/iterator.key.php
public key ( ) : string
Результат string

next() публичный Метод

Next scroll search.
См. ссылку: http://php.net/manual/en/iterator.next.php
public next ( )

rewind() публичный Метод

Initial scroll search.
См. ссылку: http://php.net/manual/en/iterator.rewind.php
public rewind ( )

valid() публичный Метод

Returns true if current result set contains at least one hit.
См. ссылку: http://php.net/manual/en/iterator.valid.php
public valid ( ) : boolean
Результат boolean

Описание свойств

$_currentResultSet защищенное свойство

protected null|ResultSet,elastica $_currentResultSet
Результат null | ResultSet

$_nextScrollId защищенное свойство

protected null|string $_nextScrollId
Результат null | string

$_options защищенное свойство

0: scroll
1: scroll id
2: search type.
protected array $_options
Результат array

$_search защищенное свойство

protected Search,elastica $_search
Результат Search

$expiryTime публичное свойство

public string $expiryTime
Результат string