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

Copy
1<?php
2
3// PHP 8.1 以降で導入された列挙型 (Enum) を定義します。
4// これはBacked Enum（バッキング値を持つEnum）の例です。
5enum UserStatus: string
6{
7    case Active = 'active';
8    case Inactive = 'inactive';
9    case Pending = 'pending';
10}
11
12/**
13 * ReflectionEnum::getProperty() メソッドの使用方法を示すサンプルコードです。
14 * このメソッドは、列挙型の特定のプロパティ（例: 'name' や 'value'）に関する
15 * ReflectionProperty オブジェクトを取得するために使用されます。
16 */
17function demonstrateReflectionEnumGetProperty(): void
18{
19    echo "--- ReflectionEnum::getProperty() の使用例 ---" . PHP_EOL . PHP_EOL;
20
21    try {
22        // UserStatus Enum のリフレクションオブジェクトを作成します。
23        // これにより、Enum自体のメタデータを検査できるようになります。
24        $reflectionEnum = new ReflectionEnum(UserStatus::class);
25        echo "対象のEnumクラス: " . $reflectionEnum->getName() . PHP_EOL . PHP_EOL;
26
27        // 1. Enumの内部プロパティ 'name' のReflectionPropertyを取得します。
28        // 'name' プロパティは、各Enumケースの宣言された名前（例: 'Active', 'Inactive'）を指します。
29        $nameProperty = $reflectionEnum->getProperty('name');
30        echo "「name」プロパティの情報:" . PHP_EOL;
31        echo "  プロパティ名: " . $nameProperty->getName() . PHP_EOL;
32        echo "  宣言されたクラス: " . $nameProperty->getDeclaringClass()->getName() . PHP_EOL;
33        echo "  パブリックプロパティか: " . ($nameProperty->isPublic() ? 'はい' : 'いいえ') . PHP_EOL;
34        echo "  静的プロパティか: " . ($nameProperty->isStatic() ? 'はい' : 'いいえ') . PHP_EOL;
35        echo PHP_EOL;
36
37        // 2. Enumの内部プロパティ 'value' のReflectionPropertyを取得します。
38        // 'value' プロパティは、Backed Enumのバッキング値（例: 'active', 'inactive'）を指します。
39        // Standard Enum（バッキング値がないEnum）の場合、このプロパティは存在しません。
40        $valueProperty = $reflectionEnum->getProperty('value');
41        echo "「value」プロパティの情報:" . PHP_EOL;
42        echo "  プロパティ名: " . $valueProperty->getName() . PHP_EOL;
43        echo "  宣言されたクラス: " . $valueProperty->getDeclaringClass()->getName() . PHP_EOL;
44        echo "  パブリックプロパティか: " . ($valueProperty->isPublic() ? 'はい' : 'いいえ') . PHP_EOL;
45        echo "  静的プロパティか: " . ($valueProperty->isStatic() ? 'はい' : 'いいえ') . PHP_EOL;
46        echo PHP_EOL;
47
48        // 存在しないプロパティを試みる (ReflectionException がスローされます)
49        echo "存在しないプロパティを試行します..." . PHP_EOL;
50        try {
51            $nonExistentProperty = $reflectionEnum->getProperty('nonExistent');
52            // この行は実行されません
53        } catch (ReflectionException $e) {
54            echo "  エラー発生: " . $e->getMessage() . PHP_EOL;
55        }
56
57    } catch (ReflectionException $e) {
58        // リフレクション処理中にエラーが発生した場合の例外ハンドリング
59        echo "致命的なエラーが発生しました: " . $e->getMessage() . PHP_EOL;
60    }
61}
62
63// サンプルコードを実行します。
64demonstrateReflectionEnumGetProperty();
65

ReflectionEnum::getProperty()は、PHP 8.1で導入された列挙型（Enum）の特定のプロパティに関する情報を取得するメソッドです。引数にはプロパティ名を文字列（string $name）で指定し、各Enumケースの名前を示す「name」や、バッキング値を持つEnumの「value」といった内部プロパティの情報取得に利用されます。

戻り値はReflectionPropertyオブジェクトで、これによりプロパティの名前、宣言クラス、公開設定、静的設定など、詳細なメタデータをプログラムで検査可能になります。指定したプロパティが存在しない場合、ReflectionExceptionがスローされます。この機能を使うことで、実行時にEnumの構造を動的に分析し、柔軟な処理を構築できます。

