PHP Manual
intl
The IntlRuleBasedBreakIterator class

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

class IntlRuleBasedBreakIterator extends IntlBreakIterator {

/* Inherited constants */

const int IntlBreakIterator::DONE = -1;

const int IntlBreakIterator::WORD_NONE = 0;

const int IntlBreakIterator::WORD_NONE_LIMIT = 100;

const int IntlBreakIterator::WORD_NUMBER = 100;

const int IntlBreakIterator::WORD_NUMBER_LIMIT = 200;

const int IntlBreakIterator::WORD_LETTER = 200;

const int IntlBreakIterator::WORD_LETTER_LIMIT = 300;

const int IntlBreakIterator::WORD_KANA = 300;

const int IntlBreakIterator::WORD_KANA_LIMIT = 400;

const int IntlBreakIterator::WORD_IDEO = 400;

const int IntlBreakIterator::WORD_IDEO_LIMIT = 500;

const int IntlBreakIterator::LINE_SOFT = 0;

const int IntlBreakIterator::LINE_SOFT_LIMIT = 100;

const int IntlBreakIterator::LINE_HARD = 100;

const int IntlBreakIterator::LINE_HARD_LIMIT = 200;

const int IntlBreakIterator::SENTENCE_TERM = 0;

const int IntlBreakIterator::SENTENCE_TERM_LIMIT = 100;

const int IntlBreakIterator::SENTENCE_SEP = 100;

const int IntlBreakIterator::SENTENCE_SEP_LIMIT = 200;

/* Methods */

public __construct(string $rules, bool $compiled = false)

public getBinaryRules(): string|false

public getRules(): string|false

public getRuleStatus(): int

public getRuleStatusVec(): array|false

/* Inherited methods */

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

public static IntlBreakIterator::createCodePointInstance(): IntlCodePointBreakIterator

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

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

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

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

public IntlBreakIterator::current(): int

public IntlBreakIterator::first(): int

public IntlBreakIterator::following(int $offset): int

public IntlBreakIterator::getErrorCode(): int

intl_get_error_code(): int

public IntlBreakIterator::getErrorMessage(): string|false

intl_get_error_message(): string

public IntlBreakIterator::getLocale(int $type): string

public IntlBreakIterator::getPartsIterator(string $type = IntlPartsIterator::KEY_SEQUENTIAL): IntlPartsIterator

public IntlBreakIterator::getText(): ?string

public IntlBreakIterator::isBoundary(int $offset): bool

public IntlBreakIterator::last(): int

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

public IntlBreakIterator::preceding(int $offset): int

public IntlBreakIterator::previous(): int

public IntlBreakIterator::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