-
Notifications
You must be signed in to change notification settings - Fork 72
/
open.xml
255 lines (232 loc) · 8.24 KB
/
open.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
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: b95d28e6ec86e4a71e012737d36ebdc1cf009180 Maintainer: irker Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="rararchive.open" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>RarArchive::open</refname>
<refname>rar_open</refname>
<refpurpose>Открывает архив RAR</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>&style.oop; (метод):</para>
<methodsynopsis>
<modifier>public</modifier> <modifier>static</modifier> <type class="union"><type>RarArchive</type><type>false</type></type><methodname>RarArchive::open</methodname>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>password</parameter><initializer>NULL</initializer></methodparam>
<methodparam choice="opt"><type>callable</type><parameter>volume_callback</parameter><initializer>NULL</initializer></methodparam>
</methodsynopsis>
<para>&style.procedural;:</para>
<methodsynopsis>
<type class="union"><type>RarArchive</type><type>false</type></type><methodname>rar_open</methodname>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>password</parameter><initializer>NULL</initializer></methodparam>
<methodparam choice="opt"><type>callable</type><parameter>volume_callback</parameter><initializer>NULL</initializer></methodparam>
</methodsynopsis>
<para>
Открывает указанный RAR-архив и возвращает объект
<type>RarArchive</type>, представляющий его.
</para>
<note>
<para>
При открытии многотомного архива путь к первому тому
должен быть передан первым параметром. Иначе не будут видны
все файлы.
</para>
</note>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>filename</parameter></term>
<listitem>
<para>
Путь к архиву Rar.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>password</parameter></term>
<listitem>
<para>
Пароль, если необходимо расшифровать заголовки архива.
Этот же пароль будет использоваться по умолчанию, если будут найдены
зашифрованные файлы. Учтите, что файлы могут быть зашифрованы с
разными паролями.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>volume_callback</parameter></term>
<listitem>
<para>
Функция, которой передаётся единственный параметр -
путь к тому, который не был найден, и возвращающая строку
с правильным путём для этого тома или &null;, если данный
том не существует или неизвестен. Разработчик должен быть уверен,
что данная функция не приведёт к зацикливанию, так как она
вызывается повторно, если путь полученный предыдущим вызовом
не соответствует нужному тому. Указание этого параметра
устраняет предупреждения, которые появлялись бы, если бы
том не был бы найден. В случае, если функция возвращает
только &null;, то не будет ни одного предупреждения.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<warning>
<para>
До версии 2.0.0 эта функция не обрабатывала правильно
относительные пути. В таких случаях используйте
<function>realpath</function>.
</para>
</warning>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Возвращает запрашиваемый объект <type>RarArchive</type>&return.falseforfailure;.
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>PECL rar 3.0.0</entry>
<entry>
Был добавлен <parameter>volume_callback</parameter>.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>&style.oop;</title>
<programlisting role="php">
<![CDATA[
<?php
$rar_arch = RarArchive::open('encrypted_headers.rar', 'samplepassword');
if ($rar_arch === FALSE)
die("Неудачное открытие файла");
$entries = $rar_arch->getEntries();
if ($entries === FALSE)
die("Неудачное получение записей");
echo "Найдено " . count($entries) . " файлов.\n";
if (empty($entries))
die("Не найдено корректных записей.");
$stream = reset($entries)->getStream();
if ($stream === FALSE)
die("Неудачное открытие первого файла");
$rar_arch->close();
echo "Содержимое первого файла:\n";
echo stream_get_contents($stream);
fclose($stream);
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
Найдено 2 файлов.
Содержимое первого файла:
Encrypted file 1 contents.
]]>
</screen>
</example>
</para>
<para>
<example>
<title>&style.procedural;</title>
<programlisting role="php">
<![CDATA[
<?php
$rar_arch = rar_open('encrypted_headers.rar', 'samplepassword');
if ($rar_arch === FALSE)
die("Неудачное открытие файла");
$entries = rar_list($rar_arch);
if ($entries === FALSE)
die("Failed fetching entries");
echo "Найдено " . count($entries) . " файлов.\n";
if (empty($entries))
die("Не найдено корректных записей.");
$stream = reset($entries)->getStream();
if ($stream === FALSE)
die("Неудачное открытие первого файла");
rar_close($rar_arch);
echo "Содержимое первого файла:\n";
echo stream_get_contents($stream);
fclose($stream);
?>
]]>
</programlisting>
</example>
</para>
<para>
<example>
<title>Callback-функция для тома</title>
<programlisting role="php">
<![CDATA[
<?php
/* В этом примере есть том с именем multi_broken.part1.rar,
* а следующий том имеет имя multi.part2.rar */
function resolve($vol) {
if (preg_match('/_broken/', $vol))
return str_replace('_broken', '', $vol);
else
return null;
}
$rar_file1 = rar_open(dirname(__FILE__).'/multi_broken.part1.rar', null, 'resolve');
$entry = $rar_file1->getEntry('file2.txt');
$entry->extract(null, dirname(__FILE__) . "/temp_file2.txt");
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><link linkend="wrappers.rar"><literal>rar://</literal> wrapper</link></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
-->