opendir.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 5c7e9e1351240b5f9e0858cdeba8f754a366d1b7 Maintainer: shein Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.opendir" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>opendir</refname>
  <refpurpose>Открывает дескриптор каталога</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>resource</type><type>false</type></type><methodname>opendir</methodname>
   <methodparam><type>string</type><parameter>directory</parameter></methodparam>
   <methodparam choice="opt"><type class="union"><type>resource</type><type>null</type></type><parameter>context</parameter><initializer>&null;</initializer></methodparam>
  </methodsynopsis>
  <simpara>
   Функция открывает дескриптор каталога, который затем передают как аргумент
   в функции <function>closedir</function>,
   <function>readdir</function> и <function>rewinddir</function>.
  </simpara>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>directory</parameter></term>
    <listitem>
     <simpara>
      Путь к каталогу, который требуется открыть.
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>context</parameter></term>
    <listitem>
     <simpara>
      Параметр <parameter>context</parameter> описывается
      в разделе руководства «<link linkend="ref.stream">Потоки</link>».
     </simpara>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <simpara>
   Функция возвращает дескриптор каталога в случае успешного выполнения&return.falseforfailure;
  </simpara>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  &fs.emits.warning.on.failure;
  <simpara>
   Ошибка возникает, если в параметр <parameter>directory</parameter> передали
   недопустимый путь к каталогу, каталог невозможно открыть
   из-за ограничений прав доступа или из-за ошибок файловой системы.
  </simpara>
 </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>context</parameter> теперь допускает значение &null;.
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

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

if ($handle = opendir('/path/to/files')) {
    echo "Записи:\n";

    /* Правильная обработка записей в каталоге, которые могут считаться ложными */
    while (false !== ($entry = readdir($handle))) {
        if ($entry === '.' || $entry === '..') {
            continue;
        }
        echo "$entry\n";
    }

    closedir($handle);
}
?>
]]>
   </programlisting>
   &example.outputs.similar;
   <screen>
<![CDATA[
Записи:
base
en
fr
output.md
test.php
]]>
   </screen>
  </example>
 </refsect1>

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