archived-doc-ja/reference/stream/streamwrapper/stream-metadata.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 86e6094e86b84a51d00ab217ac50ce8dde33d82a Maintainer: takagi Status: ready -->
<!-- Credits: mumumu -->

<refentry xml:id="streamwrapper.stream-metadata" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>streamWrapper::stream_metadata</refname>
  <refpurpose>ストリームメタデータを変更する</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <modifier>public</modifier> <type>bool</type><methodname>streamWrapper::stream_metadata</methodname>
   <methodparam><type>string</type><parameter>path</parameter></methodparam>
   <methodparam><type>int</type><parameter>option</parameter></methodparam>
   <methodparam><type>mixed</type><parameter>value</parameter></methodparam>
  </methodsynopsis>
  <para>
   ストリームのメタデータを設定します。ストリーム URL 上で次のいずれかの関数がコールされたときに呼び出されます。
  <simplelist>
    <member><function>touch</function></member>
    <member><function>chmod</function></member>
    <member><function>chown</function></member>
    <member><function>chgrp</function></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>option</parameter></term>
     <listitem>
      <para>
       次のいずれかです。
       <simplelist>
        <member><constant>STREAM_META_TOUCH</constant> (<function>touch</function> に反応してコールされる)</member>
        <member><constant>STREAM_META_OWNER_NAME</constant> (<function>chown</function> に反応して文字列引数つきでコールされる)</member>
        <member><constant>STREAM_META_OWNER</constant> (<function>chown</function> に反応してコールされる)</member>
        <member><constant>STREAM_META_GROUP_NAME</constant> (<function>chgrp</function> に反応してコールされる)</member>
        <member><constant>STREAM_META_GROUP</constant> (<function>chgrp</function> に反応してコールされる)</member>
        <member><constant>STREAM_META_ACCESS</constant> (<function>chmod</function> に反応してコールされる)</member>
       </simplelist>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>value</parameter></term>
     <listitem>
      <para>
       <parameter>option</parameter> の値が
       <simplelist>
        <member><constant>STREAM_META_TOUCH</constant> の場合は、<function>touch</function> 関数の二つの引数を含む配列。</member>
        <member><constant>STREAM_META_OWNER_NAME</constant> あるいは <constant>PHP_STREAM_META_GROUP_NAME</constant> の場合は、オーナーの名前を表す文字列。</member>
        <member><constant>STREAM_META_OWNER</constant> あるいは <constant>PHP_STREAM_META_GROUP</constant> の場合は、オーナーを表す整数値。</member>
        <member><constant>STREAM_META_ACCESS</constant> の場合は、<function>chmod</function> への引数となる整数値。</member>
       </simplelist>
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;
   <parameter>option</parameter> が実装されていない場合は &false; を返さなければなりません。
  </para>
 </refsect1>

<!--
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>streamWrapper::stream_set_option</function> example</title>
    <programlisting role="php">
<![CDATA[
<?php
/* ... */
?>
]]>
    </programlisting>
    &example.outputs.similar;
    <screen>
<![CDATA[
...
]]>
    </screen>
   </example>
  </para>
 </refsect1>
-->

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>touch</function></member>
    <member><function>chmod</function></member>
    <member><function>chown</function></member>
    <member><function>chgrp</function></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
-->