【PHP8.x】ReflectionFunction::getStaticVariables()メソッドの使い方

Copy
1<?php
2
3/**
4 * 静的変数を持つシンプルなカウンター関数です。
5 * この関数が呼び出されるたびに、静的変数 $count の値が増加します。
6 */
7function simpleCounter(): void
8{
9    // 静的変数 $count は、関数が呼び出されるたびに値を保持します。
10    // 初期値は0ですが、2回目以降の呼び出しでは前回の値が保持されます。
11    static $count = 0;
12    $count++;
13    echo "現在のカウンター値: " . $count . "\n";
14}
15
16// 関数を数回呼び出し、静的変数の値を変更します。
17echo "--- カウンター関数の実行 ---\n";
18simpleCounter(); // $count は 1 になる
19simpleCounter(); // $count は 2 になる
20simpleCounter(); // $count は 3 になる
21echo "--------------------------\n\n";
22
23/**
24 * ReflectionFunction を使用して、関数の静的変数を取得するサンプルです。
25 * getStaticVariables() メソッドは、現在の静的変数の状態を返します。
26 */
27function demonstrateStaticVariablesReflection(): void
28{
29    echo "--- ReflectionFunction による静的変数の取得 ---\n";
30
31    try {
32        // 'simpleCounter' 関数に対する ReflectionFunction オブジェクトを作成します。
33        $reflectionFunction = new ReflectionFunction('simpleCounter');
34
35        // getStaticVariables() メソッドを呼び出し、関数の静的変数とその値を取得します。
36        // これは連想配列として返され、キーは変数名、値は現在の変数値を表します。
37        $staticVariables = $reflectionFunction->getStaticVariables();
38
39        if (!empty($staticVariables)) {
40            echo "検出された静的変数:\n";
41            foreach ($staticVariables as $name => $value) {
42                echo "  変数名: \$" . $name . ", 値: " . $value . "\n";
43            }
44        } else {
45            echo "この関数には静的変数が定義されていないか、または取得できませんでした。\n";
46        }
47    } catch (ReflectionException $e) {
48        echo "エラー: " . $e->getMessage() . "\n";
49    }
50    echo "--------------------------------------------------\n";
51}
52
53// 静的変数のリフレクションデモンストレーションを実行します。
54demonstrateStaticVariablesReflection();
55
56?>

このサンプルコードは、PHPにおける静的変数の基本的な動作と、リフレクション機能を用いてその変数の情報を動的に取得する方法を示しています。静的変数とは、関数内で宣言された後もその値が保持され続け、関数が呼び出されるたびに前回の値を引き継ぐ特殊な変数です。

ReflectionFunction::getStaticVariables() メソッドは、指定された関数の内部で定義されている静的変数を取得するために使用されます。このメソッドは引数を必要としません。戻り値は連想配列であり、キーには静的変数の名前（例: "count"）、値にはその変数の現在の値が格納されます。

サンプルコードでは、まずsimpleCounter関数が複数回実行され、静的変数$countの値が1、2、3と変化する様子を示しています。次に、demonstrateStaticVariablesReflection関数内でReflectionFunctionオブジェクトを作成し、simpleCounter関数のgetStaticVariables()を呼び出しています。これにより、simpleCounter関数が最後に呼び出された時点での静的変数$countの現在の値（この例では3）を連想配列として取得し、その内容を表示しています。この機能は、実行中のプログラムの内部状態を動的に調査する際に非常に有用です。

Copy
1<?php
2
3/**
4 * 静的変数を持つシンプルなカウンター関数。
5 * この関数が呼び出されるたびに、静的変数 $count がインクリメントされます。
6 */
7function simpleCounter(): void
8{
9    // static キーワードで定義された変数は、関数呼び出しが終了してもその値を保持します。
10    static $count = 0;
11    $count++;
12    echo "Counter value: " . $count . PHP_EOL;
13}
14
15// 関数を数回呼び出して、静的変数の状態を変更します。
16simpleCounter(); // 出力: Counter value: 1
17simpleCounter(); // 出力: Counter value: 2
18simpleCounter(); // 出力: Counter value: 3
19
20echo PHP_EOL;
21
22// ReflectionFunction クラスを使用して、simpleCounter 関数の情報を取得します。
23// ReflectionFunction は、関数に関する詳細な情報を実行時に取得するためのクラスです。
24$reflectionFunction = new ReflectionFunction('simpleCounter');
25
26// getStaticVariables() メソッドを呼び出し、関数内の静的変数の現在の値を取得します。
27// 戻り値は、変数名をキー、その値をバリューとする連想配列です。
28$staticVariables = $reflectionFunction->getStaticVariables();
29
30echo "--- Static Variables for 'simpleCounter' function ---" . PHP_EOL;
31
32// 取得した静的変数の情報をループで表示します。
33foreach ($staticVariables as $name => $value) {
34    echo "Variable Name: '" . $name . "', Current Value: " . $value . PHP_EOL;
35}
36
37?>

このサンプルコードは、PHPの「静的変数」と、その情報をプログラム実行時に取得する「リフレクション機能」の利用方法を示します。

まず、simpleCounter関数では、staticキーワードで定義された$countという静的変数が使用されています。この静的変数は、関数呼び出しが終了した後も値を保持し続ける特性があり、サンプルでは関数が呼び出されるたびにその値がインクリメントされます。

次に、ReflectionFunctionクラスが使われています。このクラスは、プログラム実行中にPHPの関数に関する詳細な情報を取得するためのものです。ReflectionFunctionオブジェクトのgetStaticVariablesメソッドは、引数を取らずに呼び出すことができ、対象の関数内で定義されているすべての静的変数の現在の値を取得します。戻り値は連想配列となり、キーには静的変数の名前、値にはその変数の現在の値が格納されます。

サンプルコードでは、simpleCounter関数を数回実行して$countの値を変更した後、ReflectionFunction::getStaticVariablesメソッドを使って、その時点での静的変数$countの最終的な値を動的に取得し、表示しています。