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

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- splitted from ./en/functions/dir.xml, last change in rev 1.2 -->
<refentry xml:id="function.opendir" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>opendir</refname>
  <refpurpose>Open directory handle</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>resource</type><methodname>opendir</methodname>
   <methodparam><type>string</type><parameter>path</parameter></methodparam>
   <methodparam choice="opt"><type>resource</type><parameter>context</parameter></methodparam>
  </methodsynopsis>
  <para>
   Opens up a directory handle to be used in subsequent
   <function>closedir</function>, <function>readdir</function>, and
   <function>rewinddir</function> calls.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>path</parameter></term>
     <listitem>
      <para>
       The directory path that is to be opened
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>context</parameter></term>
     <listitem>
      <para>
       For a description of the <parameter>context</parameter> parameter, 
       refer to <link linkend="ref.stream">the streams section</link> of
       the manual.
      </para> 
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns a directory handle <type>resource</type> on success, or
   &false; on failure.
  </para> 
  <para>
   If <parameter>path</parameter> is not a valid directory or the
   directory can not be opened due to permission restrictions or
   filesystem errors, <function>opendir</function> returns &false; and
   generates a PHP error of level <link linkend="errorfunc.constants">
   E_WARNING</link>.  You can suppress the error output of
   <function>opendir</function> by prepending
   '<link linkend="language.operators.errorcontrol">@</link>' to the
   front of the function name.
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <para>
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>&Version;</entry>
       <entry>&Description;</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry>5.0.0</entry>
       <entry>
        <parameter>path</parameter> supports the <literal>ftp://</literal> 
        URL wrapper.
       </entry>
      </row>
      <row>
       <entry>4.3.0</entry>
       <entry>
        <parameter>path</parameter> can also be any URL which supports 
        directory listing, however only the <literal>file://</literal>
        URL wrapper supports this in PHP 4
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>opendir</function> example</title>
    <programlisting role="php">
<![CDATA[
<?php
$dir = "/etc/php5/";

// Open a known directory, and proceed to read its contents
if (is_dir($dir)) {
    if ($dh = opendir($dir)) {
        while (($file = readdir($dh)) !== false) {
            echo "filename: $file : filetype: " . filetype($dir . $file) . "\n";
        }
        closedir($dh);
    }
}
?>
]]>
    </programlisting>
    &example.outputs.similar;
    <screen>
<![CDATA[
filename: . : filetype: dir
filename: .. : filetype: dir
filename: apache : filetype: dir
filename: cgi : filetype: dir
filename: cli : filetype: dir
]]>
    </screen>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>is_dir</function></member>
    <member><function>readdir</function></member>
    <member><function>dir</function></member>
   </simplelist>
  </para>
 </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:"~/.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
-->