-
Notifications
You must be signed in to change notification settings - Fork 70
/
extract.xml
206 lines (187 loc) · 7.07 KB
/
extract.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
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: af5f2f87b3b0bb9ee0f83ccb787a4e7db1eb6bd4 Maintainer: irker Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="rarentry.extract" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>RarEntry::extract</refname>
<refpurpose>Извлекает элемент из архива</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>RarEntry::extract</methodname>
<methodparam><type>string</type><parameter>dir</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>filepath</parameter><initializer>""</initializer></methodparam>
<methodparam choice="opt"><type>string</type><parameter>password</parameter><initializer>NULL</initializer></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>extended_data</parameter><initializer>&false;</initializer></methodparam>
</methodsynopsis>
<para>
<methodname>RarEntry::extract</methodname> извлекает содержимое элемента.
При этом создаётся новый файл в указанной директории
<parameter>dir</parameter> с именем совпадающим с именем элемента,
если только не задан второй аргумент. Смотрите подробнее ниже.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>dir</parameter></term>
<listitem>
<para>
Путь к директории, куда необходимо извлечь файлы. Этот
параметр учитывается только если не указан параметр
<parameter>filepath</parameter>. Если оба параметра не указаны,
то файлы извлекаются в текущую директорию.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>filepath</parameter></term>
<listitem>
<para>
Путь (полный или относительный) содержит директорию
и имя извлекаемого файла. Этот параметр переопределяет
и параметр <parameter>dir</parameter> и оригинальное имя файла.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>password</parameter></term>
<listitem>
<para>
Пароль используется для расшифровки текущего элемента. Если
элемент не зашифрован, то этот параметр не будет использован и
его можно не указывать. Если же этот параметр не указан, а
элемент зашифрован, то будет использован пароль, переданный
функции <function>rar_open</function>, если её вызывали.
Если передан неверный пароль, явно или неявно через
<function>rar_open</function>, то проверка CRC будет неудачной
и будет возвращён &false;.
Вы можете проверить является ли элемент зашифрованным с помощью
<methodname>RarEntry::isEncrypted</methodname>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>extended_data</parameter></term>
<listitem>
<para>
Если &true;, то в извлекаемый файл будет добавлена
дополнительная информация, такая как NTFS ACL и владелец в
системе Unix, если они присутствовали в архиве.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<warning>
<para>
До версии 2.0.0, не обрабатывала относительные пути корректно. Используйте для этой ситуации <function>realpath</function>.
</para>
</warning>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</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>extended_data</parameter>.
</entry>
</row>
<row>
<entry>PECL rar 3.0.0</entry>
<entry>
Исправлена поддержка RAR архивов с повторяющимися именами
элементов.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Пример использования <methodname>RarEntry::extract</methodname></title>
<programlisting role="php">
<![CDATA[
<?php
$rar_file = rar_open('example.rar') or die("Не удалось открыть Rar архив");
$entry = rar_entry_get($rar_file, 'Dir/file.txt') or die("Не удалось найти такую запись");
$entry->extract('/dir/to'); // создание /dir/to/Dir/file.txt
$entry->extract(false, '/dir/to/new_name.txt'); // создание /dir/to/new_name.txt
?>
]]>
</programlisting>
</example>
<example>
<title>Как извлечь все файлы из архива: </title>
<programlisting role="php">
<![CDATA[
<?php
/* Пример от Erik Jenssen aka erix */
$filename = "foobar.rar";
$filepath = "/home/foo/bar/";
$rar_file = rar_open($filepath.$filename);
$list = rar_list($rar_file);
foreach($list as $file) {
$entry = rar_entry_get($rar_file, $file);
$entry->extract("."); // извлечь в текущий каталог
}
rar_close($rar_file);
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>RarEntry::getStream</methodname></member>
<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
-->