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

Copy
1<?php
2
3// PHP 8で追加されたEnumの定義
4// このEnumは文字列型のバッキング型を持ちます。
5enum UserRole: string
6{
7    case Admin = 'admin';
8    case Editor = 'editor';
9    case Viewer = 'viewer';
10}
11
12/**
13 * PHPのEnumとReflectionClass::isSubclassOfメソッドの使用例を示します。
14 *
15 * プログラミング言語リファレンス情報では「ReflectionEnum::isSubclassOf」が指定されていますが、
16 * ReflectionEnumクラスにはこのメソッドは存在しません。
17 * 代わりに、Enumも通常のクラスと同様にReflectionClassでリフレクション可能であり、
18 * ReflectionClass::isSubclassOfメソッドを使って継承関係（インターフェースの実装も含む）をチェックします。
19 * isSubclassOfメソッドはブール値（true/false）を返します。
20 */
21function demonstrateEnumSubclassCheck(): void
22{
23    echo "--- PHP 8 Enum と ReflectionClass::isSubclassOf の利用例 ---\n\n";
24
25    // UserRole EnumのReflectionClassオブジェクトを作成します。
26    // EnumもPHPのクラスの一種なので、ReflectionClassでリフレクションできます。
27    $reflectionEnum = new ReflectionClass(UserRole::class);
28
29    echo "対象のEnum: " . $reflectionEnum->getName() . "\n";
30
31    // ReflectionClass::isSubclassOf メソッドを使用して、継承関係をチェックします。
32    // このメソッドは、対象が指定されたクラスの子孫であるか、または指定されたインターフェースを実装しているかを判定します。
33
34    // 1. 全てのEnumが実装するUnitEnumインターフェースとの関係をチェック
35    $isSubclassOfUnitEnum = $reflectionEnum->isSubclassOf(UnitEnum::class);
36    echo "- " . $reflectionEnum->getName() . " は " . UnitEnum::class . " の子孫（実装）ですか？: "
37        . ($isSubclassOfUnitEnum ? "はい" : "いいえ") . "\n"; // 全てのEnumはUnitEnumを実装します
38
39    // 2. バッキング型を持つEnumが実装するBackedEnumインターフェースとの関係をチェック
40    // UserRole Enumはstring型のバッキング型を持つため、BackedEnumを実装しています。
41    $isSubclassOfBackedEnum = $reflectionEnum->isSubclassOf(BackedEnum::class);
42    echo "- " . $reflectionEnum->getName() . " は " . BackedEnum::class . " の子孫（実装）ですか？: "
43        . ($isSubclassOfBackedEnum ? "はい" : "いいえ") . "\n"; // UserRoleはBackedEnumを実装します
44
45    // 3. 全く関係のないクラスとの関係をチェック
46    $isSubclassOfDateTime = $reflectionEnum->isSubclassOf(DateTime::class);
47    echo "- " . $reflectionEnum->getName() . " は " . DateTime::class . " の子孫ですか？: "
48        . ($isSubclassOfDateTime ? "はい" : "いいえ") . "\n"; // 関係ありません
49}
50
51// 関数を実行してサンプルコードの動作を確認します。
52demonstrateEnumSubclassCheck();

PHP 8で導入されたEnumは、関連する定数をグループ化するための機能です。リファレンス情報ではReflectionEnum::isSubclassOfというメソッドが挙げられていますが、実際にはこのメソッドはReflectionEnumクラスには存在しません。代わりに、EnumもPHPのクラスの一種として扱えるため、ReflectionClassクラスを使用してリフレクション（プログラムの構造を動的に調べること）を行います。

ReflectionClass::isSubclassOfメソッドは、指定されたクラス（またはインターフェース）が、対象のクラスの子孫であるか、または実装しているかを動的に判定するために使われます。このメソッドの引数には、比較したいクラスのReflectionClassオブジェクトか、クラス名を文字列で渡します。そして、戻り値はブール値となり、継承関係や実装関係があればtrue、なければfalseを返します。

サンプルコードでは、UserRoleというEnumのReflectionClassオブジェクトを作成し、isSubclassOfメソッドを使ってそのEnumがUnitEnumインターフェースやBackedEnumインターフェースを実装しているかを確認しています。全てのEnumはUnitEnumを、バッキング型を持つEnumはBackedEnumを実装するため、それぞれのチェック結果はtrueとなります。このメソッドにより、実行時にクラスやEnumの型が特定のインターフェースの要件を満たしているかを安全にチェックできるため、柔軟なコード設計に役立ちます。

