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

Copy
1<?php
2
3/**
4 * サンプルクラス：リフレクションの対象となるクラスです。
5 * プロパティには公開 (public) と非公開 (private) のものを含めます。
6 */
7class ExampleClass
8{
9    public string $publicProperty = 'これは公開プロパティです。';
10    private int $privateProperty = 123; // これは非公開プロパティです。
11
12    public function __construct(string $initialValue)
13    {
14        $this->publicProperty = $initialValue;
15    }
16}
17
18// 1. リフレクションの対象となるオブジェクトを準備します。
19$myObject = new ExampleClass('新しい公開プロパティの値');
20
21// 2. ReflectionObject のインスタンスを作成します。
22//    これにより、特定のオブジェクトの構造（プロパティ、メソッドなど）に関する情報を取得できます。
23$reflector = new ReflectionObject($myObject);
24
25// 3. getProperty() メソッドを使って、指定した名前のプロパティに対応する
26//    ReflectionProperty オブジェクトを取得します。
27//    まずは公開プロパティ 'publicProperty' を取得してみましょう。
28$publicPropertyReflection = $reflector->getProperty('publicProperty');
29
30echo "--- 公開プロパティの情報 ---" . PHP_EOL;
31echo "プロパティ名: " . $publicPropertyReflection->getName() . PHP_EOL;
32echo "プロパティは公開されていますか？: " . ($publicPropertyReflection->isPublic() ? 'はい' : 'いいえ') . PHP_EOL;
33// ReflectionProperty::getValue() を使って、オブジェクトの実際の値を取得します。
34echo "現在の値: " . $publicPropertyReflection->getValue($myObject) . PHP_EOL;
35echo PHP_EOL;
36
37// 4. 非公開プロパティ 'privateProperty' も取得してみましょう。
38//    通常は外部から直接アクセスできませんが、リフレクションを使うと可能です。
39$privatePropertyReflection = $reflector->getProperty('privateProperty');
40
41echo "--- 非公開プロパティの情報 ---" . PHP_EOL;
42echo "プロパティ名: " . $privatePropertyReflection->getName() . PHP_EOL;
43echo "プロパティは非公開ですか？: " . ($privatePropertyReflection->isPrivate() ? 'はい' : 'いいえ') . PHP_EOL;
44
45// 非公開プロパティの値を読み書きするには、アクセス可能にする必要があります。
46// setAccessible(true) を呼び出すことで、プライベートプロパティへのアクセスを許可します。
47$privatePropertyReflection->setAccessible(true);
48echo "現在の値 (アクセス許可後): " . $privatePropertyReflection->getValue($myObject) . PHP_EOL;
49
50// 値を変更することもできます。
51$privatePropertyReflection->setValue($myObject, 456);
52echo "変更後の値 (アクセス許可後): " . $privatePropertyReflection->getValue($myObject) . PHP_EOL;
53

ReflectionObject::getPropertyメソッドは、PHPのリフレクションAPIの一部で、実行時にオブジェクトの内部構造を調べ、特定のプロパティに関する情報を取得する際に利用されます。

このメソッドは、引数string $nameで指定された名前のプロパティに対応するReflectionPropertyオブジェクトを返します。$nameには、取得したいプロパティの名前を文字列で指定します。

戻り値であるReflectionPropertyオブジェクトを通じて、プロパティの名前、それが公開（public）か非公開（private）かといった状態、そしてオブジェクトにおけるそのプロパティの現在の値などを取得できます。

サンプルコードでは、ExampleClassのインスタンスからReflectionObjectを作成し、getPropertyを使って公開プロパティと非公開プロパティのReflectionPropertyオブジェクトを取得しています。特に非公開プロパティの場合、ReflectionProperty::setAccessible(true)を呼び出すことで、通常ではアクセスできない値を読み書きできるようになります。これは、実行時にオブジェクトの内部状態を動的に検査・操作する強力な手段となります。

