Web aym.pekori.to

ob_get_status

(PHP 4 >= 4.2.0, PHP 5)

ob_get_status --  出力バッファのステータスを取得する

説明

array ob_get_status ( [bool full_status=FALSE] )

出力バッファのカレントのステータスを返します。 バッファのステータスを格納した配列が返されるか、エラーの場合に FALSE が返されます。 ob_get_status() は、トップレベルの出力バッファの ステータス情報を返します。full_statusTRUE に設定されている場合は、すべてのアクティブな出力バッファの ステータス情報を返します。

パラメータ full_status を指定していなかったり full_status = FALSE としていた場合は、 以下の要素を保持する配列が返されます。

例 1. 単純な ob_get_status() の出力

Array
(
    [level] => 2
    [type] => 0
    [status] => 0
    [name] => URL-Rewriter
    [del] => 1
)

単純な ob_get_status() の出力結果

キー: level

値: 出力階層レベル

キー: type

値: PHP_OUTPUT_HANDLER_INTERNAL (0) あるいは PHP_OUTPUT_HANDLER_USER (1)

キー: status

値: PHP_OUTPUT_HANDLER_START (0)、PHP_OUTPUT_HANDLER_CONT (1) あるいは PHP_OUTPUT_HANDLER_END (2) のいずれか

キー: name

値: アクティブな出力ハンドラの名前、あるいは設定されていない場合は ' default output handler'

キー: del

値: ob_start() が設定した削除フラグ

full_status = TRUE を指定してコールした場合、 出力バッファごとにひとつの要素を保持する配列が返されます。 出力レベルが配列のキーとして使用され、対応する値として 各出力レベルのステータス情報を配列として保持します。

例 2. 完全な ob_get_status() の出力

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
        )

)

完全な出力には、追加項目として以下の要素が含まれます。

完全な ob_get_status() の出力結果

キー: chunk_size

値: ob_start() で設定したチャンクの大きさ

キー: size

値: ...

キー: blocksize

値: ...

ob_get_level() および ob_list_handlers() も参照ください。