reference/phar/PharData/decompress.xml
f03806fcd8fe03a0501bd40b6e3939ff6589a1d2
f03806fcd8fe03a0501bd40b6e3939ff6589a1d2
...
...
@@ -1,6 +1,6 @@
1
1
<?xml version="1.0" encoding="utf-8"?>
2
2
<!-- $Revision$ -->
3
-
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="phardata.decompress">
3
+
<refentry xml:id="phardata.decompress" xmlns="http://docbook.org/ns/docbook">
4
4
<refnamediv>
5
5
<refname>PharData::decompress</refname>
6
6
<refpurpose>Decompresses the entire Phar archive</refpurpose>
...
...
@@ -8,9 +8,9 @@
8
8
9
9
<refsect1 role="description">
10
10
&reftitle.description;
11
-
<methodsynopsis>
12
-
<type>object</type><methodname>PharData::decompress</methodname>
13
-
<methodparam choice="opt"><type>string</type><parameter>extension</parameter></methodparam>
11
+
<methodsynopsis role="PharData">
12
+
<modifier>public</modifier> <type class="union"><type>PharData</type><type>null</type></type><methodname>PharData::decompress</methodname>
13
+
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>extension</parameter><initializer>&null;</initializer></methodparam>
14
14
</methodsynopsis>
15
15
16
16
<para>
...
...
@@ -26,7 +26,7 @@
26
26
<para>
27
27
In addition, this method automatically renames the file extension of the archive,
28
28
<literal>.tar</literal> by default.
29
-
Alternatively, a file extension may be specified with the second
29
+
Alternatively, a file extension may be specified with the <parameter>extension</parameter>
30
30
parameter.
31
31
</para>
32
32
</refsect1>
...
...
@@ -40,22 +40,21 @@
40
40
<listitem>
41
41
<para>
42
42
For decompressing, the default file extension
43
-
is <literal>.phar.tar</literal>.
44
-
Use this parameter to specify another file extension. Be aware
45
-
that no non-executable archives cannot contain <literal>.phar</literal>
46
-
in their filename.
43
+
is <literal>.tar</literal>.
44
+
Use this parameter to specify another file extension. Be aware that only
45
+
executable archives can contain <literal>.phar</literal> in their filename.
47
46
</para>
48
47
</listitem>
49
48
</varlistentry>
50
49
</variablelist>
51
50
</para>
52
-
53
51
</refsect1>
54
52
55
53
<refsect1 role="returnvalues">
56
54
&reftitle.returnvalues;
57
55
<para>
58
-
A <classname>PharData</classname> object is returned.
56
+
A <classname>PharData</classname> object is returned on success,
57
+
or &null; on failure.
59
58
</para>
60
59
</refsect1>
61
60
...
...
@@ -69,6 +68,28 @@
69
68
</para>
70
69
</refsect1>
71
70
71
+
<refsect1 role="changelog">
72
+
&reftitle.changelog;
73
+
<informaltable>
74
+
<tgroup cols="2">
75
+
<thead>
76
+
<row>
77
+
<entry>&Version;</entry>
78
+
<entry>&Description;</entry>
79
+
</row>
80
+
</thead>
81
+
<tbody>
82
+
<row>
83
+
<entry>8.0.0</entry>
84
+
<entry>
85
+
<parameter>extension</parameter> is now nullable.
86
+
</entry>
87
+
</row>
88
+
</tbody>
89
+
</tgroup>
90
+
</informaltable>
91
+
</refsect1>
92
+
72
93
<refsect1 role="examples">
73
94
&reftitle.examples;
74
95
<para>
...
...
@@ -106,7 +127,6 @@ $p->decompress(); // creates /path/to/my.tar
106
127
</refsect1>
107
128
108
129
</refentry>
109
-
110
130
<!-- Keep this comment at the end of the file
111
131
Local variables:
112
132
mode: sgml
113
133