-
Notifications
You must be signed in to change notification settings - Fork 70
/
decompressFiles.xml
149 lines (141 loc) · 5.19 KB
/
decompressFiles.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
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: f03806fcd8fe03a0501bd40b6e3939ff6589a1d2 Maintainer: rjhdby Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="phar.decompressfiles" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>Phar::decompressFiles</refname>
<refpurpose>Распаковывает все файлы в текущем Phar-архиве</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis role="Phar">
<modifier>public</modifier> <type>bool</type><methodname>Phar::decompressFiles</methodname>
<void/>
</methodsynopsis>
&phar.write;
<para>
В случае использования с phar-архивами, основанными на tar, этот метод выбрасывает исключение
<classname>BadMethodCallException</classname>, поскольку сжатие отдельных
файлов внутри tar-архива не поддерживается данным форматом.
Для сжатия целого phar-архива, основанного на tar, используйте
<function>Phar::compress</function>.
</para>
<para>
В случае использования с phar-архивами, основанными на zip или phar, этот метод распаковывает все файлы в Phar-архиве.
Если какие-либо файлы внутри архива были сжаты при помощи bzip2/zlib-сжатия, то для возможности
воспользоваться данным методом должен быть включён модуль <link linkend="ref.zlib">zlib</link>
или <link linkend="ref.bzip2">bzip2</link>. Как и в случае с другим функционалом,
модифицирующим содержание phar-архива, для успешной работы данного метода необходимо,
чтобы INI-переменная <link linkend="ini.phar.readonly">phar.readonly</link> была отключена.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</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> не доступен или
если какие-либо файлы внутри архива были сжаты с использованием bzip2-сжатия
и модуль <link linkend="ref.bzip2">bzip2</link> не включён.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Пример использования <function>Phar::decompressFiles</function></title>
<programlisting role="php">
<![CDATA[
<?php
$p = new Phar('/путь/к/my.phar', 0, 'my.phar');
$p['myfile.txt'] = 'привет';
$p['myfile2.txt'] = 'привет';
$p->compressFiles(Phar::GZ);
foreach ($p as $file) {
var_dump($file->getFileName());
var_dump($file->isCompressed());
var_dump($file->isCompressed(Phar::BZ2));
var_dump($file->isCompressed(Phar::GZ));
}
$p->decompressFiles();
foreach ($p as $file) {
var_dump($file->getFileName());
var_dump($file->isCompressed());
var_dump($file->isCompressed(Phar::BZ2));
var_dump($file->isCompressed(Phar::GZ));
}
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
string(10) "myfile.txt"
int(4096)
bool(false)
bool(true)
string(11) "myfile2.txt"
int(4096)
bool(false)
bool(true)
string(10) "myfile.txt"
bool(false)
bool(false)
bool(false)
string(11) "myfile2.txt"
bool(false)
bool(false)
bool(false)
]]>
</screen>
</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>Phar::canCompress</function></member>
<member><function>Phar::isCompressed</function></member>
<member><function>Phar::compressFiles</function></member>
<member><function>Phar::getSupportedCompression</function></member>
<member><function>Phar::compress</function></member>
<member><function>Phar::decompress</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
-->