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

Copy
1<?php
2
3/**
4 * PHP の ReflectionMethod::getStaticVariables() メソッドのサンプルコード。
5 *
6 * このメソッドは、対象のメソッド内で宣言された静的変数の現在の値を取得するために使用されます。
7 * 静的変数は、メソッドが呼び出されるたびにその状態を保持するため、
8 * リフレクションAPIを使ってその状態を検査することができます。
9 *
10 * 注意: 静的変数は、それが宣言されている行が一度でも実行された後にのみ、
11 * getStaticVariables() を通して利用可能になります。
12 */
13
14class Counter
15{
16    /**
17     * このメソッドが呼び出された回数を数える静的変数を使用します。
18     *
19     * @return int 現在の呼び出し回数
20     */
21    public function incrementAndGetCount(): int
22    {
23        // $callCount は静的変数です。
24        // メソッドが終了してもその値は保持され、次の呼び出しで引き継がれます。
25        static $callCount = 0;
26        $callCount++;
27        return $callCount;
28    }
29}
30
31// Counter クラスのインスタンスを作成します。
32$counterInstance = new Counter();
33
34// incrementAndGetCount メソッドを複数回呼び出し、静的変数の状態を更新します。
35// これにより、$callCount 静的変数が初期化され、その値が変更されます。
36echo "最初の呼び出し: " . $counterInstance->incrementAndGetCount() . "回目\n"; // 出力: 1回目
37echo "二回目の呼び出し: " . $counterInstance->incrementAndGetCount() . "回目\n"; // 出力: 2回目
38
39// ReflectionMethod オブジェクトを作成し、`incrementAndGetCount` メソッドをリフレクションします。
40$reflectionMethod = new ReflectionMethod(Counter::class, 'incrementAndGetCount');
41
42// getStaticVariables() を使用して、`incrementAndGetCount` メソッド内の
43// 静的変数の現在の値を取得します。
44// メソッドがすでに呼び出されているため、$callCount の現在の値が取得できます。
45$staticVariables = $reflectionMethod->getStaticVariables();
46
47echo "\n--- incrementAndGetCount メソッドの静的変数 ---" . "\n";
48// 取得した静的変数の連想配列を表示します。
49// キーは変数名、値はその現在の値です。
50print_r($staticVariables);
51
52/*
53期待される出力:
54Array
55(
56    [callCount] => 2
57)
58*/

ReflectionMethod::getStaticVariablesは、PHPの特定メソッド内で宣言された静的変数の現在の値を取得するためのメソッドです。静的変数は、それが宣言されたメソッドの呼び出しが終了してもその値を保持し続ける特別な変数です。このため、メソッドが複数回呼び出されると、静的変数の値は前回の呼び出しの状態を引き継ぎます。

このメソッドを使用すると、プログラムの実行中に特定のメソッド内の静的変数がどのような状態になっているかを検査できます。引数は不要で、戻り値は静的変数の名前（キー）とその現在の値（値）をペアにした連想配列です。

サンプルコードでは、CounterクラスのincrementAndGetCountメソッド内に$callCountという静的変数を定義しています。このメソッドを複数回呼び出すことで、$callCountの値が1から2へと更新される様子が示されています。

その後、incrementAndGetCountメソッドをリフレクションし、getStaticVariables()を呼び出すことで、更新された$callCountの現在の値である2が取得されます。重要な注意点として、静的変数は、その変数が宣言されている行が一度でも実行された後にのみ、このメソッドを通して取得可能になります。メソッドが一度も実行されていない場合、静的変数はまだ「存在しない」ため、取得できません。これにより、実行時の内部状態を正確に把握することができます。

