doc-fr/reference/phar/PharData/decompress.xml

<?xml version='1.0' encoding='utf-8'?>
<!-- $Revision$ -->
<!-- EN-Revision: 5b4252de4f922948110fdef85c50fd94b093bc03 Maintainer: gui Status: ready -->
<!-- Reviewed: yes -->
<refentry xml:id="phardata.decompress" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>PharData::decompress</refname>
  <refpurpose>Décompresse l'archive Phar entière</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <modifier>public</modifier> <type class="union"><type>PharData</type><type>null</type></type><methodname>PharData::decompress</methodname>
   <methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>extension</parameter><initializer>&null;</initializer></methodparam>
  </methodsynopsis>
  <para>
   Décompresse l'archive entière, si c'est une archive tar.
  </para>
  <para>
   Pour les archives Zip, cette méthode échoue et lève une exception.
   L'extension <link linkend="ref.zlib">zlib</link> doit être activée
   pour décompresser une archive compressée avec gzip et l'extension 
   <link linkend="ref.bzip2">bzip2</link> doit être disponible pour 
   décompresser une archive compressée avec bzip2.
  </para>
  <para>
   De plus, cette méthode renomme automatiquement l'extension de 
   fichier de l'archive, <literal>.tar</literal> par défaut.
   Sinon, une extension de fichier peut être spécifiée avec le paramètre
   <parameter>extension</parameter>.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>extension</parameter></term>
     <listitem>
      <para>
       Pour décompresser, l'extension par défaut est 
       <literal>.tar</literal>. Utilisez ce paramètre 
       pour spécifier une autre extension de fichier. Gardez
       à l'esprit que seul les archives exécutables peuvent
       contenir <literal>.phar</literal> dans leur nom de fichier.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Un objet <classname>PharData</classname> est retourné en cas de succès,
   ou &null; en cas d'échec.
  </para>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   Soulève une exception <classname>BadMethodCallException</classname> si
   l'extension <link linkend="ref.zlib">zlib</link> n'est pas disponible ou si 
   l'extension <link linkend="ref.bzip2">bzip2</link> n'est pas activée.
  </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>extension</parameter> est désormais nullable.
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Exemple avec <function>PharData::decompress</function></title>
    <programlisting role="php">
<![CDATA[
<?php
$p = new PharData('/path/to/my.tar.gz');
$p->decompress(); // crée /path/to/my.tar
?>
]]>
    </programlisting>
   </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>PharData::compress</function></member>
    <member><function>Phar::canCompress</function></member>
    <member><function>Phar::isCompressed</function></member>
    <member><function>PharData::compress</function></member>
    <member><function>Phar::getSupportedCompression</function></member>
    <member><function>PharData::compressFiles</function></member>
    <member><function>PharData::decompressFiles</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
-->