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

    classIntlBreakIteratorimplementsIteratorAggregate {
    publicconstintDONE;
    publicconstintWORD_NONE;
    publicconstintWORD_NONE_LIMIT;
    publicconstintWORD_NUMBER;
    publicconstintWORD_NUMBER_LIMIT;
    publicconstintWORD_LETTER;
    publicconstintWORD_LETTER_LIMIT;
    publicconstintWORD_KANA;
    publicconstintWORD_KANA_LIMIT;
    publicconstintWORD_IDEO;
    publicconstintWORD_IDEO_LIMIT;
    publicconstintLINE_SOFT;
    publicconstintLINE_SOFT_LIMIT;
    publicconstintLINE_HARD;
    publicconstintLINE_HARD_LIMIT;
    publicconstintSENTENCE_TERM;
    publicconstintSENTENCE_TERM_LIMIT;
    publicconstintSENTENCE_SEP;
    publicconstintSENTENCE_SEP_LIMIT;
    private__construct()
    publicstaticcreateCharacterInstance(?string$locale = null): ?IntlBreakIterator
    publicstaticcreateCodePointInstance(): IntlCodePointBreakIterator
    publicstaticcreateLineInstance(?string$locale = null): ?IntlBreakIterator
    publicstaticcreateSentenceInstance(?string$locale = null): ?IntlBreakIterator
    publicstaticcreateTitleInstance(?string$locale = null): ?IntlBreakIterator
    publicstaticcreateWordInstance(?string$locale = null): ?IntlBreakIterator
    publiccurrent(): int
    publicfirst(): int
    publicfollowing(int$offset): int
    publicgetErrorCode(): int
    publicgetErrorMessage(): string
    publicgetLocale(int$type): string|false
    publicgetPartsIterator(string$type = IntlPartsIterator::KEY_SEQUENTIAL): IntlPartsIterator
    publicgetText(): ?string
    publicisBoundary(int$offset): bool
    publiclast(): int
    publicnext(?int$offset = null): int
    publicpreceding(int$offset): int
    publicprevious(): int
    publicsetText(string$text): bool
    }

    Changelog

    VersionDescription
    8.0.0IntlBreakIterator implements IteratorAggregate now. Previously, Traversable was implemented instead.

    Table of Contents

    To Top