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

Copy
1<?php
2
3// インターフェースを定義します。
4// Enumが特定の振る舞いを持つことを保証するために使用できます。
5interface Printable
6{
7    public function getPrintableValue(): string;
8}
9
10// Printable インターフェースを実装するEnumを定義します。
11enum ProductStatus implements Printable
12{
13    case AVAILABLE;
14    case OUT_OF_STOCK;
15    case DISCONTINUED;
16
17    // インターフェースで定義されたメソッドを実装します。
18    public function getPrintableValue(): string
19    {
20        return match ($this) {
21            self::AVAILABLE => '在庫あり',
22            self::OUT_OF_STOCK => '在庫切れ',
23            self::DISCONTINUED => '販売終了',
24        };
25    }
26}
27
28// Printable インターフェースを実装しない別のEnumを定義します。
29enum UserRole
30{
31    case ADMIN;
32    case EDITOR;
33    case VIEWER;
34}
35
36echo "--- ReflectionEnum::implementsInterface の使用例 ---" . PHP_EOL;
37
38// 1. ProductStatus Enum のリフレクション情報を作成します。
39// ReflectionEnum は、Enumに関する情報を動的に取得するためのクラスです。
40$reflectionProductStatus = new ReflectionEnum(ProductStatus::class);
41
42// ProductStatus Enum が Printable インターフェースを実装しているか確認します。
43// implementsInterface メソッドは、指定されたインターフェースをEnumが実装している場合に true を返します。
44$doesImplementPrintable = $reflectionProductStatus->implementsInterface(Printable::class);
45
46echo "'" . ProductStatus::class . "' は '" . Printable::class . "' を実装していますか？ ";
47echo ($doesImplementPrintable ? "はい" : "いいえ") . PHP_EOL; // 期待される出力: はい
48
49echo PHP_EOL; // 見やすくするための改行
50
51// 2. UserRole Enum のリフレクション情報を作成します。
52$reflectionUserRole = new ReflectionEnum(UserRole::class);
53
54// UserRole Enum が Printable インターフェースを実装しているか確認します。
55$doesImplementPrintable = $reflectionUserRole->implementsInterface(Printable::class);
56
57echo "'" . UserRole::class . "' は '" . Printable::class . "' を実装していますか？ ";
58echo ($doesImplementPrintable ? "はい" : "いいえ") . PHP_EOL; // 期待される出力: いいえ
59
60?>

PHPのReflectionEnum::implementsInterfaceメソッドは、プログラム実行時に、特定のEnum（列挙型）が指定されたインターフェースを実装しているかどうかを動的に確認するための機能です。リフレクションとは、プログラムの構造に関する情報を実行中に取得・操作する仕組みを指します。

このメソッドは、ReflectionEnumクラスのインスタンスから呼び出され、確認したいインターフェースのクラス名（文字列）またはReflectionClassオブジェクトを引数として受け取ります。そして、対象のEnumがそのインターフェースを実装している場合はtrueを、実装していない場合はfalseを戻り値として返します。

サンプルコードでは、まずPrintableインターフェースを定義し、Enumが特定のメソッドを持つことを保証する例を示しています。ProductStatus EnumはPrintableインターフェースを実装しているため、implementsInterfaceメソッドの実行結果はtrueとなります。対照的に、UserRole EnumはPrintableインターフェースを実装していないため、同じメソッドの実行結果はfalseとなります。このように、implementsInterfaceメソッドを使用することで、Enumが特定の役割や振る舞いを持っているかをプログラムから柔軟に判別でき、動的な処理や検証を行う際に非常に有効です。

