-
Notifications
You must be signed in to change notification settings - Fork 70
/
dir.xml
147 lines (140 loc) · 4.41 KB
/
dir.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: b0b19b66183b28cebc1ffbcf1e2b8763f9d9c7b3 Maintainer: shein Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.dir" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>dir</refname>
<refpurpose>Возвращает экземпляр класса Directory</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>Directory</type><type>false</type></type><methodname>dir</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>
<para>
Псевдо-объектно-ориентированный механизм для чтения каталога. Открывается
переданный в параметре <parameter>directory</parameter> каталог.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>directory</parameter></term>
<listitem>
<para>
Каталог для открытия
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>context</parameter></term>
<listitem>
¬e.context-support;
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Возвращает экземпляр класса <classname>Directory</classname> или &false; в случае возникновения ошибки.
</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>dir</function></title>
<para>
Обратите внимание на способ, которым осуществляется
проверка значения, возвращаемого <function>Directory::read</function>
в примере, приведённом ниже. В этом примере явно проводится
проверка значения на идентичность (выражения идентичны, когда
они равны и являются одного типа - за более подробной информацией
обратитесь к главе <link linkend="language.operators.comparison">
Операторы сравнения</link>) значению &false;, поскольку
в ином случае, любой элемент каталога, чьё имя может быть
выражено как &false;, остановит цикл.
</para>
<programlisting role="php">
<![CDATA[
<?php
$d = dir("/etc/php5");
echo "Дескриптор: " . $d->handle . "\n";
echo "Путь: " . $d->path . "\n";
while (false !== ($entry = $d->read())) {
echo $entry."\n";
}
$d->close();
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
Дескриптор: Resource id #2
Путь: /etc/php5
.
..
apache
cgi
cli
]]>
</screen>
</example>
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
<note>
<para>
Порядок, в котором метод "read" возвращает элементы каталога,
зависит от операционной системы.
</para>
</note>
</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
-->