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

Copy
1<?php
2
3// MyClass というサンプルクラスを定義します。
4class MyClass
5{
6    public string $publicProperty = '公開プロパティの値';
7    protected int $protectedProperty = 123;
8    private bool $privateProperty = true;
9    public static string $staticProperty = '静的プロパティの値';
10}
11
12// ReflectionClass を使ってクラスの情報を取得します。
13// ReflectionClass のインスタンスを作成するには、クラス名を文字列またはクラス定数で渡します。
14$reflector = new ReflectionClass(MyClass::class);
15
16echo "--- ReflectionClass::getProperty の使用例 ---" . PHP_EOL . PHP_EOL;
17
18// MyClass のインスタンスを作成し、非静的プロパティの値を取得するために使用します。
19$myInstance = new MyClass();
20
21// 1. 公開プロパティ 'publicProperty' の ReflectionProperty オブジェクトを取得します。
22$publicProp = $reflector->getProperty('publicProperty');
23
24echo "プロパティ名: " . $publicProp->getName() . PHP_EOL;
25echo "プロパティの可視性:" . PHP_EOL;
26echo "  - 公開 (public): " . ($publicProp->isPublic() ? 'はい' : 'いいえ') . PHP_EOL;
27echo "  - 保護 (protected): " . ($publicProp->isProtected() ? 'はい' : 'いいえ') . PHP_EOL;
28echo "  - プライベート (private): " . ($publicProp->isPrivate() ? 'はい' : 'いいえ') . PHP_EOL;
29echo "  - 静的 (static): " . ($publicProp->isStatic() ? 'はい' : 'いいえ') . PHP_EOL;
30
31// 非静的プロパティの値を取得するには、ReflectionProperty::getValue() にクラスのインスタンスを渡します。
32$publicValue = $publicProp->getValue($myInstance);
33echo "取得したプロパティの値: " . $publicValue . PHP_EOL;
34echo PHP_EOL;
35
36// 2. 保護プロパティ 'protectedProperty' の ReflectionProperty オブジェクトを取得します。
37$protectedProp = $reflector->getProperty('protectedProperty');
38
39echo "プロパティ名: " . $protectedProp->getName() . PHP_EOL;
40echo "プロパティの可視性:" . PHP_EOL;
41echo "  - 公開 (public): " . ($protectedProp->isPublic() ? 'はい' : 'いいえ') . PHP_EOL;
42echo "  - 保護 (protected): " . ($protectedProp->isProtected() ? 'はい' : 'いいえ') . PHP_EOL;
43echo "  - プライベート (private): " . ($protectedProp->isPrivate() ? 'はい' : 'いいえ') . PHP_EOL;
44echo "  - 静的 (static): " . ($protectedProp->isStatic() ? 'はい' : 'いいえ') . PHP_EOL;
45
46// 保護プロパティやプライベートプロパティの値を取得するには、通常アクセスが制限されています。
47// ReflectionProperty::setAccessible(true) を呼び出すことでアクセスを許可できます。
48$protectedProp->setAccessible(true);
49$protectedValue = $protectedProp->getValue($myInstance);
50echo "取得したプロパティの値 (setAccessible使用): " . $protectedValue . PHP_EOL;
51echo PHP_EOL;
52
53// 3. プライベートプロパティ 'privateProperty' の ReflectionProperty オブジェクトを取得します。
54$privateProp = $reflector->getProperty('privateProperty');
55
56echo "プロパティ名: " . $privateProp->getName() . PHP_EOL;
57echo "プロパティの可視性:" . PHP_EOL;
58echo "  - 公開 (public): " . ($privateProp->isPublic() ? 'はい' : 'いいえ') . PHP_EOL;
59echo "  - 保護 (protected): " . ($privateProp->isProtected() ? 'はい' : 'いいえ') . PHP_EOL;
60echo "  - プライベート (private): " . ($privateProp->isPrivate() ? 'はい' : 'いいえ') . PHP_EOL;
61echo "  - 静的 (static): " . ($privateProp->isStatic() ? 'はい' : 'いいえ') . PHP_EOL;
62
63// プライベートプロパティも同様に setAccessible(true) でアクセスできます。
64$privateProp->setAccessible(true);
65$privateValue = $privateProp->getValue($myInstance);
66echo "取得したプロパティの値 (setAccessible使用): " . ($privateValue ? 'true' : 'false') . PHP_EOL;
67echo PHP_EOL;
68
69// 4. 静的プロパティ 'staticProperty' の ReflectionProperty オブジェクトを取得します。
70$staticProp = $reflector->getProperty('staticProperty');
71
72echo "プロパティ名: " . $staticProp->getName() . PHP_EOL;
73echo "プロパティの可視性:" . PHP_EOL;
74echo "  - 公開 (public): " . ($staticProp->isPublic() ? 'はい' : 'いいえ') . PHP_EOL;
75echo "  - 保護 (protected): " . ($staticProp->isProtected() ? 'はい' : 'いいえ') . PHP_EOL;
76echo "  - プライベート (private): " . ($staticProp->isPrivate() ? 'はい' : 'いいえ') . PHP_EOL;
77echo "  - 静的 (static): " . ($staticProp->isStatic() ? 'はい' : 'いいえ') . PHP_EOL;
78
79// 静的プロパティの値を取得する場合、ReflectionProperty::getValue() にインスタンスは不要です。
80// null を渡すか、引数を省略します。
81$staticValue = $staticProp->getValue(null); // または $staticProp->getValue();
82echo "取得したプロパティの値: " . $staticValue . PHP_EOL;
83echo PHP_EOL;
84
85?>

