ob-get-status.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: af7044e82ac0abe745ce3dfe2169e69a7e8e342f Maintainer: yannick Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.ob-get-status" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>ob_get_status</refname>
  <refpurpose>Lit le statut du tampon de sortie</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>array</type><methodname>ob_get_status</methodname>
   <methodparam choice="opt"><type>bool</type><parameter>full_status</parameter><initializer>&false;</initializer></methodparam>
  </methodsynopsis>
  <para>
   <function>ob_get_status</function> retourne les informations sur le statut
   du tampon d'affichage de haut niveau ou de tous les tampons d'affichage si
   <parameter>full_status</parameter> est défini à &true;.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>full_status</parameter></term>
     <listitem>
      <para>
       &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é.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Si le paramètre <parameter>full_status</parameter> est omis ou égal à &false;, un simple tableau
   contenant des informations sur l'état du niveau de sortie actif est retourné.
  </para>
  <para>
   Si le paramètre <parameter>full_status</parameter> 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.
  </para>
  <para>
   Un tableau vide est retourné si la mise en mémoire tampon de sortie n'est pas activée.
  </para>
  <para>
   <segmentedlist>
    <title>Éléments retourné par la fonction <function>ob_get_status</function></title>
    <segtitle>Clé</segtitle><segtitle>Valeur</segtitle>
    <seglistitem>
     <seg>name</seg>
     <seg>
      Nom du gestionnaire de sortie actif (voir les valeurs de retour de
      <function>ob_list_handlers</function> pour plus de détails)
     </seg>
    </seglistitem>
    <seglistitem>
     <seg>type</seg>
     <seg>
      <literal>0</literal> (gestionnaire interne) ou
      <literal>1</literal> (gestionnaire fourni par l'utilisateur)
     </seg>
    </seglistitem>
    <seglistitem>
     <seg>flags</seg>
     <seg>
      Masque de bits des indicateurs définis par la fonction <function>ob_start</function>,
      le type de gestionnaire de sortie (voir ci-dessus)
      et l'état du processus de mise en mémoire tampon
      (<link linkend="outcontrol.constants.flags-returned-by-handler">
       <constant>PHP_OUTPUT_HANDLER_<replaceable>*</replaceable></constant>
      </link> constantes).
      Si le gestionnaire a traité avec succès le tampon et n'a pas retourné &false;,
      <constant>PHP_OUTPUT_HANDLER_STARTED</constant> et
      <constant>PHP_OUTPUT_HANDLER_PROCESSED</constant> seront définis.
      Si le gestionnaire a échoué lors du traitement du tampon ou a retourné &false;,
      <constant>PHP_OUTPUT_HANDLER_STARTED</constant> et
      <constant>PHP_OUTPUT_HANDLER_DISABLED</constant> seront définis.
     </seg>
    </seglistitem>
    <seglistitem>
     <seg>level</seg>
     <seg>
      Niveau d'imbrication de la sortie (à partir de zéro). Notez que la valeur retournée pour le
      même niveau par la fonction <function>ob_get_level</function> est décalée d'un.
      Le premier niveau est <literal>0</literal> pour <function>ob_get_status</function>,
      et <literal>1</literal> pour <function>ob_get_level</function>.
     </seg>
    </seglistitem>
    <seglistitem>
     <seg>chunk_size</seg>
     <seg>
      Taille du fragment en octets. Défini par la fonction <function>ob_start</function>
      ou <link linkend="ini.output-buffering">output_buffering</link> s'il est activé
      et sa valeur est définie sur un entier positif
     </seg>
    </seglistitem>
    <seglistitem>
     <seg>buffer_size</seg>
     <seg>
      Taille du tampon de sortie en octets
     </seg>
    </seglistitem>
    <seglistitem>
     <seg>buffer_used</seg>
     <seg>
      Taille des données dans le tampon de sortie en octets
      (la même que la valeur de retour entière de <function>ob_get_length</function>)
     </seg>
    </seglistitem>
   </segmentedlist>
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
    <example>
    <title>Tableau retourné lorsque le paramètre <parameter>full_status</parameter> est égal à &true;</title>
    <screen>
<![CDATA[
Array
(
    [type] => 0
    [flags] => 112
    [level] => 2
    [chunk_size] => 0
    [buffer_size] => 16384
    [buffer_used] => 1024
)
]]>
    </screen>
   </example>
  </para>
  <para>
   <example>
    <title>Tableau retourné lorsque le paramètre <parameter>full_status</parameter> est égal à &true;</title>
    <screen>
<![CDATA[
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
        )

)
]]>
    </screen>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>ob_get_level</function></member>
    <member><function>ob_list_handlers</function></member>
    <member><function>ob_get_length</function></member>
    <member><function>ob_start</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
-->