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
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 288721 $ -->
<refentry xml:id="streamwrapper.url-stat" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>streamWrapper::url_stat</refname>
<refpurpose>Retrieve information about a file</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>array</type><methodname>streamWrapper::url_stat</methodname>
<methodparam><type>string</type><parameter>path</parameter></methodparam>
<methodparam><type>int</type><parameter>flags</parameter></methodparam>
</methodsynopsis>
<para>
This method is called in response to all <function>stat</function> related
functions, such as:
<simplelist>
<member><function>chmod</function> (only when <link linkend="ini.safe-mode">safe_mode</link> is enabled)</member>
<member><function>copy</function></member>
<member><function>fileperms</function></member>
<member><function>fileinode</function></member>
<member><function>filesize</function></member>
<member><function>fileowner</function></member>
<member><function>filegroup</function></member>
<member><function>fileatime</function></member>
<member><function>filemtime</function></member>
<member><function>filectime</function></member>
<member><function>filetype</function></member>
<member><function>is_writable</function></member>
<member><function>is_readable</function></member>
<member><function>is_executable</function></member>
<member><function>is_file</function></member>
<member><function>is_dir</function></member>
<member><function>is_link</function></member>
<member><function>file_exists</function></member>
<member><function>lstat</function></member>
<member><function>stat</function></member>
<member><methodname>SplFileInfo::getPerms</methodname></member>
<member><methodname>SplFileInfo::getInode</methodname></member>
<member><methodname>SplFileInfo::getSize</methodname></member>
<member><methodname>SplFileInfo::getOwner</methodname></member>
<member><methodname>SplFileInfo::getGroup</methodname></member>
<member><methodname>SplFileInfo::getATime</methodname></member>
<member><methodname>SplFileInfo::getMTime</methodname></member>
<member><methodname>SplFileInfo::getCTime</methodname></member>
<member><methodname>SplFileInfo::getType</methodname></member>
<member><methodname>SplFileInfo::isWritable</methodname></member>
<member><methodname>SplFileInfo::isReadable</methodname></member>
<member><methodname>SplFileInfo::isExecutable</methodname></member>
<member><methodname>SplFileInfo::isFile</methodname></member>
<member><methodname>SplFileInfo::isDir</methodname></member>
<member><methodname>SplFileInfo::isLink</methodname></member>
<member><methodname>RecursiveDirectoryIterator::hasChildren</methodname></member>
</simplelist>
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>path</parameter></term>
<listitem>
<para>
The file path or URL to stat. Note that in the case of a URL, it must be a :// delimited
URL. Other URL forms are not supported.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>flags</parameter></term>
<listitem>
<para>
Holds additional flags set by the streams API. It can hold one or more
of the following values OR'd together.
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>Flag</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry>STREAM_URL_STAT_LINK</entry>
<entry>
For resources with the ability to link to other resource
(such as an HTTP Location: forward, or a filesystem
symlink). This flag specified that only information
about the link itself should be returned, not the
resource pointed to by the link. This flag is set in
response to calls to <function>lstat</function>,
<function>is_link</function>, or <function>filetype</function>.
</entry>
</row>
<row>
<entry>STREAM_URL_STAT_QUIET</entry>
<entry>If this flag is set, your wrapper should not raise any
errors. If this flag is not set, you are responsible for
reporting errors using the <function>trigger_error</function>
function during stating of the path.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Should return as many elements as <function>stat</function> does.
Unknown or unavailable values should be set to a rational value
(usually <constant>0</constant>).
</para>
</refsect1>
<refsect1 role="errors"><!-- {{{ -->
&reftitle.errors;
&userstream.not.implemented.warning;
</refsect1><!-- }}} -->
<!-- {{{
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>streamWrapper::url_stat</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
/* ... */
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
...
]]>
</screen>
</example>
</para>
</refsect1>
}}}-->
<refsect1 role="notes"><!-- {{{ -->
&reftitle.notes;
&userstream.updates.context;
</refsect1><!-- }}} -->
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>stat</function></member>
<member><methodname>streamwrapper::stream_stat</methodname></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
-->
|
