Improve documentation of output control constants

php/doc-en@2ca114b

Author: mumumu

reference/outcontrol/constants.xml

@@ -1,11 +1,17 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!-- $Revision$ -->
-<!-- EN-Revision: 5e9500ddad6dbc2f1b01d7da8b53379c8b7c386c Maintainer: takagi Status: ready -->
+<!-- EN-Revision: 2ca114baf0105762660cd7a2f0300edc8ceb78c7 Maintainer: takagi Status: ready -->
 <!-- CREDITS: shimooka,hirokawa -->
 <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>
+  <title>出力ハンドラに渡されるステータスフラグ</title>
+  <para>
+   以下のフラグは、<function>ob_start</function>
+   によってセットされる出力ハンドラの2番目の引数(<parameter>phase</parameter>) 
+   に、ビットマスクの一部として渡されます。
+  </para>
   <varlistentry xml:id="constant.php-output-handler-start">
    <term>
     <constant>PHP_OUTPUT_HANDLER_START</constant>
@@ -93,14 +99,25 @@
     </para>
    </listitem>
   </varlistentry>
+ </variablelist>
+ <variablelist>
+  <title>出力バッファの制御フラグ</title>
+  <para>
+   以下のフラグは、<function>ob_start</function>
+   によってセットされる出力ハンドラの3番目の引数(<parameter>flags</parameter>) 
+   に、ビットマスクの一部として渡されます。
+  </para>
   <varlistentry xml:id="constant.php-output-handler-cleanable">
    <term>
     <constant>PHP_OUTPUT_HANDLER_CLEANABLE</constant>
     (<type>int</type>)
    </term>
    <listitem>
     <para>
-     <function>ob_start</function> が作る出力バッファをクリーンできるかどうかを設定します。
+     <function>ob_start</function> が作る出力バッファを、
+     <function>ob_clean</function> がクリーンできるかどうかを設定します。
+     このフラグは、<function>ob_end_clean</function> や
+     <function>ob_get_clean</function> の振る舞いは制御しません。
     </para>
    </listitem>
   </varlistentry>
@@ -111,7 +128,11 @@
    </term>
    <listitem>
     <para>
-     <function>ob_start</function> が作る出力バッファをフラッシュできるかどうかを設定します。
+     <function>ob_start</function> が作る出力バッファを、
+     <function>ob_flush</function> がフラッシュできるかどうかを設定します。
+     このフラグは、<function>ob_end_flush</function> や
+     <function>ob_get_flush</function> の振る舞いは制御しません。
+
     </para>
    </listitem>
   </varlistentry>
@@ -122,7 +143,11 @@
    </term>
    <listitem>
     <para>
-     <function>ob_start</function> が作る出力バッファをスクリプトの終了前に削除できるかどうかを設定します。
+     <function>ob_start</function> が作る出力バッファを、
+     スクリプトの終了前や
+     <function>ob_end_clean</function>, <function>ob_end_flush</function>,
+     <function>ob_get_clean</function>, <function>ob_get_flush</function>
+     をコールしたときに削除できるかを設定します。
     </para>
    </listitem>
   </varlistentry>
@@ -141,6 +166,50 @@
    </listitem>
   </varlistentry>
  </variablelist>
+ <variablelist>
+  <title>出力ハンドラのステータスフラグ</title>
+  <para>
+   以下のフラグは、
+   <function>ob_get_status</function> が返す
+   ビットマスク <literal>flags</literal> の一部です:
+  </para>
+  <varlistentry xml:id="constant.php-output-handler-started">
+   <term>
+    <constant>PHP_OUTPUT_HANDLER_STARTED</constant>
+    (<type>int</type>)
+   </term>
+   <listitem>
+    <para>
+     出力ハンドラがコールされたことを示します。
+    </para>
+   </listitem>
+  </varlistentry>
+  <varlistentry xml:id="constant.php-output-handler-disabled">
+   <term>
+    <constant>PHP_OUTPUT_HANDLER_DISABLED</constant>
+    (<type>int</type>)
+   </term>
+   <listitem>
+    <para>
+     出力ハンドラが無効になっていることを示します。
+     このフラグは、出力ハンドラが &false; を返したときや
+     バッファの処理が失敗したとき、
+     または出力ハンドラをコールする前に設定されたときに設定されます。
+    </para>
+   </listitem>
+  </varlistentry>
+  <varlistentry xml:id="constant.php-output-handler-processed">
+   <term>
+    <constant>PHP_OUTPUT_HANDLER_PROCESSED</constant>
+    (<type>int</type>)
+   </term>
+   <listitem>
+    <para>
+     出力ハンドラがバッファの処理に成功したことを示します。
+    </para>
+   </listitem>
+  </varlistentry>
+ </variablelist>
 </appendix>
 <!-- Keep this comment at the end of the file
 Local variables: