reference/phar/Phar/compress.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.compress">
3
+
<refentry xml:id="phar.compress" xmlns="http://docbook.org/ns/docbook">
4
4
<refnamediv>
5
5
<refname>Phar::compress</refname>
6
6
<refpurpose>Compresses the entire Phar archive using Gzip or Bzip2 compression</refpurpose>
...
...
@@ -8,10 +8,10 @@
8
8
9
9
<refsect1 role="description">
10
10
&reftitle.description;
11
-
<methodsynopsis>
12
-
<modifier>public</modifier> <type>object</type><methodname>Phar::compress</methodname>
11
+
<methodsynopsis role="Phar">
12
+
<modifier>public</modifier> <type class="union"><type>Phar</type><type>null</type></type><methodname>Phar::compress</methodname>
13
13
<methodparam><type>int</type><parameter>compression</parameter></methodparam>
14
-
<methodparam choice="opt"><type>string</type><parameter>extension</parameter></methodparam>
14
+
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>extension</parameter><initializer>&null;</initializer></methodparam>
15
15
</methodsynopsis>
16
16
&phar.write;
17
17
...
...
@@ -71,7 +71,7 @@
71
71
<refsect1 role="returnvalues">
72
72
&reftitle.returnvalues;
73
73
<para>
74
-
Returns a <classname>Phar</classname> object.
74
+
Returns a <classname>Phar</classname> object, or &null; on failure.
75
75
</para>
76
76
</refsect1>
77
77
...
...
@@ -86,6 +86,28 @@
86
86
</para>
87
87
</refsect1>
88
88
89
+
<refsect1 role="changelog">
90
+
&reftitle.changelog;
91
+
<informaltable>
92
+
<tgroup cols="2">
93
+
<thead>
94
+
<row>
95
+
<entry>&Version;</entry>
96
+
<entry>&Description;</entry>
97
+
</row>
98
+
</thead>
99
+
<tbody>
100
+
<row>
101
+
<entry>8.0.0</entry>
102
+
<entry>
103
+
<parameter>extension</parameter> is now nullable.
104
+
</entry>
105
+
</row>
106
+
</tbody>
107
+
</tgroup>
108
+
</informaltable>
109
+
</refsect1>
110
+
89
111
<refsect1 role="examples">
90
112
&reftitle.examples;
91
113
<para>
...
...
@@ -127,7 +149,6 @@ $p3 = $p2->compress(Phar::NONE); // exception: /path/to/my.phar already exists
127
149
</refsect1>
128
150
129
151
</refentry>
130
-
131
152
<!-- Keep this comment at the end of the file
132
153
Local variables:
133
154
mode: sgml
134
155