<!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>Constructs a RecursiveDirectoryIterator</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="class.recursivedirectoryiterator.html">RecursiveDirectoryIterator</a></div>
<div class="next" style="text-align: right; float: right;"><a href="recursivedirectoryiterator.getchildren.html">RecursiveDirectoryIterator::getChildren</a></div>
<div class="up"><a href="class.recursivedirectoryiterator.html">RecursiveDirectoryIterator</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="recursivedirectoryiterator.construct" class="refentry">
<div class="refnamediv">
<h1 class="refname">RecursiveDirectoryIterator::__construct</h1>
<p class="verinfo">(PHP 5 >= 5.1.2)</p><p class="refpurpose"><span class="refname">RecursiveDirectoryIterator::__construct</span> — <span class="dc-title">Constructs a RecursiveDirectoryIterator</span></p>
</div>
<div class="refsect1 description" id="refsect1-recursivedirectoryiterator.construct-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="methodname"><strong>RecursiveDirectoryIterator::__construct</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$path</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$flags</code><span class="initializer"> = FilesystemIterator::KEY_AS_PATHNAME | FilesystemIterator::CURRENT_AS_FILEINFO</span></span>
] )</div>
<p class="para rdfs-comment">
Constructs a <span class="methodname"><strong>RecursiveDirectoryIterator()</strong></span>
for the provided <em><code class="parameter">path</code></em>.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-recursivedirectoryiterator.construct-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">path</code></em></span>
<dd>
<p class="para">
The path of the directory to be iterated over.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">flags</code></em></span>
<dd>
<p class="para">
Flags may be provided which will affect the behavior of some methods.
A list of the flags can found under
<a href="class.filesystemiterator.html#filesystemiterator.constants" class="link">FilesystemIterator predefined constants</a>.
They can also be set later with <span class="methodname"><a href="filesystemiterator.setflags.html" class="methodname">FilesystemIterator::setFlags()</a></span>.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-recursivedirectoryiterator.construct-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns the newly created <a href="class.recursivedirectoryiterator.html" class="classname">RecursiveDirectoryIterator</a>.
</p>
</div>
<div class="refsect1 errors" id="refsect1-recursivedirectoryiterator.construct-errors">
<h3 class="title">Errors/Exceptions</h3>
<p class="para">
Throws an <a href="class.unexpectedvalueexception.html" class="classname">UnexpectedValueException</a>
if the <em><code class="parameter">path</code></em> cannot be found or is not a directory.
</p>
</div>
<div class="refsect1 examples" id="refsect1-recursivedirectoryiterator.construct-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-3894">
<p><strong>Example #1 <a href="class.recursivedirectoryiterator.html" class="classname">RecursiveDirectoryIterator</a> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /><br />$directory </span><span style="color: #007700">= </span><span style="color: #DD0000">'/tmp'</span><span style="color: #007700">;<br /><br /></span><span style="color: #0000BB">$it </span><span style="color: #007700">= new </span><span style="color: #0000BB">RecursiveIteratorIterator</span><span style="color: #007700">(new </span><span style="color: #0000BB">RecursiveDirectoryIterator</span><span style="color: #007700">(</span><span style="color: #0000BB">$directory</span><span style="color: #007700">));<br /><br />while(</span><span style="color: #0000BB">$it</span><span style="color: #007700">-></span><span style="color: #0000BB">valid</span><span style="color: #007700">()) {<br /><br /> if (!</span><span style="color: #0000BB">$it</span><span style="color: #007700">-></span><span style="color: #0000BB">isDot</span><span style="color: #007700">()) {<br /> echo </span><span style="color: #DD0000">'SubPathName: ' </span><span style="color: #007700">. </span><span style="color: #0000BB">$it</span><span style="color: #007700">-></span><span style="color: #0000BB">getSubPathName</span><span style="color: #007700">() . </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br /> echo </span><span style="color: #DD0000">'SubPath: ' </span><span style="color: #007700">. </span><span style="color: #0000BB">$it</span><span style="color: #007700">-></span><span style="color: #0000BB">getSubPath</span><span style="color: #007700">() . </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br /> echo </span><span style="color: #DD0000">'Key: ' </span><span style="color: #007700">. </span><span style="color: #0000BB">$it</span><span style="color: #007700">-></span><span style="color: #0000BB">key</span><span style="color: #007700">() . </span><span style="color: #DD0000">"\n\n"</span><span style="color: #007700">;<br /> }<br /><br /> </span><span style="color: #0000BB">$it</span><span style="color: #007700">-></span><span style="color: #0000BB">next</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
something similar to:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
SubPathName: fruit/apple.xml
SubPath: fruit
Key: /tmp/fruit/apple.xml
SubPathName: stuff.xml
SubPath:
Key: /tmp/stuff.xml
SubPathName: veggies/carrot.xml
SubPath: veggies
Key: /tmp/veggies/carrot.xml
</pre></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-recursivedirectoryiterator.construct-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="methodname"><a href="filesystemiterator.construct.html" class="methodname" rel="rdfs-seeAlso">FilesystemIterator::__construct()</a> - Constructs a new filesystem iterator</span></li>
<li class="member"> <span class="methodname"><a href="recursiveiteratoriterator.construct.html" class="methodname" rel="rdfs-seeAlso">RecursiveIteratorIterator::__construct()</a> - Construct a RecursiveIteratorIterator</span></li>
<li class="member"><a href="class.filesystemiterator.html#filesystemiterator.constants" class="link">FilesystemIterator predefined constants</a></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="class.recursivedirectoryiterator.html">RecursiveDirectoryIterator</a></div>
<div class="next" style="text-align: right; float: right;"><a href="recursivedirectoryiterator.getchildren.html">RecursiveDirectoryIterator::getChildren</a></div>
<div class="up"><a href="class.recursivedirectoryiterator.html">RecursiveDirectoryIterator</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
