readdir.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- splitted from ./ja/functions/dir.xml, last change in rev 1.1 -->
<!-- EN-Revision: b0b19b66183b28cebc1ffbcf1e2b8763f9d9c7b3 Maintainer: takagi Status: ready -->
<!-- CREDITS: hirokawa -->
<refentry xml:id="function.readdir" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>readdir</refname>
  <refpurpose>ディレクトリハンドルからエントリを読み込む</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>string</type><type>false</type></type><methodname>readdir</methodname>
   <methodparam choice="opt"><type class="union"><type>resource</type><type>null</type></type><parameter>dir_handle</parameter><initializer>&null;</initializer></methodparam>
  </methodsynopsis>
  <para>
   ディレクトリから次のエントリの名前を返します。
   エントリ名はファイルシステム上に格納されている順番で返されます。
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>dir_handle</parameter></term>
     <listitem>
      <para>
       <function>opendir</function> が事前にオープンした
       ディレクトリハンドルを示す <type>resource</type>。
       ディレクトリハンドルを指定しなかった場合は、
       <function>opendir</function> が最後にオープンしたものを使用します。
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   成功した場合にエントリ名、&return.falseforfailure;。
  </para> 
  &return.falseproblem;
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     <row>
      <entry>8.0.0</entry>
      <entry>
       <parameter>dir_handle</parameter> は、nullable になりました。
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>ディレクトリ内の全てのエントリのリストを得る</title>
    <para>
     以下の例で、<function>readdir</function> の戻り値をどのように調べているかに
     注目してください。戻り値が &false; と一致することを、明示的に
     （値が等しく、かつ型も等しい - 詳細は <link linkend="language.operators.comparison">
     比較演算子</link> を参照ください）調べています。なぜなら、そうしないと
     &false; と評価されてしまうディレクトリエントリ
     （例: "0" という名前のディレクトリ）があった場合にループが
     とまってしまうからです。
    </para>
    <programlisting role="php">
<![CDATA[
<?php

if ($handle = opendir('/path/to/files')) {
    echo "Directory handle: $handle\n";
    echo "Entries:\n";

    /* ディレクトリをループする際の正しい方法です */
    while (false !== ($entry = readdir($handle))) {
        echo "$entry\n";
    }

    /* ディレクトリをループする際の「間違った」方法です */
    while ($entry = readdir($handle)) {
        echo "$entry\n";
    }

    closedir($handle);
}
?>
]]>
    </programlisting>
   </example>
  </para>
  <para>
   <example>
    <title>
     カレントディレクトリの全てのエントリを一覧する。ただし <literal>.</literal>
     および <literal>..</literal> は取り除く
    </title>
    <programlisting role="php">
<![CDATA[
<?php
if ($handle = opendir('.')) {
    while (false !== ($entry = readdir($handle))) {
        if ($entry != "." && $entry != "..") {
            echo "$entry\n";
        }
    }
    closedir($handle);
}
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>is_dir</function></member>
    <member><function>glob</function></member>
    <member><function>opendir</function></member>
    <member><function>scandir</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
-->