IntlBreakIterator

(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, …}.

Synopsis de la 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éthodes */ 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 pré-définies

IntlBreakIterator::DONE

IntlBreakIterator::WORD_NONE

IntlBreakIterator::WORD_NONE_LIMIT

IntlBreakIterator::WORD_NUMBER

IntlBreakIterator::WORD_NUMBER_LIMIT

IntlBreakIterator::WORD_LETTER

IntlBreakIterator::WORD_LETTER_LIMIT

IntlBreakIterator::WORD_KANA

IntlBreakIterator::WORD_KANA_LIMIT

IntlBreakIterator::WORD_IDEO

IntlBreakIterator::WORD_IDEO_LIMIT

IntlBreakIterator::LINE_SOFT

IntlBreakIterator::LINE_SOFT_LIMIT

IntlBreakIterator::LINE_HARD

IntlBreakIterator::LINE_HARD_LIMIT

IntlBreakIterator::SENTENCE_TERM

IntlBreakIterator::SENTENCE_TERM_LIMIT

IntlBreakIterator::SENTENCE_SEP

IntlBreakIterator::SENTENCE_SEP_LIMIT

Historique

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

Sommaire

• IntlBreakIterator::__construct — Constructeur privé pour désactiver l'instantiation
• IntlBreakIterator::createCharacterInstance — Crée un itérateur pour les limites des séquences de caractères combinés
• IntlBreakIterator::createCodePointInstance — Crée un itérateur pour les limites de points de code
• IntlBreakIterator::createLineInstance — Crée un itérateur pour les coupures de lignes
• IntlBreakIterator::createSentenceInstance — Crée un itérateur pour les coupures de phrase
• IntlBreakIterator::createTitleInstance — Crée un itérateur
• IntlBreakIterator::createWordInstance — Crée un itérateur pour les coupures de mot
• IntlBreakIterator::current — Récupère l'index de la position courante
• IntlBreakIterator::first — Définit la position au premier caractère du texte
• IntlBreakIterator::following — Avance l'itérateur à la première limite suivant la position spécifiée
• IntlBreakIterator::getErrorCode — Récupère le code de la dernière erreur survenue sur l'objet
• IntlBreakIterator::getErrorMessage — Récupère le message de la dernière erreur survenue sur l'objet
• IntlBreakIterator::getLocale — Récupère la locale associée avec l'objet
• IntlBreakIterator::getPartsIterator — Crée un itérateur pour naviguer dans les fragments entre les limites
• IntlBreakIterator::getText — Récupère le texte analysé
• IntlBreakIterator::isBoundary — Indique si une position est une position limite
• IntlBreakIterator::last — Définit la position de l'itérateur à l'index après le dernier caractère
• IntlBreakIterator::next — Avance l'itérateur à la prochaine limite
• IntlBreakIterator::preceding — Définit la position de l'itérateur à la première limite avant la position
• IntlBreakIterator::previous — Définit la position de l'itérateur à la limite immédiate avant la courante
• IntlBreakIterator::setText — Définit le texte à analyser