php8.5
Home/ Manual/ reference / intl/ The IntlBreakIterator class

The IntlBreakIterator class

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.

Intro

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 { }

Predefined Constants

IntlBreakIterator::DONEint
IntlBreakIterator::WORD_NONEint
IntlBreakIterator::WORD_NONE_LIMITint
IntlBreakIterator::WORD_NUMBERint
IntlBreakIterator::WORD_NUMBER_LIMITint
IntlBreakIterator::WORD_LETTERint
IntlBreakIterator::WORD_LETTER_LIMITint
IntlBreakIterator::WORD_KANAint
IntlBreakIterator::WORD_KANA_LIMITint
IntlBreakIterator::WORD_IDEOint
IntlBreakIterator::WORD_IDEO_LIMITint
IntlBreakIterator::LINE_SOFTint
IntlBreakIterator::LINE_SOFT_LIMITint
IntlBreakIterator::LINE_HARDint
IntlBreakIterator::LINE_HARD_LIMITint
IntlBreakIterator::SENTENCE_TERMint
IntlBreakIterator::SENTENCE_TERM_LIMITint
IntlBreakIterator::SENTENCE_SEPint
IntlBreakIterator::SENTENCE_SEP_LIMITint

Changelog

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

Intlbreakiterator

In this section

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

Source: reference/intl/intlbreakiterator.xml · from the official PHP manual (php/doc-en)