outcontrol section sync

php · Jan 8, 2024 · 14988cb · 14988cb
1 parent 95313ad
commit 14988cb
Show file tree

Hide file tree

Showing 9 changed files with 175 additions and 112 deletions.
diff --git a/reference/outcontrol/constants.xml b/reference/outcontrol/constants.xml
@@ -1,12 +1,12 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!-- $Revision$ -->
-<!-- EN-Revision: 2ca114baf0105762660cd7a2f0300edc8ceb78c7 Maintainer: yannick Status: ready -->
+<!-- EN-Revision: af7044e82ac0abe745ce3dfe2169e69a7e8e342f Maintainer: yannick Status: ready -->
 <!-- Reviewed: no -->
 
 <appendix xml:id="outcontrol.constants" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
  &reftitle.constants;
  &extension.constants.core;
- <variablelist>
+ <variablelist xml:id="outcontrol.constants.flags-passed-to-handler">
   <title>Indicateurs d'état transmis au gestionnaire de sortie</title>
   <para>
    Les indicateurs suivants sont transmis au deuxième paramètre (<parameter>phase</parameter>) du gestionnaire de sortie défini par
@@ -100,7 +100,7 @@
    </listitem>
   </varlistentry>
   </variablelist>
-  <variablelist>
+  <variablelist xml:id="outcontrol.constants.buffer-control-flags">
    <title>Indicateurs de contrôle du tampon de sortie</title>
    <para>
     Les indicateurs suivants peuvent être transmis au troisième paramètre (<parameter>flags</parameter>) du gestionnaire de sortie défini par
@@ -166,7 +166,7 @@
    </listitem>
   </varlistentry>
  </variablelist>
- <variablelist>
+ <variablelist xml:id="outcontrol.constants.flags-returned-by-handler">
   <title>Indicateurs d'état du gestionnaire de sortie</title>
   <para>
    Les indicateurs suivants font partie du masque de bits <literal>flags</literal>

diff --git a/reference/outcontrol/functions/ob-clean.xml b/reference/outcontrol/functions/ob-clean.xml
@@ -1,11 +1,11 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!-- $Revision$ -->
-<!-- EN-Revision: 6ab6ea465889620fc2a8cdaf7b008cbaed83c523 Maintainer: yannick Status: ready -->
+<!-- EN-Revision: 86b976d5afaf037868174fe5c242e886eb69baa4 Maintainer: yannick Status: ready -->
 <!-- Reviewed: yes -->
 <refentry xml:id="function.ob-clean" xmlns="http://docbook.org/ns/docbook">
  <refnamediv>
   <refname>ob_clean</refname>
-  <refpurpose>Efface le tampon de sortie</refpurpose>
+  <refpurpose>Nettoyer (effacer) le contenu du tampon de sortie actif.</refpurpose>
  </refnamediv>
 
  <refsect1 role="description">
@@ -15,19 +15,19 @@
    <void/>
   </methodsynopsis>
   <para>
-   Cette fonction vide le tampon de sortie sans
-   l'envoyer au navigateur.
+   Cette fonction appelle le gestionnaire de sortie
+   (avec le drapeau <constant>PHP_OUTPUT_HANDLER_CLEAN</constant>),
+   ignore sa valeur de retour
+   et nettoie (efface) le contenu du tampon de sortie actif.
   </para>
   <para>
-   Cette fonction ne détruit pas le contenu du tampon de
-   sortie comme peut le faire
-   <function>ob_end_clean</function>.
+   Cette fonction ne désactive pas le tampon de sortie actif comme le font
+   <function>ob_end_clean</function> ou <function>ob_get_clean</function>.
   </para>
   <para>
-   Le tampon de sortie doit avoir été démarré avec la fonction
-   <function>ob_start</function> et le drapeau <link
-   linkend="constant.php-output-handler-cleanable">PHP_OUTPUT_HANDLER_CLEANABLE</link>.
-   Sinon, la fonction <function>ob_clean</function> ne fonctionnera pas.
+   <function>ob_clean</function> échouera
+   sans un tampon de sortie actif démarré avec le drapeau
+   <constant>PHP_OUTPUT_HANDLER_CLEANABLE</constant>.
   </para>
  </refsect1>
 
@@ -43,6 +43,13 @@
   </para>
  </refsect1>
 
+ <refsect1 role="errors">
+  &reftitle.errors;
+  <para>
+   Si la fonction échoue, elle génère une <constant>E_NOTICE</constant>.
+  </para>
+ </refsect1>
+
  <refsect1 role="seealso">
   &reftitle.seealso;
   <para>

diff --git a/reference/outcontrol/functions/ob-end-clean.xml b/reference/outcontrol/functions/ob-end-clean.xml
@@ -1,12 +1,12 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!-- $Revision$ -->
-<!-- EN-Revision: 6ab6ea465889620fc2a8cdaf7b008cbaed83c523 Maintainer: yannick Status: ready -->
+<!-- EN-Revision: 86b976d5afaf037868174fe5c242e886eb69baa4 Maintainer: yannick Status: ready -->
 <!-- Reviewed: yes -->
 
 <refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.ob-end-clean">
  <refnamediv>
   <refname>ob_end_clean</refname>
