The IntlPartsIterator class

(No version information available, might only be in Git)

Introduction

Objects of this class can be obtained from IntlBreakIterator objects. While the break iterators provide a sequence of boundary positions when iterated, IntlPartsIterator objects provide, as a convenience, the text fragments comprehended between two successive boundaries.

The keys may represent the offset of the left boundary, right boundary, or they may just the sequence of non-negative integers. See IntlBreakIterator::getPartsIterator().

Class synopsis

IntlPartsIterator extends IntlIterator implements Iterator {
/* Constants */
const integer KEY_SEQUENTIAL = 0 ;
const integer KEY_LEFT = 1 ;
const integer KEY_RIGHT = 2 ;
/* Methods */
public getBreakIterator ( void ) : IntlBreakIterator
/* Inherited methods */
public IntlIterator::current ( void ) : mixed
public IntlIterator::key ( void ) : string
public IntlIterator::next ( void ) : void
public IntlIterator::rewind ( void ) : void
public IntlIterator::valid ( void ) : bool
}

Predefined Constants

IntlPartsIterator::KEY_SEQUENTIAL

IntlPartsIterator::KEY_LEFT

IntlPartsIterator::KEY_RIGHT

Table of Contents