Copy
1<?php
2
3/**
4 * ReflectionObject::getProperty の使い方をデモンストレーションする関数。
5 * 指定されたオブジェクトのプロパティ情報を取得し、表示します。
6 *
7 * @param object $object 対象のオブジェクト
8 * @param string $propertyName 取得したいプロパティの名前
9 * @return void
10 */
11function demonstrateGetProperty(object $object, string $propertyName): void
12{
13    echo "--- Examining property '{$propertyName}' ---" . PHP_EOL;
14
15    try {
16        // オブジェクトの内部構造を検査するための ReflectionObject を作成します。
17        $reflector = new ReflectionObject($object);
18
19        // 指定された名前のプロパティに対応する ReflectionProperty オブジェクトを取得します。
20        $property = $reflector->getProperty($propertyName);
21
22        // 取得した ReflectionProperty オブジェクトから様々な情報を表示します。
23        echo "  Property Name: " . $property->getName() . PHP_EOL;
24        echo "  Is Public: " . ($property->isPublic() ? 'Yes' : 'No') . PHP_EOL;
25        echo "  Is Protected: " . ($property->isProtected() ? 'Yes' : 'No') . PHP_EOL;
26        echo "  Is Private: " . ($property->isPrivate() ? 'Yes' : 'No') . PHP_EOL;
27        echo "  Is Static: " . ($property->isStatic() ? 'Yes' : 'No') . PHP_EOL;
28
29        // プライベートまたはプロテクテッドプロパティの場合、
30        // その値を取得するために setAccessible(true) が必要となる場合があります (PHP 8.0以前)。
31        // PHP 8.1以降では setAccessible(true) なしでも private/protected の値を取得できますが、
32        // 意図を明確にするために使用されることもあります。
33        if ($property->isPrivate() || $property->isProtected()) {
34            $property->setAccessible(true);
35        }
36
37        // プロパティの値を取得して表示します。
38        // 静的プロパティの場合は null を渡し、インスタンスプロパティの場合はオブジェクト自身を渡します。
39        $value = $property->isStatic() ? $property->getValue(null) : $property->getValue($object);
40        $displayValue = is_bool($value) ? ($value ? 'true' : 'false') : (string)$value;
41        echo "  Value: " . $displayValue . PHP_EOL;
42
43        // setAccessible() で変更したアクセス権限を元に戻します。
44        if ($property->isPrivate() || $property->isProtected()) {
45            $property->setAccessible(false);
46        }
47
48    } catch (ReflectionException $e) {
49        // プロパティが見つからない場合などに ReflectionException がスローされます。
50        echo "  Error: Property '{$propertyName}' not found. " . $e->getMessage() . PHP_EOL;
51    }
52    echo PHP_EOL;
53}
54
55// 検査対象となるサンプルクラスを定義します。
56class UserProfile
57{
58    public string $username;
59    protected string $email;
60    private int $age;
61    public static string $defaultStatus = 'Active'; // 静的プロパティ
62
63    public function __construct(string $username, string $email, int $age)
64    {
65        $this->username = $username;
66        $this->email = $email;
67        $this->age = $age;
68    }
69}
70
71// サンプルオブジェクトを作成します。
72$user = new UserProfile("jane.smith", "jane.smith@example.com", 25);
73
74// さまざまなアクセスレベルのプロパティに対して demonstrateGetProperty 関数を呼び出し、
75// ReflectionObject::getProperty の動作を確認します。
76
77// public プロパティの例
78demonstrateGetProperty($user, 'username');
79
80// protected プロパティの例
81demonstrateGetProperty($user, 'email');
82
83// private プロパティの例
84demonstrateGetProperty($user, 'age');
85
86// static プロパティの例
87demonstrateGetProperty($user, 'defaultStatus');
88
89// 存在しないプロパティの例 (ReflectionException がどのように処理されるかを示す)
90demonstrateGetProperty($user, 'nonExistentProperty');
91

PHPのReflectionObject::getPropertyメソッドは、実行時にオブジェクトが持つ特定のプロパティに関する詳細な情報を取得するための機能です。このメソッドは、オブジェクトの内部構造を調査する「リフレクション」と呼ばれる機能の一部として、ReflectionObjectクラスのインスタンスを通じて利用されます。

引数$nameには、情報取得の対象となるプロパティの名前を文字列で指定します。例えば、usernameやemailといった具体的なプロパティ名を渡します。

戻り値はReflectionPropertyオブジェクトです。このオブジェクトは、指定されたプロパティの名前、アクセス修飾子（public/protected/private/static）、そしてその値など、多岐にわたる詳細な情報を提供します。

サンプルコードでは、まずReflectionObjectを生成し、そのgetPropertyメソッドを使ってUserProfileオブジェクトのusername、email、age、defaultStatusといった様々なプロパティの情報を取得しています。取得したReflectionPropertyオブジェクトからは、getName()でプロパティ名を取得し、isPublic()などでアクセスレベルを確認し、getValue()でその値を取得して表示します。プライベートやプロテクテッドなプロパティの値を取得する際には、セキュリティ上の制約を一時的に解除するため、setAccessible(true)が必要になることがあります。指定されたプロパティが見つからない場合にはReflectionExceptionが捕捉され、エラーメッセージが表示されるため、安全に処理を進めることが可能です。これにより、プログラムの実行中に柔軟にオブジェクトの内部構造を調査し、必要に応じて操作できます。