<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>The IntlRuleBasedBreakIterator class</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="intlbreakiterator.settext.html">IntlBreakIterator::setText</a></div>
<div class="next" style="text-align: right; float: right;"><a href="intlrulebasedbreakiterator.construct.html">IntlRuleBasedBreakIterator::__construct</a></div>
<div class="up"><a href="book.intl.html">intl</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="class.intlrulebasedbreakiterator" class="reference">
<h1 class="title">The IntlRuleBasedBreakIterator class</h1>
<div class="partintro"><p class="verinfo">(No version information available, might only be in SVN)</p>
<div class="section" id="intlrulebasedbreakiterator.intro">
<h2 class="title">Introduction</h2>
<p class="para">
A subclass of <a href="class.intlbreakiterator.html" class="classname">IntlBreakIterator</a> that encapsulates
ICU break iterators whose behavior is specified using a set of rules. This
is the most common kind of break iterators.
</p>
<p class="para">
These rules are described in the <a href="http://userguide.icu-project.org/boundaryanalysis#TOC-RBBI-Rules" class="link external">» ICU Boundary Analysis
User Guide</a>.
</p>
</div>
<div class="section" id="intlrulebasedbreakiterator.synopsis">
<h2 class="title">Class synopsis</h2>
<div class="classsynopsis">
<div class="ooclass"></div>
<div class="classsynopsisinfo">
<span class="ooclass">
<strong class="classname">IntlRuleBasedBreakIterator</strong>
</span>
<span class="ooclass">
<span class="modifier">extends</span>
<a href="class.intlbreakiterator.html" class="classname">IntlBreakIterator</a>
</span>
<span class="oointerface">implements
<span class="interfacename"><a href="class.traversable.html" class="interfacename">Traversable</a></span>
</span>
{</div>
<div class="classsynopsisinfo classsynopsisinfo_comment">/* Constants */</div>
<div class="fieldsynopsis">
<span class="modifier">const</span>
<span class="type">integer</span>
<var class="fieldsynopsis_varname"><a href="class.intlrulebasedbreakiterator.html#intlrulebasedbreakiterator.constants.done"><var class="varname">DONE</var></a></var>
<span class="initializer"> = -1</span>
;</div>
<div class="fieldsynopsis">
<span class="modifier">const</span>
<span class="type">integer</span>
<var class="fieldsynopsis_varname"><a href="class.intlrulebasedbreakiterator.html#intlrulebasedbreakiterator.constants.word-none"><var class="varname">WORD_NONE</var></a></var>
<span class="initializer"> = 0</span>
;</div>
<div class="fieldsynopsis">
<span class="modifier">const</span>
<span class="type">integer</span>
<var class="fieldsynopsis_varname"><a href="class.intlrulebasedbreakiterator.html#intlrulebasedbreakiterator.constants.word-none-limit"><var class="varname">WORD_NONE_LIMIT</var></a></var>
<span class="initializer"> = 100</span>
;</div>
<div class="fieldsynopsis">
<span class="modifier">const</span>
<span class="type">integer</span>
<var class="fieldsynopsis_varname"><a href="class.intlrulebasedbreakiterator.html#intlrulebasedbreakiterator.constants.word-number"><var class="varname">WORD_NUMBER</var></a></var>
<span class="initializer"> = 100</span>
;</div>
<div class="fieldsynopsis">
<span class="modifier">const</span>
<span class="type">integer</span>
<var class="fieldsynopsis_varname"><a href="class.intlrulebasedbreakiterator.html#intlrulebasedbreakiterator.constants.word-number-limit"><var class="varname">WORD_NUMBER_LIMIT</var></a></var>
<span class="initializer"> = 200</span>
;</div>
<div class="fieldsynopsis">
<span class="modifier">const</span>
<span class="type">integer</span>
<var class="fieldsynopsis_varname"><a href="class.intlrulebasedbreakiterator.html#intlrulebasedbreakiterator.constants.word-letter"><var class="varname">WORD_LETTER</var></a></var>
<span class="initializer"> = 200</span>
;</div>
<div class="fieldsynopsis">
<span class="modifier">const</span>
<span class="type">integer</span>
<var class="fieldsynopsis_varname"><a href="class.intlrulebasedbreakiterator.html#intlrulebasedbreakiterator.constants.word-letter-limit"><var class="varname">WORD_LETTER_LIMIT</var></a></var>
<span class="initializer"> = 300</span>
;</div>
<div class="fieldsynopsis">
<span class="modifier">const</span>
<span class="type">integer</span>
<var class="fieldsynopsis_varname"><a href="class.intlrulebasedbreakiterator.html#intlrulebasedbreakiterator.constants.word-kana"><var class="varname">WORD_KANA</var></a></var>
<span class="initializer"> = 300</span>
;</div>
<div class="fieldsynopsis">
<span class="modifier">const</span>
<span class="type">integer</span>
<var class="fieldsynopsis_varname"><a href="class.intlrulebasedbreakiterator.html#intlrulebasedbreakiterator.constants.word-kana-limit"><var class="varname">WORD_KANA_LIMIT</var></a></var>
<span class="initializer"> = 400</span>
;</div>
<div class="fieldsynopsis">
<span class="modifier">const</span>
<span class="type">integer</span>
<var class="fieldsynopsis_varname"><a href="class.intlrulebasedbreakiterator.html#intlrulebasedbreakiterator.constants.word-ideo"><var class="varname">WORD_IDEO</var></a></var>
<span class="initializer"> = 400</span>
;</div>
<div class="fieldsynopsis">
<span class="modifier">const</span>
<span class="type">integer</span>
<var class="fieldsynopsis_varname"><a href="class.intlrulebasedbreakiterator.html#intlrulebasedbreakiterator.constants.word-ideo-limit"><var class="varname">WORD_IDEO_LIMIT</var></a></var>
<span class="initializer"> = 500</span>
;</div>
<div class="fieldsynopsis">
<span class="modifier">const</span>
<span class="type">integer</span>
<var class="fieldsynopsis_varname"><a href="class.intlrulebasedbreakiterator.html#intlrulebasedbreakiterator.constants.line-soft"><var class="varname">LINE_SOFT</var></a></var>
<span class="initializer"> = 0</span>
;</div>
<div class="fieldsynopsis">
<span class="modifier">const</span>
<span class="type">integer</span>
<var class="fieldsynopsis_varname"><a href="class.intlrulebasedbreakiterator.html#intlrulebasedbreakiterator.constants.line-soft-limit"><var class="varname">LINE_SOFT_LIMIT</var></a></var>
<span class="initializer"> = 100</span>
;</div>
<div class="fieldsynopsis">
<span class="modifier">const</span>
<span class="type">integer</span>
<var class="fieldsynopsis_varname"><a href="class.intlrulebasedbreakiterator.html#intlrulebasedbreakiterator.constants.line-hard"><var class="varname">LINE_HARD</var></a></var>
<span class="initializer"> = 100</span>
;</div>
<div class="fieldsynopsis">
<span class="modifier">const</span>
<span class="type">integer</span>
<var class="fieldsynopsis_varname"><a href="class.intlrulebasedbreakiterator.html#intlrulebasedbreakiterator.constants.line-hard-limit"><var class="varname">LINE_HARD_LIMIT</var></a></var>
<span class="initializer"> = 200</span>
;</div>
<div class="fieldsynopsis">
<span class="modifier">const</span>
<span class="type">integer</span>
<var class="fieldsynopsis_varname"><a href="class.intlrulebasedbreakiterator.html#intlrulebasedbreakiterator.constants.sentence-term"><var class="varname">SENTENCE_TERM</var></a></var>
<span class="initializer"> = 0</span>
;</div>
<div class="fieldsynopsis">
<span class="modifier">const</span>
<span class="type">integer</span>
<var class="fieldsynopsis_varname"><a href="class.intlrulebasedbreakiterator.html#intlrulebasedbreakiterator.constants.sentence-term-limit"><var class="varname">SENTENCE_TERM_LIMIT</var></a></var>
<span class="initializer"> = 100</span>
;</div>
<div class="fieldsynopsis">
<span class="modifier">const</span>
<span class="type">integer</span>
<var class="fieldsynopsis_varname"><a href="class.intlrulebasedbreakiterator.html#intlrulebasedbreakiterator.constants.sentence-sep"><var class="varname">SENTENCE_SEP</var></a></var>
<span class="initializer"> = 100</span>
;</div>
<div class="fieldsynopsis">
<span class="modifier">const</span>
<span class="type">integer</span>
<var class="fieldsynopsis_varname"><a href="class.intlrulebasedbreakiterator.html#intlrulebasedbreakiterator.constants.sentence-sep-limit"><var class="varname">SENTENCE_SEP_LIMIT</var></a></var>
<span class="initializer"> = 200</span>
;</div>
<div class="classsynopsisinfo classsynopsisinfo_comment">/* Methods */</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="methodname"><a href="intlrulebasedbreakiterator.construct.html" class="methodname">__construct</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$rules</code></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$areCompiled</code></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">ReturnType</span> <span class="methodname"><a href="intlrulebasedbreakiterator.getbinaryrules.html" class="methodname">getBinaryRules</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">ReturnType</span> <span class="methodname"><a href="intlrulebasedbreakiterator.getrules.html" class="methodname">getRules</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">ReturnType</span> <span class="methodname"><a href="intlrulebasedbreakiterator.getrulestatus.html" class="methodname">getRuleStatus</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">ReturnType</span> <span class="methodname"><a href="intlrulebasedbreakiterator.getrulestatusvec.html" class="methodname">getRuleStatusVec</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="classsynopsisinfo classsynopsisinfo_comment">/* Inherited methods */</div>
<div class="methodsynopsis dc-description">
<span class="modifier">private</span> <span class="methodname"><a href="intlbreakiterator.construct.html" class="methodname">IntlBreakIterator::__construct</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="modifier">static</span> <span class="type">ReturnType</span> <span class="methodname"><a href="intlbreakiterator.createcharacterinstance.html" class="methodname">IntlBreakIterator::createCharacterInstance</a></span>
([ <span class="methodparam"><span class="type">string</span> <code class="parameter">$"locale"</code></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="modifier">static</span> <span class="type">ReturnType</span> <span class="methodname"><a href="intlbreakiterator.createcodepointinstance.html" class="methodname">IntlBreakIterator::createCodePointInstance</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="modifier">static</span> <span class="type">ReturnType</span> <span class="methodname"><a href="intlbreakiterator.createlineinstance.html" class="methodname">IntlBreakIterator::createLineInstance</a></span>
([ <span class="methodparam"><span class="type">string</span> <code class="parameter">$"locale"</code></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="modifier">static</span> <span class="type">ReturnType</span> <span class="methodname"><a href="intlbreakiterator.createsentenceinstance.html" class="methodname">IntlBreakIterator::createSentenceInstance</a></span>
([ <span class="methodparam"><span class="type">string</span> <code class="parameter">$"locale"</code></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="modifier">static</span> <span class="type">ReturnType</span> <span class="methodname"><a href="intlbreakiterator.createtitleinstance.html" class="methodname">IntlBreakIterator::createTitleInstance</a></span>
([ <span class="methodparam"><span class="type">string</span> <code class="parameter">$"locale"</code></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="modifier">static</span> <span class="type">ReturnType</span> <span class="methodname"><a href="intlbreakiterator.createwordinstance.html" class="methodname">IntlBreakIterator::createWordInstance</a></span>
([ <span class="methodparam"><span class="type">string</span> <code class="parameter">$"locale"</code></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">ReturnType</span> <span class="methodname"><a href="intlbreakiterator.current.html" class="methodname">IntlBreakIterator::current</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">ReturnType</span> <span class="methodname"><a href="intlbreakiterator.first.html" class="methodname">IntlBreakIterator::first</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">ReturnType</span> <span class="methodname"><a href="intlbreakiterator.following.html" class="methodname">IntlBreakIterator::following</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$"offset"</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">ReturnType</span> <span class="methodname"><a href="intlbreakiterator.geterrorcode.html" class="methodname">IntlBreakIterator::getErrorCode</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="type">ReturnType</span> <span class="methodname"><strong>intl_get_error_code</strong></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">ReturnType</span> <span class="methodname"><a href="intlbreakiterator.geterrormessage.html" class="methodname">IntlBreakIterator::getErrorMessage</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="type">ReturnType</span> <span class="methodname"><strong>intl_get_error_message</strong></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">ReturnType</span> <span class="methodname"><a href="intlbreakiterator.getlocale.html" class="methodname">IntlBreakIterator::getLocale</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$"locale_type"</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">ReturnType</span> <span class="methodname"><a href="intlbreakiterator.getpartsiterator.html" class="methodname">IntlBreakIterator::getPartsIterator</a></span>
([ <span class="methodparam"><span class="type">string</span> <code class="parameter">$"key_type"</code></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">ReturnType</span> <span class="methodname"><a href="intlbreakiterator.gettext.html" class="methodname">IntlBreakIterator::getText</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">ReturnType</span> <span class="methodname"><a href="intlbreakiterator.isboundary.html" class="methodname">IntlBreakIterator::isBoundary</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$"offset"</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">ReturnType</span> <span class="methodname"><a href="intlbreakiterator.last.html" class="methodname">IntlBreakIterator::last</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">ReturnType</span> <span class="methodname"><a href="intlbreakiterator.next.html" class="methodname">IntlBreakIterator::next</a></span>
([ <span class="methodparam"><span class="type">string</span> <code class="parameter">$"offset"</code></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">ReturnType</span> <span class="methodname"><a href="intlbreakiterator.preceding.html" class="methodname">IntlBreakIterator::preceding</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$"offset"</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">ReturnType</span> <span class="methodname"><a href="intlbreakiterator.previous.html" class="methodname">IntlBreakIterator::previous</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">ReturnType</span> <span class="methodname"><a href="intlbreakiterator.settext.html" class="methodname">IntlBreakIterator::setText</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$"text"</code></span>
)</div>
}</div>
</div>
<div class="section" id="intlrulebasedbreakiterator.constants">
<h2 class="title">Predefined Constants</h2>
<dl>
<dt id="intlrulebasedbreakiterator.constants.done">
<span class="term"><strong><code>IntlRuleBasedBreakIterator::DONE</code></strong></span>
<dd>
<p class="para"/>
</dd>
</dt>
<dt id="intlrulebasedbreakiterator.constants.word-none">
<span class="term"><strong><code>IntlRuleBasedBreakIterator::WORD_NONE</code></strong></span>
<dd>
<p class="para"/>
</dd>
</dt>
<dt id="intlrulebasedbreakiterator.constants.word-none-limit">
<span class="term"><strong><code>IntlRuleBasedBreakIterator::WORD_NONE_LIMIT</code></strong></span>
<dd>
<p class="para"/>
</dd>
</dt>
<dt id="intlrulebasedbreakiterator.constants.word-number">
<span class="term"><strong><code>IntlRuleBasedBreakIterator::WORD_NUMBER</code></strong></span>
<dd>
<p class="para"/>
</dd>
</dt>
<dt id="intlrulebasedbreakiterator.constants.word-number-limit">
<span class="term"><strong><code>IntlRuleBasedBreakIterator::WORD_NUMBER_LIMIT</code></strong></span>
<dd>
<p class="para"/>
</dd>
</dt>
<dt id="intlrulebasedbreakiterator.constants.word-letter">
<span class="term"><strong><code>IntlRuleBasedBreakIterator::WORD_LETTER</code></strong></span>
<dd>
<p class="para"/>
</dd>
</dt>
<dt id="intlrulebasedbreakiterator.constants.word-letter-limit">
<span class="term"><strong><code>IntlRuleBasedBreakIterator::WORD_LETTER_LIMIT</code></strong></span>
<dd>
<p class="para"/>
</dd>
</dt>
<dt id="intlrulebasedbreakiterator.constants.word-kana">
<span class="term"><strong><code>IntlRuleBasedBreakIterator::WORD_KANA</code></strong></span>
<dd>
<p class="para"/>
</dd>
</dt>
<dt id="intlrulebasedbreakiterator.constants.word-kana-limit">
<span class="term"><strong><code>IntlRuleBasedBreakIterator::WORD_KANA_LIMIT</code></strong></span>
<dd>
<p class="para"/>
</dd>
</dt>
<dt id="intlrulebasedbreakiterator.constants.word-ideo">
<span class="term"><strong><code>IntlRuleBasedBreakIterator::WORD_IDEO</code></strong></span>
<dd>
<p class="para"/>
</dd>
</dt>
<dt id="intlrulebasedbreakiterator.constants.word-ideo-limit">
<span class="term"><strong><code>IntlRuleBasedBreakIterator::WORD_IDEO_LIMIT</code></strong></span>
<dd>
<p class="para"/>
</dd>
</dt>
<dt id="intlrulebasedbreakiterator.constants.line-soft">
<span class="term"><strong><code>IntlRuleBasedBreakIterator::LINE_SOFT</code></strong></span>
<dd>
<p class="para"/>
</dd>
</dt>
<dt id="intlrulebasedbreakiterator.constants.line-soft-limit">
<span class="term"><strong><code>IntlRuleBasedBreakIterator::LINE_SOFT_LIMIT</code></strong></span>
<dd>
<p class="para"/>
</dd>
</dt>
<dt id="intlrulebasedbreakiterator.constants.line-hard">
<span class="term"><strong><code>IntlRuleBasedBreakIterator::LINE_HARD</code></strong></span>
<dd>
<p class="para"/>
</dd>
</dt>
<dt id="intlrulebasedbreakiterator.constants.line-hard-limit">
<span class="term"><strong><code>IntlRuleBasedBreakIterator::LINE_HARD_LIMIT</code></strong></span>
<dd>
<p class="para"/>
</dd>
</dt>
<dt id="intlrulebasedbreakiterator.constants.sentence-term">
<span class="term"><strong><code>IntlRuleBasedBreakIterator::SENTENCE_TERM</code></strong></span>
<dd>
<p class="para"/>
</dd>
</dt>
<dt id="intlrulebasedbreakiterator.constants.sentence-term-limit">
<span class="term"><strong><code>IntlRuleBasedBreakIterator::SENTENCE_TERM_LIMIT</code></strong></span>
<dd>
<p class="para"/>
</dd>
</dt>
<dt id="intlrulebasedbreakiterator.constants.sentence-sep">
<span class="term"><strong><code>IntlRuleBasedBreakIterator::SENTENCE_SEP</code></strong></span>
<dd>
<p class="para"/>
</dd>
</dt>
<dt id="intlrulebasedbreakiterator.constants.sentence-sep-limit">
<span class="term"><strong><code>IntlRuleBasedBreakIterator::SENTENCE_SEP_LIMIT</code></strong></span>
<dd>
<p class="para"/>
</dd>
</dt>
</dl>
</div>
</div>
<h2>Table of Contents</h2><ul class="chunklist chunklist_reference"><li><a href="intlrulebasedbreakiterator.construct.html">IntlRuleBasedBreakIterator::__construct</a> — Create iterator from ruleset</li><li><a href="intlrulebasedbreakiterator.getbinaryrules.html">IntlRuleBasedBreakIterator::getBinaryRules</a> — Get the binary form of compiled rules</li><li><a href="intlrulebasedbreakiterator.getrules.html">IntlRuleBasedBreakIterator::getRules</a> — Get the rule set used to create this object</li><li><a href="intlrulebasedbreakiterator.getrulestatus.html">IntlRuleBasedBreakIterator::getRuleStatus</a> — Get the largest status value from the break rules that determined the current break position</li><li><a href="intlrulebasedbreakiterator.getrulestatusvec.html">IntlRuleBasedBreakIterator::getRuleStatusVec</a> — Get the status values from the break rules that determined the current break position</li></ul>
</div>
<hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="intlbreakiterator.settext.html">IntlBreakIterator::setText</a></div>
<div class="next" style="text-align: right; float: right;"><a href="intlrulebasedbreakiterator.construct.html">IntlRuleBasedBreakIterator::__construct</a></div>
<div class="up"><a href="book.intl.html">intl</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
