【PHP8.x】ReflectionEnum::nameプロパティの使い方

nameプロパティの使い方について、初心者にもわかりやすく解説します。

作成日: 2025年09月11日更新日: 2026年01月29日

基本的な使い方

nameプロパティは、ReflectionEnumクラスが表す列挙型（Enum）の名前を保持するプロパティです。ReflectionEnumクラスは、PHP 8.1以降で導入された列挙型（Enum）について、プログラムの実行中にその構造や定義に関する情報を取得するために利用されます。

このnameプロパティにアクセスすることで、リフレクションの対象となっているEnum型自身の短い名前、つまり名前空間を含まないクラス名部分を文字列として取得できます。例えば、namespace App\Enums; enum Status { ... } のように定義されたStatusというEnumがある場合、対応するReflectionEnumインスタンスのnameプロパティは"Status"という文字列を返します。

この情報は、コードの実行時に特定のEnumがどのような名前で宣言されているかを確認したい場合に役立ちます。例えば、ログ出力を行う際にEnumの名前を含めたり、Enumの名前を使って動的に異なる処理を実行したりするなど、リフレクションを駆使した柔軟なプログラミングにおいて重要な役割を果たします。開発者はこのプロパティを通じて、Enumの名前をプログラム的に取得し、その情報を活用することが可能です。

構文(syntax)


1<?php
2
3enum Status
4{
5    case ACTIVE;
6    case INACTIVE;
7}
8
9$reflectionEnum = new ReflectionEnum('Status');
10
11$enumName = $reflectionEnum->name;
12
13echo $enumName;

引数(parameters)

引数なし

引数はありません

戻り値(return)

string

ReflectionEnumクラスのnameプロパティは、列挙型（Enum）の名前を文字列として返します。

サンプルコード

PHP Enumの名前空間をリフレクションする


1<?php
2
3namespace MyApp\Enums;
4
5/**
6 * サンプルで使用する列挙型（Enum）を定義します。
7 * PHP 8.1 以降で利用可能です。
8 */
9enum UserRole: string
10{
11    case ADMIN = 'admin';
12    case EDITOR = 'editor';
13    case VIEWER = 'viewer';
14}
15
16/**
17 * ReflectionEnum::name プロパティの使用方法を示す関数。
18 * 名前空間を持つ列挙型の名前を取得する方法を説明します。
19 */
20function demonstrateReflectionEnumName(): void
21{
22    // ReflectionEnum オブジェクトを作成し、UserRole 列挙型をリフレクションします。
23    // ReflectionEnum クラスは、列挙型に関する情報にアクセスするために使用されます。
24    $reflectionEnum = new \ReflectionEnum(UserRole::class);
25
26    // 'name' プロパティは、列挙型の名前空間を含まない短縮名（UserRole）を返します。
27    $enumName = $reflectionEnum->name;
28
29    echo "リフレクションされた列挙型の名前: " . $enumName . "\n";
30
31    // 名前空間を含んだ完全修飾名を取得したい場合は、getName() メソッドを使用します。
32    $fullEnumName = $reflectionEnum->getName();
33    echo "リフレクションされた列挙型の完全修飾名: " . $fullEnumName . "\n";
34}
35
36// 関数を実行してサンプルコードの動作を確認します。
37demonstrateReflectionEnumName();
38

このコードは、PHP 8で導入されたリフレクションAPIを活用し、列挙型（enum）の情報をプログラムが動的に調べる方法を紹介します。特に、ReflectionEnumクラスのnameプロパティに焦点を当てています。

まず、サンプルコードではMyApp\Enums名前空間内にUserRoleという列挙型を定義しています。これはユーザーの役割（ADMIN, EDITORなど）を表現するためのものです。

次に、new \ReflectionEnum(UserRole::class)としてReflectionEnumオブジェクトを作成します。これにより、定義したUserRole列挙型に関する様々なメタ情報にプログラムからアクセスできるようになります。

$reflectionEnum->nameプロパティは、この列挙型の名前を文字列として返します。このプロパティは引数を一切取らず、常に列挙型の「短縮名」を文字列（string）で提供します。具体的には、名前空間MyApp\Enumsを含まないUserRoleという名前が返されます。

もし名前空間を含んだ「完全修飾名」（例: MyApp\Enums\UserRole）を取得したい場合は、$reflectionEnum->getName()メソッドを使用します。このサンプルコードは、nameプロパティとgetName()メソッドを比較することで、名前空間を持つ列挙型の場合にそれぞれがどのような名前を返すのかを明確に示しています。システムエンジニアを目指す初心者の方にとって、リフレクションによるクラス情報の取得とその挙動を理解する一助となるでしょう。

このサンプルコードで利用されているReflectionEnum::nameプロパティは、列挙型の短い名前（この例ではUserRole）を返します。名前空間（MyApp\Enums）を含んだ完全な名前（MyApp\Enums\UserRole）が必要な場合は、$reflectionEnum->getName()メソッドを使用する必要がある点に注意してください。また、PHPの列挙型（enum）機能とそれに対応するReflectionEnumクラスは、PHP 8.1以降で導入されました。そのため、サンプルコードを実際に動作させるにはPHP 8.1以上の環境が必要です。名前空間はクラスの識別子の一部ですが、リフレクションで名前を扱う際には短い名前と完全修飾名を正しく区別して利用することが重要です。