【PHP8.x】enum_exists関数の使い方

Copy
1<?php
2
3/**
4 * トランプのスーツを表すBacked Enum
5 *
6 * PHP 8.1以降で利用可能な列挙型(enum)の例です。
7 */
8enum Suit: string
9{
10    case Hearts = 'H';
11    case Diamonds = 'D';
12    case Clubs = 'C';
13    case Spades = 'S';
14}
15
16/**
17 * 指定されたenumとそのケース(値)が存在するかを確認し、結果を表示します。
18 *
19 * @param string $enumClassName チェックしたいenumのクラス名
20 * @param string $caseName チェックしたいケース名
21 * @return void
22 */
23function checkEnumAndCase(string $enumClassName, string $caseName): void
24{
25    // enum_exists() を使用して、指定された名前のenumが定義されているかを確認します。
26    if (enum_exists($enumClassName)) {
27        echo "OK: enum '{$enumClassName}' は存在します。" . PHP_EOL;
28
29        // enumが存在する場合、次にそのenumに特定のケース(値)が存在するかを確認します。
30        // enumのケースは内部的にクラス定数として扱われるため、defined()でチェックできます。
31        $constantName = $enumClassName . '::' . $caseName;
32        if (defined($constantName)) {
33            echo "OK: ケース '{$caseName}' は '{$enumClassName}' に存在します。" . PHP_EOL;
34        } else {
35            echo "NG: ケース '{$caseName}' は '{$enumClassName}' に存在しません。" . PHP_EOL;
36        }
37    } else {
38        echo "NG: enum '{$enumClassName}' は存在しません。" . PHP_EOL;
39    }
40    echo "----------------------------------------" . PHP_EOL;
41}
42
43
44// --- 実行例 ---
45
46// 存在するenumと存在するケースをチェック
47checkEnumAndCase(Suit::class, 'Hearts');
48
49// 存在するenumと存在しないケースをチェック
50checkEnumAndCase(Suit::class, 'Joker');
51
52// 存在しないenumをチェック
53checkEnumAndCase('Color', 'Red');
54
55?>

PHPのenum_exists関数は、指定された名前のEnum（列挙型）が現在の環境に存在するかどうかを確認するために使用されます。この関数は、PHP 8.1以降で導入されたEnumが利用可能か、または特定のEnumが定義されているかを実行時にチェックする際に役立ちます。

引数には、確認したいEnumの完全修飾クラス名を文字列で渡します。例えば、サンプルコードのSuit::classのように指定します。オプションの第二引数$autoloadはデフォルトでtrueであり、指定されたEnumが見つからない場合にPHPのオートロード機構を試みるかどうかを制御します。戻り値は真偽値（bool）で、Enumが存在すればtrue、存在しなければfalseを返します。

サンプルコードでは、トランプのスーツを表すSuitというEnumが定義されています。checkEnumAndCase関数では、まずenum_existsを用いてSuitのようなEnumクラス自体がPHPに登録されているかを確認します。Enumが存在すると確認できた後、そのEnumに特定のケース（例えばHeartsやJoker）が存在するかどうかは、enum_existsでは直接判断できません。Enumのケースは内部的にはクラス定数として扱われるため、defined()関数に「Enum名::ケース名」という形式の文字列を渡すことで存在をチェックしています。

実行例を通じて、存在するEnumと存在するケース、存在するEnumと存在しないケース、そして存在しないEnumをそれぞれチェックし、enum_existsとdefinedを組み合わせることで、Enumとその中の特定のケースの両方を確実に存在確認できる方法が示されています。

Copy
1<?php
2
3/**
4 * enum_exists 関数の使用例
5 */
6
7// Enum が存在するか確認する
8if (enum_exists(MyEnum::class)) {
9    echo "Enum MyEnum が存在します。\n";
10} else {
11    echo "Enum MyEnum が存在しません。\n";
12}
13
14// 存在しない Enum を確認する
15if (!enum_exists("NonExistentEnum")) {
16    echo "Enum NonExistentEnum は存在しません。\n";
17} else {
18    echo "Enum NonExistentEnum が存在します。\n";
19}
20
21// Enum の定義 (上記の例を動作させるために必要)
22enum MyEnum {
23    case VALUE1;
24    case VALUE2;
25}
26
27?>

enum_exists関数は、指定されたEnum型が定義されているかどうかを確認するために使用されます。PHP 8.1で導入されたEnum型は、特定の値を事前に定義し、それ以外の値を受け付けないようにする機能です。この関数を利用することで、プログラム実行時にEnum型が存在するかどうかを動的に判断できます。

enum_exists関数は、第一引数にEnum型の名前を文字列で指定します。この名前空間を含んだ完全修飾名である必要があります（例: MyNamespace\MyEnum::class）。第二引数には、autoloadというオプションの引数があり、デフォルト値はtrueです。autoloadがtrueの場合、Enum型が見つからなければ、自動的にクラスのオートローダーが呼び出され、Enum型の定義が試みられます。autoloadがfalseの場合、オートローダーは呼び出されません。

