定義済み定数
以下の定数は、PHP コアに含まれており、常に利用可能です。
出力ハンドラに渡されるステータスフラグ
以下のフラグは、ob_start
によってセットされる出力ハンドラの2番目の引数(phase
)
に、ビットマスクの一部として渡されます。
-
PHP_OUTPUT_HANDLER_START
(int)
-
出力バッファリングが始まったことを表します。
-
PHP_OUTPUT_HANDLER_WRITE
(int)
-
出力バッファがフラッシュされ、データが出力されたことを表します。
-
PHP_OUTPUT_HANDLER_FLUSH
(int)
-
バッファがフラッシュされたことを表します。
-
PHP_OUTPUT_HANDLER_CLEAN
(int)
-
出力バッファが消去されたことを表します。
-
PHP_OUTPUT_HANDLER_FINAL
(int)
-
出力バッファリングの最終操作であることを表します。
-
PHP_OUTPUT_HANDLER_CONT
(int)
-
バッファはフラッシュされたけれども、出力バッファリングはまだ続くことを表します。
これは
PHP_OUTPUT_HANDLER_WRITE
のエイリアスです。
-
PHP_OUTPUT_HANDLER_END
(int)
-
出力バッファリングが終わったことを表します。
これは
PHP_OUTPUT_HANDLER_FINAL
のエイリアスです。
出力バッファの制御フラグ
以下のフラグは、ob_start
によってセットされる出力ハンドラの3番目の引数(flags
)
に、ビットマスクの一部として渡されます。
-
PHP_OUTPUT_HANDLER_CLEANABLE
(int)
-
ob_start が作る出力バッファを、
ob_clean がクリーンできるかどうかを設定します。
このフラグは、ob_end_clean や
ob_get_clean の振る舞いは制御しません。
-
PHP_OUTPUT_HANDLER_FLUSHABLE
(int)
-
ob_start が作る出力バッファを、
ob_flush がフラッシュできるかどうかを設定します。
このフラグは、ob_end_flush や
ob_get_flush の振る舞いは制御しません。
-
PHP_OUTPUT_HANDLER_REMOVABLE
(int)
-
ob_start が作る出力バッファを、
スクリプトの終了前や
ob_end_clean, ob_end_flush,
ob_get_clean, ob_get_flush
をコールしたときに削除できるかを設定します。
-
PHP_OUTPUT_HANDLER_STDFLAGS
(int)
-
出力バッファのフラグのデフォルト設定。
PHP_OUTPUT_HANDLER_CLEANABLE
|
PHP_OUTPUT_HANDLER_FLUSHABLE
|
PHP_OUTPUT_HANDLER_REMOVABLE
と同等です。
出力ハンドラのステータスフラグ
以下のフラグは、
ob_get_status が返す
ビットマスク flags
の一部です:
-
PHP_OUTPUT_HANDLER_STARTED
(int)
-
出力ハンドラがコールされたことを示します。
-
PHP_OUTPUT_HANDLER_DISABLED
(int)
-
出力ハンドラが無効になっていることを示します。
このフラグは、出力ハンドラが false
を返したときや
バッファの処理が失敗したときに設定されます。
PHP 8.4.0 より前のバージョンでは、
出力バッファを開始するときにもこのフラグを設定できました。
-
PHP_OUTPUT_HANDLER_PROCESSED
(int)
-
出力ハンドラがバッファの処理に成功したことを示します。
PHP 8.4.0 以降で利用可能です。