-
Notifications
You must be signed in to change notification settings - Fork 79
/
Copy pathstat.xml
362 lines (347 loc) · 10.9 KB
/
stat.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
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
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 1f7d8b1ee9e6c7350857ddc8bfce248a65a29787 Maintainer: hirokawa Status: ready -->
<!-- CREDITS: shimooka,mumumu -->
<refentry xml:id="function.stat" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>stat</refname>
<refpurpose>ファイルに関する情報を取得する</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>array</type><type>false</type></type><methodname>stat</methodname>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
</methodsynopsis>
<para>
<parameter>filename</parameter>で指定されたファイルに
ついての統計情報を取得します。
<parameter>filename</parameter> がシンボリックリンクの場合、
シンボリックリンクではなくファイルの実体の統計情報が返されます。
Windows 環境、かつ PHP 7.4.0 より前の <abbrev>NTS</abbrev> ビルドでは、
<literal>size</literal>,
<literal>atime</literal>, <literal>mtime</literal>, <literal>ctime</literal>
の統計情報は、シンボリックリンクの値が返されていました。
</para>
<para>
<function>lstat</function>
はシンボリックリンクの統計情報を返すという違いを除いて
<function>stat</function> と等価です。
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>filename</parameter></term>
<listitem>
<para>
ファイルへのパス。
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<table>
<title><function>stat</function> と <function>fstat</function>
の結果のフォーマット</title>
<tgroup cols="3">
<thead>
<row>
<entry>数値</entry>
<entry>連想配列</entry>
<entry>説明</entry>
</row>
</thead>
<tbody>
<row>
<entry>0</entry>
<entry>dev</entry>
<entry>デバイス番号 (***)</entry>
</row>
<row>
<entry>1</entry>
<entry>ino</entry>
<entry>inode 番号(****)</entry>
</row>
<row>
<entry>2</entry>
<entry>mode</entry>
<entry>inode プロテクトモード(*****)</entry>
</row>
<row>
<entry>3</entry>
<entry>nlink</entry>
<entry>リンク数</entry>
</row>
<row>
<entry>4</entry>
<entry>uid</entry>
<entry>所有者のユーザー ID(*)</entry>
</row>
<row>
<entry>5</entry>
<entry>gid</entry>
<entry>所有者のグループ ID(*)</entry>
</row>
<row>
<entry>6</entry>
<entry>rdev</entry>
<entry>inode デバイス の場合、デバイスの種類</entry>
</row>
<row>
<entry>7</entry>
<entry>size</entry>
<entry>バイト単位のサイズ</entry>
</row>
<row>
<entry>8</entry>
<entry>atime</entry>
<entry>最終アクセス時間 (Unix タイムスタンプ)</entry>
</row>
<row>
<entry>9</entry>
<entry>mtime</entry>
<entry>最終修正時間 (Unix タイムスタンプ)</entry>
</row>
<row>
<entry>10</entry>
<entry>ctime</entry>
<entry>最終 inode 変更時間 (Unix タイムスタンプ)</entry>
</row>
<row>
<entry>11</entry>
<entry>blksize</entry>
<entry>ファイル IO のブロックサイズ(**)</entry>
</row>
<row>
<entry>12</entry>
<entry>blocks</entry>
<entry>512 バイトのブロックの確保数(**)</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
<para>
* Windows では常に <literal>0</literal> となります。
</para>
<para>
** st_blksize タイプをサポートするシステムでのみ有効です。
その他のシステム(例えば Windows)では <literal>-1</literal> を返します。
</para>
<para>
*** PHP 7.4.0 以降、Windows では、この値はファイルが含まれるボリュームのシリアル番号です。
これは64ビットの <emphasis>符号なし</emphasis> 整数です。
よって、オーバーフローする可能性があります。
これより前のバージョンでは、<function>stat</function> 関数ではドライブレターを数値で表現した値
(たとえば、<literal>C:</literal> では <literal>2</literal>) でした。
<function>lstat</function> 関数では <literal>0</literal> でした。
</para>
<para>
**** PHP 7.4.0 以降、Windows では、この値はファイルに関連付けられた識別子です。
これは64ビットの <emphasis>符号なし</emphasis> 整数です。
よって、オーバーフローする可能性があります。
これより前のバージョンでは、この値は常に <literal>0</literal> でした。
</para>
<para>
***** Windows では、
読み取り専用のファイル属性に従って、
書き込み可能のパーミッションビットが設定されます。
そして、この値は全てのユーザ、グループ、
オーナーについて、同じ値が報告されます。
<function>is_writable</function>
とは異なり、ACL は考慮されません。
</para>
<para>
<literal>mode</literal> の値は、複数の関数によって読まれる情報が含まれています。
8進数の場合、一番右の桁から評価され、はじめの3桁が <function>chmod</function> によって返されます。
次の桁は PHP によって無視されます。その次の2桁は以下のファイルタイプを示します:
<table>
<title><literal>mode</literal> のファイルタイプ</title>
<tgroup cols="2">
<thead>
<row>
<entry><literal>mode</literal> が8進数だった場合</entry>
<entry>意味</entry>
</row>
</thead>
<tbody>
<row>
<entry><constant>0140000</constant></entry>
<entry>ソケット</entry>
</row>
<row>
<entry><constant>0120000</constant></entry>
<entry>リンク</entry>
</row>
<row>
<entry><constant>0100000</constant></entry>
<entry>通常のファイル</entry>
</row>
<row>
<entry><constant>0060000</constant></entry>
<entry>ブロックデバイス</entry>
</row>
<row>
<entry><constant>0040000</constant></entry>
<entry>ディレクトリ</entry>
</row>
<row>
<entry><constant>0020000</constant></entry>
<entry>キャラクタデバイス</entry>
</row>
<row>
<entry><constant>0010000</constant></entry>
<entry>fifo</entry>
</row>
</tbody>
</tgroup>
</table>
よって、たとえば 通常のファイルは <constant>0100644</constant> のような値になりますし、
ディレクトリは <constant>0040755</constant> のような値になります。
</para>
<para>
<function>stat</function> はエラーの場合 &false; を返します。
</para>
&fs.file.32bit;
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
失敗した場合は <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>7.4.0</entry>
<entry>
Windows では、
デバイス番号は、ファイルが含まれるボリュームのシリアル番号を返すようになりました。
そして、inode 番号は、ファイルに関連付けられた識別子を返すようになりました。
</entry>
</row>
<row>
<entry>7.4.0</entry>
<entry>
シンボリックリンクの場合、
<literal>size</literal>, <literal>atime</literal>, <literal>mtime</literal>,
<literal>ctime</literal> の統計情報は、ファイルの実体の値が返されるようになりました。
これより前のバージョンの Windows NTS ビルドはそうではありませんでした。
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>stat</function> の例</title>
<programlisting role="php">
<![CDATA[
<?php
/* ファイルの状態を取得します */
$stat = stat('C:\php\php.exe');
/*
* ファイルのアクセス日時を表示します。
* これは fileatime() をコールするのと同じです
*/
echo 'アクセス日時: ' . $stat['atime'];
/*
* ファイルの更新日時を表示します。
* これは filemtime() をコールするのと同じです
*/
echo '更新日時: ' . $stat['mtime'];
/* デバイス番号を表示します */
echo 'デバイス番号: ' . $stat['dev'];
?>
]]>
</programlisting>
</example>
</para>
<para>
<example>
<title><function>stat</function> の情報を <function>touch</function> と組み合わせる例</title>
<programlisting role="php">
<![CDATA[
<?php
/* ファイルの状態を取得します */
$stat = stat('C:\php\php.exe');
/* 情報の取得に失敗した? */
if (!$stat) {
echo 'stat() のコールに失敗しました...';
} else {
/*
* アクセス日時を、現在のアクセス日時の
* 一週間後に設定します
*/
$atime = $stat['atime'] + 604800;
/* ファイルを作成します */
if (!touch('some_file.txt', time(), $atime)) {
echo 'ファイルの作成に失敗しました...';
} else {
echo 'touch() が成功しました...';
}
}
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
¬e.filesystem-time-res;
¬e.clearstatcache;
&tip.fopen-wrapper.stat;
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>lstat</function></member>
<member><function>fstat</function></member>
<member><function>filemtime</function></member>
<member><function>filegroup</function></member>
<member><classname>SplFileInfo</classname></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
-->