<!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 IntlPartsIterator class</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="intlcodepointbreakiterator.getlastcodepoint.html">IntlCodePointBreakIterator::getLastCodePoint</a></div>
<div class="next" style="text-align: right; float: right;"><a href="intlpartsiterator.getbreakiterator.html">IntlPartsIterator::getBreakIterator</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.intlpartsiterator" class="reference">
<h1 class="title">The IntlPartsIterator class</h1>
<div class="partintro"><p class="verinfo">(No version information available, might only be in SVN)</p>
<div class="section" id="intlpartsiterator.intro">
<h2 class="title">Introduction</h2>
<p class="para">
Objects of this class can be obtained from
<a href="class.intlbreakiterator.html" class="classname">IntlBreakIterator</a> objects. While the break
iterators provide a sequence of boundary positions when iterated,
<strong class="classname">IntlPartsIterator</strong> objects provide, as a
convenience, the text fragments comprehended between two successive
boundaries.
</p>
<p class="para">
The keys may represent the offset of the left boundary, right boundary, or
they may just the sequence of non-negative integers. See
<span class="function"><a href="intlbreakiterator.getpartsiterator.html" class="function">IntlBreakIterator::getPartsIterator()</a></span>.
</p>
</div>
<div class="section" id="intlpartsiterator.synopsis">
<h2 class="title">Class synopsis</h2>
<div class="classsynopsis">
<div class="ooclass"></div>
<div class="classsynopsisinfo">
<span class="ooclass">
<strong class="classname">IntlPartsIterator</strong>
</span>
<span class="ooclass">
<span class="modifier">extends</span>
<a href="class.intliterator.html" class="classname">IntlIterator</a>
</span>
<span class="oointerface">implements
<span class="interfacename"><a href="class.iterator.html" class="interfacename">Iterator</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.intlpartsiterator.html#intlpartsiterator.constants.key-sequential"><var class="varname">KEY_SEQUENTIAL</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.intlpartsiterator.html#intlpartsiterator.constants.key-left"><var class="varname">KEY_LEFT</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.intlpartsiterator.html#intlpartsiterator.constants.key-right"><var class="varname">KEY_RIGHT</var></a></var>
<span class="initializer"> = 2</span>
;</div>
<div class="classsynopsisinfo classsynopsisinfo_comment">/* Methods */</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">ReturnType</span> <span class="methodname"><a href="intlpartsiterator.getbreakiterator.html" class="methodname">getBreakIterator</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="classsynopsisinfo classsynopsisinfo_comment">/* Inherited methods */</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">ReturnType</span> <span class="methodname"><a href="intliterator.current.html" class="methodname">IntlIterator::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="intliterator.key.html" class="methodname">IntlIterator::key</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="intliterator.next.html" class="methodname">IntlIterator::next</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="intliterator.rewind.html" class="methodname">IntlIterator::rewind</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="intliterator.valid.html" class="methodname">IntlIterator::valid</a></span>
( <span class="methodparam">void</span>
)</div>
}</div>
</div>
<div class="section" id="intlpartsiterator.constants">
<h2 class="title">Predefined Constants</h2>
<dl>
<dt id="intlpartsiterator.constants.key-sequential">
<span class="term"><strong><code>IntlPartsIterator::KEY_SEQUENTIAL</code></strong></span>
<dd>
<p class="para"/>
</dd>
</dt>
<dt id="intlpartsiterator.constants.key-left">
<span class="term"><strong><code>IntlPartsIterator::KEY_LEFT</code></strong></span>
<dd>
<p class="para"/>
</dd>
</dt>
<dt id="intlpartsiterator.constants.key-right">
<span class="term"><strong><code>IntlPartsIterator::KEY_RIGHT</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="intlpartsiterator.getbreakiterator.html">IntlPartsIterator::getBreakIterator</a> — Get IntlBreakIterator backing this parts iterator</li></ul>
</div>
<hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="intlcodepointbreakiterator.getlastcodepoint.html">IntlCodePointBreakIterator::getLastCodePoint</a></div>
<div class="next" style="text-align: right; float: right;"><a href="intlpartsiterator.getbreakiterator.html">IntlPartsIterator::getBreakIterator</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>