ReflectionClass::getPropertyは、PHPプログラムが自身の内部構造を動的に調べる「リフレクション」機能の一部です。このメソッドは、あるクラスがどのようなプロパティ（クラスの変数）を持っているか、その詳細な情報を実行時に取得するために利用されます。

使い方は、まずReflectionClassのインスタンスに対して、情報を取得したいプロパティの名前を文字列として引数に渡します。すると、そのプロパティに関する情報がまとめられたReflectionPropertyオブジェクトが戻り値として返されます。このReflectionPropertyオブジェクトを使うことで、プロパティの名前はもちろん、それが公開（public）、保護（protected）、プライベート（private）、静的（static）のどれであるかといった、可視性や特性を調べることが可能です。

さらに、プロパティの実際の値を取得したい場合は、ReflectionPropertyオブジェクトのgetValue()メソッドを使用します。非静的なプロパティの値を取得するには、そのクラスのインスタンスをgetValue()の引数に渡す必要があります。静的プロパティの場合は、インスタンスが不要なため、引数にnullを渡すか省略できます。通常はアクセスが制限されている保護プロパティやプライベートプロパティであっても、setAccessible(true)メソッドを呼び出すことで、その値を取得できるようになります。これにより、プログラムはクラスの内部構造に深く踏み込んで操作することが可能になります。

