1
0
mirror of https://github.com/php/doc-es.git synced 2026-03-24 07:22:16 +01:00
Files
archived-doc-es/reference/phar/Phar/setMetadata.xml
2025-07-03 21:51:59 +02:00

126 lines
3.4 KiB
XML

<?xml version='1.0' encoding='utf-8'?>
<!-- EN-Revision: f03806fcd8fe03a0501bd40b6e3939ff6589a1d2 Maintainer: PhilDaiguille Status: ready -->
<!-- Reviewed: yes -->
<refentry xmlns:xlink="http://www.w3.org/1999/xlink" xmlns="http://docbook.org/ns/docbook" xml:id="phar.setmetadata">
<refnamediv>
<refname>Phar::setMetadata</refname>
<refpurpose>Establece las metadatos del archivo phar</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis role="Phar">
<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> debe ser utilizada para almacenar datos personalizados
que describen el archivo phar, como una entidad separada.
<function>PharFileInfo::setMetadata</function> debe ser utilizada para las metadatos específicas de los ficheros.
Las metadatos pueden disminuir el rendimiento de carga de un archivo phar si los datos son grandes.
</para>
<para>
Un uso posible de las metadatos es la especificación
de los ficheros a utilizar dentro del archivo para ejecutarlo,
o la ubicación de un fichero de manifiesto como el fichero package.xml
de <link xlink:href="&url.pear;">PEAR</link>.
En general, cualquier dato útil que describa el archivo phar puede ser almacenado.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>metadata</parameter></term>
<listitem>
<para>
Cualquier variable PHP que contenga información a almacenar y que
describa el archivo phar
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Un ejemplo con <function>Phar::setMetadata</function></title>
<para>
</para>
<programlisting role="php">
<![CDATA[
<?php
// se asegura de que el phar no exista ya
@unlink('nuevo.phar');
try {
$p = new Phar(dirname(__FILE__) . '/nuevo.phar', 0, 'nuevo.phar');
$p['fichero.php'] = '<?php echo "hola"';
$p->setMetadata(array('cargador' => 'fichero.php'));
var_dump($p->getMetadata());
} catch (Exception $e) {
echo 'No puede crear/modificar el phar :', $e;
}
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
array(1) {
["cargador"]=>
string(11) "fichero.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
-->