1
0
mirror of https://github.com/php/doc-ja.git synced 2026-03-24 15:12:22 +01:00
Files
2024-02-11 19:46:17 +09:00

198 lines
6.9 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: c79b9928aa114777d864b9c70feb1436d7344b4d Maintainer: takagi Status: ready -->
<!-- Credits: mumumu -->
<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>ファイルについての情報を取得する</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type class="union"><type>array</type><type>false</type></type><methodname>streamWrapper::url_stat</methodname>
<methodparam><type>string</type><parameter>path</parameter></methodparam>
<methodparam><type>int</type><parameter>flags</parameter></methodparam>
</methodsynopsis>
<para>
このメソッドは、すべての <function>stat</function> 関連の関数に対応してコールされます。
<simplelist>
<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>
情報を取得したいファイルの URL。
URL の区切り文字は :// でなければならないことに注意しましょう。
それ以外の形式の URL はサポートしていません。
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>flags</parameter></term>
<listitem>
<para>
ストリーム API が設定する追加のフラグ。以下の値の OR で組み合わせて使用します。
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>Flag</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry>STREAM_URL_STAT_LINK</entry>
<entry>
他のリソースへのリンクを行うことができるリソース
(たとえば HTTP Location: による転送やファイルシステムのシンボリックリンク)。
このフラグを指定すると、リンク先のリソースの情報ではなくリンクそのものの情報のみを返します。
このフラグは、<function>lstat</function>
<function>is_link</function> あるいは <function>filetype</function>
に対応して設定されます。
</entry>
</row>
<row>
<entry>STREAM_URL_STAT_QUIET</entry>
<entry>
このフラグが設定されると、ラッパーが一切エラーを発生しなくなります。
フラグが設定されていない場合、
パス情報の取得中に発生したエラーは
<function>trigger_error</function> を用いて通知します。
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<function>stat</function>
が返すのと同じ要素を持つ配列を返さなければなりません。
未知の値、あるいは取得できない値については適切な値
(通常は <constant>0</constant>) を設定します。
<function>stat</function> 関数で説明されている
<literal>mode</literal> には特別な注意を払ってください。
失敗した場合は、&false; を返します。
</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
-->