<?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 => 'fr',
  ),
  'this' => 
  array (
    0 => 'phar.decompress.php',
    1 => 'Phar::decompress',
    2 => 'D&eacute;compresse l\'archive tar compl&egrave;te',
  ),
  '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' => 'fr',
    '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">Décompresse l&#039;archive tar complète</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-phar.decompress-description">
  <h3 class="title">Description</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">Note</strong>: <p class="para">Cette
    méthode nécessite que la variable de configuration INI <code class="literal">phar.readonly</code>
    soit définie à <code class="literal">0</code> pour fonctionner avec les objets <span class="classname"><a href="class.phar.php" class="classname">Phar</a></span>.
    Sinon, une exception <span class="classname"><a href="class.pharexception.php" class="classname">PharException</a></span> sera lançée.</p></p></blockquote>

  <p class="para">
   Pour les archives phar basées sur tar et sur phar, cette méthode décompresse l&#039;archive complète.
  </p>
  <p class="para">
   Pour les archives phar basées sur Zip, cette méthode échoue et lève une exception.
   L&#039;extension <a href="ref.zlib.php" class="link">zlib</a> doit être active pour décompresser 
   une archive compressée grâce à gzip, et l&#039;extension <a href="ref.bzip2.php" class="link">bzip2</a>
   doit être active pour décompresser une archive compressée grâce à bzip2.
   Comme avec toutes les fonctionnalités qui modifient le contenu d&#039;un phar, la variable INI
   <a href="phar.configuration.php#ini.phar.readonly" class="link">phar.readonly</a> doit être à off
   pour fonctionner.
  </p>
  <p class="para">
   De plus, cette méthode change automatiquement l&#039;extension de l&#039;archive,
   <code class="literal">.phar</code>
   Par défaut pour les archives phar, ou <code class="literal">.phar.tar</code> pour les archives phar basées sur tar.
   Sinon, une extension de fichier peut aussi être spécifiée en utilisant le second
   paramètre.
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-phar.decompress-parameters">
  <h3 class="title">Liste de paramètres</h3>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">extension</code></dt>
     <dd>
      <p class="para">
       Pour décompresser, les extensions de fichier par défaut
       sont <code class="literal">.phar</code> et <code class="literal">.phar.tar</code>.
       Utiliser ce paramètre pour spécifier une autre extension de fichier.
       À noter que toutes les archives phar exécutables doivent contenir <code class="literal">.phar</code>
       dans leur nom de fichier.
      </p>
     </dd>
    
   </dl>
  </p>

 </div>


 <div class="refsect1 returnvalues" id="refsect1-phar.decompress-returnvalues">
  <h3 class="title">Valeurs de retour</h3>
  <p class="para">
   Un objet <span class="classname"><a href="class.phar.php" class="classname">Phar</a></span> est retourné en cas de succès,
   ou <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong> en cas d&#039;échec.
  </p>
 </div>


 <div class="refsect1 errors" id="refsect1-phar.decompress-errors">
  <h3 class="title">Erreurs / Exceptions</h3>
  <p class="para">
   Lève une exception <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 à on, si l&#039;extension <a href="ref.zlib.php" class="link">zlib</a>
   n&#039;est pas disponible, ou si l&#039;extension <a href="ref.bzip2.php" class="link">bzip2</a>
   n&#039;est pas activée.
  </p>
 </div>


 <div class="refsect1 changelog" id="refsect1-phar.decompress-changelog">
  <h3 class="title">Historique</h3>
  <table class="doctable informaltable">
   
    <thead>
     <tr>
      <th>Version</th>
      <th>Description</th>
     </tr>

    </thead>

    <tbody class="tbody">
     <tr>
      <td>8.0.0</td>
      <td>
       <code class="parameter">extension</code> est désormais nullable.
      </td>
     </tr>

    </tbody>
   
  </table>

 </div>


 <div class="refsect1 examples" id="refsect1-phar.decompress-examples">
  <h3 class="title">Exemples</h3>
  <p class="para">
   <div class="example" id="example-1">
    <p><strong>Exemple #1 Un exemple avec <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">'/chemin/vers/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">'monfichier.txt'</span><span style="color: #007700">] = </span><span style="color: #DD0000">'salut'</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$p</span><span style="color: #007700">[</span><span style="color: #DD0000">'monfichier.txt'</span><span style="color: #007700">] = </span><span style="color: #DD0000">'salut'</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">// crée /chemin/vers/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">Voir aussi</h3>
  <p class="para">
   <ul class="simplelist">
    <li><span class="function"><a href="pharfileinfo.getcompressedsize.php" class="function" rel="rdfs-seeAlso">PharFileInfo::getCompressedSize()</a> - Retourne la taille actuelle (avec compression) du fichier au sein de l'archive Phar</span></li>
    <li><span class="function"><a href="pharfileinfo.iscompressed.php" class="function" rel="rdfs-seeAlso">PharFileInfo::isCompressed()</a> - Retourne si l'entr&eacute;e est compress&eacute;e</span></li>
    <li><span class="function"><a href="pharfileinfo.compress.php" class="function" rel="rdfs-seeAlso">PharFileInfo::compress()</a> - Compresse l'entr&eacute;e Phar courante avec une des compressions zlib ou bzip2</span></li>
    <li><span class="function"><a href="pharfileinfo.decompress.php" class="function" rel="rdfs-seeAlso">PharFileInfo::decompress()</a> - D&eacute;compresse l'entr&eacute;e Phar courante au sein du phar</span></li>
    <li><span class="function"><a href="phardata.compress.php" class="function" rel="rdfs-seeAlso">PharData::compress()</a> - Compresse l'archive tar/zip compl&egrave;te en utilisant la compression Gzip ou Bzip2</span></li>
    <li><span class="function"><a href="phar.cancompress.php" class="function" rel="rdfs-seeAlso">Phar::canCompress()</a> - D&eacute;termine si l'extension phar supporte la compression en utilisant soit zip soit bzip2</span></li>
    <li><span class="function"><a href="phar.iscompressed.php" class="function" rel="rdfs-seeAlso">Phar::isCompressed()</a> - Retourne Phar::GZ ou PHAR::BZ2 si l'archive enti&egrave;re est compress&eacute;e (.tar.gz/tar.bz, etc)</span></li>
    <li><span class="function"><a href="phar.compress.php" class="function" rel="rdfs-seeAlso">Phar::compress()</a> - Compresse l'archive Phar compl&egrave;te en utilisant la compression Gzip ou Bzip2</span></li>
    <li><span class="function"><a href="phar.getsupportedcompression.php" class="function" rel="rdfs-seeAlso">Phar::getSupportedCompression()</a> - Retourne un tableau des algorithmes de compression support&eacute;s</span></li>
    <li><span class="function"><a href="phar.compressfiles.php" class="function" rel="rdfs-seeAlso">Phar::compressFiles()</a> - Compresse tous les fichiers de l'archive Phar courante</span></li>
    <li><span class="function"><a href="phar.decompressfiles.php" class="function" rel="rdfs-seeAlso">Phar::decompressFiles()</a> - D&eacute;compresse tous les fichiers de l'archive Phar courante</span></li>
   </ul>
  </p>
 </div>


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