A classe IntlBreakIterator

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

Introdução

Um “iterador de quebra” é um objeto ICU que expõe métodos para localização de limites no texto (ex.: início/fim de palavras ou frases). A classe IntlBreakIterator do PHP serve como classe base para todos os tipos de iteradores de quebra ICU. Onde existir funcionalidade extra, a extensão Intl pode expor o iterador de quebra ICU com subclasses convenientes, como IntlRuleBasedBreakIterator ou IntlCodePointBreakIterator.

Esta classe implementa a interface IteratorAggregate. Percorrer um IntlBreakIterator produz valores inteiros não negativos que representam as localizações sucessivas dos limites do texto, expressos como contagem de unidades de código (bytes) UTF-8, tomadas do início do texto (que tem a localização 0). As chaves geradas pelo iterador formam simplesmente a sequência de números naturais {0, 1, 2, …}.

Resumo da classe

class IntlBreakIterator implements IteratorAggregate {

/* Constantes */

public const int DONE;

public const int WORD_NONE;

public const int WORD_NONE_LIMIT;

public const int WORD_NUMBER;

public const int WORD_NUMBER_LIMIT;

public const int WORD_LETTER;

public const int WORD_LETTER_LIMIT;

public const int WORD_KANA;

public const int WORD_KANA_LIMIT;

public const int WORD_IDEO;

public const int WORD_IDEO_LIMIT;

public const int LINE_SOFT;

public const int LINE_SOFT_LIMIT;

public const int LINE_HARD;

public const int LINE_HARD_LIMIT;

public const int SENTENCE_TERM;

public const int SENTENCE_TERM_LIMIT;

public const int SENTENCE_SEP;

public const int SENTENCE_SEP_LIMIT;

/* Métodos */

private __construct()

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

public static createCodePointInstance(): IntlCodePointBreakIterator

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

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

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

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

public current(): int

public first(): int

public following(int $offset): int

public getErrorCode(): int

public getErrorMessage(): string

public getLocale(int $type): string|false

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

public getText(): ?string

public isBoundary(int $offset): bool

public last(): int

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

public preceding(int $offset): int

public previous(): int

public setText(string $text): bool

}

Constantes predefinidas

IntlBreakIterator::DONE int
IntlBreakIterator::WORD_NONE int
IntlBreakIterator::WORD_NONE_LIMIT int
IntlBreakIterator::WORD_NUMBER int
IntlBreakIterator::WORD_NUMBER_LIMIT int
IntlBreakIterator::WORD_LETTER int
IntlBreakIterator::WORD_LETTER_LIMIT int
IntlBreakIterator::WORD_KANA int
IntlBreakIterator::WORD_KANA_LIMIT int
IntlBreakIterator::WORD_IDEO int
IntlBreakIterator::WORD_IDEO_LIMIT int
IntlBreakIterator::LINE_SOFT int
IntlBreakIterator::LINE_SOFT_LIMIT int
IntlBreakIterator::LINE_HARD int
IntlBreakIterator::LINE_HARD_LIMIT int
IntlBreakIterator::SENTENCE_TERM int
IntlBreakIterator::SENTENCE_TERM_LIMIT int
IntlBreakIterator::SENTENCE_SEP int
IntlBreakIterator::SENTENCE_SEP_LIMIT int

Registro de Alterações

Versão	Descrição
8.4.0	As constantes de classe agora são tipadas.
8.0.0	IntlBreakIterator agora implementa IteratorAggregate. Anteriormente, Traversable era implementado.

Índice

IntlBreakIterator::__construct — Construtor privado para não permitir instanciação
IntlBreakIterator::createCharacterInstance — Cria um iterador de quebra para limites de sequências de combinação de caracteres
IntlBreakIterator::createCodePointInstance — Cria um iterador de quebra para limites de pontos de código
IntlBreakIterator::createLineInstance — Cria um iterador de quebra para quebras de linha logicamente possíveis
IntlBreakIterator::createSentenceInstance — Cria um iterador de quebra para separação de sentenças
IntlBreakIterator::createTitleInstance — Cria um iterador para quebras de letras de título
IntlBreakIterator::createWordInstance — Cria um iterador de quebra para separação de palavras
IntlBreakIterator::current — Obtém o índice da posição atual
IntlBreakIterator::first — Define a posição para o primeiro caractere no texto
IntlBreakIterator::following — Avança o iterador para o primeiro limite após o deslocamento especificado
IntlBreakIterator::getErrorCode — Obtém o último código de erro no objeto
IntlBreakIterator::getErrorMessage — Obtém a última mensagem de erro no objeto
IntlBreakIterator::getLocale — Obtém a localidade associada com o objeto
IntlBreakIterator::getPartsIterator — Cria um iterador para navegar por fragmentos entre limites
IntlBreakIterator::getText — Obtém o texto sendo percorrido
IntlBreakIterator::isBoundary — Indica se uma posição é um posição de limite
IntlBreakIterator::last — Define a posição do iterador para um índice além do último caractere
IntlBreakIterator::next — Avança o iterador para o próximo limite
IntlBreakIterator::preceding — Define a posição do iterador para o primeiro limite depois de um deslocamento
IntlBreakIterator::previous — Define a posição do iterador para o limite imediatamente anterior ao atual
IntlBreakIterator::setText — Define o texto a ser percorrido