The IntlRuleBasedBreakIterator class

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

Introduction

A subclass of IntlBreakIterator that encapsulates ICU break iterators whose behavior is specified using a set of rules. This is the most common kind of break iterators.

These rules are described in the » ICU Boundary Analysis User Guide.

Class synopsis

classIntlRuleBasedBreakIteratorextendsIntlBreakIterator {

publicconstintIntlBreakIterator::DONE;

publicconstintIntlBreakIterator::WORD_NONE;

publicconstintIntlBreakIterator::WORD_NONE_LIMIT;

publicconstintIntlBreakIterator::WORD_NUMBER;

publicconstintIntlBreakIterator::WORD_NUMBER_LIMIT;

publicconstintIntlBreakIterator::WORD_LETTER;

publicconstintIntlBreakIterator::WORD_LETTER_LIMIT;

publicconstintIntlBreakIterator::WORD_KANA;

publicconstintIntlBreakIterator::WORD_KANA_LIMIT;

publicconstintIntlBreakIterator::WORD_IDEO;

publicconstintIntlBreakIterator::WORD_IDEO_LIMIT;

publicconstintIntlBreakIterator::LINE_SOFT;

publicconstintIntlBreakIterator::LINE_SOFT_LIMIT;

publicconstintIntlBreakIterator::LINE_HARD;

publicconstintIntlBreakIterator::LINE_HARD_LIMIT;

publicconstintIntlBreakIterator::SENTENCE_TERM;

publicconstintIntlBreakIterator::SENTENCE_TERM_LIMIT;

publicconstintIntlBreakIterator::SENTENCE_SEP;

publicconstintIntlBreakIterator::SENTENCE_SEP_LIMIT;

public__construct(string$rules, bool$compiled = false)

publicgetBinaryRules(): string|false

publicgetRules(): string|false

publicgetRuleStatus(): int

publicgetRuleStatusVec(): array|false

publicstaticIntlBreakIterator::createCharacterInstance(?string$locale = null): ?IntlBreakIterator

publicstaticIntlBreakIterator::createCodePointInstance(): IntlCodePointBreakIterator

publicstaticIntlBreakIterator::createLineInstance(?string$locale = null): ?IntlBreakIterator

publicstaticIntlBreakIterator::createSentenceInstance(?string$locale = null): ?IntlBreakIterator

publicstaticIntlBreakIterator::createTitleInstance(?string$locale = null): ?IntlBreakIterator

publicstaticIntlBreakIterator::createWordInstance(?string$locale = null): ?IntlBreakIterator

publicIntlBreakIterator::current(): int

publicIntlBreakIterator::first(): int

publicIntlBreakIterator::following(int$offset): int

publicIntlBreakIterator::getErrorCode(): int

publicIntlBreakIterator::getErrorMessage(): string

publicIntlBreakIterator::getLocale(int$type): string|false

publicIntlBreakIterator::getPartsIterator(string$type = IntlPartsIterator::KEY_SEQUENTIAL): IntlPartsIterator

publicIntlBreakIterator::getText(): ?string

publicIntlBreakIterator::isBoundary(int$offset): bool

publicIntlBreakIterator::last(): int

publicIntlBreakIterator::next(?int$offset = null): int

publicIntlBreakIterator::preceding(int$offset): int

publicIntlBreakIterator::previous(): int

publicIntlBreakIterator::setText(string$text): bool

}

IntlRuleBasedBreakIterator::__construct — Create iterator from ruleset
IntlRuleBasedBreakIterator::getBinaryRules — Get the binary form of compiled rules
IntlRuleBasedBreakIterator::getRules — Get the rule set used to create this object
IntlRuleBasedBreakIterator::getRuleStatus — Get the largest status value from the break rules that determined the current break position
IntlRuleBasedBreakIterator::getRuleStatusVec — Get the status values from the break rules that determined the current break position

The IntlRuleBasedBreakIterator class

Introduction

Class synopsis

Table of Contents