EmptyIterator

class EmptyIterator implements Iterator (View source)

The EmptyIterator class for an empty iterator.

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 108
mixed current()

Return the current element

Return Value

mixed

Can return any type.

at line 116
void next()

Move forward to next element

Return Value

void

Any returned value is ignored.

at line 124
mixed key()

Return the key of the current element

Return Value

mixed

TKey on success, or null on failure.

at line 133
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 142
void rewind()

Rewind the Iterator to the first element

Return Value

void

Any returned value is ignored.