-
Notifications
You must be signed in to change notification settings - Fork 70
/
getstream.xml
157 lines (142 loc) · 5.14 KB
/
getstream.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
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: b95d28e6ec86e4a71e012737d36ebdc1cf009180 Maintainer: rjhdby Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="rarentry.getstream" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>RarEntry::getStream</refname>
<refpurpose>Получить обработчик для записи</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type class="union"><type>resource</type><type>false</type></type><methodname>RarEntry::getStream</methodname>
<methodparam choice="opt"><type>string</type><parameter>password</parameter></methodparam>
</methodsynopsis>
<para>
Возвращает обработчик, поддерживающий операцию чтения. Этот обработчик
умеет распаковывать запись на лету.
</para>
<para>
Обработчик не уничтожается при вызове
<function>rar_close</function>.
</para>
<warning>
<para>Результирующий поток не проверяется на целостность. Следовательно
никак не определяется порча файла или расшифровка с неверным ключом. Проверка
контрольной суммы разжатого и расшифрованного файла полностью на
совести разработчика.</para>
</warning>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>password</parameter></term>
<listitem>
<para>
Пароль, использовавшийся для шифрования записи. Если запись не шифрована, то
этот параметр игнорируется и в целом может быть опущен. Если же параметр опущен,
а запись шифрована, то будет использован пароль заданный в функции
<function>rar_open</function>, если конечно он был задан. Если был задан неверный
пароль, явно или неявно через <function>rar_open</function>, этот метод вернёт
поток с неверными данными. Если пароль не задан вообще, а он нужен, то метод
вернёт &false;. Зашифрована ли запись или нет можно проверить с помощью
<methodname>RarEntry::isEncrypted</methodname>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Обработчик&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>
Поддержка RAR-архивов с дублирующимися именами записей теперь работает нормально.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Пример использования <methodname>RarEntry::getStream</methodname></title>
<programlisting role="php">
<![CDATA[
<?php
$rar_file = rar_open('example.rar');
if ($rar_file === false)
die("Не удалось открыть Rar архив");
$entry = rar_entry_get($rar_file, 'Dir/file.txt');
if ($entry === false)
die("Не удалось найти такую запись");
$stream = $entry->getStream();
if ($stream === false)
die("Не удалось получить поток.");
rar_close($rar_file); //поток не зависит от файла
while (!feof($stream)) {
$buff = fread($stream, 8192);
if ($buff !== false)
echo $buff;
else
break; //ошибка fread
}
fclose($stream);
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>RarEntry::extract</methodname></member>
<member><link linkend="wrappers.rar">обёртка <literal>rar://</literal></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
-->