<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/class.phar.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'es',
  ),
  'this' => 
  array (
    0 => 'phar.decompress.php',
    1 => 'Phar::decompress',
    2 => 'Descomprime el archivo tar completo',
  ),
  'up' => 
  array (
    0 => 'class.phar.php',
    1 => 'Phar',
  ),
  'prev' => 
  array (
    0 => 'phar.createdefaultstub.php',
    1 => 'Phar::createDefaultStub',
  ),
  'next' => 
  array (
    0 => 'phar.decompressfiles.php',
    1 => 'Phar::decompressFiles',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'es',
    'path' => 'reference/phar/Phar/decompress.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="phar.decompress" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">Phar::decompress</h1>
  <p class="verinfo">(PHP 5 &gt;= 5.3.0, PHP 7, PHP 8, PECL phar &gt;= 2.0.0)</p><p class="refpurpose"><span class="refname">Phar::decompress</span> &mdash; <span class="dc-title">Descomprime el archivo tar completo</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-phar.decompress-description">
  <h3 class="title">Descripción</h3>
  <div class="methodsynopsis dc-description">
   <span class="modifier">public</span> <span class="methodname"><strong>Phar::decompress</strong></span>(<span class="methodparam"><span class="type"><span class="type"><a href="language.types.null.php" class="type null">?</a></span><span class="type"><a href="language.types.string.php" class="type string">string</a></span></span> <code class="parameter">$extension</code><span class="initializer"> = <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong></span></span>): <span class="type"><span class="type"><a href="language.types.null.php" class="type null">?</a></span><span class="type"><a href="class.phar.php" class="type Phar">Phar</a></span></span></div>

 <blockquote class="note"><p><strong class="note">Nota</strong>: <p class="para">Este
    método requiere que la variable de configuración INI <code class="literal">phar.readonly</code>
    esté definida a <code class="literal">0</code> para funcionar con los objetos <span class="classname"><a href="class.phar.php" class="classname">Phar</a></span>.
    De lo contrario, se lanzará una excepción <span class="classname"><a href="class.pharexception.php" class="classname">PharException</a></span>.</p></p></blockquote>

  <p class="para">
   Para los archivos phar basados en tar y en phar, este método descomprime el archivo completo.
  </p>
  <p class="para">
   Para los archivos phar basados en Zip, este método falla y lanza una excepción.
   La extensión <a href="ref.zlib.php" class="link">zlib</a> debe estar activa para descomprimir
   un archivo comprimido con gzip, y la extensión <a href="ref.bzip2.php" class="link">bzip2</a>
   debe estar activa para descomprimir un archivo comprimido con bzip2.
   Al igual que con todas las funcionalidades que modifican el contenido de un phar, la variable INI
   <a href="phar.configuration.php#ini.phar.readonly" class="link">phar.readonly</a> debe estar a off
   para que funcione.
  </p>
  <p class="para">
   Además, este método cambia automáticamente la extensión del archivo,
   <code class="literal">.phar</code>
   Por omisión para los archivos phar, o <code class="literal">.phar.tar</code> para los archivos phar basados en tar.
   De lo contrario, se puede especificar una extensión de archivo utilizando el segundo
   argumento.
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-phar.decompress-parameters">
  <h3 class="title">Parámetros</h3>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">extension</code></dt>
     <dd>
      <p class="para">
       Para descomprimir, las extensiones de archivo por omisión
       son <code class="literal">.phar</code> y <code class="literal">.phar.tar</code>.
       Utilice este argumento para especificar otra extensión de archivo.
       Cabe señalar que todos los archivos phar ejecutables deben contener <code class="literal">.phar</code>
       en su nombre de archivo.
      </p>
     </dd>
    
   </dl>
  </p>

 </div>


 <div class="refsect1 returnvalues" id="refsect1-phar.decompress-returnvalues">
  <h3 class="title">Valores devueltos</h3>
  <p class="para">
   Se devuelve un objeto <span class="classname"><a href="class.phar.php" class="classname">Phar</a></span> en caso de éxito,
   o <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong> en caso de fallo.
  </p>
 </div>


 <div class="refsect1 errors" id="refsect1-phar.decompress-errors">
  <h3 class="title">Errores/Excepciones</h3>
  <p class="para">
   Se lanza una excepción <span class="classname"><a href="class.badmethodcallexception.php" class="classname">BadMethodCallException</a></span> si
   la variable INI <a href="phar.configuration.php#ini.phar.readonly" class="link">phar.readonly</a>
   está a on, si la extensión <a href="ref.zlib.php" class="link">zlib</a>
   no está disponible, o si la extensión <a href="ref.bzip2.php" class="link">bzip2</a>
   no está activada.
  </p>
 </div>


 <div class="refsect1 changelog" id="refsect1-phar.decompress-changelog">
  <h3 class="title">Historial de cambios</h3>
  <table class="doctable informaltable">
   
    <thead>
     <tr>
      <th>Versión</th>
      <th>Descripción</th>
     </tr>

    </thead>

    <tbody class="tbody">
     <tr>
      <td>8.0.0</td>
      <td>
       <code class="parameter">extension</code> ahora es nullable.
      </td>
     </tr>

    </tbody>
   
  </table>

 </div>


 <div class="refsect1 examples" id="refsect1-phar.decompress-examples">
  <h3 class="title">Ejemplos</h3>
  <p class="para">
   <div class="example" id="example-1">
    <p><strong>Ejemplo #1 Un ejemplo con <span class="function"><strong>Phar::decompress()</strong></span></strong></p>
    <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br />$p </span><span style="color: #007700">= new </span><span style="color: #0000BB">Phar</span><span style="color: #007700">(</span><span style="color: #DD0000">'/ruta/al/mon.phar'</span><span style="color: #007700">, </span><span style="color: #0000BB">0</span><span style="color: #007700">, </span><span style="color: #DD0000">'mon.phar.gz'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$p</span><span style="color: #007700">[</span><span style="color: #DD0000">'monfichero.txt'</span><span style="color: #007700">] = </span><span style="color: #DD0000">'hola'</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$p</span><span style="color: #007700">[</span><span style="color: #DD0000">'monfichero.txt'</span><span style="color: #007700">] = </span><span style="color: #DD0000">'hola'</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$p3 </span><span style="color: #007700">= </span><span style="color: #0000BB">$p2</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">decompress</span><span style="color: #007700">(); </span><span style="color: #FF8000">// crea /ruta/al/mon.phar<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
    </div>

   </div>
  </p>
 </div>


 <div class="refsect1 seealso" id="refsect1-phar.decompress-seealso">
  <h3 class="title">Ver también</h3>
  <p class="para">
   <ul class="simplelist">
    <li><span class="function"><a href="pharfileinfo.getcompressedsize.php" class="function" rel="rdfs-seeAlso">PharFileInfo::getCompressedSize()</a> - Devuelve el tama&ntilde;o actual (con compresi&oacute;n) del fichero dentro del archivo Phar</span></li>
    <li><span class="function"><a href="pharfileinfo.iscompressed.php" class="function" rel="rdfs-seeAlso">PharFileInfo::isCompressed()</a> - Indica si la entrada est&aacute; comprimida</span></li>
    <li><span class="function"><a href="pharfileinfo.compress.php" class="function" rel="rdfs-seeAlso">PharFileInfo::compress()</a> - Comprime la entrada Phar actual con una de las compresiones zlib o bzip2</span></li>
    <li><span class="function"><a href="pharfileinfo.decompress.php" class="function" rel="rdfs-seeAlso">PharFileInfo::decompress()</a> - Descomprime la entrada Phar actual dentro del phar</span></li>
    <li><span class="function"><a href="phardata.compress.php" class="function" rel="rdfs-seeAlso">PharData::compress()</a> - Comprime el archivo tar/zip completo utilizando la compresi&oacute;n Gzip o Bzip2</span></li>
    <li><span class="function"><a href="phar.cancompress.php" class="function" rel="rdfs-seeAlso">Phar::canCompress()</a> - Determina si la extensi&oacute;n phar soporta la compresi&oacute;n utilizando zip o bzip2</span></li>
    <li><span class="function"><a href="phar.iscompressed.php" class="function" rel="rdfs-seeAlso">Phar::isCompressed()</a> - Devuelve Phar::GZ o PHAR::BZ2 si el archivo completo est&aacute; comprimido (.tar.gz/tar.bz, etc)</span></li>
    <li><span class="function"><a href="phar.compress.php" class="function" rel="rdfs-seeAlso">Phar::compress()</a> - Comprime el archivo Phar completo utilizando la compresi&oacute;n Gzip o Bzip2</span></li>
    <li><span class="function"><a href="phar.getsupportedcompression.php" class="function" rel="rdfs-seeAlso">Phar::getSupportedCompression()</a> - Devuelve un array de los algoritmos de compresi&oacute;n soportados</span></li>
    <li><span class="function"><a href="phar.compressfiles.php" class="function" rel="rdfs-seeAlso">Phar::compressFiles()</a> - Comprime todos los ficheros del archivo Phar actual</span></li>
    <li><span class="function"><a href="phar.decompressfiles.php" class="function" rel="rdfs-seeAlso">Phar::decompressFiles()</a> - Descomprime todos los ficheros del archivo Phar actual</span></li>
   </ul>
  </p>
 </div>


</div><?php manual_footer($setup); ?>