mirror of
https://github.com/php/doc-ru.git
synced 2026-04-26 16:58:14 +02:00
Sergey Panteleev
492 lines
12 KiB
XML
492 lines
12 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- EN-Revision: a4fe8cf4c7712c4af6d2b0dc2e3d7090f53f4e21 Maintainer: tmn Status: ready -->
|
|
<!-- Reviewed: no -->
|
|
|
|
<refentry xml:id="function.eio-readdir" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
|
<refnamediv>
|
|
<refname>eio_readdir</refname>
|
|
<refpurpose>
|
|
Читает содержимое директории
|
|
</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>resource</type><methodname>eio_readdir</methodname>
|
|
<methodparam><type>string</type><parameter>path</parameter></methodparam>
|
|
<methodparam><type>int</type><parameter>flags</parameter></methodparam>
|
|
<methodparam><type>int</type><parameter>pri</parameter></methodparam>
|
|
<methodparam><type>callable</type><parameter>callback</parameter></methodparam>
|
|
<methodparam
|
|
choice="opt"><type>string</type><parameter>data</parameter><initializer>NULL</initializer></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Читает содержимое директории (посредством системных вызовов
|
|
<literal>opendir</literal>, <literal>readdir</literal> и
|
|
<literal>closedir</literal>) и либо возвращает имена файлов, либо передаёт
|
|
массив в качестве аргумента <parameter>result</parameter> в функцию
|
|
<parameter>callback</parameter>. Поведение метода зависит от значения параметра
|
|
<parameter>flags</parameter>.
|
|
</para>
|
|
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>path</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Путь к директории.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>flags</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Комбинация констант <emphasis>EIO_READDIR_*</emphasis>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>pri</parameter></term>
|
|
<listitem>
|
|
&eio.request.pri.values;
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>callback</parameter></term>
|
|
<listitem>
|
|
&eio.callback.proto;
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>data</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Данные, которые необходимо передать функции <parameter>callback</parameter>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
<function>eio_readdir</function> возвращает ресурс запроса в случае успешного выполнения&return.falseforfailure;.
|
|
Также может задавать значение аргумента <parameter>result</parameter>
|
|
функции <parameter>callback</parameter> в зависимости от значения параметра
|
|
<parameter>flags</parameter>:
|
|
</para>
|
|
|
|
<para>
|
|
<variablelist>
|
|
|
|
<!--{{{ EIO_READDIR_* -->
|
|
<varlistentry>
|
|
<term>
|
|
<constant>EIO_READDIR_DENTS</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
Флаг <function>eio_readdir</function>. Если задан, в качестве аргумента
|
|
callback-функции будет передаваться массив со следующими ключами:
|
|
<literal>'names'</literal> - массив имён директории
|
|
<literal>'dents'</literal> - массив структур типа <literal>struct
|
|
eio_dirent</literal>, каждая из которых представляется массивом с ключами:
|
|
<literal>'name'</literal> - имя директории;
|
|
<literal>'type'</literal> - одна из констант <emphasis>EIO_DT_*</emphasis>;
|
|
<literal>'inode'</literal> - номер узла inode, если доступен, либо пустое
|
|
значение;
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>
|
|
<constant>EIO_READDIR_DIRS_FIRST</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
Если этот флаг задан, первыми будут возвращаться имена директорий, затем
|
|
имена файлов. Порядок следования имён в каждой группе будет оптимальным для
|
|
применения функции stat.
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>
|
|
<constant>EIO_READDIR_STAT_ORDER</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
Если этот флаг задан, имена файлов и директорий будут возвращаться в
|
|
порядке, удобном для сбора статистики (<literal>stat</literal>) каждого из
|
|
объектов. Если полученный список имён предполагается передавать в функцию
|
|
<function>stat</function>, порядок следования имён обеспечит наиболее быструю
|
|
работу функции.
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>
|
|
<constant>EIO_READDIR_FOUND_UNKNOWN</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<!--}}}-->
|
|
|
|
</variablelist>
|
|
</para>
|
|
|
|
<para>Типы узлов:
|
|
<variablelist>
|
|
|
|
<!--{{{ EIO_DT_* -->
|
|
<varlistentry>
|
|
<term>
|
|
<constant>EIO_DT_UNKNOWN</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
Неизвестный тип узла (очень часто). Необходима обработка функцией
|
|
<function>stat</function>.
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>
|
|
<constant>EIO_DT_FIFO</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
Тип узла - FIFO
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>
|
|
<constant>EIO_DT_CHR</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
Тип узла
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>
|
|
<constant>EIO_DT_MPC</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
Тип узла - составное символьное устройство (v7+coherent)
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>
|
|
<constant>EIO_DT_DIR</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
Тип узла - директория
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>
|
|
<constant>EIO_DT_NAM</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
Тип узла - файл со специальным Xenix наименованием
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>
|
|
<constant>EIO_DT_BLK</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
Тип узла
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>
|
|
<constant>EIO_DT_MPB</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
Составное блочное устройство (v7+coherent)
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>
|
|
<constant>EIO_DT_REG</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
Тип узла
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>
|
|
<constant>EIO_DT_NWK</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>
|
|
<constant>EIO_DT_CMP</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
Специальный тип узла для сетей HP-UX
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>
|
|
<constant>EIO_DT_LNK</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
Тип узла - ссылка
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>
|
|
<constant>EIO_DT_SOCK</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
Тип узла - сокет
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>
|
|
<constant>EIO_DT_DOOR</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
Тип узла - Solaris door
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>
|
|
<constant>EIO_DT_WHT</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
Тип узла
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>
|
|
<constant>EIO_DT_MAX</constant>
|
|
(<type>int</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
Максимальное значение типа узла
|
|
</simpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<!--}}}-->
|
|
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<example>
|
|
<title>Пример использования <function>eio_readdir</function></title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
/* Вызывается, когда отработает eio_readdir() */
|
|
function my_readdir_callback($data, $result) {
|
|
echo "Вызвана функция ", __FUNCTION__, "\n";
|
|
echo "данные: "; var_dump($data);
|
|
echo "результат: "; var_dump($result);
|
|
echo "\n";
|
|
}
|
|
|
|
eio_readdir("/var/spool/news", EIO_READDIR_STAT_ORDER | EIO_READDIR_DIRS_FIRST,
|
|
EIO_PRI_DEFAULT, "my_readdir_callback");
|
|
eio_event_loop();
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs.similar;
|
|
<screen>
|
|
<![CDATA[
|
|
Вызвана функция my_readdir_callback
|
|
данные: NULL
|
|
результат: array(2) {
|
|
["names"]=>
|
|
array(7) {
|
|
[0]=>
|
|
string(7) "archive"
|
|
[1]=>
|
|
string(8) "articles"
|
|
[2]=>
|
|
string(8) "incoming"
|
|
[3]=>
|
|
string(7) "innfeed"
|
|
[4]=>
|
|
string(8) "outgoing"
|
|
[5]=>
|
|
string(8) "overview"
|
|
[6]=>
|
|
string(3) "tmp"
|
|
}
|
|
["dents"]=>
|
|
array(7) {
|
|
[0]=>
|
|
array(3)
|
|
{
|
|
["name"]=>
|
|
string(7)
|
|
"archive"
|
|
["type"]=>
|
|
int(4)
|
|
["inode"]=>
|
|
int(393265)
|
|
}
|
|
[1]=>
|
|
array(3)
|
|
{
|
|
["name"]=>
|
|
string(8)
|
|
"articles"
|
|
["type"]=>
|
|
int(4)
|
|
["inode"]=>
|
|
int(393266)
|
|
}
|
|
[2]=>
|
|
array(3)
|
|
{
|
|
["name"]=>
|
|
string(8)
|
|
"incoming"
|
|
["type"]=>
|
|
int(4)
|
|
["inode"]=>
|
|
int(393267)
|
|
}
|
|
[3]=>
|
|
array(3)
|
|
{
|
|
["name"]=>
|
|
string(7)
|
|
"innfeed"
|
|
["type"]=>
|
|
int(4)
|
|
["inode"]=>
|
|
int(393269)
|
|
}
|
|
[4]=>
|
|
array(3)
|
|
{
|
|
["name"]=>
|
|
string(8)
|
|
"outgoing"
|
|
["type"]=>
|
|
int(4)
|
|
["inode"]=>
|
|
int(393270)
|
|
}
|
|
[5]=>
|
|
array(3)
|
|
{
|
|
["name"]=>
|
|
string(8)
|
|
"overview"
|
|
["type"]=>
|
|
int(4)
|
|
["inode"]=>
|
|
int(393271)
|
|
}
|
|
[6]=>
|
|
array(3)
|
|
{
|
|
["name"]=>
|
|
string(3)
|
|
"tmp"
|
|
["type"]=>
|
|
int(4)
|
|
["inode"]=>
|
|
int(393272)
|
|
}
|
|
}
|
|
}
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
</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
|
|
-->
|