The IntlPartsIterator class

Introduction

(PHP 5 >= 5.5.0, PHP 7)

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 int KEY_SEQUENTIAL = 0 ;
const int KEY_LEFT = 1 ;
const int KEY_RIGHT = 2 ;
/* Methods */
public getBreakIterator ( ) : IntlBreakIterator
/* Inherited methods */
public IntlIterator::current ( ) : mixed
public IntlIterator::key ( ) : string
public IntlIterator::next ( ) : void
public IntlIterator::rewind ( ) : void
public IntlIterator::valid ( ) : bool
}

Predefined Constants

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

Table of Contents

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