reference/phar/PharData/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="phardata.compress">
3
+
<refentry xml:id="phardata.compress" xmlns="http://docbook.org/ns/docbook">
4
4
<refnamediv>
5
5
<refname>PharData::compress</refname>
6
6
<refpurpose>Compresses the entire tar/zip 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
-
<type>object</type><methodname>PharData::compress</methodname>
11
+
<methodsynopsis role="PharData">
12
+
<modifier>public</modifier> <type class="union"><type>PharData</type><type>null</type></type><methodname>PharData::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
17
17
<para>
...
...
@@ -65,7 +65,8 @@
65
65
<refsect1 role="returnvalues">
66
66
&reftitle.returnvalues;
67
67
<para>
68
-
A <classname>PharData</classname> object is returned.
68
+
A <classname>PharData</classname> object is returned on success,
69
+
or &null; on failure.
69
70
</para>
70
71
</refsect1>
71
72
...
...
@@ -79,6 +80,28 @@
79
80
</para>
80
81
</refsect1>
81
82
83
+
<refsect1 role="changelog">
84
+
&reftitle.changelog;
85
+
<informaltable>
86
+
<tgroup cols="2">
87
+
<thead>
88
+
<row>
89
+
<entry>&Version;</entry>
90
+
<entry>&Description;</entry>
91
+
</row>
92
+
</thead>
93
+
<tbody>
94
+
<row>
95
+
<entry>8.0.0</entry>
96
+
<entry>
97
+
<parameter>extension</parameter> is now nullable.
98
+
</entry>
99
+
</row>
100
+
</tbody>
101
+
</tgroup>
102
+
</informaltable>
103
+
</refsect1>
104
+
82
105
<refsect1 role="examples">
83
106
&reftitle.examples;
84
107
<para>
...
...
@@ -110,7 +133,6 @@ $p3 = $p2->compress(Phar::NONE); // exception: /path/to/my.tar already exists
110
133
</refsect1>
111
134
112
135
</refentry>
113
-
114
136
<!-- Keep this comment at the end of the file
115
137
Local variables:
116
138
mode: sgml
117
139