archived-doc-ru/reference/dir/functions/readdir.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: b0b19b66183b28cebc1ffbcf1e2b8763f9d9c7b3 Maintainer: shein Status: ready -->
<!-- Reviewed: no -->
<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>
       Дескриптор каталога (<type>resource</type>), ранее открытый
       функцией <function>opendir</function>. Если дескриптор каталога
       не указан, используется последний дескриптор, открытый функцией
       <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> теперь допускает значение null.
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Вывести список всех элементов каталога</title>
    <para>
     Обратите внимание на способ проверки значения, возвращаемого
     функцией <function>readdir</function> в приведённом ниже
     примере. В этом примере осуществляется явная проверка значения
     на идентичность (выражения идентичны, когда они равны и являются
     значениями одного типа - за более подробной информацией
     обратитесь к главе "<link linkend="language.operators.comparison">Операторы сравнения</link>") значению &false;, поскольку
     в ином случае любой элемент каталога, чьё имя может быть
     преобразовано к &false;, остановит цикл (например, элемент с
     именем "0").
    </para>
    <programlisting role="php">
<![CDATA[
<?php

if ($handle = opendir('/path/to/files')) {
    echo "Дескриптор каталога: $handle\n";
    echo "Элементы:\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
-->