-
Notifications
You must be signed in to change notification settings - Fork 146
/
stream-read.xml
124 lines (114 loc) · 3.67 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
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 906db3b3f78cfa98a7453e3910bcba95bc66d1ee Maintainer: yannick 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>Lit dans le flux</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>
Cette méthode est appelée en réponse à <function>fread</function>
et <function>fgets</function>.
</para>
<note>
<para>
N'oubliez pas de modifier la position de lecture et écriture
du nombre d'octets qui ont pu être lus.
</para>
</note>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>count</parameter></term>
<listitem>
<para>
Le nombre d'octets qui ont pu être lus, à partir de
la position courante.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
S'il y a moins que <parameter>count</parameter> octets
disponibles, autant que possible devrait être retourné.
S'il n'y a plus de données disponibles, une chaîne vide doit être retourné.
Pour signaler une erreur de lecture &false; doit être retourné.
</para>
</refsect1>
<refsect1 role="errors"><!-- {{{ -->
&reftitle.errors;
&userstream.not.implemented.warning;
<note>
<para>
Si la valeur de retour est plus grande que <parameter>count</parameter>,
une erreur <constant>E_WARNING</constant> sera émise, et
les données excédentaires seront perdues.
</para>
</note>
</refsect1><!-- }}} -->
<refsect1 role="notes"><!-- {{{ -->
&reftitle.notes;
<note>
<para>
<methodname>streamWrapper::stream_eof</methodname> est appelé directement
après <methodname>streamWrapper::stream_read</methodname> pour vérifier
si <acronym>EOF</acronym> a été atteint. Si la fonction n'est pas
implémenté, <acronym>EOF</acronym> est utilisé.
</para>
</note>
<warning>
<para>
Lors de la lecture complète d'un fichier (par exemple, par
la fonction <function>file_get_contents</function>), PHP
appellera la fonction <methodname>streamWrapper::stream_read</methodname>
suivie de la fonction <methodname>streamWrapper::stream_eof</methodname>
dans une boucle, mais tant que la fonction
<methodname>streamWrapper::stream_read</methodname> retournera une
chaîne non vide, la valeur retournée de la fonction
<methodname>streamWrapper::stream_eof</methodname> sera ignorée.
</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
-->