NoRewindIterator

class NoRewindIterator extends IteratorIterator (View source)

This iterator cannot be rewinded.

Methods

__construct(Traversable $iterator)

Construct a NoRewindIterator

Iterator|null
getInnerIterator()

Get the inner iterator

void
rewind()

Prevents the rewind operation on the inner iterator.

bool
valid()

Validates the iterator

TKey|null
key()

Get the current key

TValue
current()

Get the current value

void
next()

Forward to the next element

Details

at line 1054
__construct(Traversable $iterator)

Construct a NoRewindIterator

Parameters

Traversable $iterator

at line 1106
Iterator|null getInnerIterator()

Get the inner iterator

Return Value

Iterator|null

The inner iterator for the current entry.

at line 1061
void rewind()

Prevents the rewind operation on the inner iterator.

Return Value

void

Any returned value is ignored.

at line 1070
bool valid()

Validates the iterator

Return Value

bool

The return value will be casted to boolean and then evaluated. Returns true on success or false on failure.

at line 1079
TKey|null key()

Get the current key

Return Value

TKey|null

TKey on success, or null on failure.

at line 1088
TValue current()

Get the current value

Return Value

TValue

Can return any type.

at line 1097
void next()

Forward to the next element

Return Value

void

Any returned value is ignored.