戻り値はbool型で、Enum型が存在する場合はtrue、存在しない場合はfalseを返します。サンプルコードでは、まずMyEnumというEnum型が存在するかどうかを確認しています。存在する場合は「Enum MyEnum が存在します。」というメッセージが表示されます。次に、存在しないEnum型であるNonExistentEnumの存在を確認し、存在しないことを確認しています。enum MyEnumの定義は、enum_exists関数の使用例を動作させるために必須です。この関数を使用することで、Enum型を利用する前にその存在を確認し、エラーを未然に防ぐことができます。

Copy
1<?php
2
3/**
4 * ユーザーの状態を表すEnum。
5 *
6 * PHP 8.1以降で導入されたEnumは、関連する定数をグループ化し、
7 * 型安全性を提供します。
8 */
9enum UserStatus
10{
11    case Active;
12    case Inactive;
13    case Pending;
14}
15
16/**
17 * アプリケーション設定を表すEnum。
18 * バックドEnumとして文字列値を持ちます。
19 */
20enum AppConfig: string
21{
22    case DebugMode = 'debug';
23    case ProductionMode = 'production';
24}
25
26/**
27 * `enum_exists` 関数の基本的な使用例を示します。
28 *
29 * `enum_exists(string $enum, bool $autoload = true)` は、
30 * 指定された名前のEnum型が定義されているかどうかを真偽値で返します。
31 *
32 * @return void
33 */
34function demonstrateEnumExists(): void
35{
36    echo "--- `enum_exists` 関数によるEnum型の存在チェック ---" . PHP_EOL;
37
38    // 1. 存在するEnum型名を指定してチェック
39    // 'UserStatus' というEnumが定義されているため、trueを返します。
40    $userStatusExists = enum_exists('UserStatus');
41    echo "Enum 'UserStatus' は存在しますか？: " . ($userStatusExists ? 'はい' : 'いいえ') . PHP_EOL; // 期待される出力: はい
42
43    // 'AppConfig' というEnumも定義されているため、trueを返します。
44    $appConfigExists = enum_exists('AppConfig');
45    echo "Enum 'AppConfig' は存在しますか？: " . ($appConfigExists ? 'はい' : 'いいえ') . PHP_EOL; // 期待される出力: はい
46
47    // 2. 存在しないEnum型名を指定してチェック
48    // 'NonExistentEnum' は定義されていないため、falseを返します。
49    $nonExistentEnumExists = enum_exists('NonExistentEnum');
50    echo "Enum 'NonExistentEnum' は存在しますか？: " . ($nonExistentEnumExists ? 'はい' : 'いいえ') . PHP_EOL; // 期待される出力: いいえ
51
52    echo PHP_EOL;
53    echo "--- autoload 引数について ---" . PHP_EOL;
54    echo "`enum_exists`関数の第二引数`$autoload`はデフォルトで`true`です。" . PHP_EOL;
55    echo "これにより、指定されたEnumがまだロードされていない場合でも、PHPは自動的に対応するファイルを検索し、" . PHP_EOL;
56    echo "そのEnumをロードしようと試みます。通常はこのデフォルト設定で問題ありません。" . PHP_EOL;
57}
58
59// 上記の関数を実行して、結果を出力します。
60demonstrateEnumExists();
61

PHPのenum_exists関数は、指定された名前のEnum（列挙型）がアプリケーション内に定義されているかどうかを確認するために使用される関数です。この関数は、PHP 8.1以降で導入されたEnum型の存在チェックに利用できます。

第一引数$enumには、存在を確認したいEnum型の完全な名前を文字列で指定します。例えば、サンプルコードで定義されているUserStatusやAppConfigといったEnumの名前を指定します。

第二引数$autoloadはオプションで、デフォルトはtrueに設定されています。この引数がtrueの場合、指定されたEnumがまだPHPによってロードされていない場合でも、PHPはオートロード機能を使ってそのEnumを定義しているファイルを自動的に検索し、ロードを試みます。特別な理由がない限り、通常はこのデフォルト設定のままで問題ありません。

enum_exists関数の戻り値はbool型です。指定された名前のEnum型が定義されていればtrueを、存在しなければfalseを返します。

サンプルコードでは、まずUserStatusとAppConfigという二つのEnumを定義しています。enum_exists('UserStatus')やenum_exists('AppConfig')の呼び出しは、これらのEnumが定義されているためtrue（「はい」）を返します。これに対し、定義されていないNonExistentEnumを指定したenum_exists('NonExistentEnum')の呼び出しは、false（「いいえ」）を返します。このように、この関数を使うことで、プログラムの実行中に特定のEnumが利用可能かどうかを動的に、かつ安全に確認できます。