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

Copy
1<?php
2
3// PHP 8.1 以降で導入されたバックアップされた列挙型（Backed Enum）を定義します。
4// ReflectionEnumBackedCase クラスは、この種の列挙型ケースの情報を取得するために使用されます。
5enum UserStatus: string
6{
7    case Active = 'active';
8    case Inactive = 'inactive';
9    case Pending = 'pending';
10}
11
12/**
13 * ReflectionEnumBackedCase::$class プロパティと class_exists() 関数の使用法をデモンストレーションします。
14 *
15 * ReflectionEnumBackedCase::$class プロパティは、列挙型ケースが属する列挙型クラスの名前を文字列で返します。
16 * このクラス名を class_exists() 関数に渡すことで、そのクラスがPHP環境内に存在するかを確認できます。
17 */
18function demonstrateReflectionEnumClassProperty(): void
19{
20    // UserStatus 列挙型から特定のケースを取得します。
21    $enumCase = UserStatus::Active;
22
23    // ReflectionEnumBackedCase オブジェクトを作成します。
24    // このオブジェクトは、バックアップされた列挙型ケースに関する情報を取得するために使用されます。
25    // コンストラクタには、列挙型クラス名とケース名が必要です。
26    $reflectionEnumCase = new ReflectionEnumBackedCase(UserStatus::class, $enumCase->name);
27
28    // 'class' プロパティにアクセスして、列挙型ケースが属する列挙型クラスの名前を取得します。
29    // 戻り値は、列挙型クラスの完全修飾名を含む文字列です。
30    $enumClassName = $reflectionEnumCase->class;
31
32    echo "ReflectionEnumBackedCase::\$class で取得した列挙型クラス名: " . $enumClassName . PHP_EOL;
33
34    // class_exists() 関数を使用して、取得したクラス名が実際に存在するクラス（この場合は列挙型）に対応するか確認します。
35    if (class_exists($enumClassName)) {
36        echo "確認: クラス '{$enumClassName}' は存在します。" . PHP_EOL;
37    } else {
38        echo "エラー: クラス '{$enumClassName}' は存在しません。" . PHP_EOL;
39    }
40
41    echo PHP_EOL; // 出力を見やすくするための改行
42
43    // 存在しないクラス名で class_exists() を試す例
44    $nonExistentClassName = 'NonExistentEnum';
45    if (class_exists($nonExistentClassName)) {
46        echo "エラー: クラス '{$nonExistentClassName}' が予期せず存在します。" . PHP_EOL;
47    } else {
48        echo "確認: クラス '{$nonExistentClassName}' は存在しません (期待通り)。" . PHP_EOL;
49    }
50}
51
52// デモンストレーション関数を実行します。
53demonstrateReflectionEnumClassProperty();
54

このサンプルコードは、PHP 8.1以降で利用可能な列挙型（Enum）に関する情報を取得するReflectionEnumBackedCaseクラスと、クラスの存在を確認するclass_exists()関数の使い方を示しています。

ReflectionEnumBackedCase::$classプロパティは、特定のバックアップされた列挙型ケースが属している列挙型クラスの完全修飾名を文字列として返します。例えば、UserStatus::Activeというケースに対してこのプロパティを使用すると、「UserStatus」という文字列が得られます。このプロパティは引数を取らず、戻り値は常に文字列型です。

サンプルコードでは、まずUserStatusという列挙型を定義し、そのActiveケースからReflectionEnumBackedCaseオブジェクトを作成しています。そして、$reflectionEnumCase->classで列挙型クラス名「UserStatus」を取得し、その結果を出力しています。

次に、class_exists()関数を使用して、取得したクラス名がPHPの実行環境内に実際に存在するかどうかを確認しています。class_exists()は、引数として渡されたクラス名が存在すればtrueを、存在しなければfalseを返します。この関数は、プログラムが特定のクラスに依存する前にその存在を検証する際に役立ちます。サンプルコードでは、「UserStatus」が存在することと、「NonExistentEnum」が存在しないことを両方確認し、その挙動を明確に示しています。

Copy
1<?php
2
3// このコードは PHP 8.1 以降で導入された Enum と ReflectionEnumBackedCase クラスを使用します。
4
5/**
6 * 整数型または文字列型をバックエンドに持つ列挙型（Backed Enum）を定義します。
7 * ReflectionEnumBackedCase はこのような Enum のケースを扱います。
8 */
9enum Status: string
10{
11    case Active = 'active';
12    case Inactive = 'inactive';
13    case Pending = 'pending';
14}
15
16/**
17 * ReflectionEnumBackedCase::class プロパティの使用例を示します。
18 * このプロパティは、列挙型ケースが属するEnumの完全修飾クラス名を文字列で返します。
19 *
20 * キーワード「php class 定数」に関連し、
21 * Enum自体の `::class` 定数と Reflection を通して取得したクラス名が同じであることを確認します。
22 */
23function demonstrateReflectionEnumBackedCaseClassProperty(): void
24{
25    // 特定の列挙型ケースのReflectionオブジェクトを作成します。
26    // ここでは `Status::Active` ケースを使用します。
27    $reflectionCase = new ReflectionEnumBackedCase(Status::Active);
28
29    // ReflectionEnumBackedCase オブジェクトの 'class' プロパティにアクセスします。
30    // これは、このケースが属するEnumの完全修飾クラス名（例: 'Status'）を返します。
31    $enumClassNameFromReflection = $reflectionCase->class;
32
33    // PHPの `::class` 定数を使って、直接Enumの完全修飾クラス名を取得します。
34    $enumClassNameFromConstant = Status::class;
35
36    echo "--- ReflectionEnumBackedCase::class プロパティの使用 ---" . PHP_EOL;
37    echo "Reflection を通して取得した Enum のクラス名: " . $enumClassNameFromReflection . PHP_EOL;
38    echo "直接 `::class` 定数で取得した Enum のクラス名: " . $enumClassNameFromConstant . PHP_EOL;
39    echo "両方の値は同じですか？ " . ($enumClassNameFromReflection === $enumClassNameFromConstant ? 'はい' : 'いいえ') . PHP_EOL;
40
41    echo PHP_EOL;
42    echo "このサンプルは、Reflection API を利用して Enum ケースからその親となる Enum のクラス名を取得する方法と、" . PHP_EOL;
43    echo "PHP の `::class` 定数が返す値が同じであることを示しています。" . PHP_EOL;
44}
45
46// サンプル関数を実行します。
47demonstrateReflectionEnumBackedCaseClassProperty();

ReflectionEnumBackedCase::classプロパティは、PHP 8.1以降で導入された列挙型（Enum）のうち、文字列型や整数型を内部値として持つ「Backed Enum」の個々のケースが、どのEnumクラスに属しているかを知るために使用されます。

このプロパティは引数を必要とせず、アクセスすると、該当するEnumケースが属するEnumの完全修飾クラス名を文字列として返します。

サンプルコードでは、StatusというBacked Enumを定義し、そのActiveケースの情報をReflectionEnumBackedCaseオブジェクトで取得しています。$reflectionCase->classのようにこのプロパティにアクセスすることで、Status::ActiveケースがStatusクラスに属しているという情報を文字列「Status」として得ることができます。これは、Status::classというPHPの::class定数を用いて直接Enumのクラス名を取得するのと同等の結果が得られることを示しています。

このように、ReflectionEnumBackedCase::classプロパティは、実行時にEnumケースからその親となるEnumクラスの情報を動的に取得する際に役立ちます。