【PHP8.x】ob_get_level関数の使い方

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * ob_get_level() の使用方法を実演します。
7 *
8 * この関数は、出力バッファリングの現在のネストレベルを取得します。
9 * ob_start() を呼び出すたびにレベルが1つ上がり、
10 * ob_end_clean() や ob_end_flush() を呼び出すと1つ下がります。
11 */
12function demonstrateOutputBufferingLevel(): void
13{
14    // 最初は出力バッファリングが開始されていないため、レベルは 0 です。
15    echo '初期レベル: ' . ob_get_level() . PHP_EOL;
16
17    // 出力バッファリングを開始します。
18    ob_start();
19    // レベルが 1 になります。
20    echo 'ob_start() 実行後のレベル: ' . ob_get_level() . PHP_EOL;
21
22    // さらにもう一つ、入れ子（ネスト）でバッファリングを開始します。
23    ob_start();
24    // レベルが 2 になります。
25    echo '2回目の ob_start() 実行後のレベル: ' . ob_get_level() . PHP_EOL;
26
27    // 一番内側のバッファリングを終了します（バッファ内容は破棄されます）。
28    ob_end_clean();
29    // レベルが 1 に戻ります。
30    echo 'ob_end_clean() 実行後のレベル: ' . ob_get_level() . PHP_EOL;
31
32    // 最後のバッファリングを終了します。
33    ob_end_clean();
34    // レベルが 0 に戻ります。
35    echo '最後の ob_end_clean() 実行後のレベル: ' . ob_get_level() . PHP_EOL;
36}
37
38// 作成した関数を実行します。
39demonstrateOutputBufferingLevel();
40
41?>

PHPのob_get_level関数は、出力バッファリングの現在のネストレベル（階層の深さ）を取得するための関数です。この関数は引数を取らず、戻り値として現在のバッファリングレベルを整数で返します。出力バッファリングが開始されていない状態では、レベルは0です。

サンプルコードでは、この関数の動作を段階的に示しています。最初にob_get_level()を呼び出すと、まだバッファリングが開始されていないため0が出力されます。次にob_start()関数でバッファリングを開始すると、レベルが1つ上がり、ob_get_level()は1を返します。さらにもう一度ob_start()を呼び出すと、バッファリングが入れ子（ネスト）状態になり、レベルは2になります。

一方、ob_end_clean()関数を呼び出すと、一番内側のバッファリングが終了し、レベルは1つ下がって1に戻ります。最後にもう一度ob_end_clean()を実行すると、全てのバッファリングが終了し、レベルは0に戻ります。このように、ob_get_level関数は、複数のバッファを管理する際に現在の状態を正確に把握するために利用されます。