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

Copy
1<?php
2
3/**
4 * 静的プロパティを持つサンプルクラス。
5 */
6class MySampleClass
7{
8    // 公開静的プロパティ
9    public static string $publicStaticProp = "これは公開静的プロパティの値です。";
10
11    // 保護静的プロパティ
12    protected static int $protectedStaticProp = 123;
13
14    // 非公開静的プロパティ
15    private static bool $privateStaticProp = true;
16
17    // インスタンスプロパティ (getStaticPropertiesの対象外であることを示すため)
18    public string $instanceProp = "これはインスタンスプロパティの値です。";
19
20    public function __construct(string $value = "デフォルト")
21    {
22        $this->instanceProp = $value;
23    }
24}
25
26// MySampleClass のインスタンスを作成します。
27// ReflectionObject はインスタンスを介してクラスの情報を取得します。
28$obj = new MySampleClass("カスタムインスタンス値");
29
30// ReflectionObject を初期化し、指定されたオブジェクトのリフレクション情報を取得します。
31$reflectionObject = new ReflectionObject($obj);
32
33// getStaticProperties() メソッドを使用して、クラスのすべての静的プロパティを取得します。
34// 戻り値はプロパティ名がキー、プロパティ値が値となる連想配列です。
35$staticProperties = $reflectionObject->getStaticProperties();
36
37echo "--- ReflectionObject::getStaticProperties() の結果 ---" . PHP_EOL;
38
39// 取得した静的プロパティをループして表示します。
40if (empty($staticProperties)) {
41    echo "このクラスには静的プロパティが見つかりませんでした。" . PHP_EOL;
42} else {
43    foreach ($staticProperties as $name => $value) {
44        // プロパティの値は様々な型を取り得るため、var_exportで型情報と共に表示します。
45        echo "静的プロパティ名: '{$name}', 値: " . var_export($value, true) . PHP_EOL;
46    }
47}
48
49echo PHP_EOL;
50
51// 補足: getStaticProperties() はインスタンスプロパティは返しません。
52echo "--- 注意点 ---" . PHP_EOL;
53echo "getStaticProperties() は静的プロパティのみを返します。" . PHP_EOL;
54echo "インスタンスプロパティ 'instanceProp' は結果に含まれません。" . PHP_EOL;
55echo "インスタンスプロパティは、ReflectionObject::getProperties() などで取得できます。" . PHP_EOL;
56
57?>

ReflectionObject::getStaticPropertiesは、PHPのリフレクション機能を用いて、指定されたオブジェクトが属するクラスの静的プロパティをすべて取得するメソッドです。リフレクションとは、プログラム実行時にクラスの構造を動的に調べることができる機能です。

このメソッドは引数なしで呼び出され、そのクラスに存在するすべての静的プロパティを連想配列で返します。配列のキーはプロパティ名、値はその静的プロパティの現在の値です。公開（public）、保護（protected）、非公開（private）といったアクセス権に関わらず、すべての静的プロパティが対象となります。

サンプルコードでは、MySampleClassに定義された複数の静的プロパティが、このメソッドでどのように取得されるかを示しています。まずクラスのインスタンスを作成し、それをReflectionObjectに渡してリフレクション情報を取得します。その後、getStaticProperties()を呼び出すことで、MySampleClassのすべての静的プロパティ名とその値がまとめて取得され、内容を確認できます。

このメソッドは、クラスの「静的プロパティ」のみを取得し、「インスタンスプロパティ」は対象外です。これにより、実行時にクラス全体の静的な状態や設定値を動的に調べ、柔軟なプログラミングに役立てることができます。

Copy
1<?php
2
3/**
4 * ReflectionObject::getStaticProperties メソッドのサンプルクラス。
5 * 静的プロパティとインスタンスプロパティの両方を含みます。
6 */
7class MyStaticPropertiesClass
8{
9    // 公開静的プロパティ
10    public static string $publicStaticProperty = 'これは公開静的プロパティです';
11
12    // 保護静的プロパティ
13    protected static int $protectedStaticProperty = 12345;
14
15    // 非公開静的プロパティ
16    private static bool $privateStaticProperty = true;
17
18    // インスタンスプロパティ（getStaticProperties では取得されません）
19    public string $instanceProperty = 'これはインスタンスプロパティです';
20
21    /**
22     * コンストラクタ。
23     */
24    public function __construct()
25    {
26        // 必要に応じて初期化処理を記述
27    }
28}
29
30// ReflectionObject を使用してクラスの情報を取得するために、まずオブジェクトをインスタンス化します。
31$obj = new MyStaticPropertiesClass();
32
33// ReflectionObject のインスタンスを作成し、対象オブジェクトのクラスの情報にアクセスします。
34$reflector = new ReflectionObject($obj);
35
36// getStaticProperties メソッドを呼び出し、クラスが持つすべての静的プロパティを取得します。
37// 戻り値は ['プロパティ名' => '値'] の連想配列です。
38$staticProperties = $reflector->getStaticProperties();
39
40echo "--- クラス 'MyStaticPropertiesClass' の静的プロパティ一覧 ---\n";
41
42if (empty($staticProperties)) {
43    echo "  静的プロパティは見つかりませんでした。\n";
44} else {
45    foreach ($staticProperties as $name => $value) {
46        // プロパティの値の型に応じて、適切な形式で表示します。
47        $displayValue = match (true) {
48            is_bool($value) => $value ? 'true' : 'false',
49            is_null($value) => 'null',
50            default => (string)$value, // その他の型は文字列に変換して表示
51        };
52        echo "  - {$name}: {$displayValue}\n";
53    }
54}
55
56echo "--------------------------------------------------------\n";
57
58?>

PHP 8におけるReflectionObject::getStaticPropertiesメソッドは、クラスの静的プロパティに関する情報を動的に取得するために使用されます。ReflectionObjectは、実行時にオブジェクトの構造（クラス、メソッド、プロパティなど）を調べ、操作するための機能を提供するクラスです。このメソッドは、指定されたオブジェクトが所属するクラスに定義されているすべての静的プロパティを、そのアクセス修飾子（public, protected, private）に関わらず取得します。

引数は不要で、呼び出すだけで機能します。戻り値は、プロパティ名をキーとし、その値を値とする連想配列です。これにより、プログラムの実行中にクラスの静的プロパティの一覧とその現在の値を動的に調べることが可能になります。サンプルコードでは、MyStaticPropertiesClassというクラスに定義された公開、保護、非公開の各静的プロパティが、インスタンスプロパティとは区別されて正確に取得され、表示されていることが確認できます。この機能は、特にフレームワーク開発やデバッグ、ライブラリ作成などで、クラスの内部構造を解析したい場合に非常に役立ちます。