Description
bool
ob_start ( [callback output_callback [, int chunk_size [, bool erase]]] )
Cette fonction démarre la tamporisation de sortie.
Tant qu'elle est enclenchée, aucune donnée, hormis
les en-têtes, n'est envoyée au navigateur, mais
temporairement mise en tampon.
Le contenu de ce tampon peut être copié dans une chaîne
avec la fonction ob_get_contents(). Pour afficher le
contenu de ce tampon, utilisez ob_end_flush(). Au
contraire, ob_end_clean() effacera le contenu de ce
tampon.
Une fonction optionnelle de callback peut être spécifiée
en troisième argument. ob_start() prend une
chaîne comme paramètre, et retourne une chaîne.
Elle sera appelée par ob_end_flush() ou
lorsque le tampon sera envoyé au navigateur à la fin du script et
recevra le contenu du tampon de sortie. Lorsque la fonction
output_callback est appelée,
elle doit retourner un nouveau contenu pour le tampon de sortie :
celui-ci sera envoyé au navigateur. Si
output_callback
n'est pas une fonction accessible, la fonction retournera FALSE.
Si la fonction de callback a deux paramètres, le second est composé
du champ bits constitué par
PHP_OUTPUT_HANDLER_START,
PHP_OUTPUT_HANDLER_CONT et
PHP_OUTPUT_HANDLER_END.
Si output_callback retourne FALSE,
l'entrée originale est envoyée au navigateur.
Note :
En PHP 4.0.4, ob_gzhandler() a été
introduite pour faciliter l'envoi de fichiers compressés
avec gz aux navigateurs web qui supportent les pages
compressées. ob_gzhandler()
détermine le type d'encodage accepté par un navigateur,
et retourne le contenu le plus adéquat.
Note :
Avant PHP 4.3.2, cette fonction ne retournait pas FALSE
dans le cas où
output_callback ne pouvait être exécutée.
| Avertissement |
Quelques serveurs web (par exemple Apache) modifient le dossier de travail d'un script
lorsqu'il appelle une fonction de callback. Vous pouvez revenir à un comportement
normal en ajoutant
chdir(dirname($_SERVER['SCRIPT_FILENAME']))
dans votre fonction de callback.
|
Si le paramètre optionnel chunk_size est passé,
la fonction de callback est appelée à chaque nouvelle ligne après
chunk_size octets d'affichage.
Le paramètre output_callback
peut être outrepassé en lui affectant la valeur NULL.
Si le paramètre optionnel erase est défini Ã
FALSE, le tampon ne sera pas effacé tant que le script ne sera pas terminé
(depuis PHP 4.3.0).
Les tampons de sortie sont gérés par pile,
c'est-Ã -dire que vous pouvez appeler plusieurs fois
ob_start() simultanément.
Assurez-vous que vous appelez ob_end_flush()
suffisamment souvent. Si plusieurs fonctions de callback
sont actives, les contenus seront filtrés
séquentiellement, dans l'ordre d'emboîtement.
ob_end_clean(),
ob_end_flush(), ob_clean(),
ob_flush() et ob_start()
ne doivent pas être appelés depuis une fonction de callback.
Si vous les appelez depuis une fonction de callback, le comportement
ne sera pas défini. Si vous voulez effacer le contenu du tampon, retournez ""
(une chaîne vide) comme fonction de callback.
Vous ne pourrez jamais appeler les fonctions utilisant la fonction de
tamporisation de sortie
comme print_r($expression, true) ou
highlight_file($filename, true) depuis une fonction de
callback.
Exemple 1. Exemple de gestion de sortie avec fonction utilisateur
<?php
function callback($buffer) { // remplace toutes les pommes par des carottes return (ereg_replace("pommes de terre", "carottes", $buffer)); }
ob_start("callback");
?>
<html> <body> <p>C'est comme comparer des carottes et des pommes de terre.</p> </body> </html>
<?php
ob_end_flush();
?>
|
L'exemple ci-dessus va afficher :
<html> <body> <p>C'est comme comparer des carottes et des carottes.</p> </body> </html>
|
|
Voir aussi
ob_get_contents(),
ob_end_flush(),
ob_end_clean(),
ob_implicit_flush(),
ob_gzhandler(),
ob_iconv_handler(),
mb_output_handler() et
ob_tidyhandler().