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

Copy
1<?php
2
3/**
4 * PHP 8.1で導入されたEnum（列挙型）を定義します。
5 */
6enum TrafficLight
7{
8    case Red;
9    case Yellow;
10    case Green;
11}
12
13/**
14 * 比較のために、通常のクラスを定義します。
15 */
16class Car
17{
18    public string $model;
19
20    public function __construct(string $model)
21    {
22        $this->model = $model;
23    }
24}
25
26// Enumのインスタンスを作成します。
27$redLight = TrafficLight::Red;
28
29// 通常のクラスのインスタンスを作成します。
30$myCar = new Car('Toyota');
31
32echo "--- ReflectionObject::isEnum() の使用例 ---" . PHP_EOL . PHP_EOL;
33
34// Enumインスタンスのリフレクションを作成し、isEnum()を呼び出します。
35// ReflectionObjectは、特定のオブジェクトの情報を取得するためのクラスです。
36$reflectionEnum = new ReflectionObject($redLight);
37echo "TrafficLight::Red はEnumか？: ";
38var_dump($reflectionEnum->isEnum()); // Enumなので true が出力されます。
39
40echo PHP_EOL;
41
42// 通常のクラスインスタンスのリフレクションを作成し、isEnum()を呼び出します。
43$reflectionObject = new ReflectionObject($myCar);
44echo "new Car('Toyota') はEnumか？: ";
45var_dump($reflectionObject->isEnum()); // 通常のクラスなので false が出力されます。
46
47?>

PHP 8.1で導入されたEnum（列挙型）は、特定の値の集合を表現するための機能です。ReflectionObject::isEnum()メソッドは、このEnumかどうかをプログラムから判定するために使用されます。

ReflectionObjectクラスは、実行中の任意のオブジェクトに関する情報を取得できるPHPの機能「リフレクションAPI」の一部です。このメソッドは、特定のオブジェクトがEnumであるかどうかを確認したい場合に役立ちます。

isEnum()メソッドは引数をとりません。呼び出すと、対象のオブジェクトがEnum型であればtrueを、通常のクラスやその他のオブジェクト型であればfalseを真偽値（bool）として返します。

サンプルコードでは、まずTrafficLightというEnumと、通常のCarクラスを定義しています。TrafficLight::RedというEnumのインスタンスを作成し、それをReflectionObjectに渡してisEnum()を呼び出すと、Enumであるためtrueが返されます。一方、new Car('Toyota')という通常のクラスのインスタンスに対して同様にReflectionObjectを作成しisEnum()を呼び出すと、Enumではないためfalseが返されます。このように、このメソッドはオブジェクトの型を動的に判別する際に利用できます。

Copy
1<?php
2
3/**
4 * PHP 8.1で導入されたEnum（列挙型）を定義します。
5 * 'string' をバッキング型として指定することで、from() メソッドが利用可能になります。
6 */
7enum UserStatus: string
8{
9    case Active = 'active';
10    case Pending = 'pending';
11    case Inactive = 'inactive';
12
13    /**
14     * Enumケースに応じた、より人間が理解しやすい表示用の文字列を返します。
15     */
16    public function label(): string
17    {
18        return match ($this) {
19            self::Active => '有効',
20            self::Pending => '保留中',
21            self::Inactive => '無効',
22        };
23    }
24}
25
26/**
27 * ReflectionObject::isEnum との比較のために、通常のクラスも定義します。
28 */
29class MyClass
30{
31    public string $name = '通常のクラスオブジェクト';
32}
33
34echo "--- ReflectionObject::isEnum の使用例 ---" . PHP_EOL;
35
36// キーワード 'php enum from' に関連して、from() メソッドを使ってEnumケースを取得します。
37$activeStatus = UserStatus::from('active');
38
39// Enumのインスタンスに対して ReflectionObject を作成します。
40$reflectionActiveStatus = new ReflectionObject($activeStatus);
41
42// isEnum() メソッドの結果を出力します。
43echo "オブジェクトタイプ: " . get_class($activeStatus) . PHP_EOL;
44echo "  値: " . $activeStatus->label() . " ({$activeStatus->value})" . PHP_EOL;
45echo "  isEnum() の結果: " . ($reflectionActiveStatus->isEnum() ? 'true' : 'false') . PHP_EOL . PHP_EOL;
46
47// 別のEnumケースを直接指定して、同様にチェックします。
48$pendingStatus = UserStatus::Pending;
49$reflectionPendingStatus = new ReflectionObject($pendingStatus);
50
51echo "オブジェクトタイプ: " . get_class($pendingStatus) . PHP_EOL;
52echo "  値: " . $pendingStatus->label() . " ({$pendingStatus->value})" . PHP_EOL;
53echo "  isEnum() の結果: " . ($reflectionPendingStatus->isEnum() ? 'true' : 'false') . PHP_EOL . PHP_EOL;
54
55echo "--- 通常のクラスインスタンスとの比較 ---" . PHP_EOL;
56
57// 通常のクラスのインスタンスを作成します。
58$myObject = new MyClass();
59
60// 通常のクラスインスタンスに対して ReflectionObject を作成します。
61$reflectionMyObject = new ReflectionObject($myObject);
62
63// isEnum() メソッドの結果を出力します。
64echo "オブジェクトタイプ: " . get_class($myObject) . PHP_EOL;
65echo "  値: " . $myObject->name . PHP_EOL;
66echo "  isEnum() の結果: " . ($reflectionMyObject->isEnum() ? 'true' : 'false') . PHP_EOL . PHP_EOL;
67
68?>

PHPのReflectionObject::isEnumメソッドは、指定されたオブジェクトがEnum（列挙型）のインスタンスであるかどうかを判定するために利用されます。このメソッドはReflectionObjectクラスに属しており、実行時にプログラムの構造や情報を動的に取得する「リフレクション」という機能の一部です。

EnumはPHP 8.1で導入された特別な型で、例えばユーザーの状態を「有効」「保留中」のように、あらかじめ決められた固定の選択肢として表現する際に役立ちます。

isEnum()メソッドは引数を必要としません。このメソッドを呼び出すと、対象のオブジェクトがEnumのインスタンスであればtrue（真）を、通常のクラスのインスタンスなどEnumではない場合はfalse（偽）を真偽値として戻り値で返します。

サンプルコードでは、UserStatusというEnumが定義されており、from('active')のように文字列値から対応するEnumケースを取得できるバッキング型を持っています。UserStatusのインスタンスに対してisEnum()を実行するとtrueが返されますが、MyClassのような通常のクラスのインスタンスに対して実行するとfalseが返されることが確認できます。これにより、プログラム実行時にオブジェクトの型を正確に識別することが可能になります。