Copy
1<?php
2
3// このコードは PHP 8.1 以降で動作します。
4
5/**
6 * Enumの定義。
7 * ReflectionEnum::isSubclassOf の動作を確認するために使用します。
8 */
9enum TrafficLight
10{
11    case Red;
12    case Yellow;
13    case Green;
14}
15
16/**
17 * 比較対象となるクラスの定義。
18 */
19class Vehicle {}
20
21/**
22 * 比較対象となるインターフェースの定義。
23 */
24interface ControlSystem {}
25
26/**
27 * ReflectionEnum::isSubclassOf メソッドの動作をデモンストレーションする関数です。
28 *
29 * このメソッドは、ReflectionEnum オブジェクトが表すEnumが、
30 * 指定されたクラスやインターフェースのサブクラスであるかを判定します。
31 * PHPのEnumはクラスを継承したりインターフェースを実装したりできないため、
32 * ReflectionEnum::isSubclassOf は常に false を返します。
33 *
34 * @param string $enumClass Enumの完全修飾名（例: TrafficLight::class）。
35 */
36function demonstrateReflectionEnumIsSubclassOf(string $enumClass): void
37{
38    echo "--- Enum: {$enumClass} の ReflectionEnum::isSubclassOf メソッドのデモンストレーション ---\n";
39
40    try {
41        $reflectionEnum = new ReflectionEnum($enumClass);
42
43        // 指定されたクラスが Enum のサブクラスであるかを確認
44        // PHPのEnumはクラスを継承できないため、結果は常に false になります。
45        $isSubclassOfVehicle = $reflectionEnum->isSubclassOf(Vehicle::class);
46        echo "{$enumClass} は " . Vehicle::class . " のサブクラスですか？ "
47            . ($isSubclassOfVehicle ? 'はい' : 'いいえ') . "\n";
48
49        // 指定されたインターフェースが Enum のサブクラスであるかを確認
50        // PHPのEnumはインターフェースを実装できないため、結果は常に false になります。
51        $isSubclassOfControlSystem = $reflectionEnum->isSubclassOf(ControlSystem::class);
52        echo "{$enumClass} は " . ControlSystem::class . " のサブクラスですか？ "
53            . ($isSubclassOfControlSystem ? 'はい' : 'いいえ') . "\n";
54
55        // Enum自身と比較した場合も false を返します。
56        $isSubclassOfSelf = $reflectionEnum->isSubclassOf($enumClass);
57        echo "{$enumClass} は自身 (" . $enumClass . ") のサブクラスですか？ "
58            . ($isSubclassOfSelf ? 'はい' : 'いいえ') . "\n";
59
60    } catch (ReflectionException $e) {
61        echo "エラー: " . $e->getMessage() . "\n";
62    }
63
64    echo "--- デモンストレーション終了 ---\n\n";
65}
66
67// デモンストレーション関数を実行
68demonstrateReflectionEnumIsSubclassOf(TrafficLight::class);

PHP 8.1以降で導入されたEnum（列挙型）の情報を扱うReflectionEnumクラスに属するisSubclassOfメソッドについて説明します。

このメソッドは、ReflectionEnumオブジェクトが表すEnumが、引数に指定されたクラスやインターフェースのサブクラスであるかを判定します。引数$classには、比較対象となるクラス名（例: Vehicle::class）またはReflectionClassのインスタンスを指定します。

しかし、PHPのEnumは、他のクラスを継承したりインターフェースを実装したりする仕組みがありません。このため、ReflectionEnum::isSubclassOfメソッドは、常にfalseを返します。

サンプルコードでは、TrafficLightというEnumを定義し、一般的なクラスVehicleやインターフェースControlSystemと比較しています。TrafficLightがこれらVehicleやControlSystemのサブクラスであるかをisSubclassOfで確認していますが、PHPのEnumの特性上、結果は常に「いいえ」(false)となります。Enum自身と比較した場合も同様にfalseを返します。このメソッドの戻り値はbool型ですが、Enumが継承や実装を行わないため、その性質上、常にfalseを返す挙動となります。