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
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 312105 $ -->
<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>Read from stream</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>string</type><methodname>streamWrapper::stream_read</methodname>
<methodparam><type>int</type><parameter>count</parameter></methodparam>
</methodsynopsis>
<para>
This method is called in response to <function>fread</function>
and <function>fgets</function>.
</para>
<note>
<para>
Remember to update the read/write position of the stream (by the number of
bytes that were successfully read).
</para>
</note>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>count</parameter></term>
<listitem>
<para>
How many bytes of data from the current position should be returned.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
If there are less than <parameter>count</parameter>
bytes available, return as many as are available. If no
more data is available, return either &false; or an
empty string.
</para>
</refsect1>
<refsect1 role="errors"><!-- {{{ -->
&reftitle.errors;
&userstream.not.implemented.warning;
<note>
<para>
If the return value is longer then <parameter>count</parameter> an
<constant>E_WARNING</constant> error will be emitted, and excess data will be
lost.
</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> is called directly after
calling <methodname>streamWrapper::stream_read</methodname> to check if
<acronym>EOF</acronym> has been reached. If not implemented,
<acronym>EOF</acronym> is assumed.
</para>
</note>
<warning>
<para>
When reading the whole file (for example, with
<function>file_get_contents</function>), PHP will call
<methodname>streamWrapper::stream_read</methodname> followed by
<methodname>streamWrapper::stream_eof</methodname> in a loop but as long
as <methodname>streamWrapper::stream_read</methodname> returns a
non-empty string, the return value of
<methodname>streamWrapper::stream_eof</methodname> is ignored.
</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
-->
|
