Sophie

Sophie

distrib > Mageia > 4 > x86_64 > by-pkgid > f800694edefe91adea2624f711a41a2d > files > 1934

php-manual-en-5.5.7-1.mga4.noarch.rpm

<!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 new filesystem iterator</title>

 </head>
 <body><div class="manualnavbar" style="text-align: center;">
 <div class="prev" style="text-align: left; float: left;"><a href="class.filesystemiterator.html">FilesystemIterator</a></div>
 <div class="next" style="text-align: right; float: right;"><a href="filesystemiterator.current.html">FilesystemIterator::current</a></div>
 <div class="up"><a href="class.filesystemiterator.html">FilesystemIterator</a></div>
 <div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="filesystemiterator.construct" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">FilesystemIterator::__construct</h1>
  <p class="verinfo">(PHP 5 &gt;= 5.3.0)</p><p class="refpurpose"><span class="refname">FilesystemIterator::__construct</span> &mdash; <span class="dc-title">Constructs a new filesystem iterator</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-filesystemiterator.construct-description">
  <h3 class="title">Description</h3>
  <div class="methodsynopsis dc-description">
   <span class="modifier">public</span>  <span class="methodname"><strong>FilesystemIterator::__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 | FilesystemIterator::SKIP_DOTS</span></span>
  ] )</div>

  <p class="para rdfs-comment">
   Constructs a new filesystem iterator from the <em><code class="parameter">path</code></em>.
  </p>

 </div>


 <div class="refsect1 parameters" id="refsect1-filesystemiterator.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 filesystem item 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-filesystemiterator.construct-returnvalues">
  <h3 class="title">Return Values</h3>
  <p class="para">
   No value is returned.
  </p>
 </div>


 <div class="refsect1 errors" id="refsect1-filesystemiterator.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.
  </p>
 </div>


 <div class="refsect1 examples" id="refsect1-filesystemiterator.construct-examples">
  <h3 class="title">Examples</h3>
  <p class="para">
   <div class="example" id="example-3873">
    <p><strong>Example #1  <span class="function"><strong>FilesystemIterator::__construct()</strong></span> example</strong></p>
    <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB">&lt;?php<br />$it&nbsp;</span><span style="color: #007700">=&nbsp;new&nbsp;</span><span style="color: #0000BB">FilesystemIterator</span><span style="color: #007700">(</span><span style="color: #0000BB">dirname</span><span style="color: #007700">(</span><span style="color: #0000BB">__FILE__</span><span style="color: #007700">));<br />foreach&nbsp;(</span><span style="color: #0000BB">$it&nbsp;</span><span style="color: #007700">as&nbsp;</span><span style="color: #0000BB">$fileinfo</span><span style="color: #007700">)&nbsp;{<br />&nbsp;&nbsp;&nbsp;&nbsp;echo&nbsp;</span><span style="color: #0000BB">$fileinfo</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">getFilename</span><span style="color: #007700">()&nbsp;.&nbsp;</span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br />}<br /></span><span style="color: #0000BB">?&gt;</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>
apples.jpg
banana.jpg
example.php
</pre></div>
    </div>
   </div>
  </p>
 </div>


 <div class="refsect1 seealso" id="refsect1-filesystemiterator.construct-seealso">
  <h3 class="title">See Also</h3>
  <p class="para">
   <ul class="simplelist">
    <li class="member"> <span class="methodname"><a href="filesystemiterator.setflags.html" class="methodname" rel="rdfs-seeAlso">FilesystemIterator::setFlags()</a> - Sets handling flags</span></li>
    <li class="member"> <span class="methodname"><a href="directoryiterator.construct.html" class="methodname" rel="rdfs-seeAlso">DirectoryIterator::__construct()</a> - Constructs a new directory iterator from a path</span></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.filesystemiterator.html">FilesystemIterator</a></div>
 <div class="next" style="text-align: right; float: right;"><a href="filesystemiterator.current.html">FilesystemIterator::current</a></div>
 <div class="up"><a href="class.filesystemiterator.html">FilesystemIterator</a></div>
 <div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>