ob_get_status

(PHP 4 >= 4.2.0, PHP 5, PHP 7, PHP 8)

ob_get_status — Lit le statut du tampon de sortie

Description

function ob_get_status(bool $full_status = false): array

ob_get_status() retourne les informations sur le statut du tampon d'affichage de haut niveau ou de tous les tampons d'affichage si full_status est défini à true.

Liste de paramètres

full_status

true pour retourner tous les tampons d'affichage. Si vaut false ou non défini, seul le statut du tampon d'affichage de haut niveau sera retourné.

Valeurs de retour

Si le paramètre full_status est omis ou égal à false, un simple tableau contenant des informations sur l'état du niveau de sortie actif est retourné.

Si le paramètre full_status est égal à true, un tableau avec un élément pour chaque niveau de tampon de sortie actif est retourné. Le niveau de sortie est utilisé comme clé du tableau de niveau supérieur et chaque élément du tableau est lui-même un autre tableau contenant des informations sur un niveau de sortie actif.

Un tableau vide est retourné si la mise en mémoire tampon de sortie n'est pas activée.

Éléments retournés par la fonction ob_get_status()
CléValeur
name Nom du gestionnaire de sortie actif (voir les valeurs de retour de ob_list_handlers() pour plus de détails)
type 0 (gestionnaire interne) ou 1 (gestionnaire fourni par l'utilisateur)
flags Masque de bits des indicateurs définis par la fonction ob_start(), le type de gestionnaire de sortie (voir ci-dessus) et l'état du processus de mise en mémoire tampon ( PHP_OUTPUT_HANDLER_* constantes). Si le gestionnaire a traité avec succès le tampon et n'a pas retourné false, PHP_OUTPUT_HANDLER_STARTED et PHP_OUTPUT_HANDLER_PROCESSED seront définis. Si le gestionnaire a échoué lors du traitement du tampon ou a retourné false, PHP_OUTPUT_HANDLER_STARTED et PHP_OUTPUT_HANDLER_DISABLED seront définis.
level Niveau d'imbrication de la sortie (à partir de zéro). Il est à noter que la valeur retournée pour le même niveau par la fonction ob_get_level() est décalée d'un. Le premier niveau est 0 pour ob_get_status(), et 1 pour ob_get_level().
chunk_size Taille du fragment en octets. Définie par la fonction ob_start() ou output_buffering s'il est activé et sa valeur est définie sur un entier positif
buffer_size Taille actuellement allouée du tampon de sortie en octets. Elle démarre à 16384 octets avec le chunk_size par défaut, ou à chunk_size arrondi au prochain multiple de 4096 lorsqu'une valeur est fournie, et croît par multiples de 4096 au fur et à mesure que des données sont mises en tampon. Ce n'est pas la quantité de données dans le tampon (voir buffer_used).
buffer_used Taille des données dans le tampon de sortie en octets (la même que la valeur de retour entière de ob_get_length())

Exemples

Exemple #1 Tableau retourné lorsque le paramètre full_status est égal à false

Array
(
    [name] => URL-Rewriter
    [type] => 0
    [flags] => 112
    [level] => 2
    [chunk_size] => 0
    [buffer_size] => 16384
    [buffer_used] => 1024
)

Exemple #2 Tableau retourné lorsque le paramètre full_status est égal à true

Array
(
    [0] => Array
        (
            [name] => default output handler
            [type] => 0
            [flags] => 112
            [level] => 1
            [chunk_size] => 0
            [buffer_size] => 16384
            [buffer_used] => 2048
        )

    [1] => Array
        (
            [name] => URL-Rewriter
            [type] => 0
            [flags] => 112
            [level] => 2
            [chunk_size] => 0
            [buffer_size] => 16384
            [buffer_used] => 1024
        )

)

Voir aussi

  • ob_get_level() - Retourne le nombre de niveaux d'imbrications du système de temporisation de sortie
  • ob_list_handlers() - Liste les gestionnaires d'affichage utilisés
  • ob_get_length() - Retourne la longueur du contenu du tampon de sortie
  • ob_start() - Enclenche la temporisation de sortie

Found A Problem?

Learn How To Improve This Page • Submit a Pull Request • Report a Bug
＋add a note

User Contributed Notes 1 note

up
4
rmagalhaess at hotmail dot com
8 years ago
The fields inside the array returned by ob_get_status() are:

Array
(
    [name] => default output handler
    [type] => 0
    [flags] => 112
    [level] => 1
    [chunk_size] => 0
    [buffer_size] => 16384
    [buffer_used] => 0
)

These values are filled just after the function ob_start()
＋add a note