Iterator

interface Iterator implements Traversable (View source)

Interface for external iterators or objects that can be iterated themselves internally.

Methods

mixed
current()

Return the current element

void
next()

Move forward to next element

mixed
key()

Return the key of the current element

bool
valid()

Checks if current position is valid

void
rewind()

Rewind the Iterator to the first element

Details

at line 69
mixed current()

Return the current element

Return Value

mixed

Can return any type.

at line 77
void next()

Move forward to next element

Return Value

void

Any returned value is ignored.

at line 85
mixed key()

Return the key of the current element

Return Value

mixed

TKey on success, or null on failure.

at line 94
bool valid()

Checks if current position is valid

Return Value

bool

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

at line 102
void rewind()

Rewind the Iterator to the first element

Return Value

void

Any returned value is ignored.