mirror of
https://github.com/php/doc-en.git
synced 2026-03-24 07:42:10 +01:00
133 lines
3.2 KiB
XML
133 lines
3.2 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="phar.getmetadata" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>Phar::getMetadata</refname>
|
|
<refpurpose>Returns phar archive meta-data</refpurpose>
|
|
</refnamediv>
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis role="Phar">
|
|
<modifier>public</modifier> <type>mixed</type><methodname>Phar::getMetadata</methodname>
|
|
<methodparam choice="opt"><type>array</type><parameter>unserializeOptions</parameter><initializer>[]</initializer></methodparam>
|
|
</methodsynopsis>
|
|
|
|
<para>
|
|
Retrieve archive meta-data. Meta-data can be any PHP variable that can be serialized.
|
|
</para>
|
|
|
|
<caution>
|
|
<simpara>
|
|
Accessing the meta-data will trigger deserialization, which can trigger
|
|
the execution of arbitrary PHP code. Do not use this on untrusted phar
|
|
archives, or configure the <parameter>unserializeOptions</parameter>
|
|
in a secure manner.
|
|
</simpara>
|
|
</caution>
|
|
|
|
</refsect1>
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
No parameters.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Any PHP value that can be serialized and is stored as meta-data for the Phar archive,
|
|
or &null; if no meta-data is stored.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="changelog">
|
|
&reftitle.changelog;
|
|
<informaltable>
|
|
<tgroup cols="2">
|
|
<thead>
|
|
<row>
|
|
<entry>&Version;</entry>
|
|
<entry>&Description;</entry>
|
|
</row>
|
|
</thead>
|
|
<tbody>
|
|
<row>
|
|
<entry>8.0.0</entry>
|
|
<entry>
|
|
The parameter <parameter>unserializeOptions</parameter> has been added.
|
|
</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</informaltable>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title>A <function>Phar::getMetadata</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 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::setMetadata</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
|
|
-->
|