-
Notifications
You must be signed in to change notification settings - Fork 146
/
ob-start.xml
283 lines (269 loc) · 9.05 KB
/
ob-start.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
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: da6be21fef84d61cc4c621b3fe1d5fd2c9046c45 Maintainer: yannick Status: ready -->
<!-- Reviewed: yes -->
<refentry xml:id="function.ob-start" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>ob_start</refname>
<refpurpose>Enclenche la temporisation de sortie</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>ob_start</methodname>
<methodparam choice="opt"><type class="union"><type>callable</type><type>null</type></type><parameter>callback</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>chunk_size</parameter><initializer>0</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer><constant>PHP_OUTPUT_HANDLER_STDFLAGS</constant></initializer></methodparam>
</methodsynopsis>
<para>
Cette fonction active la mise en mémoire tampon de la sortie.
Lorsque la mise en mémoire tampon est active, aucune sortie n'est envoyée depuis le script ;
au lieu de cela, la sortie est stockée dans une mémoire tampon interne.
Consultez <xref linkend="outcontrol.what-output-is-buffered"/>
pour savoir exactement quelles sorties sont concernées.
</para>
<para>
Les tampons de sortie sont empilables, c'est-à-dire
<function>ob_start</function> peut être appelée pendant qu'un autre tampon est actif.
Si plusieurs tampons de sortie sont actifs,
la sortie est filtrée séquentiellement
à travers chacun d'eux dans l'ordre d'emboîtement.
Consultez <xref linkend="outcontrol.nesting-output-buffers"/> pour plus de détails.
</para>
<para>
Consultez <xref linkend="outcontrol.user-level-output-buffers"/>
pour une description détaillée des tampons de sortie.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>callback</parameter></term>
<listitem>
<para>
Un <parameter>callback</parameter> <type>callable</type> optionnel peut être
spécifié. Il peut également être contourné en passant &null;.
</para>
<para>
<parameter>callback</parameter> est invoqué lorsque le tampon de sortie est
vidé (envoyé), nettoyé, ou lorsque le tampon de sortie est vidé
à la fin du script.
</para>
<para>
La signature du <parameter>callback</parameter> est la suivante :
</para>
<para>
<methodsynopsis>
<type>string</type><methodname><replaceable>handler</replaceable></methodname>
<methodparam><type>string</type><parameter>buffer</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>phase</parameter></methodparam>
</methodsynopsis>
<variablelist>
<varlistentry>
<term><parameter>buffer</parameter></term>
<listitem>
<simpara>
Contenu du buffer de sortie.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>phase</parameter></term>
<listitem>
<simpara>
Masque de bits des constantes
<link linkend="constant.php-output-handler-start">
<constant>PHP_OUTPUT_HANDLER_<replaceable>*</replaceable></constant>
</link>.
Consultez <xref linkend="outcontrol.flags-passed-to-output-handlers"/>
pour plus de détails.
</simpara>
</listitem>
</varlistentry>
</variablelist>
</para>
<para>
Si <parameter>callback</parameter> renvoie &false;,
le contenu du tampon est renvoyé.
Consultez <xref linkend="outcontrol.output-handler-return-values"/>
pour plus de détails.
</para>
<warning>
<simpara>
Appeler l'une des fonctions suivantes à partir d'un gestionnaire de sortie
entraînera une erreur fatale :
<function>ob_clean</function>, <function>ob_end_clean</function>,
<function>ob_end_flush</function>, <function>ob_flush</function>,
<function>ob_get_clean</function>, <function>ob_get_flush</function>,
<function>ob_start</function>.
</simpara>
</warning>
<para>
Consultez <xref linkend="outcontrol.output-handlers"/>
et <xref linkend="outcontrol.working-with-output-handlers"/>
pour plus de détails sur les <parameter>callback</parameter>s (gestionnaires de sortie).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>chunk_size</parameter></term>
<listitem>
<para>
Si le paramètre optionnel <parameter>chunk_size</parameter> est passé,
la fonction de rappel est appelée à chaque nouvelle ligne après
<parameter>chunk_size</parameter> octets d'affichage.
La valeur par défaut <literal>0</literal> signifie
que toute la sortie est mise en mémoire tampon jusqu'à ce que la mémoire tampon soit désactivée.
Consultez <xref linkend="outcontrol.buffer-size"/> pour plus de détails.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>flags</parameter></term>
<listitem>
<para>
Le paramètre <parameter>flags</parameter> est un masque qui contrôle
les opérations qui peuvent être effectuées sur le tampon de sortie.
Par défaut, il autorise le tampon de sortie à être nettoyé, envoyé
et supprimé, ce qui peut être défini explicitement avec les
<link linkend="outcontrol.constants.buffer-control-flags">
indicateurs de contrôle de la mémoire tampon
</link>.
Consultez <xref linkend="outcontrol.operations-on-buffers"/>
pour plus de détails.
</para>
<para>
Chaque drapeau contrôle l'accès à un jeu de fonctions, tel décrit
ci-dessous :
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>Constante</entry>
<entry>Fonctions</entry>
</row>
</thead>
<tbody>
<row>
<entry><constant>PHP_OUTPUT_HANDLER_CLEANABLE</constant></entry>
<entry>
<function>ob_clean</function>,
</entry>
</row>
<row>
<entry><constant>PHP_OUTPUT_HANDLER_FLUSHABLE</constant></entry>
<entry>
<function>ob_flush</function>,
</entry>
</row>
<row>
<entry><constant>PHP_OUTPUT_HANDLER_REMOVABLE</constant></entry>
<entry>
<function>ob_end_clean</function>,
<function>ob_end_flush</function> et
<function>ob_get_clean</function>.
<function>ob_get_flush</function>.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Exemple de gestion de sortie avec fonction de rappel</title>
<programlisting role="php">
<![CDATA[
<?php
function rappel($buffer)
{
// remplace toutes les pommes par des carottes
return (str_replace("pommes de terre", "carottes", $buffer));
}
ob_start("rappel");
?>
<html>
<body>
<p>C'est comme comparer des carottes et des pommes de terre.</p>
</body>
</html>
<?php
ob_end_flush();
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
<html>
<body>
<p>C'est comme comparer des carottes et des carottes.</p>
</body>
</html>
]]>
</screen>
</example>
</para>
<para>
<example xml:id="function.ob-start.flags-bc">
<title>Crée un tampon de sortie in-effaçable</title>
<programlisting role="php">
<![CDATA[
<?php
ob_start(null, 0, PHP_OUTPUT_HANDLER_STDFLAGS ^ PHP_OUTPUT_HANDLER_REMOVABLE);
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>ob_get_contents</function></member>
<member><function>ob_end_clean</function></member>
<member><function>ob_end_flush</function></member>
<member><function>ob_implicit_flush</function></member>
<member><function>ob_gzhandler</function></member>
<member><function>ob_iconv_handler</function></member>
<member><function>mb_output_handler</function></member>
<member><function>ob_tidyhandler</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
-->