Files
doc-fr/reference/phar/PharFileInfo/decompress.xml
2021-06-12 07:27:28 +01:00

123 lines
3.7 KiB
XML

<?xml version='1.0' encoding='utf-8'?>
<!-- $Revision$ -->
<!-- EN-Revision: f5a5f5ae75cf140bd3dd65da52b70f6236b0e131 Maintainer: gui Status: ready -->
<!-- Reviewed: yes -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="pharfileinfo.decompress">
<refnamediv>
<refname>PharFileInfo::decompress</refname>
<refpurpose>Décompresse l'entrée Phar courante au sein du phar</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>PharFileInfo::decompress</methodname>
<void/>
</methodsynopsis>
<para>
Cette méthode décompresse le fichier au sein de l'archive Phar. Selon la façon dont le fichier est
compressé, les extensions <link linkend="ref.bzip2">bzip2</link>
ou <link linkend="ref.zlib">zlib</link> doivent être activées pour tirer parti de cette fonctionnalité.
Comme avec toutes les fonctionnalités qui modifient le contenu d'un phar, la variable INI
<link linkend="ini.phar.readonly">phar.readonly</link> doit être à off pour réussir si le fichier
est dans une archive <classname>Phar</classname>. Les fichiers au sein d'archives
<classname>PharData</classname> n'ont pas cette restriction.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
Soulève une exception <classname>BadMethodCallException</classname> si
la variable INI <link linkend="ini.phar.readonly">phar.readonly</link> est à on, ou
si l'extension <link linkend="ref.bzip2">bzip2</link>/<link linkend="ref.zlib">zlib</link>
n'est pas disponible.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Exemple avec <function>PharFileInfo::decompress</function></title>
<programlisting role="php">
<![CDATA[
<?php
try {
$p = new Phar('/chemin/vers/mon.phar', 0, 'mon.phar');
$p['monfichier.txt'] = 'salut';
$file = $p['monfichier.txt'];
$file->compress(Phar::GZ);
var_dump($file->isCompressed());
$p['monfichier.txt']->decompress();
var_dump($file->isCompressed());
} catch (Exception $e) {
echo 'Ne peut pas créer/modifier mon.phar: ', $e;
}
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
int(4096)
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>Phar::canCompress</function></member>
<member><function>Phar::isCompressed</function></member>
<member><function>Phar::compressFiles</function></member>
<member><function>Phar::decompressFiles</function></member>
<member><function>Phar::compress</function></member>
<member><function>Phar::decompress</function></member>
<member><function>Phar::getSupportedCompression</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
-->