Webエンジニア向けプログラミング解説動画をYouTubeで配信中!
▶ チャンネル登録はこちら

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

isEnumメソッドの使い方について、初心者にもわかりやすく解説します。

作成日: 更新日:

基本的な使い方

isEnumメソッドは、特定のクラスがPHP 8.1以降で導入されたEnum(列挙型)であるかどうかを判定するメソッドです。このメソッドは、PHPのリフレクションAPIの一部であるReflectionClassクラスのインスタンスから呼び出されます。ReflectionClassは、クラスやインターフェース、トレイトといったPHPの構造に関する詳細な情報を、プログラムの実行中に取得できる強力な機能を提供します。

isEnumメソッドを呼び出すと、対象となるReflectionClassオブジェクトが表すクラスがEnumとして定義されていれば真(true)を、そうでなければ偽(false)をブール値で返します。これにより、開発者は実行時に動的にクラスの型を検査し、そのクラスがEnumであるかどうかに応じて異なる処理を実行する判断を下すことができます。

例えば、Enum型に特化した処理を行う汎用的なツールを作成する際や、未知のクラスがEnumであるか否かを検証するテストコードなどでこのメソッドは非常に有用です。このメソッドは、PHP 8.1で列挙型が正式に導入されたことに伴い追加されたものであり、それ以前のPHPバージョンでは利用できませんのでご注意ください。

構文(syntax)

1enum MyEnum
2{
3    case CaseA;
4    case CaseB;
5}
6
7$reflector = new ReflectionClass(MyEnum::class);
8$isEnum = $reflector->isEnum();
9var_dump($isEnum);

引数(parameters)

引数なし

引数はありません

戻り値(return)

bool

このメソッドは、ReflectionClassインスタンスが表すクラスが列挙型(Enum)である場合に true を、そうでない場合に false を返します。

関連コンテンツ