<!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 IteratorIterator class</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="infiniteiterator.next.html">InfiniteIterator::next</a></div>
<div class="next" style="text-align: right; float: right;"><a href="iteratoriterator.construct.html">IteratorIterator::__construct</a></div>
<div class="up"><a href="spl.iterators.html">Iterators</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="class.iteratoriterator" class="reference">
<h1 class="title">The IteratorIterator class</h1>
<div class="partintro"><p class="verinfo">(PHP 5 >= 5.1.0)</p>
<div class="section" id="iteratoriterator.intro">
<h2 class="title">Introduction</h2>
<p class="para">
This iterator wrapper allows the conversion of anything that is
<a href="class.traversable.html" class="link">Traversable</a> into an Iterator.
It is important to understand that most classes that do not implement
Iterators have reasons as most likely they do not allow the full
Iterator feature set. If so, techniques should be provided to prevent
misuse, otherwise expect exceptions or fatal errors.
</p>
</div>
<div class="section" id="iteratoriterator.synopsis">
<h2 class="title">Class synopsis</h2>
<div class="classsynopsis">
<div class="ooclass"></div>
<div class="classsynopsisinfo">
<span class="ooclass">
<strong class="classname">IteratorIterator</strong>
</span>
<span class="oointerface">implements
<span class="interfacename"><a href="class.outeriterator.html" class="interfacename">OuterIterator</a></span>
</span>
{</div>
<div class="classsynopsisinfo classsynopsisinfo_comment">/* Methods */</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="methodname"><a href="iteratoriterator.construct.html" class="methodname">__construct</a></span>
( <span class="methodparam"><span class="type"><a href="class.traversable.html" class="type Traversable">Traversable</a></span> <code class="parameter">$iterator</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">mixed</span> <span class="methodname"><a href="iteratoriterator.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">Traversable</span> <span class="methodname"><a href="iteratoriterator.getinneriterator.html" class="methodname">getInnerIterator</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">scalar</span> <span class="methodname"><a href="iteratoriterator.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">void</span> <span class="methodname"><a href="iteratoriterator.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">void</span> <span class="methodname"><a href="iteratoriterator.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">bool</span> <span class="methodname"><a href="iteratoriterator.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="iteratoriterator.construct.html">IteratorIterator::__construct</a> — Create an iterator from anything that is traversable</li><li><a href="iteratoriterator.current.html">IteratorIterator::current</a> — Get the current value</li><li><a href="iteratoriterator.getinneriterator.html">IteratorIterator::getInnerIterator</a> — Get the inner iterator</li><li><a href="iteratoriterator.key.html">IteratorIterator::key</a> — Get the key of the current element</li><li><a href="iteratoriterator.next.html">IteratorIterator::next</a> — Forward to the next element</li><li><a href="iteratoriterator.rewind.html">IteratorIterator::rewind</a> — Rewind to the first element</li><li><a href="iteratoriterator.valid.html">IteratorIterator::valid</a> — Checks if the iterator is valid</li></ul>
</div>
<hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="infiniteiterator.next.html">InfiniteIterator::next</a></div>
<div class="next" style="text-align: right; float: right;"><a href="iteratoriterator.construct.html">IteratorIterator::__construct</a></div>
<div class="up"><a href="spl.iterators.html">Iterators</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