Copy
1<?php
2
3/**
4 * リフレクションを使ってプロパティ情報を取得する対象となるクラスです。
5 * さまざまな可視性のプロパティを含んでいます。
6 */
7class MySampleClass
8{
9    public string $publicProperty = 'これは公開プロパティの値です。';
10    private int $privateProperty = 123;
11    protected bool $protectedProperty = true;
12    public static float $staticProperty = 3.14;
13
14    public function __construct()
15    {
16        // コンストラクタはデモンストレーションのためシンプルにします。
17    }
18}
19
20/**
21 * ReflectionClass::getProperty メソッドのデモンストレーション関数です。
22 * システムエンジニアを目指す初心者の方にもわかりやすいように、
23 * リフレクションの基本的な使い方とプロパティ情報の取得方法を示します。
24 */
25function demonstrateReflectionGetProperty(): void
26{
27    echo "--- ReflectionClass::getProperty のデモンストレーション --- \n\n";
28
29    // 1. ReflectionClass のインスタンスを作成します。
30    //    これにより、MySampleClass に関するメタデータ（情報）にプログラム実行中にアクセスできるようになります。
31    $reflector = new ReflectionClass(MySampleClass::class);
32    echo "対象クラス: " . $reflector->getName() . "\n\n";
33
34    // 2. getProperty() を使って、特定の名前のプロパティに関する情報を取得します。
35    //    getProperty() は ReflectionProperty オブジェクトを返します。
36
37    // public プロパティ 'publicProperty' の情報を取得します。
38    try {
39        $publicProperty = $reflector->getProperty('publicProperty');
40
41        echo "--- プロパティ '" . $publicProperty->getName() . "' の情報 --- \n";
42        echo "  ・プロパティ名: " . $publicProperty->getName() . "\n";
43        echo "  ・可視性: ";
44        if ($publicProperty->isPublic()) {
45            echo "public\n";
46        } elseif ($publicProperty->isPrivate()) {
47            echo "private\n";
48        } elseif ($publicProperty->isProtected()) {
49            echo "protected\n";
50        }
51        echo "  ・静的プロパティか: " . ($publicProperty->isStatic() ? 'はい' : 'いいえ') . "\n";
52
53        // プロパティの現在の値を取得するには、クラスのインスタンスが必要です。
54        $instance = new MySampleClass();
55        echo "  ・現在の値: " . $publicProperty->getValue($instance) . "\n\n";
56
57    } catch (ReflectionException $e) {
58        echo "エラー: 'publicProperty' の取得に失敗しました。(" . $e->getMessage() . ")\n\n";
59    }
60
61    // private プロパティ 'privateProperty' の情報を取得します。
62    // private プロパティも getProperty で情報自体は取得できます。
63    try {
64        $privateProperty = $reflector->getProperty('privateProperty');
65
66        echo "--- プロパティ '" . $privateProperty->getName() . "' の情報 --- \n";
67        echo "  ・プロパティ名: " . $privateProperty->getName() . "\n";
68        echo "  ・可視性: ";
69        if ($privateProperty->isPublic()) {
70            echo "public\n";
71        } elseif ($privateProperty->isPrivate()) {
72            echo "private\n";
73        } elseif ($privateProperty->isProtected()) {
74            echo "protected\n";
75        }
76
77        // private プロパティの値を取得/設定するには、アクセシビリティを変更する必要があります。
78        // これは通常のアクセス制限をバイパスするため、特別な場合にのみ慎重に使用すべきです。
79        $privateProperty->setAccessible(true);
80        $instance = $instance ?? new MySampleClass(); // インスタンスがなければ作成
81        echo "  ・現在の値 (setAccessible後): " . $privateProperty->getValue($instance) . "\n\n";
82
83    } catch (ReflectionException $e) {
84        echo "エラー: 'privateProperty' の取得に失敗しました。(" . $e->getMessage() . ")\n\n";
85    }
86
87    // static プロパティ 'staticProperty' の情報を取得します。
88    // 静的プロパティはインスタンスがなくても値を取得できます。
89    try {
90        $staticProperty = $reflector->getProperty('staticProperty');
91
92        echo "--- プロパティ '" . $staticProperty->getName() . "' の情報 --- \n";
93        echo "  ・プロパティ名: " . $staticProperty->getName() . "\n";
94        echo "  ・静的プロパティか: " . ($staticProperty->isStatic() ? 'はい' : 'いいえ') . "\n";
95
96        // 静的プロパティの値はインスタンスを渡さなくても取得できます。
97        echo "  ・現在の値: " . $staticProperty->getValue() . "\n\n";
98
99    } catch (ReflectionException $e) {
100        echo "エラー: 'staticProperty' の取得に失敗しました。(" . $e->getMessage() . ")\n\n";
101    }
102
103    // 存在しないプロパティ名を指定した場合の例
104    // getProperty() はプロパティが見つからない場合、ReflectionException をスローします。
105    try {
106        echo "--- 存在しないプロパティの取得 --- \n";
107        $nonExistentProperty = $reflector->getProperty('nonExistentProperty');
108        echo "  ・取得されたプロパティ名: " . $nonExistentProperty->getName() . "\n\n";
109    } catch (ReflectionException $e) {
110        echo "  ・エラー: 存在しないプロパティを取得しようとしました。(" . $e->getMessage() . ")\n\n";
111    }
112}
113
114// デモンストレーション関数を実行します。
115demonstrateReflectionGetProperty();

このサンプルコードは、PHPのReflectionClass::getPropertyメソッドを使って、プログラム実行中にクラスのプロパティに関する詳細な情報を動的に取得する方法を示しています。まず、対象となるクラスのReflectionClassインスタンスを作成します。次に、このインスタンスからgetPropertyメソッドを呼び出します。このメソッドには、情報を取得したいプロパティの名前を文字列で渡します。成功すると、そのプロパティのメタデータ（情報）をカプセル化したReflectionPropertyオブジェクトが戻り値として返されます。

返されたReflectionPropertyオブジェクトからは、プロパティの名前、その可視性（public, private, protected）、静的プロパティであるかなどの詳細な情報をプログラム的に確認できます。また、クラスのインスタンスを渡すことで、そのプロパティの現在の値も取得可能です。プライベートプロパティの値を取得・設定する際には、setAccessible(true)を呼び出すことで一時的にアクセス権を変更できますが、これは通常のアクセス制限をバイパスするため、利用には注意が必要です。もし指定されたプロパティが存在しない場合は、ReflectionExceptionがスローされます。この機能は、フレームワークやライブラリの開発で、クラスの内部構造を柔軟に操作したり検査したりする際に非常に強力なツールとなります。