stream-metadata.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 86e6094e86b84a51d00ab217ac50ce8dde33d82a Maintainer: seros Status: ready -->
<!-- Reviewed: yes Maintainer: seros -->
<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>Cambiar los metadatos del flujo</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>
   Este método es llamado para establecer metadatos en el flujo. Se invoca cuando una de las siguientes funciones es llamada sobre un URL de flujo:
   <simplelist>
    <member><function>touch</function></member>
    <member><function>chmod</function></member>
    <member><function>chown</function></member>
    <member><function>chgrp</function></member>
   </simplelist>
   Observe que algunas de estas operaciones pueden no estar disponibles en su sistema.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>path</parameter></term>
     <listitem>
      <para>
       La ruta del fichero o el URL a establecer los metadatos. Observe que en caso de ser un URL, debe ser un URL delimitado por
       ://. No se admiten otros formatos de URL.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>option</parameter></term>
     <listitem>
      <para>
       Una de las siguientes opciones:
       <simplelist>
        <member><constant>STREAM_META_TOUCH</constant> (El método fue llamado en respuesta a <function>touch</function>)</member>
        <member><constant>STREAM_META_OWNER_NAME</constant> (El método fue llamado en respuesta a <function>chown</function> con parámetro de tipo string)</member>
        <member><constant>STREAM_META_OWNER</constant> (El método fue llamado en respuesta a <function>chown</function>)</member>
        <member><constant>STREAM_META_GROUP_NAME</constant> (El método fue llamado en respuesta a <function>chgrp</function>)</member>
        <member><constant>STREAM_META_GROUP</constant> (El método fue llamado en respuesta a <function>chgrp</function>)</member>
        <member><constant>STREAM_META_ACCESS</constant> (El método fue llamado en respuesta a <function>chmod</function>)</member>
       </simplelist>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>value</parameter></term>
     <listitem>
      <para>
       Si el parámetro <parameter>option</parameter> es
       <simplelist>
        <member><constant>STREAM_META_TOUCH</constant>: <type>Array</type> que consiste en dos argumentos de la función
         <function>touch</function>.</member>
        <member><constant>STREAM_META_OWNER_NAME</constant> o <constant>STREAM_META_GROUP_NAME</constant>:
         El nombre del usuario/grupo propietario como <type>string</type>.</member>
        <member><constant>STREAM_META_OWNER</constant> o <constant>STREAM_META_GROUP</constant>:
         El valor del argumento del usuario/grupo propietario como <type>int</type>.</member>
        <member><constant>STREAM_META_ACCESS</constant>: El argumento de la función <function>chmod</function> como <type>int</type>.</member>
       </simplelist>
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;
   Si <parameter>option</parameter> no se implementa, debería devolver
   &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
-->