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

Copy
1<?php
2
3/**
4 * ユーザーのステータスを表す列挙型（Enum）を定義します。
5 * 列挙型はPHP 8.1以降で利用可能な機能です。
6 */
7enum UserStatus
8{
9    case ACTIVE;
10    case INACTIVE;
11    case PENDING;
12}
13
14/**
15 * 管理者のステータスを表す別の列挙型を定義します。
16 */
17enum AdminStatus
18{
19    case ONLINE;
20    case OFFLINE;
21}
22
23/**
24 * 指定されたオブジェクトが特定の列挙型のインスタンスであるかをチェックし、結果を出力する関数です。
25 * ReflectionEnum::isInstance() メソッドと、PHPの 'instanceof' 演算子の両方を使用します。
26 *
27 * @param object $object チェック対象のオブジェクト。
28 */
29function demonstrateEnumInstanceCheck(object $object): void
30{
31    echo "--- 列挙型インスタンスの型チェック ---" . PHP_EOL;
32    echo "チェック対象オブジェクトの型: " . get_debug_type($object) . PHP_EOL . PHP_EOL;
33
34    // ReflectionEnum は、プログラムの実行時にクラスや列挙型に関する情報を取得するための機能です。
35    // ここでは、UserStatus 列挙型と AdminStatus 列挙型それぞれのリフレクションオブジェクトを作成します。
36    $reflectionUserStatus = new ReflectionEnum(UserStatus::class);
37    $reflectionAdminStatus = new ReflectionEnum(AdminStatus::class);
38
39    echo "◆ ReflectionEnum::isInstance() を使用したチェック:" . PHP_EOL;
40    // ReflectionEnum::isInstance() は、指定されたオブジェクトが、
41    // このリフレクションオブジェクトが表す列挙型のインスタンスである場合に true を返します。
42    if ($reflectionUserStatus->isInstance($object)) {
43        echo "  - ReflectionEnum(UserStatus) は、オブジェクトが UserStatus 列挙型のインスタンスだと判断しました。" . PHP_EOL;
44    } else {
45        echo "  - ReflectionEnum(UserStatus) は、オブジェクトが UserStatus 列挙型のインスタンスではないと判断しました。" . PHP_EOL;
46    }
47
48    if ($reflectionAdminStatus->isInstance($object)) {
49        echo "  - ReflectionEnum(AdminStatus) は、オブジェクトが AdminStatus 列挙型のインスタンスだと判断しました。" . PHP_EOL;
50    } else {
51        echo "  - ReflectionEnum(AdminStatus) は、オブジェクトが AdminStatus 列挙型のインスタンスではないと判断しました。" . PHP_EOL;
52    }
53
54    echo PHP_EOL;
55
56    echo "◆ 'instanceof' 演算子 (php instanceof) を使用したチェック:" . PHP_EOL;
57    // 'instanceof' 演算子は、オブジェクトが特定のクラス、インターフェース、または列挙型の
58    // インスタンスであるか、またはその子孫であるかを直接判定します。
59    if ($object instanceof UserStatus) {
60        echo "  - instanceof UserStatus は、オブジェクトが UserStatus 列挙型のインスタンスだと判断しました。" . PHP_EOL;
61    } else {
62        echo "  - instanceof UserStatus は、オブジェクトが UserStatus 列挙型のインスタンスではないと判断しました。" . PHP_EOL;
63    }
64
65    if ($object instanceof AdminStatus) {
66        echo "  - instanceof AdminStatus は、オブジェクトが AdminStatus 列挙型のインスタンスだと判断しました。" . PHP_EOL;
67    } else {
68        echo "  - instanceof AdminStatus は、オブジェクトが AdminStatus 列挙型のインスタンスではないと判断しました。" . PHP_EOL;
69    }
70
71    echo PHP_EOL;
72}
73
74// -------------------------------------------------------------
75// 以下のコードで、実際にさまざまなオブジェクトの型チェックを試します。
76// -------------------------------------------------------------
77
78// 1. UserStatus 列挙型のインスタンスをチェック
79demonstrateEnumInstanceCheck(UserStatus::ACTIVE);
80echo "=========================================" . PHP_EOL . PHP_EOL;
81
82// 2. AdminStatus 列挙型のインスタンスをチェック
83demonstrateEnumInstanceCheck(AdminStatus::ONLINE);
84echo "=========================================" . PHP_EOL . PHP_EOL;
85
86// 3. 列挙型ではない通常のクラスのインスタンスをチェック
87class MyCustomClass {}
88demonstrateEnumInstanceCheck(new MyCustomClass());
89echo "=========================================" . PHP_EOL . PHP_EOL;
90
91// 4. PHP組み込みのクラスのインスタンスをチェック
92demonstrateEnumInstanceCheck(new stdClass());
93echo "=========================================" . PHP_EOL . PHP_EOL;
94
95?>

ReflectionEnum::isInstance()は、PHP 8.1以降で利用できる「列挙型（Enum）」のインスタンスが、特定の列挙型の型に属するかどうかを、プログラムの実行中に確認するためのメソッドです。これは、プログラムの実行時にクラスや列挙型の詳細な情報を取得する「リフレクションAPI」の一部であるReflectionEnumクラスに属しています。

このisInstance()メソッドは、チェック対象となるobject $objectを引数として受け取ります。そして、もしそのオブジェクトが、このReflectionEnumインスタンスが表している列挙型の実体であるならばtrueを、そうでない場合はfalseをbool型の戻り値として返します。

PHPには、オブジェクトが特定の型であるかを直接確認するinstanceof演算子（例えば$object instanceof UserStatus）がありますが、これはコード上で型を明示的に指定する必要があります。それに対してReflectionEnum::isInstance()は、どの列挙型を検証するかをプログラムの実行時に動的に指定できるため、より柔軟な型チェックを実現したい場合に利用されます。サンプルコードでは、両者の挙動の違いを比較しながら、列挙型インスタンスの型がどのように判断されるかを具体的に示しています。