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
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.14 $ -->
<!-- splitted from ./en/functions/dir.xml, last change in rev 1.2 -->
<refentry xml:id="class.dir" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>dir</refname>
<refpurpose>Return an instance of the Directory class</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<classsynopsis>
<ooclass><classname>Directory</classname></ooclass>
<classsynopsisinfo>
<ooclass>
<classname>Directory</classname>
</ooclass>
</classsynopsisinfo>
<fieldsynopsis>
<type>string</type><varname>path</varname>
</fieldsynopsis>
<fieldsynopsis>
<type>resource</type><varname>handle</varname>
</fieldsynopsis>
<methodsynopsis><type>string</type><methodname>Directory::read</methodname><void/></methodsynopsis>
<methodsynopsis><type>void</type><methodname>Directory::rewind</methodname><void/></methodsynopsis>
<methodsynopsis><type>void</type><methodname>Directory::close</methodname><void/></methodsynopsis>
</classsynopsis>
<para>
A pseudo-object oriented mechanism for reading a directory. The
given <parameter>directory</parameter> is opened. Two properties
are available once the directory has been opened. The handle
property can be used with other directory functions such as
<function>readdir</function>, <function>rewinddir</function> and
<function>closedir</function>. The path property is set to path
the directory that was opened. Three methods are available:
read, rewind and close.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>dir</function> example</title>
<para>
Please note the fashion in which <function>dir::read</function>'s
return value is checked in the example below. We are explicitly
testing whether the return value is identical to (equal to and of
the same type as - see <link linkend="language.operators.comparison">
Comparison Operators</link> for more information) &false; since
otherwise, any directory entry whose name evaluates to &false; will
stop the loop.
</para>
<programlisting role="php">
<![CDATA[
<?php
$d = dir("/etc/php5");
echo "Handle: " . $d->handle . "\n";
echo "Path: " . $d->path . "\n";
while (false !== ($entry = $d->read())) {
echo $entry."\n";
}
$d->close();
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
Handle: Resource id #2
Path: /etc/php5
.
..
apache
cgi
cli
]]>
</screen>
</example>
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
<note>
<para>
The order in which directory entries are returned by the read method is
system-dependent.
</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:"../../../../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
-->
|
