InfiniteIterator

class InfiniteIterator extends IteratorIterator (View source)

The InfiniteIterator allows one to infinitely iterate over an iterator without having to manually rewind the iterator upon reaching its end.

Methods

__construct(Traversable $iterator)

Constructs an InfiniteIterator

Iterator|null
getInnerIterator()

Get the inner iterator

from  IteratorIterator
void
rewind()

Rewind to the first element

from  IteratorIterator
bool
valid()

Checks if the iterator is valid

from  IteratorIterator
mixed
key()

Get the key of the current element

from  IteratorIterator
mixed
current()

Get the current value

from  IteratorIterator
void
next()

Moves the inner Iterator forward or rewinds it

Details

at line 1117
__construct(Traversable $iterator)

Constructs an InfiniteIterator

Parameters

Traversable $iterator

in IteratorIterator at line 457
Iterator|null getInnerIterator()

Get the inner iterator

Return Value

Iterator|null

The inner iterator for the current entry.

in IteratorIterator at line 465
void rewind()

Rewind to the first element

Return Value

void

Any returned value is ignored.

in IteratorIterator at line 473
bool valid()

Checks if the iterator is valid

Return Value

bool

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

in IteratorIterator at line 481
mixed key()

Get the key of the current element

Return Value

mixed

TKey on success, or null on failure.

in IteratorIterator at line 489
mixed current()

Get the current value

Return Value

mixed

Can return any type.

at line 1124
void next()

Moves the inner Iterator forward or rewinds it

Return Value

void

Any returned value is ignored.