Documentation

HashKey extends CursorBasedIterator

in package

• Application

Abstracts the iteration of fields and values of an hash by leveraging the HSCAN command (Redis >= 2.8) wrapped in a fully-rewindable PHP iterator.

Tags

author

Daniele Alessandri suppakilla@gmail.com

link

http://redis.io/commands/scan

Table of Contents

$client  : mixed

$count  : mixed

$current  : mixed

$cursor  : mixed

$elements  : mixed

$fetchmore  : mixed

$key  : mixed

$match  : mixed

$position  : mixed

$valid  : mixed

__construct()  : mixed

current()  : mixed

{@inheritdoc}

key()  : mixed

{@inheritdoc}

next()  : mixed

{@inheritdoc}

rewind()  : mixed

{@inheritdoc}

valid()  : mixed

{@inheritdoc}

executeCommand()  : array<string|int, mixed>

Fetches a new set of elements from the remote collection, effectively advancing the iteration process.

extractNext()  : mixed

Extracts next values for key() and current().

fetch()  : mixed

Populates the local buffer of elements fetched from the server during the iteration.

getScanOptions()  : array<string|int, mixed>

Returns an array of options for the `SCAN` command.

requiredCommand()  : mixed

Ensures that the client supports the specified Redis command required to fetch elements from the server to perform the iteration.

reset()  : mixed

Resets the inner state of the iterator.