<!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>Construct a RecursiveIteratorIterator</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="recursiveiteratoriterator.callhaschildren.html">RecursiveIteratorIterator::callHasChildren</a></div>
<div class="next" style="text-align: right; float: right;"><a href="recursiveiteratoriterator.current.html">RecursiveIteratorIterator::current</a></div>
<div class="up"><a href="class.recursiveiteratoriterator.html">RecursiveIteratorIterator</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="recursiveiteratoriterator.construct" class="refentry">
<div class="refnamediv">
<h1 class="refname">RecursiveIteratorIterator::__construct</h1>
<p class="verinfo">(PHP 5 >= 5.1.3)</p><p class="refpurpose"><span class="refname">RecursiveIteratorIterator::__construct</span> — <span class="dc-title">Construct a RecursiveIteratorIterator</span></p>
</div>
<div class="refsect1 description" id="refsect1-recursiveiteratoriterator.construct-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="methodname"><strong>RecursiveIteratorIterator::__construct</strong></span>
( <span class="methodparam"><span class="type"><a href="class.traversable.html" class="type Traversable">Traversable</a></span> <code class="parameter">$iterator</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$mode</code><span class="initializer"> = RecursiveIteratorIterator::LEAVES_ONLY</span></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$flags</code><span class="initializer"> = 0</span></span>
]] )</div>
<p class="para rdfs-comment">
Creates a <a href="class.recursiveiteratoriterator.html" class="classname">RecursiveIteratorIterator</a> from a <a href="class.recursiveiterator.html" class="classname">RecursiveIterator</a>.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-recursiveiteratoriterator.construct-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">iterator</code></em></span>
<dd>
<p class="para">
The iterator being constructed from. Either a
<a href="class.recursiveiterator.html" class="classname">RecursiveIterator</a> or <a href="class.iteratoraggregate.html" class="classname">IteratorAggregate</a>.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">mode</code></em></span>
<dd>
<p class="para">
Optional mode. Possible values are
<ul class="simplelist">
<li class="member">
<strong><code>RecursiveIteratorIterator::LEAVES_ONLY</code></strong>
- The default. Lists only leaves in iteration.
</li>
<li class="member">
<strong><code>RecursiveIteratorIterator::SELF_FIRST</code></strong>
- Lists leaves and parents in iteration with parents coming first.
</li>
<li class="member">
<strong><code>RecursiveIteratorIterator::CHILD_FIRST</code></strong>
- Lists leaves and parents in iteration with leaves coming first.
</li>
</ul>
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">flags</code></em></span>
<dd>
<p class="para">
Optional flag. Possible values are <strong><code>RecursiveIteratorIterator::CATCH_GET_CHILD</code></strong>
which will then ignore exceptions thrown in calls to <span class="methodname"><strong>RecursiveIteratorIterator::getChildren()</strong></span>.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-recursiveiteratoriterator.construct-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
No value is returned.
</p>
</div>
<div class="refsect1 examples" id="refsect1-recursiveiteratoriterator.construct-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="recursiveiteratoriterator.example.basic">
<p><strong>Example #1 Iterating a RecursiveIteratorIterator</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$array </span><span style="color: #007700">= array(<br /> array(<br /> array(<br /> array(<br /> </span><span style="color: #DD0000">'leaf-0-0-0-0'</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'leaf-0-0-0-1'<br /> </span><span style="color: #007700">),<br /> </span><span style="color: #DD0000">'leaf-0-0-0'<br /> </span><span style="color: #007700">),<br /> array(<br /> array(<br /> </span><span style="color: #DD0000">'leaf-0-1-0-0'</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'leaf-0-1-0-1'<br /> </span><span style="color: #007700">),<br /> </span><span style="color: #DD0000">'leaf-0-1-0'<br /> </span><span style="color: #007700">),<br /> </span><span style="color: #DD0000">'leaf-0-0'<br /> </span><span style="color: #007700">)<br />);<br /><br /></span><span style="color: #0000BB">$iterator </span><span style="color: #007700">= new </span><span style="color: #0000BB">RecursiveIteratorIterator</span><span style="color: #007700">(<br /> new </span><span style="color: #0000BB">RecursiveArrayIterator</span><span style="color: #007700">(</span><span style="color: #0000BB">$array</span><span style="color: #007700">),<br /> </span><span style="color: #0000BB">$mode<br /></span><span style="color: #007700">);<br />foreach (</span><span style="color: #0000BB">$iterator </span><span style="color: #007700">as </span><span style="color: #0000BB">$key </span><span style="color: #007700">=> </span><span style="color: #0000BB">$leaf</span><span style="color: #007700">) {<br /> echo </span><span style="color: #DD0000">"</span><span style="color: #0000BB">$key</span><span style="color: #DD0000"> => </span><span style="color: #0000BB">$leaf</span><span style="color: #DD0000">"</span><span style="color: #007700">, </span><span style="color: #0000BB">PHP_EOL</span><span style="color: #007700">;<br />}<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents"><p>
Output with <em>$mode = RecursiveIteratorIterator::LEAVES_ONLY</em>
</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
0 => leaf-0-0-0-0
1 => leaf-0-0-0-1
0 => leaf-0-0-0
0 => leaf-0-1-0-0
1 => leaf-0-1-0-1
0 => leaf-0-1-0
0 => leaf-0-0
</pre></div>
</div>
<div class="example-contents"><p>
Output with <em>$mode = RecursiveIteratorIterator::SELF_FIRST</em>
</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
0 => Array
0 => Array
0 => Array
0 => leaf-0-0-0-0
1 => leaf-0-0-0-1
1 => leaf-0-0-0
1 => Array
0 => Array
0 => leaf-0-1-0-0
1 => leaf-0-1-0-1
1 => leaf-0-1-0
2 => leaf-0-0
</pre></div>
</div>
<div class="example-contents"><p>
Output with <em>$mode = RecursiveIteratorIterator::CHILD_FIRST</em>
</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
0 => leaf-0-0-0-0
1 => leaf-0-0-0-1
0 => Array
1 => leaf-0-0-0
0 => Array
0 => leaf-0-1-0-0
1 => leaf-0-1-0-1
0 => Array
1 => leaf-0-1-0
1 => Array
2 => leaf-0-0
0 => Array
</pre></div>
</div>
</div>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="recursiveiteratoriterator.callhaschildren.html">RecursiveIteratorIterator::callHasChildren</a></div>
<div class="next" style="text-align: right; float: right;"><a href="recursiveiteratoriterator.current.html">RecursiveIteratorIterator::current</a></div>
<div class="up"><a href="class.recursiveiteratoriterator.html">RecursiveIteratorIterator</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
