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

Copy
1<?php
2
3/**
4 * 静的プロパティを持つサンプルクラス。
5 * ReflectionClass::getStaticProperties() メソッドで取得されるプロパティの例を提供します。
6 */
7class MyClass
8{
9    // 公開静的プロパティ
10    public static string $publicStaticProperty = 'Hello Public Static';
11
12    // 保護静的プロパティ（getStaticPropertiesで取得可能）
13    protected static int $protectedStaticProperty = 12345;
14
15    // 非公開静的プロパティ（getStaticPropertiesで取得可能）
16    private static bool $privateStaticProperty = true;
17
18    // 配列型の静的プロパティ
19    public static array $arrayStaticProperty = ['item1', 'item2'];
20}
21
22/**
23 * 指定されたクラスの全ての静的プロパティを取得し、その名前と値を表示します。
24 *
25 * PHPのReflectionClass::getStaticProperties() メソッドの使用例を示します。
26 * このメソッドは、public, protected, private すべてのアクセス修飾子を持つ
27 * 静的プロパティをプロパティ名とその値の連想配列として返します。
28 *
29 * @param string $className プロパティを取得するクラスの完全修飾名。
30 */
31function displayClassStaticProperties(string $className): void
32{
33    try {
34        // ReflectionClassのインスタンスを生成し、クラスの情報を取得します。
35        $reflector = new ReflectionClass($className);
36
37        echo "クラス '{$className}' の静的プロパティ:\n";
38
39        // getStaticProperties() メソッドを使って、クラスの全ての静的プロパティを取得します。
40        $staticProperties = $reflector->getStaticProperties();
41
42        if (empty($staticProperties)) {
43            echo "  静的プロパティは見つかりませんでした。\n";
44        } else {
45            foreach ($staticProperties as $name => $value) {
46                // プロパティの名前とその値を分かりやすい形式で出力します。
47                echo "  プロパティ名: {$name}, 値: " . var_export($value, true) . "\n";
48            }
49        }
50
51    } catch (ReflectionException $e) {
52        // クラスが存在しないなどのエラーが発生した場合に、例外を捕捉します。
53        echo "エラー: クラス '{$className}' のリフレクションに失敗しました - " . $e->getMessage() . "\n";
54    }
55}
56
57// 上記で定義したMyClassの静的プロパティを表示する例を実行します。
58displayClassStaticProperties(MyClass::class);
59

PHPのReflectionClass::getStaticPropertiesメソッドは、指定したクラスの静的プロパティを動的に取得します。これは、実行中にプログラムの構造を検査する「リフレクション」機能の一部です。

利用するには、ReflectionClassのインスタンスを作成し、クラス名を指定します。その後、そのインスタンスから引数なしでgetStaticProperties()メソッドを呼び出します。戻り値は配列で、クラスに定義されているpublic、protected、private全ての静的プロパティが、プロパティ名と値の連想配列として返されます。

サンプルコードでは、MyClassの静的プロパティが、displayClassStaticProperties関数内でgetStaticProperties()により取得・表示される様子が示されています。これにより、実行中にクラスの静的プロパティ情報を簡単に調べられます。

Copy
1<?php
2
3/**
4 * 静的プロパティを持つサンプルクラスです。
5 */
6class ProductConfig
7{
8    /**
9     * 公開静的プロパティ：データベース接続文字列。
10     */
11    public static string $databaseHost = 'localhost';
12
13    /**
14     * 公開静的プロパティ：アプリケーションバージョン。
15     */
16    public static string $appVersion = '1.0.0';
17
18    /**
19     * 保護静的プロパティ：APIキー（リフレクションで値を確認できることを示す）。
20     */
21    protected static string $apiKey = 'your_protected_api_key';
22
23    /**
24     * 非公開静的プロパティ：デバッグモード（リフレクションで値を確認できることを示す）。
25     */
26    private static bool $debugMode = true;
27}
28
29// ReflectionClass を使用して、ProductConfig クラスの情報を取得します。
30// これにより、クラスの内部構造（プロパティ、メソッドなど）にアクセスできるようになります。
31$reflector = new ReflectionClass(ProductConfig::class);
32
33// getStaticProperties() メソッドを呼び出して、ProductConfig クラスが持つ全ての静的プロパティの配列を取得します。
34// このメソッドは、public, protected, private の可視性に関わらず、全ての静的プロパティとその現在の値を返します。
35$staticProperties = $reflector->getStaticProperties();
36
37echo "--- ProductConfig クラスの静的プロパティ ---" . PHP_EOL;
38
39// 取得した静的プロパティをループして、名前と値を出力します。
40foreach ($staticProperties as $name => $value) {
41    // 値が真偽値の場合は、'true' または 'false' として表示します。
42    // その他の型の値はそのまま表示します。
43    $displayValue = is_bool($value) ? ($value ? 'true' : 'false') : $value;
44    echo "プロパティ名: {$name}, 値: {$displayValue}" . PHP_EOL;
45}
46
47// 出力例:
48// --- ProductConfig クラスの静的プロパティ ---
49// プロパティ名: databaseHost, 値: localhost
50// プロパティ名: appVersion, 値: 1.0.0
51// プロパティ名: apiKey, 値: your_protected_api_key
52// プロパティ名: debugMode, 値: true
53

PHP 8のReflectionClass::getStaticPropertiesメソッドは、指定されたクラスが持つ全ての静的プロパティの情報を取得するために使用されます。このメソッドは引数を必要とせず、呼び出すだけで対象クラスの静的プロパティに関する情報を取得できます。戻り値としては、静的プロパティの名前をキーとし、その現在の値を格納した配列が返されます。このメソッドの大きな特徴は、public、protected、privateといった可視性に関わらず、クラスに定義されている全ての静的プロパティにアクセスし、その値を取得できる点です。

サンプルコードでは、ProductConfigというクラスが定義されており、公開、保護、非公開の静的プロパティがいくつか含まれています。まず、ReflectionClass(ProductConfig::class)としてProductConfigクラスの情報を扱うためのReflectionClassオブジェクトを作成します。これにより、コード実行時にクラスの内部構造を調べることが可能になります。次に、この$reflectorオブジェクトに対してgetStaticProperties()メソッドを呼び出すことで、ProductConfigクラスが持つ全ての静的プロパティと、それぞれの現在の値が配列として取得されます。最後に、取得した配列をループ処理し、各プロパティの名前と値を画面に出力しています。この結果から、本来アクセスできないはずの保護されたプロパティや非公開のプロパティの値も動的に確認できることがわかります。