-  <refpurpose>Détruit les données du tampon de sortie et éteint la temporisation de sortie</refpurpose>
+  <refpurpose>Effacez (nettoyez) le contenu du tampon de sortie actif et désactivez-le.</refpurpose>
  </refnamediv>
 
  <refsect1 role="description">
@@ -16,20 +16,23 @@
    <void/>
   </methodsynopsis>
   <para>
-   Cette fonction efface le contenu du premier
-   tampon de sortie et désactive la temporisation de sortie.
-   Si vous voulez traiter le contenu du tampon, vous devrez 
-   appeler <function>ob_get_contents</function> avant
-   <function>ob_end_clean</function>, car le tampon est
-   détruit par <function>ob_end_clean</function>.
+   Cette fonction appelle le gestionnaire de sortie
+   (avec les drapeaux <constant>PHP_OUTPUT_HANDLER_CLEAN</constant> et
+   <constant>PHP_OUTPUT_HANDLER_FINAL</constant>),
+   ignore sa valeur de retour,
+   ignore le contenu du tampon de sortie actif
+   et désactive ce dernier.
   </para>
   <para>
-   Le tampon de sortie doit avoir été démarré avec la fonction
-   <function>ob_start</function> et les drapeaux <link
-   linkend="constant.php-output-handler-cleanable">PHP_OUTPUT_HANDLER_CLEANABLE</link>
-   et <link
-   linkend="constant.php-output-handler-removable">PHP_OUTPUT_HANDLER_REMOVABLE</link>.
-   Sinon, la fonction <function>ob_end_clean</function> ne fonctionnera pas.
+   <function>ob_end_clean</function> échouera
+   sans un tampon de sortie actif démarré avec le drapeau
+   <constant>PHP_OUTPUT_HANDLER_REMOVABLE</constant>.
+  </para>
+  <para>
+   <function>ob_end_clean</function>
+   supprimera le contenu du tampon de sortie actif
+   même s'il a été démarré sans le drapeau
+   <constant>PHP_OUTPUT_HANDLER_CLEANABLE</constant>.
   </para>
  </refsect1>
 
@@ -41,9 +44,7 @@
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-   &return.success; Les raisons d'un tel échec sont que la
-   temporisation de sortie pouvait ne pas être activée, ou que, pour 
-   une raison quelconque, le tampon n'a pu être détruit.
+   &return.success;
   </para>
  </refsect1>
 
@@ -57,8 +58,8 @@
  <refsect1 role="examples">
   &reftitle.examples;
   <para>
-   L'exemple suivant montre comment se débarrasser de tous les 
-   tampons de sortie :
+   L'exemple suivant montre une manière simple de se débarrasser du
+   contenu du tampon de sortie actif :
   </para>
   <para>
    <example>
@@ -82,7 +83,9 @@ ob_end_clean();
    <simplelist>
     <member><function>ob_start</function></member>
     <member><function>ob_get_contents</function></member>
-    <member><function>ob_flush</function></member>
+    <member><function>ob_clean</function></member>
+    <member><function>ob_get_clean</function></member>
+    <member><function>ob_end_flush</function></member>
    </simplelist>
   </para>
  </refsect1>

diff --git a/reference/outcontrol/functions/ob-end-flush.xml b/reference/outcontrol/functions/ob-end-flush.xml
@@ -1,12 +1,15 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!-- $Revision$ -->
-<!-- EN-Revision: 6ab6ea465889620fc2a8cdaf7b008cbaed83c523 Maintainer: yannick Status: ready -->
+<!-- EN-Revision: 86b976d5afaf037868174fe5c242e886eb69baa4 Maintainer: yannick Status: ready -->
 <!-- Reviewed: yes -->
 
 <refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.ob-end-flush">
  <refnamediv>
   <refname>ob_end_flush</refname>
-  <refpurpose>Envoie les données du tampon de sortie et éteint la temporisation de sortie</refpurpose>
+  <refpurpose>
+   Vide (envoie) la valeur de retour du gestionnaire de sortie actif
+   et désactive le tampon de sortie actif
+  </refpurpose>
  </refnamediv>
 
  <refsect1 role="description">
@@ -16,27 +19,23 @@
    <void/>
   </methodsynopsis>
   <para>
