The IntlPartsIterator class

(PHP 5 >= 5.5.0, PHP 7, PHP 8)

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

class IntlPartsIterator extends IntlIterator {
/* Constants */
public const int KEY_SEQUENTIAL;
public const int KEY_LEFT;
public const int KEY_RIGHT;
/* Methods */
public getBreakIterator(): IntlBreakIterator
/* Inherited methods */
public IntlIterator::current(): mixed
public IntlIterator::key(): mixed
public IntlIterator::next(): void
public IntlIterator::rewind(): void
public IntlIterator::valid(): bool
}

Changelog

VersionDescription
8.4.0The class constants are now typed.

Table of Contents