<!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 IteratorAggregate interface</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="iterator.valid.html">Iterator::valid</a></div> <div class="next" style="text-align: right; float: right;"><a href="iteratoraggregate.getiterator.html">IteratorAggregate::getIterator</a></div> <div class="up"><a href="reserved.interfaces.html">Predefined Interfaces and Classes</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div><hr /><div id="class.iteratoraggregate" class="reference"> <h1 class="title">The IteratorAggregate interface</h1> <div class="partintro"><p class="verinfo">(PHP 5 >= 5.0.0)</p> <div class="section" id="iteratoraggregate.intro"> <h2 class="title">Introduction</h2> <p class="para"> Interface to create an external Iterator. </p> </div> <div class="section" id="iteratoraggregate.synopsis"> <h2 class="title">Interface synopsis</h2> <div class="classsynopsis"> <div class="ooclass"></div> <div class="classsynopsisinfo"> <span class="ooclass"> <strong class="classname">IteratorAggregate</strong> </span> <span class="ooclass"> <span class="modifier">extends</span> <a href="class.traversable.html" class="classname">Traversable</a> </span> {</div> <div class="classsynopsisinfo classsynopsisinfo_comment">/* Methods */</div> <div class="methodsynopsis dc-description"> <span class="modifier">abstract</span> <span class="modifier">public</span> <span class="type">Traversable</span> <span class="methodname"><a href="iteratoraggregate.getiterator.html" class="methodname">getIterator</a></span> ( <span class="methodparam">void</span> )</div> }</div> </div> <div class="section" id="iteratoraggregate.examples"> <div class="example" id="iteratoraggregate.example.basic"> <p><strong>Example #1 Basic usage</strong></p> <div class="example-contents"> <div class="phpcode"><code><span style="color: #000000"> <span style="color: #0000BB"><?php<br /></span><span style="color: #007700">class </span><span style="color: #0000BB">myData </span><span style="color: #007700">implements </span><span style="color: #0000BB">IteratorAggregate </span><span style="color: #007700">{<br /> public </span><span style="color: #0000BB">$property1 </span><span style="color: #007700">= </span><span style="color: #DD0000">"Public property one"</span><span style="color: #007700">;<br /> public </span><span style="color: #0000BB">$property2 </span><span style="color: #007700">= </span><span style="color: #DD0000">"Public property two"</span><span style="color: #007700">;<br /> public </span><span style="color: #0000BB">$property3 </span><span style="color: #007700">= </span><span style="color: #DD0000">"Public property three"</span><span style="color: #007700">;<br /><br /> public function </span><span style="color: #0000BB">__construct</span><span style="color: #007700">() {<br /> </span><span style="color: #0000BB">$this</span><span style="color: #007700">-></span><span style="color: #0000BB">property4 </span><span style="color: #007700">= </span><span style="color: #DD0000">"last property"</span><span style="color: #007700">;<br /> }<br /><br /> public function </span><span style="color: #0000BB">getIterator</span><span style="color: #007700">() {<br /> return new </span><span style="color: #0000BB">ArrayIterator</span><span style="color: #007700">(</span><span style="color: #0000BB">$this</span><span style="color: #007700">);<br /> }<br />}<br /><br /></span><span style="color: #0000BB">$obj </span><span style="color: #007700">= new </span><span style="color: #0000BB">myData</span><span style="color: #007700">;<br /><br />foreach(</span><span style="color: #0000BB">$obj </span><span style="color: #007700">as </span><span style="color: #0000BB">$key </span><span style="color: #007700">=> </span><span style="color: #0000BB">$value</span><span style="color: #007700">) {<br /> </span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$key</span><span style="color: #007700">, </span><span style="color: #0000BB">$value</span><span style="color: #007700">);<br /> echo </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br />}<br /></span><span style="color: #0000BB">?></span> </span> </code></div> </div> <div class="example-contents"><p>The above example will output something similar to:</p></div> <div class="example-contents screen"> <div class="cdata"><pre> string(9) "property1" string(19) "Public property one" string(9) "property2" string(19) "Public property two" string(9) "property3" string(21) "Public property three" string(9) "property4" string(13) "last property" </pre></div> </div> </div> </div> </div> <h2>Table of Contents</h2><ul class="chunklist chunklist_reference"><li><a href="iteratoraggregate.getiterator.html">IteratorAggregate::getIterator</a> — Retrieve an external iterator</li></ul> </div> <hr /><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="iterator.valid.html">Iterator::valid</a></div> <div class="next" style="text-align: right; float: right;"><a href="iteratoraggregate.getiterator.html">IteratorAggregate::getIterator</a></div> <div class="up"><a href="reserved.interfaces.html">Predefined Interfaces and Classes</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div></body></html>