-   Envoie le contenu du tampon de sortie (s'il existe) et éteint la
-   temporisation de sortie. Si vous voulez continuer à manipuler la
-   valeur du tampon, vous pouvez appeler <function>ob_get_contents</function>
-   avant <function>ob_end_flush</function> car le contenu du tampon
-   est détruit après un appel à <function>ob_end_flush</function>.
+   Cette fonction appelle le gestionnaire de sortie
+   (avec le drapeau <constant>PHP_OUTPUT_HANDLER_FINAL</constant>),
+   vide (envoie) sa valeur de retour,
+   ignore le contenu du tampon de sortie actif
+   et désactive ce dernier.
   </para>
   <para>
-   Le tampon de sortie doit avoir été démarré avec la fonction
-   <function>ob_start</function> et les drapeaux <link
-   linkend="constant.php-output-handler-flushable">PHP_OUTPUT_HANDLER_FLUSHABLE</link>
-   et <link
-   linkend="constant.php-output-handler-removable">PHP_OUTPUT_HANDLER_REMOVABLE</link>.
-   Sinon, la fonction <function>ob_end_flush</function> ne fonctionnera pas.
+   <function>ob_end_flush</function> échouera
+   sans un tampon de sortie actif démarré avec le drapeau
+   <constant>PHP_OUTPUT_HANDLER_REMOVABLE</constant>.
+  </para>
+  <para>
+   <function>ob_end_flush</function> videra (enverra)
+   la valeur de retour du gestionnaire de sortie
+   même si le tampon de sortie actif a été démarré sans le drapeau
+   <constant>PHP_OUTPUT_HANDLER_FLUSHABLE</constant>.
   </para>
-  <note>
-   <simpara>
-    Cette fonction est similaire à <function>ob_get_flush</function>, excepté
-    que <function>ob_get_flush</function> retourne le tampon comme une chaîne
-    de caractères.
-   </simpara>
-  </note>
  </refsect1>
 
  <refsect1 role="parameters">
@@ -47,10 +46,7 @@
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-   &return.success; Les raisons d'échec sont que vous pourriez avoir
-   appelé la fonction sans avoir de tampon actif, ou que, pour une
-   raison quelconque, le tampon n'a pu être effacé (possible pour un
-   tampon spécial).
+   &return.success;
   </para>
  </refsect1>
 
@@ -87,8 +83,8 @@ while (@ob_end_flush());
    <simplelist>
     <member><function>ob_start</function></member>
     <member><function>ob_get_contents</function></member>
-    <member><function>ob_get_flush</function></member>
     <member><function>ob_flush</function></member>
+    <member><function>ob_get_flush</function></member>
     <member><function>ob_end_clean</function></member>
    </simplelist>
   </para>

diff --git a/reference/outcontrol/functions/ob-flush.xml b/reference/outcontrol/functions/ob-flush.xml
@@ -1,11 +1,11 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!-- $Revision$ -->
-<!-- EN-Revision: 6ab6ea465889620fc2a8cdaf7b008cbaed83c523 Maintainer: yannick Status: ready -->
+<!-- EN-Revision: 86b976d5afaf037868174fe5c242e886eb69baa4 Maintainer: yannick Status: ready -->
 <!-- Reviewed: yes -->
 <refentry xml:id="function.ob-flush" xmlns="http://docbook.org/ns/docbook">
  <refnamediv>
   <refname>ob_flush</refname>
-  <refpurpose>Envoie le tampon de sortie</refpurpose>
+  <refpurpose>Vide (envoie) la valeur de retour du gestionnaire de sortie actif.</refpurpose>
  </refnamediv>
 
  <refsect1 role="description">
@@ -15,14 +15,19 @@
    <void/>
   </methodsynopsis>
   <para>
-   Envoie le contenu du tampon de sortie (s'il y en a un). Si vous voulez
-   vérifier le contenu du tampon, vous devez appeler la fonction
-   <function>ob_get_contents</function> avant <function>ob_flush</function>
-   car le contenu du tampon est effacé après l'appel de <function>ob_flush</function>.
+   Cette fonction appelle le gestionnaire de sortie
+   (avec le drapeau <constant>PHP_OUTPUT_HANDLER_FLUSH</constant>),
+   vide (envoie) sa valeur de retour
+   et ignore le contenu du tampon de sortie actif.
   </para>
   <para>
-   <function>ob_flush</function> ne désactive pas la temporisation de sortie
-   comme peut le faire <function>ob_end_flush</function>.
+   Cette fonction ne désactive pas le tampon de sortie actif comme le font
+   <function>ob_end_flush</function> ou <function>ob_get_flush</function>.
+  </para>
+  <para>
+   <function>ob_flush</function> échouera
+   sans un tampon de sortie actif démarré avec le drapeau
+   <constant>PHP_OUTPUT_HANDLER_FLUSHABLE</constant>.
   </para>
  </refsect1>
 
@@ -38,14 +43,22 @@
   </para>
  </refsect1>
 
+ <refsect1 role="errors">
+  &reftitle.errors;
+  <para>
+   En cas d'échec de la fonction, elle génère une <constant>E_NOTICE</constant>.
+  </para>
+ </refsect1>
+
  <refsect1 role="seealso">
   &reftitle.seealso;
   <para>
    <simplelist>
+    <member><function>ob_start</function></member>
     <member><function>ob_get_contents</function></member>
-    <member><function>ob_clean</function></member>
     <member><function>ob_end_flush</function></member>
-    <member><function>ob_end_clean</function></member>
+    <member><function>ob_get_flush</function></member>
+    <member><function>ob_clean</function></member>
    </simplelist>
   </para>
  </refsect1>