scandir.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 3f63f2b26300dd0c15d5635b8053e67448076146 Maintainer: irker Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.scandir" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>scandir</refname>
  <refpurpose>Получает список файлов и каталогов, расположенных по указанному пути</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>array</type><type>false</type></type><methodname>scandir</methodname>
   <methodparam><type>string</type><parameter>directory</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>sorting_order</parameter><initializer><constant>SCANDIR_SORT_ASCENDING</constant></initializer></methodparam>
   <methodparam choice="opt"><type class="union"><type>resource</type><type>null</type></type><parameter>context</parameter><initializer>&null;</initializer></methodparam>
  </methodsynopsis>
  <para>
   Возвращает массив (<type>array</type>), содержащий имена файлов и каталогов,
   расположенных по пути, переданном в параметре <parameter>directory</parameter>.
  </para>

 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>directory</parameter></term>
     <listitem>
      <para>
       Сканируемый каталог.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>sorting_order</parameter></term>
     <listitem>
      <para>
       По умолчанию сортировка производится в алфавитном порядке
       по возрастанию. Если необязательный параметр
       <parameter>sorting_order</parameter> установлен в значение
       <constant>SCANDIR_SORT_DESCENDING</constant>, сортировка производится
       в алфавитном порядке по убыванию. Если же он установлен в значение
       <constant>SCANDIR_SORT_NONE</constant>, то сортировка не производится.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>context</parameter></term>
     <listitem>
      <para>
       За описанием параметра <parameter>context</parameter>
       обратитесь к разделу <link linkend="ref.stream">Потоки</link>
       данного руководства.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Возвращает массив (<type>array</type>) имён файлов в случае успешного выполнения или
   &false; в случае возникновения ошибки. Если <parameter>directory</parameter> не
   является каталогом, возвращается &false; и генерируется сообщение
   об ошибке уровня <constant>E_WARNING</constant>.
  </para>
 </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;
  <para>
   <example>
    <title>Простой пример использования функции <function>scandir</function></title>
    <programlisting role="php">
<![CDATA[
<?php
$dir    = '/tmp';
$files1 = scandir($dir);
$files2 = scandir($dir, SCANDIR_SORT_DESCENDING);

print_r($files1);
print_r($files2);
?>
]]>
    </programlisting>
    &example.outputs.similar;
    <screen>
<![CDATA[
Array
(
    [0] => .
    [1] => ..
    [2] => bar.php
    [3] => foo.txt
    [4] => somedir
)
Array
(
    [0] => somedir
    [1] => foo.txt
    [2] => bar.php
    [3] => ..
    [4] => .
)
]]>
    </screen>
   </example>
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  &tip.fopen-wrapper;
 </refsect1>

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