1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="phar.decompress">
<refnamediv>
<refname>Phar::decompress</refname>
<refpurpose>Decompresses the entire Phar archive</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>object</type><methodname>Phar::decompress</methodname>
<methodparam choice="opt"><type>string</type><parameter>extension</parameter></methodparam>
</methodsynopsis>
&phar.write;
<para>
For tar-based and phar-based phar archives, this method decompresses the entire archive.
</para>
<para>
For Zip-based phar archives, this method fails with an exception.
The <link linkend="ref.zlib">zlib</link> extension must be enabled to decompress
an archive compressed with with gzip compression, and the
<link linkend="ref.bzip2">bzip2</link> extension must be
enabled in order to decompress an archive compressed with bzip2 compression.
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.
</para>
<para>
In addition, this method automatically changes the file extension of the archive,
<literal>.phar</literal>
by default for phar archives, or <literal>.phar.tar</literal> for tar-based phar archives.
Alternatively, a file extension may be specified with the second
parameter.
</para>
<para>
A <classname>Phar</classname> object is returned.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>extension</parameter></term>
<listitem>
<para>
For decompressing, the default file extensions
are <literal>.phar</literal> and <literal>.phar.tar</literal>.
Use this parameter to specify another file extension. Be aware
that all executable phar archives must contain <literal>.phar</literal>
in their filename.
</para>
</listitem>
</varlistentry>
</variablelist>
</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, the <link linkend="ref.zlib">zlib</link>
extension is not available, or the <link linkend="ref.bzip2">bzip2</link> extension
is not enabled.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>A <function>Phar::decompress</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$p = new Phar('/path/to/my.phar', 0, 'my.phar.gz');
$p['myfile.txt'] = 'hi';
$p['myfile2.txt'] = 'hi';
$p3 = $p2->decompress(); // creates /path/to/my.phar
?>
]]>
</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>Phar::compress</function></member>
<member><function>Phar::getSupportedCompression</function></member>
<member><function>Phar::compressFiles</function></member>
<member><function>Phar::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:"../../../../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
-->
|
