filesystemiterator.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->

<phpdoc:classref xml:id="class.filesystemiterator" xmlns:phpdoc="http://php.net/ns/phpdoc" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">

 <title>The FilesystemIterator class</title>
 <titleabbrev>FilesystemIterator</titleabbrev>

 <partintro>

<!-- {{{ FilesystemIterator intro -->
  <section xml:id="filesystemiterator.intro">
   &reftitle.intro;
   <para>
    The Filesystem iterator
   </para>
  </section>
<!-- }}} -->

  <section xml:id="filesystemiterator.synopsis">
   &reftitle.classsynopsis;

<!-- {{{ Synopsis -->
   <classsynopsis>
    <ooclass><classname>FilesystemIterator</classname></ooclass>

<!-- {{{ Class synopsis -->
    <classsynopsisinfo>
     <ooclass>
      <classname>FilesystemIterator</classname>
     </ooclass>
     
     <ooclass>
      <modifier>extends</modifier>
      <classname>DirectoryIterator</classname>
     </ooclass>
     
     <oointerface>
      <interfacename>SeekableIterator</interfacename>
     </oointerface>

    </classsynopsisinfo>
<!-- }}} -->

   <classsynopsisinfo role="comment">&Constants;</classsynopsisinfo>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>integer</type>
     <varname linkend="filesystemiterator.constants.current-as-pathname">FilesystemIterator::CURRENT_AS_PATHNAME</varname>
     <initializer>32</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>integer</type>
     <varname linkend="filesystemiterator.constants.current-as-fileinfo">FilesystemIterator::CURRENT_AS_FILEINFO</varname>
     <initializer>0</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>integer</type>
     <varname linkend="filesystemiterator.constants.current-as-self">FilesystemIterator::CURRENT_AS_SELF</varname>
     <initializer>16</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>integer</type>
     <varname linkend="filesystemiterator.constants.current-mode-mask">FilesystemIterator::CURRENT_MODE_MASK</varname>
     <initializer>240</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>integer</type>
     <varname linkend="filesystemiterator.constants.key-as-pathname">FilesystemIterator::KEY_AS_PATHNAME</varname>
     <initializer>0</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>integer</type>
     <varname linkend="filesystemiterator.constants.key-as-filename">FilesystemIterator::KEY_AS_FILENAME</varname>
     <initializer>256</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>integer</type>
     <varname linkend="filesystemiterator.constants.follow-symlinks">FilesystemIterator::FOLLOW_SYMLINKS</varname>
     <initializer>512</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>integer</type>
     <varname linkend="filesystemiterator.constants.key-mode-mask">FilesystemIterator::KEY_MODE_MASK</varname>
     <initializer>3840</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>integer</type>
     <varname linkend="filesystemiterator.constants.new-current-and-key">FilesystemIterator::NEW_CURRENT_AND_KEY</varname>
     <initializer>256</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>integer</type>
     <varname linkend="filesystemiterator.constants.skip-dots">FilesystemIterator::SKIP_DOTS</varname>
     <initializer>4096</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>integer</type>
     <varname linkend="filesystemiterator.constants.unix-paths">FilesystemIterator::UNIX_PATHS</varname>
     <initializer>8192</initializer>
    </fieldsynopsis>
    
    <classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.filesystemiterator')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
    
    <classsynopsisinfo role="comment">&InheritedMethods;</classsynopsisinfo>
    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.directoryiterator')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />

   </classsynopsis>
<!-- }}} -->

  </section>
 
  <!-- {{{ FilesystemIterator constants -->
  <section xml:id="filesystemiterator.constants">
   &reftitle.constants;
   <variablelist>
    <varlistentry xml:id="filesystemiterator.constants.current-as-pathname">
     <term><constant>FilesystemIterator::CURRENT_AS_PATHNAME</constant></term>
     <listitem>
      <para>Makes <methodname>FilesystemIterator::current</methodname> return the pathname.</para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="filesystemiterator.constants.current-as-fileinfo">
     <term><constant>FilesystemIterator::CURRENT_AS_FILEINFO</constant></term>
     <listitem>
      <para>Makes <methodname>FilesystemIterator::current</methodname> return an <classname>SplFileInfo</classname> instance.</para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="filesystemiterator.constants.current-as-self">
     <term><constant>FilesystemIterator::CURRENT_AS_SELF</constant></term>
     <listitem>
      <para>Makes <methodname>FilesystemIterator::current</methodname> return $this (the FilesystemIterator).</para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="filesystemiterator.constants.current-mode-mask">
     <term><constant>FilesystemIterator::CURRENT_MODE_MASK</constant></term>
     <listitem>
      <para>Masks <methodname>FilesystemIterator::current</methodname></para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="filesystemiterator.constants.key-as-pathname">
     <term><constant>FilesystemIterator::KEY_AS_PATHNAME</constant></term>
     <listitem>
      <para>Makes <methodname>FilesystemIterator::key</methodname> return the pathname.</para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="filesystemiterator.constants.key-as-filename">
     <term><constant>FilesystemIterator::KEY_AS_FILENAME</constant></term>
     <listitem>
      <para>Makes <methodname>FilesystemIterator::key</methodname> return the filename.</para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="filesystemiterator.constants.follow-symlinks">
     <term><constant>FilesystemIterator::FOLLOW_SYMLINKS</constant></term>
     <listitem>
      <para>Makes <methodname>RecursiveDirectoryIterator::hasChildren</methodname> follow symlinks.</para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="filesystemiterator.constants.key-mode-mask">
     <term><constant>FilesystemIterator::KEY_MODE_MASK</constant></term>
     <listitem>
      <para>Masks <methodname>FilesystemIterator::key</methodname></para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="filesystemiterator.constants.new-current-and-key">
     <term><constant>FilesystemIterator::NEW_CURRENT_AND_KEY</constant></term>
     <listitem>
      <para>Same as <literal>FilesystemIterator::KEY_AS_FILENAME | FilesystemIterator::CURRENT_AS_FILEINFO</literal>.</para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="filesystemiterator.constants.skip-dots">
     <term><constant>FilesystemIterator::SKIP_DOTS</constant></term>
     <listitem>
      <para>Skips dot files (<literal>.</literal> and <literal>..</literal>).</para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="filesystemiterator.constants.unix-paths">
     <term><constant>FilesystemIterator::UNIX_PATHS</constant></term>
     <listitem>
      <para>
       Makes paths use Unix-style forward slash irrespective of system default.
       Note that the <parameter>path</parameter> that is passed to the
       constructor is not modified.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </section>
  <!-- }}} -->

  <!-- {{{ Changelog -->
  <section role="changelog">
   &reftitle.changelog;
   <para>
    <informaltable>
     <tgroup cols="2">
      <thead>
       <row>
        <entry>&Version;</entry>
        <entry>&Description;</entry>
       </row>
      </thead>
      <tbody>
       <row>
        <entry>5.3.1</entry>
        <entry>Added <constant>FilesystemIterator::FOLLOW_SYMLINKS</constant></entry>
       </row>
      </tbody>
     </tgroup>
    </informaltable>
   </para>
  </section>
  <!-- }}} -->  

 </partintro>

 &reference.spl.entities.filesystemiterator;

</phpdoc:classref>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->