File: outcontrol.xml

package info (click to toggle)
phpdoc 20020310-1
  • links: PTS
  • area: main
  • in suites: woody
  • size: 35,272 kB
  • ctags: 354
  • sloc: xml: 799,767; php: 1,395; cpp: 500; makefile: 200; sh: 140; awk: 51
file content (388 lines) | stat: -rw-r--r-- 13,187 bytes parent folder | download
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
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.21 $ -->
 <reference id="ref.outcontrol">
  <title>Entr&eacute;es/sorties</title>
  <titleabbrev>Entr&eacute;es/sorties</titleabbrev>
  <partintro>
   <para>
    Les fonctions d'entr&eacute;e/sorties vous permettent de contr&ocirc;ler
    quand les donn&eacute;es ont &eacute;t&eacute; envoy&eacute;es par le script. Cela peut
    &ecirc;tre utile dans certaines situations, notamment si vous devez
    envoyer des en-t&ecirc;tes au navigateur apr&egrave;s avoir envoy&eacute;
    des donn&eacute;es. Ces fonctions n'affectent pas les en-t&ecirc;tes
    envoy&eacute;es par la fonction <function>header</function> ou les
    cookies envoy&eacute;s par <function>setcookie</function>. Seules les
    fonctions telles que <function>echo</function> et les donn&eacute;es entre
    blocs PHP sont affect&eacute;es.
   </para>
   <para>
    <example>
     <title>Exemple de gestion des sorties</title>
     <programlisting role="php">
