php-doc-en/reference/dir/functions/class.dir.xml

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/dir.xml, last change in rev 1.2 -->
  <refentry id="class.dir">
   <refnamediv>
    <refname>dir</refname>
    <refpurpose>directory class</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
    <classsynopsis>
     <ooclass><classname>dir</classname></ooclass>
     <constructorsynopsis>
      <methodname>dir</methodname>
      <methodparam><type>string</type><parameter>directory</parameter></methodparam>
     </constructorsynopsis>
     <fieldsynopsis>
      <type>string</type><varname>path</varname>
     </fieldsynopsis>
     <fieldsynopsis>
      <type>resource</type><varname>handle</varname>
     </fieldsynopsis>
     <methodsynopsis><type>string</type><methodname>read</methodname><void/></methodsynopsis>
     <methodsynopsis><type>void</type><methodname>rewind</methodname><void/></methodsynopsis>
     <methodsynopsis><type>void</type><methodname>close</methodname><void/></methodsynopsis>
    </classsynopsis>
    <para>
     A pseudo-object oriented mechanism for reading a directory.  The
     given <parameter>directory</parameter> is opened.  Two properties
     are available once the directory has been opened.  The handle
     property can be used with other directory functions such as
     <function>readdir</function>, <function>rewinddir</function> and
     <function>closedir</function>.  The path property is set to path
     the directory that was opened.  Three methods are available:
     read, rewind and close.
    </para>
    <para>
     Please note the fashion in which <function>dir</function>'s
     return value is checked in the example below. We are explicitly
     testing whether the return value is identical to (equal to and of
     the same type as--see <link linkend="language.operators.comparison">
     Comparison Operators</link> for more information) &false; since
     otherwise, any directory entry whose name evaluates to &false; will
     stop the loop.
     <example>
      <title><function>dir</function> example</title>
      <programlisting role="php">
<![CDATA[
<?php
$d = dir("/etc");
echo "Handle: " . $d->handle . "<br />\n";
echo "Path: " . $d->path . "<br />\n";
while (false !== ($entry = $d->read())) {
   echo $entry."<br />\n";
}
$d->close();
?>
]]>
      </programlisting>
     </example>
    </para>
    <note>
     <para>
      The order in which directory entries are returned by the read method is
      system-dependent.
     </para>
    </note>
    <note>
     <para>
      This defines the internal class
      <classname>Directory</classname>, meaning that you will not be
      able to define your own classes with that name. For a full list
      of predefined classes in PHP, please see <link
      linkend="reserved.classes">Predefined Classes</link>.
     </para>
    </note>
   </refsect1>
  </refentry>

<!-- 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:"../../../../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
-->