mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-27 22:38:55 +00:00
d871d0abb6
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@339492 c90b9560-bf6c-de11-be94-00142212c4b1
146 lines
4.8 KiB
XML
146 lines
4.8 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
|
|
<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>Change stream metadata</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>
|
|
This method is called to set metadata on the stream. It is called when one of the following functions is called on a stream URL:
|
|
<simplelist>
|
|
<member><function>touch</function></member>
|
|
<member><function>chmod</function></member>
|
|
<member><function>chown</function></member>
|
|
<member><function>chgrp</function></member>
|
|
</simplelist>
|
|
Please note that some of these operations may not be available on your system.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>path</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The file path or URL to set metadata. 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>option</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
One of:
|
|
<simplelist>
|
|
<member><constant>STREAM_META_TOUCH</constant> (The method was called in response to <function>touch</function>)</member>
|
|
<member><constant>STREAM_META_OWNER_NAME</constant> (The method was called in response to <function>chown</function> with string parameter)</member>
|
|
<member><constant>STREAM_META_OWNER</constant> (The method was called in response to <function>chown</function>)</member>
|
|
<member><constant>STREAM_META_GROUP_NAME</constant> (The method was called in response to <function>chgrp</function>)</member>
|
|
<member><constant>STREAM_META_GROUP</constant> (The method was called in response to <function>chgrp</function>)</member>
|
|
<member><constant>STREAM_META_ACCESS</constant> (The method was called in response to <function>chmod</function>)</member>
|
|
</simplelist>
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>value</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
If <parameter>option</parameter> is
|
|
<simplelist>
|
|
<member><constant>STREAM_META_TOUCH</constant>: <type>Array</type> consisting of two arguments of the <function>touch</function>
|
|
function.</member>
|
|
<member><constant>STREAM_META_OWNER_NAME</constant> or <constant>STREAM_META_GROUP_NAME</constant>:
|
|
The name of the owner user/group as <type>string</type>.</member>
|
|
<member><constant>STREAM_META_OWNER</constant> or <constant>STREAM_META_GROUP</constant>:
|
|
The value owner user/group argument as <type>integer</type>.</member>
|
|
<member><constant>STREAM_META_ACCESS</constant>: The argument of the <function>chmod</function> as <type>integer</type>.</member>
|
|
</simplelist>
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
&return.success;
|
|
If <parameter>option</parameter> is not implemented, &false; should be
|
|
returned.
|
|
</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
|
|
-->
|