mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-16 08:58:56 +00:00
121 lines
3.5 KiB
XML
121 lines
3.5 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="pharfileinfo.decompress">
|
|
<refnamediv>
|
|
<refname>PharFileInfo::decompress</refname>
|
|
<refpurpose>Decompresses the current Phar entry within the phar</refpurpose>
|
|
</refnamediv>
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<modifier>public</modifier> <type>bool</type><methodname>PharFileInfo::decompress</methodname>
|
|
<void/>
|
|
</methodsynopsis>
|
|
|
|
<para>
|
|
This method decompresses the file inside the Phar archive.
|
|
Depending on how the file is compressed, the <link linkend="ref.bzip2">bzip2</link>
|
|
or <link linkend="ref.zlib">zlib</link> extensions must be enabled to take
|
|
advantage of this feature. As with all functionality that modifies the contents of
|
|
a phar, the <link linkend="ini.phar.readonly">phar.readonly</link> INI variable
|
|
must be off in order to succeed if the file is within a <classname>Phar</classname>
|
|
archive. Files within <classname>PharData</classname> archives do not have
|
|
this 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>
|
|
Throws <classname>BadMethodCallException</classname> if
|
|
the <link linkend="ini.phar.readonly">phar.readonly</link>
|
|
INI variable is on, or if the <link linkend="ref.bzip2">bzip2</link>/<link linkend="ref.zlib">zlib</link>
|
|
extension is not available.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title>A <function>PharFileInfo::decompress</function> example</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
try {
|
|
$p = new Phar('/path/to/my.phar', 0, 'my.phar');
|
|
$p['myfile.txt'] = 'hi';
|
|
$file = $p['myfile.txt'];
|
|
$file->compress(Phar::GZ);
|
|
var_dump($file->isCompressed());
|
|
$p['myfile.txt']->decompress();
|
|
var_dump($file->isCompressed());
|
|
} catch (Exception $e) {
|
|
echo 'Create/modify failed for my.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
|
|
-->
|