<!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 LimitIterator class</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="iteratoriterator.valid.html">IteratorIterator::valid</a></div>
<div class="next" style="text-align: right; float: right;"><a href="limititerator.construct.html">LimitIterator::__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.limititerator" class="reference">
<h1 class="title">The LimitIterator class</h1>
<div class="partintro"><p class="verinfo">(PHP 5 >= 5.1.0)</p>
<div class="section" id="limititerator.intro">
<h2 class="title">Introduction</h2>
<p class="para">
The <strong class="classname">LimitIterator</strong> class allows iteration over
a limited subset of items in an <a href="class.iterator.html" class="classname">Iterator</a>.
</p>
</div>
<div class="section" id="limititerator.synopsis">
<h2 class="title">Class synopsis</h2>
<div class="classsynopsis">
<div class="ooclass"></div>
<div class="classsynopsisinfo">
<span class="ooclass">
<strong class="classname">LimitIterator</strong>
</span>
<span class="ooclass">
<span class="modifier">extends</span>
<a href="class.iteratoriterator.html" class="classname">IteratorIterator</a>
</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="limititerator.construct.html" class="methodname">__construct</a></span>
( <span class="methodparam"><span class="type"><a href="class.iterator.html" class="type Iterator">Iterator</a></span> <code class="parameter">$iterator</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$offset</code><span class="initializer"> = 0</span></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$count</code><span class="initializer"> = -1</span></span>
]] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">mixed</span> <span class="methodname"><a href="limititerator.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">Iterator</span> <span class="methodname"><a href="limititerator.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">int</span> <span class="methodname"><a href="limititerator.getposition.html" class="methodname">getPosition</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">mixed</span> <span class="methodname"><a href="limititerator.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="limititerator.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="limititerator.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">int</span> <span class="methodname"><a href="limititerator.seek.html" class="methodname">seek</a></span>
( <span class="methodparam"><span class="type">int</span> <code class="parameter">$position</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="limititerator.valid.html" class="methodname">valid</a></span>
( <span class="methodparam">void</span>
)</div>
}</div>
</div>
<div class="section" id="limititerator.examples">
<h2 class="title">Examples</h2>
<p class="para">
<div class="example" id="example-3883">
<p><strong>Example #1 <strong class="classname">LimitIterator</strong> usage example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /><br /></span><span style="color: #FF8000">// Create an iterator to be limited<br /></span><span style="color: #0000BB">$fruits </span><span style="color: #007700">= new </span><span style="color: #0000BB">ArrayIterator</span><span style="color: #007700">(array(<br /> </span><span style="color: #DD0000">'apple'</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'banana'</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'cherry'</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'damson'</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'elderberry'<br /></span><span style="color: #007700">));<br /><br /></span><span style="color: #FF8000">// Loop over first three fruits only<br /></span><span style="color: #007700">foreach (new </span><span style="color: #0000BB">LimitIterator</span><span style="color: #007700">(</span><span style="color: #0000BB">$fruits</span><span style="color: #007700">, </span><span style="color: #0000BB">0</span><span style="color: #007700">, </span><span style="color: #0000BB">3</span><span style="color: #007700">) as </span><span style="color: #0000BB">$fruit</span><span style="color: #007700">) {<br /> </span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$fruit</span><span style="color: #007700">);<br />}<br /><br />echo </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br /><br /></span><span style="color: #FF8000">// Loop from third fruit until the end<br />// Note: offset starts from zero for apple<br /></span><span style="color: #007700">foreach (new </span><span style="color: #0000BB">LimitIterator</span><span style="color: #007700">(</span><span style="color: #0000BB">$fruits</span><span style="color: #007700">, </span><span style="color: #0000BB">2</span><span style="color: #007700">) as </span><span style="color: #0000BB">$fruit</span><span style="color: #007700">) {<br /> </span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$fruit</span><span style="color: #007700">);<br />}<br /><br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents"><p>The above example will output:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
string(5) "apple"
string(6) "banana"
string(6) "cherry"
string(6) "cherry"
string(6) "damson"
string(10) "elderberry"
</pre></div>
</div>
</div>
</p>
</div>
</div>
<h2>Table of Contents</h2><ul class="chunklist chunklist_reference"><li><a href="limititerator.construct.html">LimitIterator::__construct</a> — Construct a LimitIterator</li><li><a href="limititerator.current.html">LimitIterator::current</a> — Get current element</li><li><a href="limititerator.getinneriterator.html">LimitIterator::getInnerIterator</a> — Get inner iterator</li><li><a href="limititerator.getposition.html">LimitIterator::getPosition</a> — Return the current position</li><li><a href="limititerator.key.html">LimitIterator::key</a> — Get current key</li><li><a href="limititerator.next.html">LimitIterator::next</a> — Move the iterator forward</li><li><a href="limititerator.rewind.html">LimitIterator::rewind</a> — Rewind the iterator to the specified starting offset</li><li><a href="limititerator.seek.html">LimitIterator::seek</a> — Seek to the given position</li><li><a href="limititerator.valid.html">LimitIterator::valid</a> — Check whether the current element is valid</li></ul>
</div>
<hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="iteratoriterator.valid.html">IteratorIterator::valid</a></div>
<div class="next" style="text-align: right; float: right;"><a href="limititerator.construct.html">LimitIterator::__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>
