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

Copy
1<?php
2
3/**
4 * 静的変数（static variable）を持つシンプルなカウンター関数。
5 * この関数は呼び出されるたびに、staticキーワードで定義された変数の値を保持し更新します。
6 */
7function simpleCounter()
8{
9    // staticキーワードで定義された変数は、関数が終了してもその値を保持し続けます。
10    // 初回呼び出し時のみ初期化され、以降は前回の値を引き継ぎます。
11    static $count = 0;
12    $count++;
13    echo "カウンター値: " . $count . PHP_EOL;
14}
15
16// 関数を複数回呼び出し、静的変数`$count`が値を保持していることを確認します。
17simpleCounter(); // 出力例: カウンター値: 1
18simpleCounter(); // 出力例: カウンター値: 2
19simpleCounter(); // 出力例: カウンター値: 3
20
21// ReflectionFunctionクラスを使用して、`simpleCounter`関数のリフレクション情報を取得します。
22// ReflectionFunctionはReflectionFunctionAbstractを継承しており、
23// getStaticVariablesメソッドを利用できます。
24$reflectionFunction = new ReflectionFunction('simpleCounter');
25
26// getStaticVariables()メソッドを呼び出し、`simpleCounter`関数内に定義されている
27// 静的変数の情報（名前と現在の値）を取得します。
28// 戻り値は、静的変数の名前をキーとし、その現在の値を値とする連想配列です。
29$staticVariables = $reflectionFunction->getStaticVariables();
30
31echo PHP_EOL . "--- 'simpleCounter' 関数内の静的変数情報 ---" . PHP_EOL;
32print_r($staticVariables);
33
34/*
35上記のコードを実行すると、以下のような出力が得られます。
36
37カウンター値: 1
38カウンター値: 2
39カウンター値: 3
40
41--- 'simpleCounter' 関数内の静的変数情報 ---
42Array
43(
44    [count] => 3
45)
46
47これは、$countという静的変数が現在の値として3を持っていることを示しており、
48getStaticVariablesメソッドが正しく静的変数の情報を取得していることがわかります。
49*/

PHPにおいて、staticキーワードで定義された静的変数は、関数が実行を終了してもその値を保持し続けます。サンプルコードのsimpleCounter関数では、static $count = 0;と定義された$count変数が呼び出されるたびに値を保持し、1ずつ増加します。3回呼び出し後、$countの値は3となります。

ReflectionFunctionAbstract::getStaticVariablesメソッドは、PHPのリフレクションAPIの一部で、プログラム実行時に特定の関数が持つ静的変数の情報を取得するために使用されます。このメソッドは引数を必要とせず、関数内で定義されている静的変数の名前をキー、その現在の値を値とする連想配列を戻り値として返します。ReflectionFunctionクラスがReflectionFunctionAbstractを継承しており、このメソッドを利用できます。

サンプルコードでは、simpleCounter関数のリフレクション情報を持つReflectionFunctionインスタンスを作成し、getStaticVariables()メソッドを呼び出しています。これにより、simpleCounter関数内で保持されている静的変数$countの現在の値「3」が、['count' => 3]という連想配列として取得されます。出力結果からも、この情報が正しく取得されていることが確認できます。この機能は、プログラムの内部状態を動的に確認する際に役立ちます。

Copy
1<?php
2
3/**
4 * static (静的) 変数を持つ関数を定義します。
5 * この関数が呼び出されるたびに、static変数の値は保持され、増加します。
6 * 通常のローカル変数とは異なり、関数の呼び出しが終了しても値はリセットされません。
7 */
8function myCounter(): void
9{
10    // static変数を宣言。初めて関数が呼び出されたときに一度だけ初期化されます。
11    static $count = 0;
12    $count++;
13    echo "myCounter() が呼び出されました。現在のカウント: " . $count . "\n";
14}
15
16// 関数を複数回呼び出し、static変数の挙動を確認します。
17myCounter(); // 出力: myCounter() が呼び出されました。現在のカウント: 1
18myCounter(); // 出力: myCounter() が呼び出されました。現在のカウント: 2
19myCounter(); // 出力: myCounter() が呼び出されました。現在のカウント: 3
20
21// ReflectionFunction を使用して、定義した関数のリフレクションオブジェクトを作成します。
22// これにより、実行時にその関数の構造や状態に関する情報を取得できます。
23$reflectionFunction = new ReflectionFunction('myCounter');
24
25echo "\n--- ReflectionFunction::getStaticVariables() の結果 ---\n";
26
27// getStaticVariables() メソッドを呼び出して、関数内のすべてのstatic変数を取得します。
28// 戻り値は、変数名をキーとし、その値を値とする連想配列です。
29$staticVariables = $reflectionFunction->getStaticVariables();
30
31// 取得したstatic変数をループで表示します。
32if (!empty($staticVariables)) {
33    foreach ($staticVariables as $name => $value) {
34        echo "静的変数名: '" . $name . "', 現在の値: " . $value . "\n";
35    }
36} else {
37    echo "この関数には静的変数がありません。\n";
38}
39
40?>

PHPのstatic変数は、関数内で宣言されると、その関数の呼び出しが終了しても値がリセットされず、次回の呼び出し時に前回の値が保持される特別な変数です。サンプルコードのmyCounter()関数では、static $countが呼び出しごとに増加し、その値が引き継がれていることが分かります。

ReflectionFunctionAbstract::getStaticVariablesは、PHPのリフレクション機能を使って、特定の関数の内部情報を取得するためのメソッドです。リフレクション機能は、プログラムの実行中にコードの構造や状態を調べたいときに利用されます。このメソッドは、ReflectionFunctionオブジェクトが表す関数内で定義されている全てのstatic変数を取得します。

このメソッドに引数はなく、戻り値は連想配列です。配列のキーにはstatic変数の名前が、値にはその変数の現在の値が格納されます。

サンプルコードでは、myCounter()関数を複数回実行し、static $countの値を変更した後、ReflectionFunctionクラスを使ってmyCounter()関数の情報を取得しています。そして、getStaticVariables()メソッドを呼び出すことで、関数実行後のstatic $countの最終的な値がプログラム的に取得できる様子を示しています。これにより、実行時のstatic変数の状態を動的に確認することが可能です。