W3cubDocs

/PHP

The IntlPartsIterator class

Introduction

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

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
}

Predefined Constants

IntlPartsIterator::KEY_SEQUENTIAL int
IntlPartsIterator::KEY_LEFT int
IntlPartsIterator::KEY_RIGHT int

Changelog

Version Description
8.4.0 The class constants are now typed.

Table of Contents

© 1997–2025 The PHP Documentation Group
Licensed under the Creative Commons Attribution License v3.0 or later.
https://www.php.net/manual/en/class.intlpartsiterator.php