mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-27 14:28:56 +00:00
656d1610af
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@330543 c90b9560-bf6c-de11-be94-00142212c4b1
124 lines
3.2 KiB
XML
124 lines
3.2 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xmlns:xlink="http://www.w3.org/1999/xlink" xmlns="http://docbook.org/ns/docbook" xml:id="phardata.setmetadata">
|
|
<refnamediv>
|
|
<refname>Phar::setMetadata</refname>
|
|
<refpurpose>Sets phar archive meta-data</refpurpose>
|
|
</refnamediv>
|
|
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<modifier>public</modifier> <type>void</type><methodname>Phar::setMetadata</methodname>
|
|
<methodparam><type>mixed</type><parameter>metadata</parameter></methodparam>
|
|
</methodsynopsis>
|
|
&phar.write;
|
|
|
|
<para>
|
|
<function>Phar::setMetadata</function> should be used to store customized data
|
|
that describes something about the phar archive as a complete entity.
|
|
<function>PharFileInfo::setMetadata</function> should be used for file-specific meta-data.
|
|
Meta-data can slow down the performance of loading a phar archive if the data is large.
|
|
</para>
|
|
<para>
|
|
Some possible uses for meta-data include specifying which file within the archive
|
|
should be used to bootstrap the archive, or the location of a file manifest
|
|
like <link xlink:href="&url.pear;">PEAR</link>'s package.xml file.
|
|
However, any useful data that describes the phar archive 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 that describes the phar archive
|
|
</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>Phar::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.php'] = '<?php echo "hello"';
|
|
$p->setMetadata(array('bootstrap' => 'file.php'));
|
|
var_dump($p->getMetadata());
|
|
} catch (Exception $e) {
|
|
echo 'Could not create and/or modify phar:', $e;
|
|
}
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs;
|
|
<screen>
|
|
<![CDATA[
|
|
array(1) {
|
|
["bootstrap"]=>
|
|
string(8) "file.php"
|
|
}
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>Phar::getMetadata</function></member>
|
|
<member><function>Phar::delMetadata</function></member>
|
|
<member><function>Phar::hasMetadata</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
|
|
-->
|