<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<phpdoc:classref xml:id="class.directory" 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 Directory class</title>
 <titleabbrev>Directory</titleabbrev>

 <partintro>

<!-- {{{ Directory intro -->
  <section xml:id="directory.intro">
   &reftitle.intro;
   <para>
    Instances of <classname>Directory</classname> are created by calling the
    <function>dir</function> function, not by the <link linkend="language.oop5.basic.new">new</link> operator.
   </para>
  </section>
<!-- }}} -->

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

<!-- {{{ Synopsis -->
   <classsynopsis class="class">
    <ooclass>
     <classname>Directory</classname>
    </ooclass>

    <classsynopsisinfo role="comment">&Properties;</classsynopsisinfo>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>readonly</modifier>
     <type>string</type>
     <varname linkend="directory.props.path">path</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>readonly</modifier>
     <type>resource</type>
     <varname linkend="directory.props.handle">handle</varname>
    </fieldsynopsis>

    <classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.directory')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[@role='Directory'])">
     <xi:fallback/>
    </xi:include>
   </classsynopsis>
<!-- }}} -->

  </section>

<!-- {{{ directory properties -->
  <section xml:id="directory.props">
   &reftitle.properties;
   <variablelist>
    <varlistentry xml:id="directory.props.path">
     <term><varname>path</varname></term>
     <listitem>
      <para>
       The directory that was opened.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="directory.props.handle">
     <term><varname>handle</varname></term>
     <listitem>
      <para>
       Can be used with other directory functions such as
       <function>readdir</function>, <function>rewinddir</function> and
       <function>closedir</function>.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </section>

  <section role="changelog">
   &reftitle.changelog;
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>&Version;</entry>
       <entry>&Description;</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry>8.1.0</entry>
       <entry>
        The <varname>path</varname> and <varname>handle</varname> properties are now readonly.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </section>
<!-- }}} -->

 </partintro>

 &reference.dir.entities.directory;

</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
-->
