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

Copy
1<?php
2
3/**
4 * プロパティを持つサンプルクラス
5 * ReflectionClass::getProperties() の動作確認用
6 */
7class SampleClass
8{
9    public string $publicProperty = 'これは公開プロパティです。';
10    protected int $protectedProperty = 123;
11    private bool $privateProperty = true;
12    public static string $staticProperty = 'これは静的プロパティです。';
13
14    /**
15     * プライベートな静的プロパティ
16     * PHP 8 ではプロパティの型宣言が可能です。
17     */
18    private static array $privateStaticProperty = ['item1', 'item2'];
19}
20
21/**
22 * ReflectionClass::getProperties() の使用例を示す関数
23 *
24 * @param string $className リフレクションを行うクラス名
25 */
26function demonstrateGetProperties(string $className): void
27{
28    echo "--- クラス '{$className}' のプロパティ情報 ---" . PHP_EOL;
29
30    try {
31        // ReflectionClass のインスタンスを作成
32        // これにより、指定されたクラスの構造に関する情報にアクセスできるようになります。
33        $reflector = new ReflectionClass($className);
34
35        // getProperties() メソッドを呼び出し、クラスのすべてのプロパティを取得
36        // デフォルトでは、public, protected, private のすべてのプロパティが取得されます。
37        $properties = $reflector->getProperties();
38
39        if (empty($properties)) {
40            echo "このクラスにはプロパティがありません。" . PHP_EOL;
41            return;
42        }
43
44        echo "取得されたプロパティの数: " . count($properties) . PHP_EOL;
45
46        // 取得したプロパティの配列をループして、各プロパティの詳細情報を表示
47        foreach ($properties as $property) {
48            echo "  プロパティ名: " . $property->getName() . PHP_EOL;
49            echo "    可視性: ";
50            if ($property->isPublic()) {
51                echo "public";
52            } elseif ($property->isProtected()) {
53                echo "protected";
54            } elseif ($property->isPrivate()) {
55                echo "private";
56            }
57            echo ($property->isStatic() ? " (static)" : "") . PHP_EOL;
58        }
59
60        // 特定のフィルターを使用してプロパティを取得する例 (オプション)
61        // 例えば、public プロパティのみを取得する場合
62        echo PHP_EOL . "--- public プロパティのみ ---" . PHP_EOL;
63        $publicProperties = $reflector->getProperties(ReflectionProperty::IS_PUBLIC);
64        if (empty($publicProperties)) {
65            echo "public プロパティはありません。" . PHP_EOL;
66        } else {
67            foreach ($publicProperties as $publicProperty) {
68                echo "  公開プロパティ名: " . $publicProperty->getName() . PHP_EOL;
69            }
70        }
71
72    } catch (ReflectionException $e) {
73        echo "エラーが発生しました: " . $e->getMessage() . PHP_EOL;
74    }
75}
76
77// demonstrateGetProperties 関数を実行して、SampleClass のプロパティ情報を表示
78demonstrateGetProperties(SampleClass::class);
79
80?>

ReflectionClass::getProperties()は、PHPのクラスが持つプロパティ（変数）に関する情報を動的に取得するためのメソッドです。このメソッドは、プログラムの実行中にクラスの内部構造を調べたい場合に利用されます。

使用するには、まず対象のクラスをReflectionClassクラスのインスタンスとして作成し、そのインスタンスからgetProperties()を呼び出します。引数$filterはオプションで、ReflectionProperty::IS_PUBLICなどの定数を指定することで、publicプロパティのみ、privateプロパティのみといった形で取得するプロパティを絞り込むことができます。この引数を省略すると、public、protected、private、および静的プロパティを含む、そのクラスに定義されているすべてのプロパティが取得されます。

戻り値は、各プロパティの詳細を表すReflectionPropertyオブジェクトの配列です。このオブジェクトからは、プロパティ名、そのプロパティがpublic、protected、privateのいずれであるか、また静的プロパティであるかどうかといった情報を取得できます。これにより、実行時にクラスの構造を柔軟に分析・操作することが可能になります。

Copy
1<?php
2
3/**
4 * プロパティを持つサンプルクラス
5 */
6class SampleClass
7{
8    /** @var string 公開プロパティ */
9    public string $publicProperty = 'Public Value';
10
11    /** @var int 保護されたプロパティ */
12    protected int $protectedProperty = 123;
13
14    /** @var bool プライベートプロパティ */
15    private bool $privateProperty = true;
16
17    /** @var string 静的公開プロパティ */
18    public static string $staticProperty = 'Static Value';
19}
20
21// ReflectionClass のインスタンスを作成
22// ReflectionClass は、クラスの構造に関する情報を取得するために使用されます。
23$reflectionClass = new ReflectionClass(SampleClass::class);
24
25// getProperties() メソッドを使用して、クラスの全てのプロパティ情報を取得
26// 引数なしの場合、public, protected, private, static など、全てのプロパティが取得されます。
27$properties = $reflectionClass->getProperties();
28
29echo "--- SampleClass の全てのプロパティ情報 ---\n";
30
31// 取得したプロパティの配列をループで処理
32foreach ($properties as $property) {
33    echo "  プロパティ名: " . $property->getName() . "\n";
34
35    // プロパティの可視性（public, protected, private）を表示
36    echo "    可視性: ";
37    if ($property->isPublic()) {
38        echo "public";
39    } elseif ($property->isProtected()) {
40        echo "protected";
41    } elseif ($property->isPrivate()) {
42        echo "private";
43    }
44
45    // プロパティが静的（static）かどうかを表示
46    if ($property->isStatic()) {
47        echo " (static)";
48    }
49    echo "\n";
50}
51
52echo "\n--- 特定のフィルタを指定したプロパティ情報（public プロパティのみ）---\n";
53
54// ReflectionProperty::IS_PUBLIC フィルタを使って、public プロパティのみを取得
55$publicProperties = $reflectionClass->getProperties(ReflectionProperty::IS_PUBLIC);
56
57foreach ($publicProperties as $property) {
58    echo "  プロパティ名 (public): " . $property->getName() . "\n";
59}
60
61?>

PHPのReflectionClass::getPropertiesメソッドは、指定したクラスが持つプロパティ（変数）に関する詳細な情報を取得するために使用されます。このメソッドは、クラスの内部構造をプログラムから動的に調べたい場合に大変役立ちます。

引数にはオプションで整数型の$filterを指定できます。デフォルトの0（または引数なし）の場合、public、protected、private、staticを含む全てのプロパティが配列として返されます。ReflectionProperty::IS_PUBLICのような定数を指定することで、publicプロパティのみといった特定の条件に合致するプロパティだけを絞り込むことが可能です。戻り値は、各プロパティの情報を保持するReflectionPropertyオブジェクトの配列となります。

サンプルコードでは、まずpublic、protected、private、staticの各プロパティを持つSampleClassを定義しています。次に、このSampleClassのReflectionClassインスタンスを作成し、getProperties()を引数なしで呼び出すことで、全てのプロパティ情報が取得されます。取得した各ReflectionPropertyオブジェクトからは、getName()メソッドでプロパティ名を取得したり、isPublic()などで可視性を確認したりできます。さらに、ReflectionProperty::IS_PUBLICフィルタを指定してgetProperties()を呼び出すことで、publicプロパティのみを効率的に取得できる様子も示しています。これにより、クラスのプロパティを柔軟に検査し、プログラムの動作に合わせて利用できるようになります。