Copy
1<?php
2
3// PHP 8 以降で利用可能な Enum (列挙型) の定義です。
4// このEnumは、インターフェース `Loggable` を `implements` (実装) しています。
5// インターフェースを実装することで、特定のメソッド（この場合は `getLogMessage`）
6// を必ず持つことを保証します。これが「php implements とは」の基本的な概念です。
7interface Loggable
8{
9    public function getLogMessage(): string;
10}
11
12// Loggable インターフェースを実装する Enum の例
13enum HttpStatus implements Loggable
14{
15    case OK;
16    case NotFound;
17    case InternalServerError;
18
19    // インターフェースで定義されたメソッドを実装します。
20    public function getLogMessage(): string
21    {
22        return "HTTP ステータス: " . $this->name;
23    }
24}
25
26// Loggable インターフェースを実装しない別の Enum の例
27enum Priority
28{
29    case High;
30    case Medium;
31    case Low;
32}
33
34/**
35 * ReflectionEnum::implementsInterface メソッドの使用例を示します。
36 * このメソッドは、列挙型が特定のインターフェースを実装しているかを確認します。
37 *
38 * @param string $enumClassName 確認したい Enum の完全修飾クラス名
39 * @param string|ReflectionClass $interfaceName 確認したいインターフェースの完全修飾クラス名、または ReflectionClass オブジェクト
40 */
41function demonstrateImplementsInterface(string $enumClassName, string|ReflectionClass $interfaceName): void
42{
43    // 指定された Enum のリフレクションオブジェクトを作成します。
44    // ReflectionEnum は Enum の詳細情報を実行時に取得するためのクラスです。
45    $reflectionEnum = new ReflectionEnum($enumClassName);
46
47    // 確認対象のインターフェース名を適切に表示するための処理
48    $interfaceDisplayName = is_string($interfaceName) ? $interfaceName : $interfaceName->getName();
49
50    echo "--- 確認: {$reflectionEnum->getName()} は {$interfaceDisplayName} を実装していますか？ ---" . PHP_EOL;
51
52    // implementsInterface メソッドを呼び出し、実装しているかどうかの真偽値を取得します。
53    // 引数にはインターフェースのクラス名（文字列）または ReflectionClass オブジェクトを渡せます。
54    $result = $reflectionEnum->implementsInterface($interfaceName);
55
56    if ($result) {
57        echo "結果: はい、'{$reflectionEnum->getName()}' は '{$interfaceDisplayName}' を実装しています。" . PHP_EOL;
58    } else {
59        echo "結果: いいえ、'{$reflectionEnum->getName()}' は '{$interfaceDisplayName}' を実装していません。" . PHP_EOL;
60    }
61    echo PHP_EOL;
62}
63
64// HttpStatus Enum が Loggable インターフェースを実装しているか確認します。（文字列でインターフェース名を指定）
65demonstrateImplementsInterface(HttpStatus::class, Loggable::class);
66
67// Priority Enum が Loggable インターフェースを実装しているか確認します。（文字列でインターフェース名を指定）
68demonstrateImplementsInterface(Priority::class, Loggable::class);
69
70// HttpStatus Enum が Loggable インターフェースを実装しているか確認します。（ReflectionClass オブジェクトでインターフェースを指定）
71$loggableReflectionClass = new ReflectionClass(Loggable::class);
72demonstrateImplementsInterface(HttpStatus::class, $loggableReflectionClass);
73

PHP 8から導入されたEnum（列挙型）は、事前に決められた選択肢を扱う際に便利な機能です。ここで、「php implements とは」という概念が登場します。implementsとは、Enumやクラスが特定のインターフェースを実装することを示し、そのインターフェースが定義するメソッドを必ず持つことを保証する仕組みです。これにより、コードの安全性と共通の振る舞いを保つことができます。

ReflectionEnumクラスは、PHPの実行中にEnumの構造や情報を詳しく調べるためのクラスです。このクラスに用意されているimplementsInterfaceメソッドは、指定したEnumが特定のインターフェースを実装しているかを確認するために使用されます。

implementsInterfaceメソッドの引数には、確認したいインターフェースの完全なクラス名（文字列）か、そのインターフェースを表すReflectionClassオブジェクトを渡します。このメソッドは、もしEnumがそのインターフェースを実装していればtrueを、実装していなければfalseを戻り値として返します。

サンプルコードでは、Loggableインターフェースを実装するHttpStatus Enumと、実装しないPriority Enumを例に、implementsInterfaceメソッドの動作を確認しています。HttpStatus Enumに対してはtrueが、Priority Enumに対してはfalseが返されることで、インターフェースの実装状況が正確に判定できることを示しています。これにより、特定の機能を持つEnumを動的に判別し、処理を分岐させることが可能になります。