IntlIterator

Since: 5.5

class IntlIterator implements Iterator (View source)

Methods

TValue
current()

Return the current element

TKey|null
key()

Return the key of the current element

void
next()

Move forward to next element

void
rewind()

Rewind the Iterator to the first element

bool
valid()

Checks if current position is valid

Details

at line 3724
TValue current()

Return the current element

Return Value

TValue

Can return any type.

at line 3728
TKey|null key()

Return the key of the current element

Return Value

TKey|null

TKey on success, or null on failure.

at line 3732
void next()

Move forward to next element

Return Value

void

Any returned value is ignored.

at line 3736
void rewind()

Rewind the Iterator to the first element

Return Value

void

Any returned value is ignored.

at line 3740
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.