IntlPartsIterator

Since: 5.5

class IntlPartsIterator extends IntlIterator implements Iterator (View source)

Constants

KEY_SEQUENTIAL

KEY_LEFT

KEY_RIGHT

Methods

TValue
current()

Return the current element

from  IntlIterator
TKey|null
key()

Return the key of the current element

from  IntlIterator
void
next()

Move forward to next element

from  IntlIterator
void
rewind()

Rewind the Iterator to the first element

from  IntlIterator
bool
valid()

Checks if current position is valid

from  IntlIterator
IntlBreakIterator
getBreakIterator()

No description

getRuleStatus()

No description

Details

in IntlIterator at line 3724
TValue current()

Return the current element

Return Value

TValue

Can return any type.

in IntlIterator at line 3728
TKey|null key()

Return the key of the current element

Return Value

TKey|null

TKey on success, or null on failure.

in IntlIterator at line 3732
void next()

Move forward to next element

Return Value

void

Any returned value is ignored.

in IntlIterator at line 3736
void rewind()

Rewind the Iterator to the first element

Return Value

void

Any returned value is ignored.

in IntlIterator 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.

at line 7745
IntlBreakIterator getBreakIterator()

No description

Return Value

IntlBreakIterator

at line 7753
getRuleStatus()

Since: 8.1

No description