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 */

public const int IntlBreakIterator::DONE ;

public const int IntlBreakIterator::WORD_NONE ;

public const int IntlBreakIterator::WORD_NONE_LIMIT ;

public const int IntlBreakIterator::WORD_NUMBER ;

public const int IntlBreakIterator::WORD_NUMBER_LIMIT ;

public const int IntlBreakIterator::WORD_LETTER ;

public const int IntlBreakIterator::WORD_LETTER_LIMIT ;

public const int IntlBreakIterator::WORD_KANA ;

public const int IntlBreakIterator::WORD_KANA_LIMIT ;

public const int IntlBreakIterator::WORD_IDEO ;

public const int IntlBreakIterator::WORD_IDEO_LIMIT ;

public const int IntlBreakIterator::LINE_SOFT ;

public const int IntlBreakIterator::LINE_SOFT_LIMIT ;

public const int IntlBreakIterator::LINE_HARD ;

public const int IntlBreakIterator::LINE_HARD_LIMIT ;

public const int IntlBreakIterator::SENTENCE_TERM ;

public const int IntlBreakIterator::SENTENCE_TERM_LIMIT ;

public const int IntlBreakIterator::SENTENCE_SEP ;

public const int IntlBreakIterator::SENTENCE_SEP_LIMIT ;

/* 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

public IntlBreakIterator::getErrorMessage (): string

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

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

Found A Problem?

Learn How To Improve This Page • Submit a Pull Request • Report a Bug

+add a note

User Contributed Notes

There are no user contributed notes for this page.

The IntlRuleBasedBreakIterator class

Introduction

Class synopsis

Table of Contents

Found A Problem?

User Contributed Notes