constants.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 2a8768782512db2b95e5da2f032dd0347806d203 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 xml:id="outcontrol.constants.flags-passed-to-handler">
  <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>
    (<type>int</type>)
   </term>
   <listitem>
    <para>
     出力バッファリングが始まったことを表します。
    </para>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.php-output-handler-write">
   <term>
    <constant>PHP_OUTPUT_HANDLER_WRITE</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <para>
     出力バッファがフラッシュされ、データが出力されたことを表します。
    </para>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.php-output-handler-flush">
   <term>
    <constant>PHP_OUTPUT_HANDLER_FLUSH</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <para>
     バッファがフラッシュされたことを表します。
    </para>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.php-output-handler-clean">
   <term>
    <constant>PHP_OUTPUT_HANDLER_CLEAN</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <para>
     出力バッファが消去されたことを表します。
    </para>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.php-output-handler-final">
   <term>
    <constant>PHP_OUTPUT_HANDLER_FINAL</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <para>
     出力バッファリングの最終操作であることを表します。
    </para>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.php-output-handler-cont">
   <term>
    <constant>PHP_OUTPUT_HANDLER_CONT</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <para>
     バッファはフラッシュされたけれども、出力バッファリングはまだ続くことを表します。
    </para>
    <para>
     これは
     <constant>PHP_OUTPUT_HANDLER_WRITE</constant>
     のエイリアスです。
    </para>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.php-output-handler-end">
   <term>
    <constant>PHP_OUTPUT_HANDLER_END</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <para>
     出力バッファリングが終わったことを表します。
    </para>
    <para>
     これは
     <constant>PHP_OUTPUT_HANDLER_FINAL</constant>
     のエイリアスです。
    </para>
   </listitem>
  </varlistentry>
 </variablelist>
 <variablelist xml:id="outcontrol.constants.buffer-control-flags">
  <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_clean</function> がクリーンできるかどうかを設定します。
     このフラグは、<function>ob_end_clean</function> や
     <function>ob_get_clean</function> の振る舞いは制御しません。
    </para>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.php-output-handler-flushable">
   <term>
    <constant>PHP_OUTPUT_HANDLER_FLUSHABLE</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <para>
     <function>ob_start</function> が作る出力バッファを、
     <function>ob_flush</function> がフラッシュできるかどうかを設定します。
     このフラグは、<function>ob_end_flush</function> や
     <function>ob_get_flush</function> の振る舞いは制御しません。

    </para>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.php-output-handler-removable">
   <term>
    <constant>PHP_OUTPUT_HANDLER_REMOVABLE</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <para>
     <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>
  <varlistentry xml:id="constant.php-output-handler-stdflags">
   <term>
    <constant>PHP_OUTPUT_HANDLER_STDFLAGS</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <para>
     出力バッファのフラグのデフォルト設定。
     <constant>PHP_OUTPUT_HANDLER_CLEANABLE</constant> |
     <constant>PHP_OUTPUT_HANDLER_FLUSHABLE</constant> |
     <constant>PHP_OUTPUT_HANDLER_REMOVABLE</constant> と同等です。
    </para>
   </listitem>
  </varlistentry>
 </variablelist>
 <variablelist xml:id="outcontrol.constants.flags-returned-by-handler">
  <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; を返したときや
     バッファの処理が失敗したときに設定されます。
     PHP 8.4.0 より前のバージョンでは、
     出力バッファを開始するときにもこのフラグを設定できました。
    </para>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.php-output-handler-processed">
   <term>
    <constant>PHP_OUTPUT_HANDLER_PROCESSED</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <para>
     出力ハンドラがバッファの処理に成功したことを示します。
     PHP 8.4.0 以降で利用可能です。
    </para>
   </listitem>
  </varlistentry>
 </variablelist>
</appendix>
<!-- 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
-->