decompressFiles.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: c8ba91f7e546462dc66c2a11a7eab6f55c93915b Maintainer: PhilDaiguille Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="phar.decompressfiles" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>Phar::decompressFiles</refname>
  <refpurpose>Descomprime todos los ficheros del archivo Phar actual</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis role="Phar">
   <modifier>public</modifier> <type>true</type><methodname>Phar::decompressFiles</methodname>
   <void/>
  </methodsynopsis>
  &phar.write;

  <para>
   Para los archivos phar basados en tar, este método lanza una excepción
   <classname>BadMethodCallException</classname>, ya que la compresión individual de los ficheros
   dentro de un archivo tar no es soportada por el formato de archivo. Utilice
   <function>Phar::compress</function> para comprimir en un archivo phar basado en tar en su totalidad.
  </para>
  <para>
   Para los archivos phar basados en Zip o en phar, este método descomprime todos los ficheros
   del archivo Phar.
   Las extensiones <link linkend="ref.zlib">zlib</link> o <link linkend="ref.bzip2">bzip2</link>
   deben estar activadas para aprovechar esta funcionalidad si alguno de los ficheros
   está comprimido utilizando la compresión bzip2/zlib.
   Al igual que con todas las funcionalidades que modifican el contenido de un phar, la variable INI
   <link linkend="ini.phar.readonly">phar.readonly</link> debe estar a off
   para que funcione.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  &no.function.parameters;
 </refsect1>

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

 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   Lanza una excepción <classname>BadMethodCallException</classname> si
   la variable INI <link linkend="ini.phar.readonly">phar.readonly</link>
   está a on, si la extensión <link linkend="ref.zlib">zlib</link> no está
   disponible o si alguno de los ficheros está comprimido utilizando la compresión
   bzip2 y la extensión <link linkend="ref.bzip2">bzip2</link> no está activada.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Un ejemplo con <function>Phar::decompressFiles</function></title>
    <programlisting role="php">
<![CDATA[
<?php
$p = new Phar('/ruta/hacia/mon.phar', 0, 'mon.phar');
$p['monfichier.txt'] = 'hola';
$p['monfichier2.txt'] = 'hola';
$p->compressFiles(Phar::GZ);
foreach ($p as $file) {
    var_dump($file->getFileName());
    var_dump($file->isCompressed());
    var_dump($file->isCompressed(Phar::BZ2));
    var_dump($file->isCompressed(Phar::GZ));
}
$p->decompressFiles();
foreach ($p as $file) {
    var_dump($file->getFileName());
    var_dump($file->isCompressed());
    var_dump($file->isCompressed(Phar::BZ2));
    var_dump($file->isCompressed(Phar::GZ));
}
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
string(10) "monfichier.txt"
int(4096)
bool(false)
bool(true)
string(11) "monfichier2.txt"
int(4096)
bool(false)
bool(true)
string(10) "monfichier.txt"
bool(false)
bool(false)
bool(false)
string(11) "monfichier2.txt"
bool(false)
bool(false)
bool(false)
]]>
    </screen>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>PharFileInfo::getCompressedSize</function></member>
    <member><function>PharFileInfo::isCompressed</function></member>
    <member><function>PharFileInfo::compress</function></member>
    <member><function>PharFileInfo::decompress</function></member>
    <member><function>Phar::canCompress</function></member>
    <member><function>Phar::isCompressed</function></member>
    <member><function>Phar::compressFiles</function></member>
    <member><function>Phar::getSupportedCompression</function></member>
    <member><function>Phar::compress</function></member>
    <member><function>Phar::decompress</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
-->