stream-metadata.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 86e6094e86b84a51d00ab217ac50ce8dde33d82a Maintainer: yannick Status: ready -->
<!-- Reviewed: no -->

<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 les metadata du flux</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>
   Cette méthode est appelée pour changer les métadonnées du flux. Elle est invoquée lorsque l'une des fonctions suivantes est
   appelée sur un flux:
   <simplelist>
    <member><function>touch</function></member>
    <member><function>chmod</function></member>
    <member><function>chown</function></member>
    <member><function>chgrp</function></member>
   </simplelist>
   Veuillez noter que certaines de ces opérations peuvent ne pas être disponibles sur votre système.
  </para>
 </refsect1>
 
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>path</parameter></term>
     <listitem>
      <para>
       Le chemin du fichier ou l'URL pour laquelle changer les métadonnées. Notez que dans le cas d'une URL,
       elle doit utiliser le délimiteur ://, les autres formes d'URL ne sont pas supportées.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>option</parameter></term>
     <listitem>
      <para>
       A choisir parmi :
       <simplelist>
        <member><constant>STREAM_META_TOUCH</constant> (La méthode a été appelée suite à <function>touch</function>)</member>
        <member><constant>STREAM_META_OWNER_NAME</constant> (La méthode a été appelée suite à <function>chown</function> avec un paramètre de type chaine)</member>
        <member><constant>STREAM_META_OWNER</constant> (La méthode a été appelée suite à  <function>chown</function>)</member>
        <member><constant>STREAM_META_GROUP_NAME</constant> (La méthode a été appelée suite à <function>chgrp</function>)</member>
        <member><constant>STREAM_META_GROUP</constant> (La méthode a été appelée suite à <function>chgrp</function>)</member>
        <member><constant>STREAM_META_ACCESS</constant> (La méthode a été appelée suite à <function>chmod</function>)</member>
       </simplelist>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>value</parameter></term>
     <listitem>
      <para>
       Si <parameter>option</parameter> est
       <simplelist>
        <member><constant>STREAM_META_TOUCH</constant> : <type>Array</type> consistant en deux arguments de la fonction <function>touch</function>.</member>
        <member><constant>STREAM_META_OWNER_NAME</constant> ou <constant>STREAM_META_GROUP_NAME</constant>: 
         Le nom du propriétaire user/group sous forme de <type>string</type>.</member>
        <member><constant>STREAM_META_OWNER</constant> ou <constant>STREAM_META_GROUP</constant>: 
         La valeur du propriétaire user/group sous forme <type>int</type>.</member>
        <member><constant>STREAM_META_ACCESS</constant> : L'argument de <function>chmod</function> sous forme <type>int</type>.</member>
       </simplelist>
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;
   Si <parameter>option</parameter> n'est pas implémentée, &false; devrait être retourné.
  </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
-->