<!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 IntlIterator class</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="class.intlexception.html">IntlException</a></div>
<div class="next" style="text-align: right; float: right;"><a href="intliterator.current.html">IntlIterator::current</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.intliterator" class="reference">
<h1 class="title">The IntlIterator class</h1>
<div class="partintro"><p class="verinfo">(No version information available, might only be in SVN)</p>
<div class="section" id="intliterator.intro">
<h2 class="title">Introduction</h2>
<p class="para">
This class represents iterator objects throughout the intl extension
whenever the iterator cannot be identified with any other object provided
by the extension. The distinct iterator object used internally by the
<a href="control-structures.foreach.html" class="link"><em>foreach</em>
construct</a> can only be obtained (in the relevant part here) from
objects, so objects of this class serve the purpose of providing the hook
through which this internal object can be obtained. As a convenience, this
class also implements the <a href="class.iterator.html" class="classname">Iterator</a> interface,
allowing the collection of values to be navigated using the methods
defined in that interface. Both these methods and the internal iterator
objects provided to <em>foreach</em> are backed by the same
state (e.g. the position of the iterator and its current value).
</p>
<p class="para">
Subclasses may provide richer functionality.
</p>
</div>
<div class="section" id="intliterator.synopsis">
<h2 class="title">Class synopsis</h2>
<div class="classsynopsis">
<div class="ooclass"></div>
<div class="classsynopsisinfo">
<span class="ooclass">
<strong class="classname">IntlIterator</strong>
</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">/* 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">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">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">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">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">valid</a></span>
( <span class="methodparam">void</span>
)</div>
}</div>
</div>
</div>
<h2>Table of Contents</h2><ul class="chunklist chunklist_reference"><li><a href="intliterator.current.html">IntlIterator::current</a> — Get the current element</li><li><a href="intliterator.key.html">IntlIterator::key</a> — Get the current key</li><li><a href="intliterator.next.html">IntlIterator::next</a> — Move forward to the next element</li><li><a href="intliterator.rewind.html">IntlIterator::rewind</a> — Rewind the iterator to the first element</li><li><a href="intliterator.valid.html">IntlIterator::valid</a> — Check if curent position is valid</li></ul>
</div>
<hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="class.intlexception.html">IntlException</a></div>
<div class="next" style="text-align: right; float: right;"><a href="intliterator.current.html">IntlIterator::current</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>
