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

Copy
1<?php
2
3/**
4 * ユーザー定義の列挙型（Enum）を定義します。
5 * ReflectionEnum::isUserDefined メソッドは、この列挙型が開発者によってコード内で定義されたものかを確認します。
6 */
7enum Status
8{
9    case Active;
10    case Inactive;
11    case Pending;
12}
13
14/**
15 * 定義した列挙型 `Status` について ReflectionEnum オブジェクトを作成します。
16 * Reflection クラス群は、プログラムの構造（クラス、メソッド、プロパティなど）に関する情報を
17 * 実行時に取得するための機能を提供します。
18 */
19$reflectionEnum = new ReflectionEnum(Status::class);
20
21/**
22 * isUserDefined メソッドを呼び出し、列挙型がユーザー定義であるかを確認します。
23 * このメソッドは、PHPの内部で定義されたものではなく、私たちがコード内で定義したものである場合に true を返します。
24 */
25$isUserDefined = $reflectionEnum->isUserDefined();
26
27/**
28 * 結果を表示します。
29 * `Status` はこのサンプルコードで定義したものであるため、true が出力されます。
30 */
31echo "列挙型 'Status' はユーザー定義ですか？ ";
32var_dump($isUserDefined);
33
34?>

PHPで利用できるReflectionEnum::isUserDefinedメソッドは、プログラムの実行中に「列挙型（Enum）」が開発者自身によって定義されたものか、それともPHPの内部で予め定義されているものかを判別するための機能です。

このメソッドはReflectionEnumクラスに属し、列挙型に関する情報をプログラムから動的に取得する際に利用されます。isUserDefinedメソッドは引数を取りません。呼び出すと、結果として真偽値（bool）を返します。もし対象の列挙型がユーザー（開発者）によってPHPコード内で独自に定義されたものであればtrueを返し、PHP本体に組み込まれた内部的な列挙型である場合はfalseを返します。

サンプルコードでは、まずStatusという列挙型を独自に定義しています。次に、このStatus列挙型の情報を調べるためにReflectionEnumオブジェクトを作成します。そして、作成した$reflectionEnumオブジェクトからisUserDefinedメソッドを呼び出すと、Statusは私たちがコード内で定義したものであるため、trueが戻り値として得られます。これにより、特定の列挙型がユーザー定義か否かをプログラムで判断し、それに応じた処理を行うことが可能になります。

Copy
1<?php
2
3// ユーザーが定義するEnumの例
4enum TrafficLight: string
5{
6    case Red = 'stop';
7    case Yellow = 'caution';
8    case Green = 'go';
9}
10
11/**
12 * ReflectionEnum::isUserDefined() のサンプルコード。
13 * このメソッドは、Enumがユーザーコードによって定義されたものかを確認します。
14 *
15 * キーワード「php isset undefined variable」との関連性:
16 * 変数の「定義の有無」を扱うissetやundefined variableと同様に、
17 * isUserDefinedはEnumの「定義元」という側面からその状態を検査します。
18 */
19
20// 1. ユーザー定義Enumに対するチェック
21try {
22    $reflectionUserEnum = new ReflectionEnum(TrafficLight::class);
23    $isUserDefined = $reflectionUserEnum->isUserDefined();
24
25    echo "Enum '" . TrafficLight::class . "' はユーザー定義ですか？ ";
26    echo ($isUserDefined ? 'はい' : 'いいえ') . PHP_EOL; // このEnumはユーザー定義なので「はい」と出力される
27} catch (ReflectionException $e) {
28    // ReflectionEnumのインスタンス化に失敗した場合
29    echo "エラー (ユーザー定義Enum): " . $e->getMessage() . PHP_EOL;
30}
31
32echo PHP_EOL; // 出力を見やすくするための改行
33
34// 2. 存在しないEnumクラス名でReflectionEnumを試みる
35// これは「未定義の変数」を扱おうとする状況と似ており、ReflectionExceptionが発生します。
36try {
37    // 存在しないEnumクラス名を指定
38    $reflectionNonExistentEnum = new ReflectionEnum('NonExistentEnum');
39    // 上の行で例外が発生するため、この下の行は実行されない
40} catch (ReflectionException $e) {
41    echo "エラー (未定義Enumクラス): 未定義のEnumクラスにアクセスしようとしました: " . $e->getMessage() . PHP_EOL;
42}

ReflectionEnum::isUserDefined()メソッドは、PHP 8で導入されたEnum（列挙型）が、プログラマであるユーザーのコードによって定義されたものかどうかを判定します。

このメソッドは引数を取りません。戻り値は真偽値（bool）で、ユーザーが定義したEnumであればtrueを、PHPが内部的に提供するようなEnumであればfalseを返します。

サンプルコードでは、まずTrafficLightというユーザーが定義したEnumに対してこのメソッドを適用しています。この場合、TrafficLightはユーザーコードで作成されたものなので、isUserDefined()はtrueを返します。

次に、存在しないNonExistentEnumというクラス名でReflectionEnumのインスタンスを作成しようとしています。この際、対象のEnumクラスが見つからないためReflectionExceptionが発生します。これは、PHPでisset関数が未定義の変数をチェックするのと似ており、「定義されているか」という状態を異なる文脈で検査していると言えます。つまり、isUserDefinedはEnumの「定義元」がユーザーコードであるかを確認するもので、変数の「定義の有無」を扱うissetや「未定義の変数」と同様に、対象の状態を検査するという共通の考え方を含んでいます。