Copy
1<?php
2
3/**
4 * static変数を持つメソッドの例を示すクラス。
5 * static変数は、そのメソッドが呼び出されるたびに値を保持し続けます。
6 */
7class CounterExample
8{
9    /**
10     * このメソッドが呼び出された回数をカウントし、その値を返します。
11     *
12     * static $callCount は、このメソッドの実行が終了しても破棄されず、
13     * 次にメソッドが呼び出されたときに以前の値を保持しています。
14     *
15     * @return int 現在の呼び出し回数
16     */
17    public static function incrementAndGetCount(): int
18    {
19        static $callCount = 0; // static変数の宣言と初期化
20        $callCount++;          // 呼び出されるたびに値をインクリメント
21        return $callCount;
22    }
23
24    /**
25     * 未呼び出しのstatic変数を持つメソッドの例。
26     */
27    public static function getInitialMessage(): string
28    {
29        static $message = 'Hello, Reflection!';
30        return $message;
31    }
32}
33
34// --- ReflectionMethod::getStaticVariables の使用例 ---
35
36echo "--- CounterExample::incrementAndGetCount の動作確認 ---\n";
37// ターゲットメソッドを数回呼び出し、static変数の値を変更します。
38echo "1回目呼び出し: " . CounterExample::incrementAndGetCount() . "回\n"; // $callCount = 1
39echo "2回目呼び出し: " . CounterExample::incrementAndGetCount() . "回\n"; // $callCount = 2
40echo "3回目呼び出し: " . CounterExample::incrementAndGetCount() . "回\n"; // $callCount = 3
41echo "\n";
42
43echo "--- ReflectionMethod::getStaticVariables でstatic変数を取得 ---\n";
44
45try {
46    // 1. 'incrementAndGetCount' メソッドのリフレクションオブジェクトを作成
47    $reflectionMethod = new ReflectionMethod(CounterExample::class, 'incrementAndGetCount');
48
49    // 2. getStaticVariables() を呼び出し、メソッド内のstatic変数を取得
50    //    戻り値は連想配列で、キーがstatic変数名、値が現在の値です。
51    $staticVariables = $reflectionMethod->getStaticVariables();
52
53    echo "CounterExample::incrementAndGetCount の static変数:\n";
54    print_r($staticVariables);
55    // 期待される出力例: Array ( [callCount] => 3 )
56
57    echo "\n";
58
59    // --- メソッドが一度も呼び出されていない場合のstatic変数の取得例 ---
60    // 'getInitialMessage' メソッドはまだ一度も呼び出されていません。
61    $reflectionMethodUncalled = new ReflectionMethod(CounterExample::class, 'getInitialMessage');
62    $staticVariablesUncalled = $reflectionMethodUncalled->getStaticVariables();
63
64    echo "CounterExample::getInitialMessage (未呼び出し) の static変数:\n";
65    print_r($staticVariablesUncalled);
66    // 期待される出力例: Array ( [message] => Hello, Reflection! )
67    // メソッドが未実行でも、static変数の初期値が取得できます。
68
69} catch (ReflectionException $e) {
70    echo "エラーが発生しました: " . $e->getMessage() . "\n";
71}
72
73?>

PHPのReflectionMethod::getStaticVariablesメソッドは、特定のクラスメソッド内に定義されているstatic変数とその現在の値を取得するために使用されます。static変数は、メソッドの呼び出しが終了してもその値を保持し続ける特殊な変数であり、次回の呼び出し時には以前の値から処理を再開できる点が特徴です。例えば、サンプルコードのCounterExample::incrementAndGetCountメソッド内の$callCountは、呼び出されるたびに値を記憶し、インクリメントを継続します。

このメソッドを使用するには、まずReflectionMethodクラスのインスタンスを生成し、値を調べたいメソッドが属するクラス名とメソッド名を指定します。その後、生成したReflectionMethodインスタンスに対してgetStaticVariables()メソッドを呼び出します。このメソッドは引数を必要としません。戻り値は連想配列となり、キーはstatic変数の名前、値はその変数の現在の値を示します。サンプルコードでは、incrementAndGetCountメソッドが複数回実行された後の$callCountの値や、一度も実行されていないgetInitialMessageメソッド内の$messageの初期値が取得されている様子が示されています。これにより、プログラムの実行中に特定のメソッド内のstatic変数の状態を動的に確認できるようになり、コードのデバッグや解析を行う際に役立ちます。