Copy
1<?php
2
3/**
4 * このスクリプトはPHP 8.1以降で動作します。
5 * ReflectionEnum::getProperty メソッドの使用例を示します。
6 *
7 * ReflectionEnum::getProperty は、Enumが持つ特定のプロパティに関する
8 * ReflectionProperty オブジェクトを取得するために使用されます。
9 * EnumはPHP 8.1で導入され、内部的に 'name' プロパティと、
10 * バッキングEnumの場合は 'value' プロパティを持ちます。
11 */
12
13// 1. バッキングEnumを定義します。
14// 'Status' というEnumを定義し、各ケースが整数値をバッキング値として持ちます。
15enum Status: int
16{
17    case Active = 1;
18    case Inactive = 0;
19    case Pending = 2;
20}
21
22echo "--- ReflectionEnum::getProperty の使用例 ---" . PHP_EOL;
23
24// 2. Status EnumのReflectionEnumインスタンスを作成します。
25// ReflectionEnumは、Enum自体の構造に関するメタデータ（情報）を取得するためのクラスです。
26$reflectionEnum = new ReflectionEnum(Status::class);
27
28// 3. Enumの 'name' プロパティに関する ReflectionProperty オブジェクトを取得します。
29// すべてのEnumケースは、そのケース名を表す 'name' プロパティを内部的に持ちます。
30// getProperty() は指定された名前のプロパティの情報を持つ ReflectionProperty オブジェクトを返します。
31$nameProperty = $reflectionEnum->getProperty('name');
32
33echo "\n◆ 'name' プロパティの情報:" . PHP_EOL;
34echo "  プロパティ名: " . $nameProperty->getName() . PHP_EOL;
35echo "  宣言されているクラス: " . $nameProperty->getDeclaringClass()->getName() . PHP_EOL;
36echo "  パブリックプロパティか: " . ($nameProperty->isPublic() ? 'はい' : 'いいえ') . PHP_EOL;
37echo "  静的プロパティか: " . ($nameProperty->isStatic() ? 'はい' : 'いいえ') . PHP_EOL;
38
39// 4. Enumの 'value' プロパティに関する ReflectionProperty オブジェクトを取得します。
40// バッキングEnumの場合、各ケースはバッキング値を示す 'value' プロパティを内部的に持ちます。
41$valueProperty = $reflectionEnum->getProperty('value');
42
43echo "\n◆ 'value' プロパティの情報 (バッキングEnumの場合):" . PHP_EOL;
44echo "  プロパティ名: " . $valueProperty->getName() . PHP_EOL;
45echo "  宣言されているクラス: " . $valueProperty->getDeclaringClass()->getName() . PHP_EOL;
46echo "  パブリックプロパティか: " . ($valueProperty->isPublic() ? 'はい' : 'いいえ') . PHP_EOL;
47echo "  静的プロパティか: " . ($valueProperty->isStatic() ? 'はい' : 'いいえ') . PHP_EOL;
48
49echo "\n--- 完了 ---" . PHP_EOL;
50
51?>

ReflectionEnum::getPropertyは、PHP 8.1以降で導入されたEnum（列挙型）が持つ特定のプロパティに関する情報を取得するメソッドです。Enumは、そのケース名を示すnameプロパティや、バッキングEnumの場合にはバッキング値を示すvalueプロパティを内部に持っています。

このメソッドを利用するには、まず対象のEnumクラスからReflectionEnumのインスタンスを作成します。ReflectionEnumは、Enumの構造や定義情報をプログラム実行時に動的に検査するためのクラスです。

getPropertyメソッドは、引数string $nameに「name」や「value」など、取得したいプロパティ名を指定します。戻り値として、そのプロパティの詳細情報を持つReflectionPropertyオブジェクトを返します。このオブジェクトからは、プロパティ名、宣言クラス、公開・静的といった特性を確認できます。

サンプルコードでは、StatusというバッキングEnumのReflectionEnumインスタンスからgetProperty('name')とgetProperty('value')を呼び出し、それぞれのプロパティに関するメタデータを取得・表示しています。これにより、Enumの内部構造を動的に調べ、その情報を活用する手順を学ぶことができます。