php-doc-en/reference/xattr/functions/xattr-set.xml

<?xml version="1.0" encoding="UTF-8"?>
<!-- $Revision$ -->
<!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. -->
<refentry xml:id="function.xattr-set" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>xattr_set</refname>
  <refpurpose>
   Set an extended attribute
  </refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>xattr_set</methodname>
   <methodparam><type>string</type><parameter>filename</parameter></methodparam>
   <methodparam><type>string</type><parameter>name</parameter></methodparam>
   <methodparam><type>string</type><parameter>value</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
  </methodsynopsis>
  <para>
   This function sets the value of an extended attribute of a file.
  </para>
  &xattr.namespace;
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>filename</parameter></term>
     <listitem>
      <para>
       The file in which we set the attribute.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>name</parameter></term>
     <listitem>
      <para>
       The name of the extended attribute. This attribute will be created if 
       it doesn't exist or replaced otherwise. You can change this behaviour 
       by using the <parameter>flags</parameter> parameter.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>value</parameter></term>
     <listitem>
      <para>
       The value of the attribute.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>flags</parameter></term>
     <listitem>
      <para>
       <table>
        <title>Supported xattr flags</title>
        <tgroup cols="2">
         <tbody>
          <row>
           <entry><constant>XATTR_CREATE</constant></entry>
           <entry>Function will fail if extended attribute already exists.</entry>
          </row>
          <row>
           <entry><constant>XATTR_REPLACE</constant></entry>
           <entry>Function will fail if extended attribute doesn't exist.</entry>
          </row>
          <row>
           <entry><constant>XATTR_DONTFOLLOW</constant></entry>
           <entry>Do not follow the symbolic link but operate on symbolic link itself.</entry>
          </row>
          <row>
           <entry><constant>XATTR_ROOT</constant></entry>
           <entry>Set attribute in root (trusted) namespace. Requires root privileges.</entry>
          </row>
         </tbody>
        </tgroup>
       </table>
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;
  </para>
 </refsect1>
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Sets extended attributes on <filename>.wav</filename> file</title>
    <programlisting role="php">
<![CDATA[
<?php
$file = 'my_favourite_song.wav';
xattr_set($file, 'Artist', 'Someone');
xattr_set($file, 'My ranking', 'Good');
xattr_set($file, 'Listen count', '34');

/* ... other code ... */

printf("You've played this song %d times", xattr_get($file, 'Listen count')); 
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>xattr_get</function></member>
    <member><function>xattr_remove</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
-->