The IntlBreakIterator class

(PHP 5 >= 5.5.0, PHP 7)

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

PHP: IntlBreakIterator - Manual Home of Manuel PHP Contents Haut

Class synopsis

IntlBreakIterator implements Traversable {

/* Constants */

const integer DONE = -1 ;

const integer WORD_NONE = 0 ;

const integer WORD_NONE_LIMIT = 100 ;

const integer WORD_NUMBER = 100 ;

const integer WORD_NUMBER_LIMIT = 200 ;

const integer WORD_LETTER = 200 ;

const integer WORD_LETTER_LIMIT = 300 ;

const integer WORD_KANA = 300 ;

const integer WORD_KANA_LIMIT = 400 ;

const integer WORD_IDEO = 400 ;

const integer WORD_IDEO_LIMIT = 500 ;

const integer LINE_SOFT = 0 ;

const integer LINE_SOFT_LIMIT = 100 ;

const integer LINE_HARD = 100 ;

const integer LINE_HARD_LIMIT = 200 ;

const integer SENTENCE_TERM = 0 ;

const integer SENTENCE_TERM_LIMIT = 100 ;

const integer SENTENCE_SEP = 100 ;

const integer SENTENCE_SEP_LIMIT = 200 ;

/* Methods */

private __construct ( void )

public static createCharacterInstance ([ string $locale ] ) : IntlBreakIterator

public static createCodePointInstance ( void ) : IntlBreakIterator

public static createLineInstance ([ string $locale ] ) : IntlBreakIterator

public static createSentenceInstance ([ string $locale ] ) : IntlBreakIterator

public static createTitleInstance ([ string $locale ] ) : IntlBreakIterator

public static createWordInstance ([ string $locale ] ) : IntlBreakIterator

public current ( void ) : int

public first ( void ) : int

public following ( int $offset ) : int

public getErrorCode ( void ) : int

intl_get_error_code ( void ) : int

public getErrorMessage ( void ) : string

intl_get_error_message ( void ) : string

public getLocale ( string $locale_type ) : string

public getPartsIterator ([ int $key_type = IntlPartsIterator::KEY_SEQUENTIAL ] ) : IntlPartsIterator

public getText ( void ) : string

public isBoundary ( int $offset ) : bool

public last ( void ) : int

public next ([ int $offset ] ) : int

public preceding ( int $offset ) : int

public previous ( void ) : int

public setText ( string $text ) : bool

}

PHP: IntlBreakIterator - Manual Home of Manuel PHP Contents Haut

Predefined Constants

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

PHP: IntlBreakIterator - Manual Home of Manuel PHP Contents Haut

IntlBreakIterator::__construct — Private constructor for disallowing instantiation
IntlBreakIterator::createCharacterInstance — Create break iterator for boundaries of combining character sequences
IntlBreakIterator::createCodePointInstance — Create break iterator for boundaries of code points
IntlBreakIterator::createLineInstance — Create break iterator for logically possible line breaks
IntlBreakIterator::createSentenceInstance — Create break iterator for sentence breaks
IntlBreakIterator::createTitleInstance — Create break iterator for title-casing breaks
IntlBreakIterator::createWordInstance — Create break iterator for word breaks
IntlBreakIterator::current — Get index of current position
IntlBreakIterator::first — Set position to the first character in the text
IntlBreakIterator::following — Advance the iterator to the first boundary following specified offset
IntlBreakIterator::getErrorCode — Get last error code on the object
IntlBreakIterator::getErrorMessage — Get last error message on the object
IntlBreakIterator::getLocale — Get the locale associated with the object
IntlBreakIterator::getPartsIterator — Create iterator for navigating fragments between boundaries
IntlBreakIterator::getText — Get the text being scanned
IntlBreakIterator::isBoundary — Tell whether an offset is a boundaryʼs offset
IntlBreakIterator::last — Set the iterator position to index beyond the last character
IntlBreakIterator::next — Advance the iterator the next boundary
IntlBreakIterator::preceding — Set the iterator position to the first boundary before an offset
IntlBreakIterator::previous — Set the iterator position to the boundary immediately before the current
IntlBreakIterator::setText — Set the text being scanned

Find a PHP function

English translation

You have asked to visit this site in English. For now, only the interface is translated, but not all the content yet.

If you want to help me in translations, your contribution is welcome. All you need to do is register on the site, and send me a message asking me to add you to the group of translators, which will give you the opportunity to translate the pages you want. A link at the bottom of each translated page indicates that you are the translator, and has a link to your profile.

Thank you in advance.

Document created the 30/01/2003, last modified the 26/10/2018
Source of the printed document:https://www.gaudry.be/en/php-rf-class.intlbreakiterator.html

The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.

References

Manuel PHP : http://php.net

These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.

Contents Haut

The IntlBreakIterator class

Introduction

Class synopsis

Predefined Constants

Table of Contents

References