-
Notifications
You must be signed in to change notification settings - Fork 70
/
compress.xml
169 lines (160 loc) · 7.05 KB
/
compress.xml
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
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: f03806fcd8fe03a0501bd40b6e3939ff6589a1d2 Maintainer: rjhdby Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="phar.compress" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>Phar::compress</refname>
<refpurpose>Сжимает весь Phar-архив с помощью Gzip- или Bzip2-сжатия</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis role="Phar">
<modifier>public</modifier> <type class="union"><type>Phar</type><type>null</type></type><methodname>Phar::compress</methodname>
<methodparam><type>int</type><parameter>compression</parameter></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>extension</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
&phar.write;
<para>
В случае использования с phar-архивами, основанными на tar или phar, этот метод сжимает весь архив,
используя gzip- или bzip2-сжатие. Полученный файл может быть обработан одной из команд
gunzip/bunzip; к нему также можно получить прямой доступ, используя модуль Phar.
</para>
<para>
В случае использования с phar-архивами, основанными на zip, вызов этого метода потерпит неудачу и будет
брошено исключение. Для сжатия по алгоритму gzip должен быть включён модуль
<link linkend="ref.zlib">zlib</link>. Для сжатия по алгоритму bzip2 должен быть включён модуль
<link linkend="ref.bzip2">bzip2</link>. Как и в случае с другим функционалом,
модифицирующим содержание phar-архива, для успешной работы данного метода необходимо,
чтобы INI-переменная <link linkend="ini.phar.readonly">phar.readonly</link> была отключена.
</para>
<para>
Кроме того, этот метод автоматически переименовывает архив, добавляя <literal>.gz</literal>,
<literal>.bz2</literal> или удаляя расширение, если в качестве первого параметра был передан
<literal>Phar::NONE</literal>, сообщающий о необходимости распаковки. В качестве альтернативы
расширение файла может быть задано с помощью второго параметра.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>compression</parameter></term>
<listitem>
<para>
Сжатие должно быть определено одной из констант: <literal>Phar::GZ</literal>,
<literal>Phar::BZ2</literal> для использования соответствующего алгоритма сжатия, или
<literal>Phar::NONE</literal> для распаковки.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>extension</parameter></term>
<listitem>
<para>
Для сжатия phar-архивов по умолчанию используется расширение
<literal>.phar.gz</literal> или <literal>.phar.bz2</literal>, а
для сжатия tar-архивов — <literal>.phar.tar.gz</literal> или
<literal>.phar.tar.bz2</literal>. В случае распаковки, расширениями по
умолчанию являются <literal>.phar</literal> и <literal>.phar.tar</literal>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Возвращает объект <classname>Phar</classname> или &null; в случае возникновения ошибки.
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
Выбрасывает исключение <classname>BadMethodCallException</classname>,
если INI-переменная <link linkend="ini.phar.readonly">phar.readonly</link>
включена, модуль <link linkend="ref.zlib">zlib</link> не доступен или
модуль <link linkend="ref.bzip2">bzip2</link> не включён.
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>8.0.0</entry>
<entry>
<parameter>extension</parameter> теперь допускает значение null.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Пример использования <function>Phar::compress</function></title>
<programlisting role="php">
<![CDATA[
<?php
$p = new Phar('/путь/к/my.phar', 0, 'my.phar');
$p['myfile.txt'] = 'привет';
$p['myfile2.txt'] = 'привет';
$p1 = $p->compress(Phar::GZ); // копирует в /путь/к/my.phar.gz
$p2 = $p->compress(Phar::BZ2); // копирует в /путь/к/my.phar.bz2
$p3 = $p2->compress(Phar::NONE); // исключение: /путь/к/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::decompress</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:"~/.phpdoc/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
-->