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

Copy
1<?php
2
3/**
4 * PHP 8.1 以降で導入されたBacked Enumの定義。
5 * ReflectionEnumBackedCase::getName() を使用するためにBacked Enumが必要です。
6 */
7enum UserStatus: string
8{
9    case PENDING = '保留中';
10    case ACTIVE = 'アクティブ';
11    case INACTIVE = '非アクティブ';
12}
13
14// ReflectionEnumBackedCase::getName() メソッドの使用例
15// このメソッドは、Backed Enumの特定のケース名を文字列として取得します。
16
17try {
18    // ReflectionEnum クラスを使って Enum 全体のリフレクション情報を作成
19    $reflectionEnum = new ReflectionEnum(UserStatus::class);
20
21    // 特定の Enum ケース 'ACTIVE' のリフレクション情報（ReflectionEnumBackedCase）を取得
22    // ReflectionEnum::getCase() は、指定された名前のEnumケースのリフレクションオブジェクトを返します。
23    $reflectionCase = $reflectionEnum->getCase('ACTIVE');
24
25    // 取得したリフレクションオブジェクトが ReflectionEnumBackedCase のインスタンスであることを確認
26    // Backed Enum のケースでなければ getName() は適用できません。
27    if ($reflectionCase instanceof ReflectionEnumBackedCase) {
28        // getName() メソッドを呼び出して、Enum ケースの宣言名を取得
29        $caseName = $reflectionCase->getName();
30
31        // 取得したケース名を表示
32        echo "取得されたEnumケース名: " . $caseName . PHP_EOL; // 出力例: 取得されたEnumケース名: ACTIVE
33    } else {
34        echo "エラー: 取得されたケースは Backed Enum のケースではありません。" . PHP_EOL;
35    }
36} catch (ReflectionException $e) {
37    // リフレクション操作中に発生する可能性のある例外を捕捉
38    echo "リフレクションエラー: " . $e->getMessage() . PHP_EOL;
39}
40

ReflectionEnumBackedCase::getName()は、PHP 8.1で導入された「Backed Enum（バックスド・イーナム）」の特定のケース名を取得するためのメソッドです。このメソッドは、ReflectionEnumBackedCaseクラスのインスタンスに対して使用され、そのEnumケースがPHPコード内でどのように宣言されているかという名前を文字列として返します。引数は必要なく、戻り値の型はstringです。

サンプルコードでは、まずUserStatusというBacked Enumを定義しています。これは、PENDING、ACTIVE、INACTIVEといった具体的な状態を表すケースを持ち、それぞれ文字列値を関連付けています。

次に、ReflectionEnumクラスを使ってUserStatus Enum全体の情報を取得し、そのgetCase('ACTIVE')メソッドを用いて、ACTIVEという特定のEnumケースのリフレクション情報（ReflectionEnumBackedCaseのインスタンス）を取得しています。

取得したオブジェクトがReflectionEnumBackedCaseのインスタンスであることを確認した後、getName()メソッドを呼び出しています。これにより、ACTIVEというケースの宣言名である「ACTIVE」という文字列が取得され、画面に表示されます。このように、プログラム実行時にEnumの構造を動的に調べ、特定のケースの名前を取得したい場合にこのメソッドが役立ちます。リフレクション操作中に問題が発生した場合は、ReflectionExceptionが捕捉されます。

Copy
1<?php
2
3// このスクリプトは、PHP 8 の ReflectionEnumBackedCase::getName() メソッドの使用例を示します。
4// Reflection API を使用して、列挙型 (enum) のケース名を動的に取得する方法を学ぶことができます。
5
6namespace App\Enums;
7
8// バック付き列挙型（Backed Enum）の定義。
9// ReflectionEnumBackedCase を使用するには、値を持つ列挙型（string, int）が必要です。
10enum UserStatus: string
11{
12    case Active = 'active';
13    case Inactive = 'inactive';
14    case Pending = 'pending';
15}
16
17namespace App\Examples;
18
19use ReflectionEnum;
20use App\Enums\UserStatus; // 定義した列挙型をインポート
21
22/**
23 * ReflectionEnumBackedCase::getName() の使用例を提供するクラス。
24 * システムエンジニアを目指す初心者向けに、列挙型の反射的な検査方法を示します。
25 */
26final class EnumCaseNameExtractor
27{
28    /**
29     * ReflectionEnumBackedCase::getName() メソッドのデモンストレーションを実行します。
30     * このメソッドは、列挙型ケースのシンプル（短い）な名前を文字列で返します。
31     */
32    public static function run(): void
33    {
34        echo "--- ReflectionEnumBackedCase::getName() デモンストレーション ---\n\n";
35
36        // UserStatus 列挙型に対するReflectionオブジェクトを作成します。
37        // これにより、実行時に列挙型の構造を検査できます。
38        $reflectionEnum = new ReflectionEnum(UserStatus::class);
39
40        // 列挙型の全てのケースを反復処理し、それぞれの名前を取得・表示します。
41        echo "UserStatus 列挙型の各ケースの名前:\n";
42        foreach ($reflectionEnum->getCases() as $caseReflection) {
43            // $caseReflection は ReflectionEnumBackedCase のインスタンスとなります。
44            // getName() は、列挙型ケースのシンボル名（例: 'Active'）を返します。
45            $caseName = $caseReflection->getName();
46            echo sprintf("- ケース名: %s\n", $caseName);
47        }
48
49        echo "\n----------------------------------------------------\n";
50
51        // 特定のケース（例: 'Inactive'）のReflectionオブジェクトを直接取得し、getName() を呼び出す例。
52        echo "特定のケース 'Inactive' の名前を取得:\n";
53        $inactiveCaseReflection = $reflectionEnum->getCase('Inactive');
54
55        // 取得したオブジェクトが ReflectionEnumBackedCase のインスタンスであることを確認します。
56        // これはバック付きEnumを扱っているため常に true になりますが、安全なプログラミング習慣です。
57        if ($inactiveCaseReflection instanceof \ReflectionEnumBackedCase) {
58            $name = $inactiveCaseReflection->getName();
59            echo sprintf("- 'Inactive' ケースの名前: %s\n", $name);
60        } else {
61            echo "- エラー: 'Inactive' はバック付き列挙型のケースではありません。\n";
62        }
63    }
64}
65
66// スクリプトを実行します。
67EnumCaseNameExtractor::run();

ReflectionEnumBackedCase::getName()は、PHP 8で導入された列挙型（Enum）のバック付きケースから、そのケースのシンボル名を動的に取得するためのメソッドです。このメソッドは、Reflection APIの一部として提供されており、プログラムの実行中に列挙型の構造を検査する際に利用されます。

このメソッドには引数がなく、呼び出すだけで列挙型ケースの短い名前（宣言時に指定されたシンボル名、例えばActiveやInactiveなど）をstring型で返します。これにより、コード内で直接ケース名を知らなくても、プログラムが動的にケース名を識別し、処理を進めることが可能になります。

サンプルコードでは、UserStatusというバック付き列挙型を定義し、まずReflectionEnumクラスを使ってこの列挙型全体の反射オブジェクトを作成しています。その後、getCases()メソッドで各列挙型ケースの反射オブジェクト（ReflectionEnumBackedCaseのインスタンス）を取得しています。各ケースオブジェクトに対してgetName()を呼び出すことで、それぞれのケースが持つシンボル名を文字列として抽出し、表示しています。また、getCase()メソッドで特定のケースを直接取得し、その名前を取り出す例も示されており、実行時に列挙型のケース名を柔軟に扱う方法を学ぶことができます。