&lt;?php
ob_start();
echo "Bonjour\n";
setcookie ("nom_du_cookie", "valeur_du_cookie");
ob_end_flush();
?&gt;
     </programlisting>
    </example>
   </para>
   <para>
    Dans l'exemple ci-dessus, la fonction <function>echo</function>
    est stock&eacute;e dans un buffer jusqu'&agrave; l'appel de la fonction
    <function>ob_end_flush</function>. Dans le m&ecirc;me
    temps, l'appel &agrave; <function>setcookie</function> a r&eacute;ussi
    &agrave; cr&eacute;er un cookie, sans g&eacute;n&eacute;rer d'erreur.
    (D'habitude, vous devez envoyer les en-t&ecirc;tes avant les donn&eacute;es).
   </para>
   <para>
    Voir aussi
    <function>header</function> et
    <function>setcookie</function>.
   </para>
  </partintro>
  <refentry id="function.flush">
   <refnamediv>
    <refname>flush</refname>
    <refpurpose>Vide les buffers de sortie.</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>void</type><methodname>flush</methodname>
      <void/>
     </methodsynopsis>
    <simpara>
     <function>flush</function> vide les buffers de sortie de PHP et
     tous ceux que PHP utilisait (CGI, un serveur web, etc.).
    </simpara>
	<note>
	 <para>
	  <function>flush</function> n'a aucun effet sur la bufferisation
	  de votre serveur web ou du navigateur.
	 </para>
	<para>
	 De nombreux serveurs, essentiellement sous Windows,
	 continueront &agrave; bufferiser l'affichage de votre script
	 jusqu'&agrave; ce qu'il soit termin&eacute;, avant de transmettre
	 les r&eacute;sultats &agrave; l'internaute.
	 </para>
	 <para>
		M&ecirc;me le navigateur peut mettre des informations en cache
		avant de les afficher. Par exemple, Netscape &eacute;crit les
		textes dand un cache, jusqu'&agrave; ce qu'il ait re&ccedil;u une
		fin de ligne, ou une balise ouvrante. Il n'affichera
		pas les tables avant d'avoir re&ccedil;u la balise fermante
		&lt;/table&gt;.
	 </para>
    </note>
   </refsect1>
  </refentry>
  <refentry id="function.ob-start">
   <refnamediv>
    <refname>ob_start</refname>
    <refpurpose>Enclenche la bufferisation de sortie</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
       <type>void</type><methodname>ob_start</methodname>
      <methodparam choice="opt"><type>string</type><parameter>
        output_callback
       </parameter></methodparam>
     </methodsynopsis>
    <para>
     <function>ob_start</function> d&eacute;marre la bufferisation de sortie.
     Tant qu'elle est enclench&eacute;e, aucune donn&eacute;e, hormis
     les en-t&ecirc;tes, n'est envoy&eacute;e au navigateur, mais
     temporairement mise en buffer.
    </para>
    <para>
     Le contenu de ce buffer peut &ecirc;tre copi&eacute; dans une cha&icirc;ne
     avec la fonction <function>ob_get_contents</function>.  Pour afficher le
     contenu de ce buffer, utilisez <function>ob_end_flush</function>.  Au
     contraire, <function>ob_end_clean</function> effacera le contenu de ce buffer.
    </para>
    <para>
     Une fonction optionnelle de callback peut &ecirc;tre sp&eacute;cifi&eacute;e
     en troisi&egrave;me argument. <function>ob_start</function> prend une
     cha&icirc;ne comme param&egrave;tre, et retourne une cha&icirc;ne.
     Elle sera appel&eacute;e par <function>ob_end_flush</function> ou
     lorsque le buffer sera envoy&eacute; au navigateur &agrave; la fin du script et
     recevra le contenu du buffer de sortie. Lorsque la fonction
     <parameter>output_callback</parameter> est appel&eacute;e,
     elle doit retourner un nouveau contenu pour le buffer de sortie :
     celui-ci sera envoy&eacute; au navigateur.
    </para>
    <note>
     <para>
      En PHP 4.0.4, <function>ob_gzhandler</function> a &eacute;t&eacute;
      introduit pour faciliter l'envoi de fichier compress&eacute;
      avec gz aux navigateurs web qui supportent les pages
      compress&eacute;es. <function>ob_gzhandler</function>
      d&eacute;termine le type d'encodage accept&eacute; par un navigateur,
      et retourne le contenu le plus ad&eacute;quat.
     </para>
    </note>
    <para>
     Les buffers de sortie sont g&eacute;r&eacute;s par pile,
     c'est-&agrave;-dire que vous pouvez appeler plusieurs fois
     <function>ob_start</function> simultan&eacute;ment.
     Assurez-vous que vous appelez <function>ob_end_flush</function>
     suffisamment souvent. Si plusieurs fonctions de callback
     sont actives, les contenus seront filtr&eacute;s
     s&eacute;quentiellement, dans l'ordre d'embo&icirc;tement.
    </para>
    <example>
     <title>Exemple de callback avec fonction utilisateur</title>
     <programlisting role="php">
&lt;?php
function callback($buffer) {
  // remplace toutes les pommes par des oranges
  return (ereg_replace("pommes de terre", "carottes", $buffer));
}
ob_start("callback");
?&gt;
&lt;html&gt;
&lt;body&gt;
&lt;p&gt;C'est comme comparer des carottes et des pommes de terre.
&lt;/body&gt;
&lt;/html&gt;
&lt;?php
 ob_end_flush();
?&gt;
     </programlisting>
    </example>
     <para>
     va afficher :
     <informalexample>
      <programlisting role="php">
&lt;html&gt;
&lt;body&gt;
&lt;p&gt;C'est comme comparer des carottes et des carottes.
&lt;/body&gt;
&lt;/html&gt;
      </programlisting>
     </informalexample>
    </para>
    <para>
     Voir aussi
     <function>ob_get_contents</function>,
     <function>ob_end_flush</function>,
     <function>ob_end_clean</function>,
     <function>ob_implicit_flush</function> et
     <function>ob_gzhandler</function>.
    </para>
   </refsect1>
  </refentry>
  <refentry id="function.ob-gzhandler">
   <refnamediv>
    <refname>ob_gzhandler</refname>
    <refpurpose>
     Fonction de callback pour la compression automatique des buffers
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>string</type><methodname>ob_gzhandler</methodname>
      <methodparam><type>string</type><parameter>buffer</parameter></methodparam>
     </methodsynopsis>
    <para>
     <function>ob_gzhandler</function> est destin&eacute;e &agrave;
     &ecirc;tre utilis&eacute;e comme fonction de callback par
     <function>ob_start</function> pour faciliter l'envoi de
     donn&eacute;es compress&eacute;es aux navigateurs
     qui supportent les pages compress&eacute;es. Avant que
     <function>ob_gzhandler</function> envoie les donn&eacute;es compress&eacute;es,
     il d&eacute;termine les types d'encodage qui sont support&eacute;s par le
     navigateur ("gzip", "deflate" ou aucun) et retourne le
     contenu des buffers de mani&egrave;re appropri&eacute;e. Tous les navigateurs
     sont trait&eacute;s, car c'est aux navigateurs d'envoyer une en-t&ecirc;te
     indiquant les types de pages support&eacute;s.
    </para>
    <para>
     <example>
      <title>
        Exemple d'envoi de page compress&eacute;e avec <function>ob_gzhandler</function>
      </title>
      <programlisting role="php">
&lt;?php
ob_start("ob_gzhandler");
?&gt;
&lt;html&gt;
&lt;body&gt;
&lt;p&gt;Ceci devrait &ecirc;tre une page compress&eacute;e.
&lt;/html&gt;
&lt;/body&gt;
?&gt;
      </programlisting>
     </example>
    </para>
    <para>
     Voir aussi
     <function>ob_start</function> et
     <function>ob_end_flush</function>.
    </para>
   </refsect1>
  </refentry>
  <refentry id="function.ob-get-contents">
   <refnamediv>
    <refname>ob_get_contents</refname>
    <refpurpose>
     Retourne le contenu du buffer de sortie
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>string</type><methodname>ob_get_contents</methodname>
      <void/>
     </methodsynopsis>
    <para>
     <function>ob_get_contents</function> retourne le contenu du buffer
     de sortie si la bufferisation est activ&eacute;e,
     ou &false; sinon.
    </para>
    <para>
     Voir aussi
     <function>ob_start</function> et
     <function>ob_get_length</function>.
    </para>
   </refsect1>
  </refentry>
  <refentry id="function.ob-get-length">
   <refnamediv>
    <refname>ob_get_length</refname>
    <refpurpose>
     Retourne la longueur du contenu du buffer de sortie
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>string</type><methodname>ob_get_length</methodname>
      <void/>
     </methodsynopsis>
    <para>
     <function>ob_get_length</function> retourne la longueur du contenu
     du buffer de sortie si la bufferisation est activ&eacute;e,
     et &false; sinon.
    </para>
    <para>
     Voir aussi
     <function>ob_start</function> et
     <function>ob_get_contents</function>.
    </para>
   </refsect1>
  </refentry>
  <refentry id="function.ob-end-flush">
   <refnamediv>
    <refname>ob_end_flush</refname>
    <refpurpose>
     Envoie les donn&eacute;es du buffer de sortie, et &eacute;teint la
     bufferisation de sortie
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
       <type>void</type><methodname>ob_end_flush</methodname>
      <void/>
     </methodsynopsis>
    <para>
     <function>ob_end_flush</function> envoie le contenu du buffer de sortie (s'il
     existe) et &eacute;teint la bufferisation de sortie. Si vous voulez
     continuer &agrave; manipuler la valeur du buffer, vous pouvez appeler
     <function>ob_get_contents</function> avant <function>ob_end_flush</function>
     car le contenu du buffer est d&eacute;truit apr&egrave;s un appel &agrave;
     <function>ob_end_flush</function>.
    </para>
    <para>
     Voir aussi
     <function>ob_start</function>,
     <function>ob_get_contents</function> et
     <function>ob_end_clean</function>.
    </para>
   </refsect1>
  </refentry>
  <refentry id="function.ob-end-clean">
   <refnamediv>
    <refname>ob_end_clean</refname>
    <refpurpose>
     D&eacute;truit les donn&eacute;es du buffer de sortie, et &eacute;teint
     la bufferisation de sortie
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
       <type>void</type><methodname>ob_end_clean</methodname>
      <void/>
     </methodsynopsis>
    <para>
     <function>ob_end_clean</function> d&eacute;truit les donn&eacute;es
     du buffer de sortie, et &eacute;teint la bufferisation.
    </para>
    <para>
     Voir aussi
     <function>ob_start</function> et
     <function>ob_end_flush</function>.
    </para>
   </refsect1>
  </refentry>
  <refentry id="function.ob-implicit-flush">
   <refnamediv>
    <refname>ob_implicit_flush</refname>
    <refpurpose>
     Active/d&eacute;sactive l'envoi implicite
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
       <type>void</type><methodname>ob_implicit_flush</methodname>
      <methodparam choice="opt"><type>int</type><parameter>flag</parameter></methodparam>
     </methodsynopsis>
    <para>
     <function>ob_implicit_flush</function> active/d&eacute;sactive
     l'envoi implicite (si <parameter>flag</parameter> est fourni.
     Par d&eacute;faut, il est activ&eacute;). L'envoi implicite
     signifie que toute fonction qui envoie des donn&eacute;es
     au navigateur verra ses donn&eacute;es envoy&eacute;es
     imm&eacute;diatement (la fonction <function>flush</function>
     est appel&eacute;e automatiquement).
    </para>
    <para>
     Une fois que l'envoi implicite est d&eacute;sactiv&eacute;, le buffer de sortie ne
     sera envoy&eacute; qu'au moment de l'appel de
     <function>ob_end_flush</function>.
    </para>
    <para>
     Voir aussi
     <function>flush</function>,
     <function>ob_start</function> et
     <function>ob_end_flush</function>.
    </para>
   </refsect1>
  </refentry>
 </reference>
<!-- 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:"../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->