final class RedisBlessScanIterator implements Iterator (View source)

Lazy iterator returned by Redis::bless('SCAN', ...) and RedisCluster::bless('SCAN', ...).

Methods

mixed
current()

Returns the current key name, or null when the scan has finished.

mixed
key()

Returns the position of the current key, or null when the scan has finished.

void
next()

Moves to the next key.

void
rewind()

Restarts the scan if any keys have been consumed.

bool
valid()

Returns whether there is a current key, fetching pages as needed.

Details

mixed current()

Returns the current key name, or null when the scan has finished.

Return Value

mixed

mixed key()

Returns the position of the current key, or null when the scan has finished.

Return Value

mixed

void next()

Moves to the next key.

Return Value

void

void rewind()

Restarts the scan if any keys have been consumed.

Return Value

void

bool valid()

Returns whether there is a current key, fetching pages as needed.

Return Value

bool