【PHP8.x】ReflectionEnumUnitCase::classプロパティの使い方

Copy
1<?php
2
3/**
4 * PHP 8.1以降で導入されたEnum（列挙型）の定義です。
5 * このEnumを使って、ReflectionEnumUnitCase::classプロパティの動作を検証します。
6 */
7enum PaymentStatus
8{
9    case Paid;
10    case Unpaid;
11    case Refunded;
12}
13
14/**
15 * ReflectionEnumUnitCase の 'class' プロパティを使用して、
16 * Enumケースが属するクラス名を取得し、そのクラスの存在を検証する関数です。
17 *
18 * @param string $enumClassName 検証するEnumの完全修飾クラス名（例: PaymentStatus::class）
19 */
20function demonstrateReflectionEnumUnitCaseClassProperty(string $enumClassName): void
21{
22    // 指定されたクラス名がEnumとして存在するかを確認します。
23    if (!enum_exists($enumClassName)) {
24        echo "エラー: 指定されたEnum '{$enumClassName}' は存在しません。\n";
25        return;
26    }
27
28    try {
29        // Enum全体のReflectionインスタンスを作成します。
30        $reflectionEnum = new ReflectionEnum($enumClassName);
31
32        // Enumのすべてのケース（ReflectionEnumUnitCaseのインスタンス群）を取得します。
33        $cases = $reflectionEnum->getCases();
34
35        // ケースが一つもない場合は処理を中断します。
36        if (empty($cases)) {
37            echo "Enum '{$enumClassName}' にはケースが定義されていません。\n";
38            return;
39        }
40
41        // 最初のケースのReflectionインスタンスを取得します。
42        $firstCase = $cases[0];
43
44        // ReflectionEnumUnitCase::class プロパティを使って、
45        // このEnumケースが属するクラスの完全修飾名（FQN）を取得します。
46        // 戻り値は string 型で、"PaymentStatus" のようなクラス名が返されます。
47        $owningClassName = $firstCase->class;
48
49        echo "Enumケース '{$firstCase->getName()}' は、クラス '{$owningClassName}' に属しています。\n";
50
51        // キーワードである php class_exists 関数を使用して、
52        // 取得したクラス名がPHPの実行環境で実際に存在するかを検証します。
53        if (class_exists($owningClassName)) {
54            echo "検証成功: 取得したクラス名 '{$owningClassName}' は存在します。\n";
55        } else {
56            echo "検証失敗: 取得したクラス名 '{$owningClassName}' は存在しません。\n";
57        }
58
59    } catch (ReflectionException $e) {
60        // リフレクション処理中にエラーが発生した場合のハンドリング
61        echo "リフレクションエラー: " . $e->getMessage() . "\n";
62    }
63}
64
65// 上記関数を実行して、ReflectionEnumUnitCase::classプロパティの動作を確認します。
66// PaymentStatus::class は、定義したEnumクラス名を文字列として渡すための定数です。
67demonstrateReflectionEnumUnitCaseClassProperty(PaymentStatus::class);

ReflectionEnumUnitCase::classプロパティは、PHP 8.1で導入されたEnum（列挙型）の各ケースが、どのEnumクラスに属しているかの完全修飾クラス名（文字列）を取得するために使用されます。このプロパティは引数を取らず、戻り値はstring型で、例えば"PaymentStatus"のようなクラス名が返されます。

サンプルコードでは、PaymentStatusというEnumを定義し、その中のPaidなどの各ケースが属するクラス名を取得する例を示しています。まず、ReflectionEnumを使ってEnum全体の情報を取得し、getCases()メソッドで個々のケースを表すReflectionEnumUnitCaseインスタンスを取得します。そして、このインスタンスの->classプロパティにアクセスすると、そのEnumケースが属するクラス名（ここでは"PaymentStatus")が文字列として得られます。

取得したクラス名がPHPの実行環境に実際に存在するかどうかは、キーワードであるclass_exists()関数で確認できます。これは、リフレクションで得られた情報が正しいことを検証する一般的な方法です。このプロパティは、実行時にEnumの構造を動的に調べ、特定のケースの親となるEnumクラス名を特定したい場合に役立ちます。

Copy
1<?php
2
3// PHP 8.1 以降で導入された Enum (列挙型) を定義します。
4// Enumのケースは、ある種の定数として扱われます。
5enum UserStatus
6{
7    case Active;
8    case Inactive;
9    case Pending;
10}
11
12/**
13 * ReflectionEnumUnitCase::class プロパティの使用方法を示します。
14 *
15 * このプロパティは、特定の列挙型ケース (例: UserStatus::Active) が属する
16 * 列挙型そのもの (例: UserStatus) の ReflectionClass オブジェクトを返します。
17 * ReflectionClass オブジェクトを文字列コンテキストで利用すると、
18 * そのクラスの完全修飾名 (FQN) が文字列として得られます。
19 *
20 * @return void
21 */
22function demonstrateReflectionEnumUnitCaseClassProperty(): void
23{
24    // リフレクションの対象となる Enum のユニットケース (値を持たないケース) を取得します。
25    // ここでは UserStatus::Active を選択しています。
26    $enumUnitCase = UserStatus::Active;
27
28    try {
29        // ReflectionEnumUnitCase オブジェクトを作成し、
30        // 特定の Enum ケースに関するリフレクション情報にアクセスできるようにします。
31        $reflectionEnumUnitCase = new ReflectionEnumUnitCase($enumUnitCase);
32
33        // 'class' プロパティにアクセスします。
34        // これは UserStatus クラスの ReflectionClass オブジェクトを返します。
35        // この ReflectionClass オブジェクトを文字列として出力すると、
36        // そのクラスの完全修飾名 (UserStatus) が自動的に得られます。
37        $enumClassName = $reflectionEnumUnitCase->class;
38
39        echo "リフレクションを介して取得したEnumケース '{$enumUnitCase->name}' が属するクラス名: " . $enumClassName . PHP_EOL;
40
41        // 参考: PHP のマジック定数 `::class` を使って、直接クラス名を取得する方法です。
42        // これも同じく Enum の完全修飾名 (UserStatus) を文字列として返します。
43        echo "直接取得した Enum クラス名 (UserStatus::class): " . UserStatus::class . PHP_EOL;
44
45    } catch (ReflectionException $e) {
46        // リフレクション処理中にエラーが発生した場合にキャッチします。
47        echo "エラーが発生しました: " . $e->getMessage() . PHP_EOL;
48    }
49}
50
51// サンプルコードを実行します。
52demonstrateReflectionEnumUnitCaseClassProperty();

PHP 8.1以降で導入されたEnum（列挙型）の情報を取得する際、ReflectionEnumUnitCaseクラスが利用されます。このクラスは、UserStatus::Activeのような、値を持たないEnumケース（ユニットケース）に関する詳細なリフレクション情報を提供します。

ReflectionEnumUnitCase::classプロパティは、特定のEnumケースがどのEnumクラスに属しているかを知るために使用します。このプロパティにアクセスする際に引数は不要です。プロパティ自体は、そのEnumケースが定義されているEnumクラス自体のReflectionClassオブジェクトを返します。このReflectionClassオブジェクトを文字列として利用すると、Enumクラスの完全修飾名（FQN）が自動的に文字列として得られます。つまり、サンプルコードのようにUserStatus::Activeというケースに対してこのプロパティを使うと、UserStatusという文字列が取得できます。これにより、プログラム実行中にEnumケースからその親となるEnumのクラス名を動的に取得することが可能となり、柔軟な処理を実現できます。