IntlIterator

Since: 5.5

class IntlIterator implements Iterator (View source)

Methods

mixed
current()

Return the current element

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

Return the current element

Return Value

mixed

Can return any type.

at line 3534
mixed key()

Return the key of the current element

Return Value

mixed

TKey on success, or null on failure.

at line 3537
void next()

Move forward to next element

Return Value

void

Any returned value is ignored.

at line 3540
void rewind()

Rewind the Iterator to the first element

Return Value

void

Any returned value is ignored.

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