PHP Class Predis\Collection\Iterator\ListKey

This iterator tries to emulate the behaviour of cursor-based iterators based on the SCAN-family of commands introduced in Redis <= 2.8, meaning that due to its incremental nature with multiple fetches it can only offer limited guarantees on the returned elements because the collection can change several times (trimmed, deleted, overwritten) during the iteration process.

See link: http://redis.io/commands/lrange

Author: Daniele Alessandri ([email protected])

Inheritance: implements Iterator

Show file Open project: nrk/predis Class Usage Examples

Protected Properties

Property	Type	Description
$client
$count
$current
$elements
$fetchmore
$key
$position
$valid

Public Methods

Method	Description
__construct ( Predis\ClientInterface $client, string $key, integer $count = 10 )
current ( )
key ( )
next ( )
rewind ( )
valid ( )

Protected Methods

Method	Description
executeCommand ( ) : array	Fetches a new set of elements from the remote collection, effectively advancing the iteration process.
extractNext ( )	Extracts next values for key() and current().
fetch ( )	Populates the local buffer of elements fetched from the server during the iteration.
requiredCommand ( Predis\ClientInterface $client, string $commandID )	Ensures that the client instance supports the specified Redis command required to fetch elements from the server to perform the iteration.
reset ( )	Resets the inner state of the iterator.

Method Details

__construct() public method

public __construct ( Predis\ClientInterface $client, string $key, integer $count = 10 )
$client	Predis\ClientInterface	Client connected to Redis.
$key	string	Redis list key.
$count	integer	Number of items retrieved on each fetch operation.

current() public method

public current ( )

executeCommand() protected method

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

protected executeCommand ( ) : array
return	array

extractNext() protected method

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

protected extractNext ( )

fetch() protected method

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

protected fetch ( )

key() public method

public key ( )

next() public method

public next ( )

requiredCommand() protected method

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

protected requiredCommand ( Predis\ClientInterface $client, string $commandID )
$client	Predis\ClientInterface	Client connected to Redis.
$commandID	string	Command ID.

reset() protected method

Resets the inner state of the iterator.

protected reset ( )

rewind() public method

public rewind ( )

valid() public method

public valid ( )

Property Details

$client protected property

protected $client

$count protected property

protected $count

$current protected property

protected $current

$elements protected property

protected $elements

$fetchmore protected property

protected $fetchmore

$key protected property

protected $key

$position protected property

protected $position

$valid protected property

protected $valid