<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="pharfileinfo.setmetadata" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>PharFileInfo::setMetadata</refname>
  <refpurpose>Sets file-specific meta-data saved with a file</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis role="PharFileInfo">
   <modifier>public</modifier> <type>void</type><methodname>PharFileInfo::setMetadata</methodname>
   <methodparam><type>mixed</type><parameter>metadata</parameter></methodparam>
  </methodsynopsis>

  <para>
   <function>PharFileInfo::setMetadata</function> should only be used to store customized data in a file
   that cannot be represented with existing information stored with a file.
   Meta-data can significantly slow down the performance of loading a phar
   archive if the data is large, or if there are many files containing meta-data.
   It is important to note that file permissions are natively supported inside a
   phar; it is possible to set them with the
   <function>PharFileInfo::chmod</function> method.  As with all functionality that modifies the contents of
   a phar, the <link linkend="ini.phar.readonly">phar.readonly</link> INI variable
   must be off in order to succeed if the file is within a <classname>Phar</classname>
   archive.  Files within <classname>PharData</classname> archives do not have
   this restriction.
  </para>
  <para>
   Some possible uses for meta-data include passing a user/group that should be set
   when a file is extracted from the phar to disk.  Other uses could include
   explicitly specifying a MIME type to return.  However, any useful data that
   describes a file, but should not be contained inside of it may be stored.
  </para>

 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>metadata</parameter></term>
     <listitem>
      <para>
       Any PHP variable containing information to store alongside a file
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.void;
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>A <function>PharFileInfo::setMetadata</function> example</title>
    <para>
    </para>
    <programlisting role="php">
<![CDATA[
<?php
// make sure it doesn't exist
@unlink('brandnewphar.phar');
try {
    $p = new Phar(dirname(__FILE__) . '/brandnewphar.phar', 0, 'brandnewphar.phar');
    $p['file.txt'] = 'hello';
    $p['file.txt']->setMetadata(array('user' => 'bill', 'mime-type' => 'text/plain'));
    var_dump($p['file.txt']->getMetaData());
} catch (Exception $e) {
    echo 'Could not create/modify phar: ', $e;
}
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
array(2) {
  ["user"]=>
  string(4) "bill"
  ["mime-type"]=>
  string(10) "text/plain"
}
]]>
    </screen>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>PharFileInfo::hasMetadata</function></member>
    <member><function>PharFileInfo::getMetadata</function></member>
    <member><function>PharFileInfo::delMetadata</function></member>
    <member><function>Phar::setMetadata</function></member>
    <member><function>Phar::hasMetadata</function></member>
    <member><function>Phar::getMetadata</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
-->
