-
Notifications
You must be signed in to change notification settings - Fork 70
/
stream-read.xml
145 lines (135 loc) · 4.56 KB
/
stream-read.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
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 906db3b3f78cfa98a7453e3910bcba95bc66d1ee Maintainer: tmn Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="streamwrapper.stream-read" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>streamWrapper::stream_read</refname>
<refpurpose>Читает из потока</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type class="union"><type>string</type><type>false</type></type><methodname>streamWrapper::stream_read</methodname>
<methodparam><type>int</type><parameter>count</parameter></methodparam>
</methodsynopsis>
<para>
Этот метод вызывается в процессе выполнения функций
<function>fread</function> и <function>fgets</function>.
</para>
<note>
<para>
Не забывайте обновлять позицию чтения/записи в потоке (на количество успешно
прочитанных байт).
</para>
</note>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>count</parameter></term>
<listitem>
<para>
Сколько байт данных от текущей позиции должно быть возвращено.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Если в потоке количество доступных байт меньше, чем <parameter>count</parameter>,
должно быть возвращено столько данных, сколько доступно.
Если доступных данных больше нет, функция возвращает &false;.
</para>
</refsect1>
<refsect1 role="errors"><!-- {{{ -->
&reftitle.errors;
&userstream.not.implemented.warning;
<note>
<para>
Если возвращаемое значение будет больше, чем <parameter>count</parameter>,
то будет вызвана ошибка <constant>E_WARNING</constant>, и данные более
указанного количества будут потеряны.
</para>
</note>
</refsect1><!-- }}} -->
<!--
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>streamWrapper::stream_read</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
/* ... */
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
...
]]>
</screen>
</example>
</para>
</refsect1>
-->
<refsect1 role="notes"><!-- {{{ -->
&reftitle.notes;
<note>
<para>
<methodname>streamWrapper::stream_eof</methodname> вызывается сразу после вызова
<methodname>streamWrapper::stream_read</methodname>, чтобы проверить,
достигнут ли конец файла <acronym>EOF</acronym>. Если метод не реализован, то
полагается, что конец файла <acronym>EOF</acronym> достигнут.
</para>
</note>
<warning>
<para>
При чтении файла целиком (например, функцией
<function>file_get_contents</function>), PHP будет вызывать
<methodname>streamWrapper::stream_read</methodname> и вместе с ним
<methodname>streamWrapper::stream_eof</methodname> в цикле, пока
<methodname>streamWrapper::stream_read</methodname> возвращает
непустую строку. Возвращаемое из
<methodname>streamWrapper::stream_eof</methodname> значение при этом
игнорируется.
</para>
</warning>
</refsect1><!-- }}} -->
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>fread</function></member>
<member><function>fgets</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
-->