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

Copy
1<?php
2
3// PHP 8.1以降で導入された列挙型 (Enum) を定義します。
4// これは、関連する定数をまとめるためのもので、特定の値を表す一連のケースを定義します。
5enum UserStatus
6{
7    case Active;   // ユーザーがアクティブ状態であることを示すケース
8    case Inactive; // ユーザーが非アクティブ状態であることを示すケース
9    case Pending;  // ユーザーが保留状態であることを示すケース
10}
11
12// UserStatus::Active 列挙型ケースのリフレクション情報を作成します。
13// ReflectionEnumUnitCase クラスは、特定の列挙型ケース（バッキング値を持たない「ユニットケース」）の詳細を検査するために使用されます。
14$reflectionCase = new ReflectionEnumUnitCase(UserStatus::Active);
15
16// getName() メソッドを呼び出して、列挙型ケースの名前を文字列として取得します。
17// このメソッドは引数を取らず、ケースが定義されたときの名前を返します。
18$caseName = $reflectionCase->getName();
19
20// 取得したケース名を出力します。
21echo "取得した列挙型ケースの名前: " . $caseName . PHP_EOL;
22
23// 別のケースで試すこともできます。
24$reflectionCaseInactive = new ReflectionEnumUnitCase(UserStatus::Inactive);
25echo "別の列挙型ケースの名前: " . $reflectionCaseInactive->getName() . PHP_EOL;
26
27?>

このPHPサンプルコードは、PHP 8.1以降で導入された列挙型（Enum）の情報を取得するリフレクション機能について説明しています。

まず、UserStatusという列挙型が定義されており、Active、Inactive、Pendingといったユーザーの状態を示すケース（選択肢）が含まれています。列挙型は、限られた選択肢の中から値を選ぶ際に利用され、コードの可読性と安全性を高めます。

次に、UserStatus::Activeという特定の列挙型ケースを対象に、ReflectionEnumUnitCaseクラスのインスタンスを作成しています。このReflectionEnumUnitCaseクラスは、列挙型の中でも、付随する値を持たない「ユニットケース」と呼ばれる種類のケースについて、その情報をプログラムから動的に検査するために使われます。

そして、作成した$reflectionCaseインスタンスからgetName()メソッドを呼び出しています。このgetName()メソッドは引数を一切取りません。役割としては、それが表す列挙型ケースの名前を文字列として返すことです。例えば、UserStatus::ActiveのReflectionEnumUnitCaseインスタンスに対して呼び出すと、「Active」という文字列が戻り値として得られます。

最後に、取得したケースの名前が画面に出力され、getName()メソッドが正しくケース名を返していることが確認できます。この機能は、プログラム実行時に列挙型ケースの名前を動的に知りたい場合に非常に有用です。

Copy
1<?php
2
3/**
4 * Enum (列挙型) の定義例です。
5 * PHP 8.1 以降で利用可能です。
6 * このEnumは 'App\Enums' という名前空間に属しています。
7 */
8namespace App\Enums;
9
10enum Status: string
11{
12    case ACTIVE = 'active';
13    case INACTIVE = 'inactive';
14    case PENDING = 'pending';
15}
16
17/**
18 * ReflectionEnumUnitCase::getName() メソッドの使用例を示します。
19 * このメソッドは、列挙型ケースの短い名前（名前空間を含まない）を返します。
20 *
21 * システムエンジニアを目指す初心者の方へ:
22 * プログラミングでは「名前」の概念が重要です。
23 * `getName()` はこのケースの名前そのもの（例: "ACTIVE"）を返します。
24 * クラスやEnumが属する「名前空間」とは別の情報であることに注意してください。
25 */
26function demonstrateReflectionEnumUnitCaseGetName(): void
27{
28    // 調べたい列挙型ケースを取得します。ここでは Status::ACTIVE を例とします。
29    $enumCase = Status::ACTIVE;
30
31    // ReflectionEnumUnitCase オブジェクトを作成します。
32    // Enumの情報をリフレクションで取得するための ReflectionEnum クラスを使用します。
33    $reflectionEnum = new \ReflectionEnum(Status::class);
34
35    // 特定の列挙型ケース (例: 'ACTIVE') の ReflectionEnumUnitCase オブジェクトを取得します。
36    $reflectionCase = $reflectionEnum->getCase('ACTIVE');
37
38    // ReflectionEnumUnitCase::getName() メソッドを呼び出し、
39    // 列挙型ケースの「名前」を取得します。
40    $caseName = $reflectionCase->getName();
41
42    echo "取得された列挙型ケースの名前: " . $caseName . "\n"; // 結果: ACTIVE
43
44    // 参考: Enumクラス自体の名前空間情報を取得して比較します。
45    // ReflectionClass を使用すると、Enumクラス全体の詳細情報を取得できます。
46    $reflectionClass = new \ReflectionClass(Status::class);
47
48    // Enumクラスの完全修飾名（名前空間を含む名前）を取得します。
49    $fullClassName = $reflectionClass->getName();
50
51    // Enumクラスが属する名前空間の名前を取得します。
52    $namespaceName = $reflectionClass->getNamespaceName();
53
54    echo "\n--- 名前空間との関連性について --- \n";
55    echo "Enumクラスの完全修飾名 (名前空間を含む): " . $fullClassName . "\n"; // 例: App\Enums\Status
56    echo "Enumクラスが属する名前空間: " . $namespaceName . "\n";             // 例: App\Enums
57
58    // getName() が返すのは、Enumクラスの名前空間とは独立した、
59    // 列挙型ケース自身の短い名前であることを示します。
60    if ($caseName === 'ACTIVE') {
61        echo "上記 `ReflectionEnumUnitCase::getName()` が返すのは、列挙型ケースの短い名前 ('ACTIVE') です。\n";
62        echo "これは Enum クラスが属する名前空間 ('App\\Enums') とは直接関係なく、ケース固有の識別名です。\n";
63    }
64}
65
66// 関数の実行
67demonstrateReflectionEnumUnitCaseGetName();

PHP 8以降で導入されたReflectionEnumUnitCase::getName()メソッドは、Enum（列挙型）の特定のケースの名前を取得するために利用されます。このメソッドは引数を一切取らず、戻り値として、その列挙型ケースの短い名前を示す文字列を返します。例えば、Status::ACTIVEという列挙型ケースに対してこのメソッドを呼び出すと、"ACTIVE"という文字列が取得されます。

このメソッドが返すのは、Enumクラスが属する名前空間とは独立した、ケース固有の識別名です。サンプルコードでは、まずStatus::ACTIVEという列挙型ケースのReflectionEnumUnitCaseオブジェクトを取得し、getName()を呼び出すことで"ACTIVE"という結果を得ています。さらに、Enumクラス自体の完全修飾名や名前空間名も取得して比較することで、getName()が名前空間情報を含まない、純粋なケース名のみを返すことを明確に示しています。これにより、Enumのケースを動的に識別したり、プログラム上で利用したりする際に役立ちます。