archived-doc-es/reference/phar/Phar/convertToData.xml

<?xml version='1.0' encoding='utf-8'?>
<!-- EN-Revision: f03806fcd8fe03a0501bd40b6e3939ff6589a1d2 Maintainer: PhilDaiguille Status: ready -->
<!-- Reviewed: yes -->
<refentry xml:id="phar.converttodata" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>Phar::convertToData</refname>
  <refpurpose>Convierte un archivo phar en un fichero no ejecutable</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis role="Phar">
   <modifier>public</modifier> <type class="union"><type>PharData</type><type>null</type></type><methodname>Phar::convertToData</methodname>
   <methodparam choice="opt"><type class="union"><type>int</type><type>null</type></type><parameter>format</parameter><initializer>&null;</initializer></methodparam>
   <methodparam choice="opt"><type class="union"><type>int</type><type>null</type></type><parameter>compression</parameter><initializer>&null;</initializer></methodparam>
   <methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>extension</parameter><initializer>&null;</initializer></methodparam>
  </methodsynopsis>

  <para>
   Convierte un archivo phar ejecutable en un fichero tar o zip.
   Para hacer que el tar o el zip no sea ejecutable, el contenedor phar
   y el alias phar son eliminados del archivo recién creado.
  </para>
  <para>
   Si no se especifica ningún cambio, este método lanza una excepción
   <classname>BadMethodCallException</classname> si el archivo está en
   el formato de archivo phar. Para los archivos basados en tar o zip,
   este método convierte el archivo en un archivo no ejecutable.
  </para>
  <para>
   En caso de éxito, el método crea un nuevo archivo en el disco
   y devuelve un objeto <classname>PharData</classname>. El archivo antiguo
   no se elimina del disco, lo cual debe hacerse manualmente al final del proceso.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>format</parameter></term>
     <listitem>
      <para>
       Debe ser uno de los formatos <literal>Phar::TAR</literal>
       o <literal>Phar::ZIP</literal>. Si este argumento es &null;,
       se conservará el formato de archivo actual.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>compression</parameter></term>
     <listitem>
      <para>
       Debe ser <literal>Phar::NONE</literal> para ninguna compresión global,
       <literal>Phar::GZ</literal> para una compresión basada en zlib y
       <literal>Phar::BZ2</literal> para una compresión basada en bzip2.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>extension</parameter></term>
     <listitem>
      <para>
       Este argumento se utiliza para sobrescribir la extensión por defecto de un
       archivo convertido. Cabe señalar que <literal>.phar</literal> no puede
       ser utilizado en el nombre de archivo de un archivo tar o zip
       no ejecutable.
      </para>
      <para>
       Si se convierte a un archivo basado en tar, las extensiones por defecto son
       <literal>.tar</literal>, <literal>.tar.gz</literal>,
       y <literal>.tar.bz2</literal> según la compresión especificada.
       Para los archivos phar basados en zip, la extensión por
       defecto es <literal>.zip</literal>.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>

 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   El método devuelve un objeto <classname>PharData</classname> en caso de éxito,
   o &null; en caso de fallo.
  </para>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   Este método lanza una excepción <classname>BadMethodCallException</classname>
   si no es capaz de comprimir, si se ha especificado un método de compresión
   desconocido o si el archivo solicitado ha sido almacenado en búfer
   con <function>Phar::startBuffering</function> sin ser concluido con
   <function>Phar::stopBuffering</function>, y lanza una excepción
   <classname>PharException</classname> si se ha encontrado algún problema durante
   la fase de creación del archivo.
  </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>
       <parameter>format</parameter>, <parameter>compression</parameter>,
       y <parameter>extension</parameter> ahora son nullable.
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Un ejemplo con <function>Phar::convertToData</function></title>
    <para>
     Utilización de Phar::convertToData():
    </para>
    <programlisting role="php">
<![CDATA[
<?php
try {
    $tarphar = new Phar('monphar.phar.tar');
    // note que monphar.phar.tar no es *eliminado*
    // se convierte al formato de archivo tar no ejecutable
    // crea monphar.tar
    $tar = $tarphar->convertToData();
    // se convierte al formato de archivo zip no ejecutable y crea monphar.zip
    $zip = $tarphar->convertToData(Phar::ZIP);
    // crea monphar.tbz
    $tgz = $tarphar->convertToData(Phar::TAR, Phar::BZ2, '.tbz');
    // crea monphar.phar.tgz
    $phar = $tarphar->convertToData(Phar::PHAR); // lanza una excepción
} catch (Exception $e) {
    // se manejan los errores aquí
}
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>Phar::convertToExecutable</function></member>
    <member><function>PharData::convertToExecutable</function></member>
    <member><function>PharData::convertToData</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
-->