reference/phar/Phar/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="phar.decompress">
3
+
<refentry xml:id="phar.decompress" xmlns="http://docbook.org/ns/docbook">
4
4
<refnamediv>
5
5
<refname>Phar::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
-
<modifier>public</modifier> <type>object</type><methodname>Phar::decompress</methodname>
13
-
<methodparam choice="opt"><type>string</type><parameter>extension</parameter></methodparam>
11
+
<methodsynopsis role="Phar">
12
+
<modifier>public</modifier> <type class="union"><type>Phar</type><type>null</type></type><methodname>Phar::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
&phar.write;
16
16
...
...
@@ -60,7 +60,7 @@
60
60
<refsect1 role="returnvalues">
61
61
&reftitle.returnvalues;
62
62
<para>
63
-
A <classname>Phar</classname> object is returned.
63
+
A <classname>Phar</classname> object is returned on success, and &null; on failure.
64
64
</para>
65
65
</refsect1>
66
66
...
...
@@ -75,6 +75,28 @@
75
75
</para>
76
76
</refsect1>
77
77
78
+
<refsect1 role="changelog">
79
+
&reftitle.changelog;
80
+
<informaltable>
81
+
<tgroup cols="2">
82
+
<thead>
83
+
<row>
84
+
<entry>&Version;</entry>
85
+
<entry>&Description;</entry>
86
+
</row>
87
+
</thead>
88
+
<tbody>
89
+
<row>
90
+
<entry>8.0.0</entry>
91
+
<entry>
92
+
<parameter>extension</parameter> is now nullable.
93
+
</entry>
94
+
</row>
95
+
</tbody>
96
+
</tgroup>
97
+
</informaltable>
98
+
</refsect1>
99
+
78
100
<refsect1 role="examples">
79
101
&reftitle.examples;
80
102
<para>
...
...
@@ -114,7 +136,6 @@ $p3 = $p2->decompress(); // creates /path/to/my.phar
114
136
</refsect1>
115
137
116
138
</refentry>
117
-
118
139
<!-- Keep this comment at the end of the file
119
140
Local variables:
120
141
mode: sgml
121
142