doc-fr/reference/outcontrol/functions/ob-get-status.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 55f70d19870c396f3bf86b6c45826da3cb7e525f 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 la fonction est appelée sans le paramètre <parameter>full_status</parameter>
   ou avec le paramètre <parameter>full_status</parameter> = &false;, un tableau simple avec
   les éléments suivants sera retourné :
   <informalexample>
    <screen>
<![CDATA[
Array
(
    [level] => 2
    [type] => 0
    [status] => 0
    [name] => URL-Rewriter
    [del] => 1
)
]]>
    </screen>
   </informalexample>
   <segmentedlist>
    <title>Résultats simples pour la fonction <function>ob_get_status</function></title>
    <segtitle>Clé</segtitle>
    <segtitle>Valeur</segtitle>
    <seglistitem>
     <seg>level</seg>
     <seg>Niveau de sortie désiré</seg>
    </seglistitem>
    <seglistitem>
     <seg>type</seg>
     <seg><literal>0</literal> (gestionnaire interne) ou <literal>1</literal> (gestionnaire fournit par l'utilisateur)</seg>
    </seglistitem>
    <seglistitem>
     <seg>status</seg>
     <seg>Un parmi <literal>PHP_OUTPUT_HANDLER_START</literal> (0), <literal>PHP_OUTPUT_HANDLER_CONT</literal> (1) ou <literal>PHP_OUTPUT_HANDLER_END</literal> (2)</seg>
    </seglistitem>
    <seglistitem>
     <seg>name</seg>
     <seg>Nom du gestionnaire de sortie actif ou ' default output handler' si aucun n'est défini</seg>
    </seglistitem>
    <seglistitem>
     <seg>del</seg>
     <seg>Flag d'effacement tel que défini par <function>ob_start</function></seg>
    </seglistitem>
   </segmentedlist>
  </para>
  <para>
   Si la fonction est appelée avec le paramètre <parameter>full_status</parameter>
   défini à &true;, un tableau avec un élément par tampon de sortie actif est
   retourné. Le niveau de sortie est utilisé en tant que clé du tableau de
   niveau élevé et chaque élément du tableau est un autre tableau contenant les
   informations sur le statut du niveau du tampon actif.
   <informalexample>
    <screen>
<![CDATA[
Array
(
    [0] => Array
        (
            [chunk_size] => 0
            [size] => 40960
            [block_size] => 10240
            [type] => 1
            [status] => 0
            [name] => default output handler
            [del] => 1
        )

    [1] => Array
        (
            [chunk_size] => 0
            [size] => 40960
            [block_size] => 10240
            [type] => 0
            [buffer_size] => 0
            [status] => 0
            [name] => URL-Rewriter
            [del] => 1
        )

)
]]>
    </screen>
   </informalexample>
  </para>
  <para>
   La sortie complète contient les éléments suivants :
   <segmentedlist>
    <title>Résultats complets pour la fonction <function>ob_get_status</function></title>
    <segtitle>Clé</segtitle>
    <segtitle>Valeur</segtitle>
    <seglistitem>
     <seg>chunk_size</seg>
     <seg>Taille telle que définie par la fonction <function>ob_start</function></seg>
    </seglistitem>
    <seglistitem>
     <seg>size</seg>
     <seg>...</seg></seglistitem>
    <seglistitem>
     <seg>blocksize</seg>
     <seg>...</seg>
    </seglistitem>
   </segmentedlist>
  </para>
 </refsect1>

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