The IntlBreakIterator class

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

Introduction

A “break iterator” is an ICU object that exposes methods for locating boundaries in text (e.g. word or sentence boundaries). The PHP IntlBreakIterator serves as the base class for all types of ICU break iterators. Where extra functionality is available, the intl extension may expose the ICU break iterator with suitable subclasses, such as IntlRuleBasedBreakIterator or IntlCodePointBreakIterator.

This class implements IteratorAggregate. Traversing an IntlBreakIterator yields non-negative integer values representing the successive locations of the text boundaries, expressed as UTF-8 code units (byte) counts, taken from the beginning of the text (which has the location 0). The keys yielded by the iterator simply form the sequence of natural numbers {0, 1, 2, …}.

Class synopsis

class IntlBreakIterator implements IteratorAggregate {

/* Constants */

public const int DONE;

public const int WORD_NONE;

public const int WORD_NONE_LIMIT;

public const int WORD_NUMBER;

public const int WORD_NUMBER_LIMIT;

public const int WORD_LETTER;

public const int WORD_LETTER_LIMIT;

public const int WORD_KANA;

public const int WORD_KANA_LIMIT;

public const int WORD_IDEO;

public const int WORD_IDEO_LIMIT;

public const int LINE_SOFT;

public const int LINE_SOFT_LIMIT;

public const int LINE_HARD;

public const int LINE_HARD_LIMIT;

public const int SENTENCE_TERM;

public const int SENTENCE_TERM_LIMIT;

public const int SENTENCE_SEP;

public const int SENTENCE_SEP_LIMIT;

/* Methods */

private function __construct()

public static function createCharacterInstance(?string $locale = null): ?IntlBreakIterator

public static function createCodePointInstance(): IntlCodePointBreakIterator

public static function createLineInstance(?string $locale = null): ?IntlBreakIterator

public static function createSentenceInstance(?string $locale = null): ?IntlBreakIterator

public static function createTitleInstance(?string $locale = null): ?IntlBreakIterator

public static function createWordInstance(?string $locale = null): ?IntlBreakIterator

public function current(): int

public function first(): int

public function following(int $offset): int

public function getErrorCode(): int

public function getErrorMessage(): string

public function getLocale(int $type): string|false

public function getPartsIterator(int $type = IntlPartsIterator::KEY_SEQUENTIAL): IntlPartsIterator

public function getText(): ?string

public function isBoundary(int $offset): bool

public function last(): int

public function next(?int $offset = null): int

public function preceding(int $offset): int

public function previous(): int

public function setText(string $text): bool

}

Predefined Constants

IntlBreakIterator::DONE int
IntlBreakIterator::WORD_NONE int
IntlBreakIterator::WORD_NONE_LIMIT int
IntlBreakIterator::WORD_NUMBER int
IntlBreakIterator::WORD_NUMBER_LIMIT int
IntlBreakIterator::WORD_LETTER int
IntlBreakIterator::WORD_LETTER_LIMIT int
IntlBreakIterator::WORD_KANA int
IntlBreakIterator::WORD_KANA_LIMIT int
IntlBreakIterator::WORD_IDEO int
IntlBreakIterator::WORD_IDEO_LIMIT int
IntlBreakIterator::LINE_SOFT int
IntlBreakIterator::LINE_SOFT_LIMIT int
IntlBreakIterator::LINE_HARD int
IntlBreakIterator::LINE_HARD_LIMIT int
IntlBreakIterator::SENTENCE_TERM int
IntlBreakIterator::SENTENCE_TERM_LIMIT int
IntlBreakIterator::SENTENCE_SEP int
IntlBreakIterator::SENTENCE_SEP_LIMIT int

Changelog

Version	Description
8.4.0	The class constants are now typed.
8.0.0	IntlBreakIterator implements IteratorAggregate now. Previously, Traversable was implemented instead.

IntlBreakIterator::__construct — Private constructor for disallowing instantiation
IntlBreakIterator::createCharacterInstance — Create break iterator for boundaries of combining character sequences
IntlBreakIterator::createCodePointInstance — Create break iterator for boundaries of code points
IntlBreakIterator::createLineInstance — Create break iterator for logically possible line breaks
IntlBreakIterator::createSentenceInstance — Create break iterator for sentence breaks
IntlBreakIterator::createTitleInstance — Create break iterator for title-casing breaks
IntlBreakIterator::createWordInstance — Create break iterator for word breaks
IntlBreakIterator::current — Get index of current position
IntlBreakIterator::first — Set position to the first character in the text
IntlBreakIterator::following — Advance the iterator to the first boundary following specified offset
IntlBreakIterator::getErrorCode — Get last error code on the object
IntlBreakIterator::getErrorMessage — Get last error message on the object
IntlBreakIterator::getLocale — Get the locale associated with the object
IntlBreakIterator::getPartsIterator — Create iterator for navigating fragments between boundaries
IntlBreakIterator::getText — Get the text being scanned
IntlBreakIterator::isBoundary — Tell whether an offset is a boundaryʼs offset
IntlBreakIterator::last — Set the iterator position to index beyond the last character
IntlBreakIterator::next — Advance the iterator the next boundary
IntlBreakIterator::preceding — Set the iterator position to the first boundary before an offset
IntlBreakIterator::previous — Set the iterator position to the boundary immediately before the current
IntlBreakIterator::setText — Set the text being scanned

The IntlBreakIterator class

Introduction

Class synopsis

Predefined Constants

Changelog

Table of Contents