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

Copy
1<?php
2
3// PHP 8.1以降で導入されたEnum（列挙型）を定義します。
4// ReflectionEnumはこのEnumの情報を取得するために使用されます。
5enum Status: string
6{
7    case Active = 'active';
8    case Inactive = 'inactive';
9    case Pending = 'pending';
10
11    /**
12     * Enumに定義されたメソッド。
13     * このメソッドをリフレクションAPIで取得し、情報を表示します。
14     */
15    public function getDescription(): string
16    {
17        return match ($this) {
18            self::Active => 'アカウントはアクティブです',
19            self::Inactive => 'アカウントは非アクティブです',
20            self::Pending => 'アカウントは保留中です',
21        };
22    }
23
24    /**
25     * 別のメソッドも定義しておきます。
26     */
27    public function isActive(): bool
28    {
29        return $this === self::Active;
30    }
31}
32
33/**
34 * ReflectionEnum::getMethod の使用例を示す関数。
35 * Enumから指定した名前のメソッドの情報を取得します。
36 */
37function demonstrateReflectionEnumGetMethod(): void
38{
39    // ReflectionEnumオブジェクトを作成します。
40    // 引数にはEnumクラスのフルネーム（または ::class 定数）を渡します。
41    $reflectionEnum = new ReflectionEnum(Status::class);
42
43    // 取得したいEnumメソッドの名前を指定します。
44    $methodName = 'getDescription';
45
46    try {
47        // ReflectionEnum::getMethod() を使用して、指定したメソッドの
48        // ReflectionMethodオブジェクトを取得します。
49        // 指定したメソッドが存在しない場合、ReflectionExceptionがスローされます。
50        $reflectionMethod = $reflectionEnum->getMethod($methodName);
51
52        echo "--- 取得した Enum メソッドの情報 ---" . PHP_EOL;
53        echo "メソッド名: " . $reflectionMethod->getName() . PHP_EOL;
54        echo "宣言クラス: " . $reflectionMethod->getDeclaringClass()->getName() . PHP_EOL;
55        echo "このメソッドはパブリックですか？ " . ($reflectionMethod->isPublic() ? 'はい' : 'いいえ') . PHP_EOL;
56        echo "このメソッドは静的ですか？ " . ($reflectionMethod->isStatic() ? 'はい' : 'いいえ') . PHP_EOL;
57        echo "メソッドの開始行: " . $reflectionMethod->getStartLine() . PHP_EOL;
58        echo "メソッドの終了行: " . $reflectionMethod->getEndLine() . PHP_EOL;
59        echo PHP_EOL;
60
61        // 別のメソッド 'isActive' を取得して情報を表示する例
62        $anotherMethodName = 'isActive';
63        echo "--- 別のEnumメソッド '" . $anotherMethodName . "' の情報 ---" . PHP_EOL;
64        $anotherReflectionMethod = $reflectionEnum->getMethod($anotherMethodName);
65        echo "メソッド名: " . $anotherReflectionMethod->getName() . PHP_EOL;
66        echo "このメソッドはパブリックですか？ " . ($anotherReflectionMethod->isPublic() ? 'はい' : 'いいえ') . PHP_EOL;
67        echo PHP_EOL;
68
69        // 存在しないメソッド名を試した場合の例（エラーが発生します）
70        $nonExistentMethod = 'nonExistentMethod';
71        echo "--- 存在しないメソッド名 '" . $nonExistentMethod . "' を取得しようとしました ---" . PHP_EOL;
72        try {
73            $reflectionEnum->getMethod($nonExistentMethod);
74        } catch (ReflectionException $e) {
75            echo "エラー: " . $e->getMessage() . PHP_EOL;
76        }
77
78    } catch (ReflectionException $e) {
79        // `getMethod`呼び出しでエラーが発生した場合
80        echo "主要メソッド取得中にエラーが発生しました: " . $e->getMessage() . PHP_EOL;
81    }
82}
83
84// 上で定義した関数を実行し、サンプルコードの動作を確認します。
85demonstrateReflectionEnumGetMethod();
86
87?>

ReflectionEnum::getMethodは、PHP 8.1以降で導入されたEnum（列挙型）に定義された特定のメソッドの情報を、プログラム実行中に動的に取得するための機能です。Enumの内部にどのようなメソッドが実装されているか、そのメソッドが持つ属性（例えばパブリックかどうか、引数、戻り値の型など）を詳しく調べたい場合に利用します。

このメソッドは、引数として取得したいEnumメソッドの名前を文字列（string $name）で指定します。戻り値としては、指定されたメソッドに関する詳細な情報を保持するReflectionMethodオブジェクトが返されます。もし指定された名前のメソッドがEnum内に存在しない場合、ReflectionExceptionというエラーがスローされます。

サンプルコードでは、StatusというEnumを定義し、その中にgetDescriptionやisActiveといったメソッドを実装しています。次に、ReflectionEnumのインスタンスを生成し、getMethodを使ってgetDescriptionメソッドのReflectionMethodオブジェクトを取得しています。取得したオブジェクトからは、メソッドの名前、宣言されているクラス、パブリックであるか、コードの開始行と終了行などの情報を引き出して表示しています。また、存在しないメソッド名を指定した場合に、どのようにReflectionExceptionを捕捉してエラーを処理するかの例も示しており、Enumの構造を解析する上で非常に有用な機能であることがわかります。

Copy
1<?php
2
3// Enum（列挙型）の定義
4// PHP 8.1 以降で利用可能です。
5// Enumは関連する定数をまとめるための仕組みで、メソッドを持つこともできます。
6enum UserRole: string
7{
8    case ADMIN = 'admin';
9    case EDITOR = 'editor';
10    case VIEWER = 'viewer';
11
12    /**
13     * Enumの各ケースに対応する表示名を取得するメソッド。
14     * これはインスタンスメソッドです。
15     */
16    public function getDisplayName(): string
17    {
18        return match ($this) {
19            self::ADMIN => '管理者',
20            self::EDITOR => '編集者',
21            self::VIEWER => '閲覧者',
22        };
23    }
24
25    /**
26     * すべてのロールとその表示名の連想配列を取得する静的メソッド。
27     * これは静的 (static) メソッドです。
28     */
29    public static function getAllRoleDescriptions(): array
30    {
31        return [
32            self::ADMIN->value => self::ADMIN->getDisplayName(),
33            self::EDITOR->value => self::EDITOR->getDisplayName(),
34            self::VIEWER->value => self::VIEWER->getDisplayName(),
35        ];
36    }
37}
38
39/**
40 * ReflectionEnum::getMethod() の使用例を示す関数。
41 *
42 * この関数は、PHPのリフレクションAPIを使用して、指定されたEnumの特定のメソッドを動的に取得し、
43 * そのメソッドに関する詳細情報を表示します。
44 * システムエンジニアを目指す初心者の方々が、プログラムの構造を動的に解析する
45 * リフレクションの強力さを理解するのに役立ちます。
46 */
47function demonstrateReflectionEnumGetMethod(): void
48{
49    echo "--- ReflectionEnum::getMethod() の使用例 ---\n";
50    echo "Enumのメソッドをリフレクションで取得し、その情報を解析します。\n\n";
51
52    // UserRole Enum の ReflectionEnum オブジェクトを作成します。
53    // ReflectionEnum は、Enumに関するリフレクション情報を提供します。
54    $reflectionEnum = new ReflectionEnum(UserRole::class);
55
56    echo "対象 Enum: " . $reflectionEnum->getName() . "\n\n";
57
58    // 1. 存在するインスタンスメソッドをリフレクションで取得する例
59    //    getMethod() は、指定された名前のメソッドに対応する ReflectionMethod オブジェクトを返します。
60    $methodName = 'getDisplayName';
61    try {
62        $reflectionMethod = $reflectionEnum->getMethod($methodName);
63        echo "■ インスタンスメソッドの情報 (メソッド名: '{$methodName}')\n";
64        echo "  - メソッド名: " . $reflectionMethod->getName() . "\n";
65        echo "  - 宣言されているクラス/Enum: " . $reflectionMethod->getDeclaringClass()->getName() . "\n";
66        echo "  - アクセス修飾子 (public か): " . ($reflectionMethod->isPublic() ? 'はい' : 'いいえ') . "\n";
67        echo "  - 静的メソッドか (static か): " . ($reflectionMethod->isStatic() ? 'はい' : 'いいえ') . "\n";
68        echo "  - パラメータ数: " . count($reflectionMethod->getParameters()) . "\n";
69        echo "\n";
70    } catch (ReflectionException $e) {
71        // メソッドが存在しない場合、ReflectionException がスローされます。
72        echo "エラー: メソッド '{$methodName}' の取得に失敗しました。 " . $e->getMessage() . "\n\n";
73    }
74
75    // 2. 存在する静的メソッド (static method) をリフレクションで取得する例
76    $staticMethodName = 'getAllRoleDescriptions';
77    try {
78        $reflectionStaticMethod = $reflectionEnum->getMethod($staticMethodName);
79        echo "■ 静的メソッドの情報 (メソッド名: '{$staticMethodName}')\n";
80        echo "  - メソッド名: " . $reflectionStaticMethod->getName() . "\n";
81        echo "  - 宣言されているクラス/Enum: " . $reflectionStaticMethod->getDeclaringClass()->getName() . "\n";
82        echo "  - アクセス修飾子 (public か): " . ($reflectionStaticMethod->isPublic() ? 'はい' : 'いいえ') . "\n";
83        echo "  - 静的メソッドか (static か): " . ($reflectionStaticMethod->isStatic() ? 'はい' : 'いいえ') . "\n";
84        echo "  - パラメータ数: " . count($reflectionStaticMethod->getParameters()) . "\n";
85        echo "\n";
86    } catch (ReflectionException $e) {
87        echo "エラー: 静的メソッド '{$staticMethodName}' の取得に失敗しました。 " . $e->getMessage() . "\n\n";
88    }
89
90    // 3. 存在しないメソッド名を指定した場合の例（エラーハンドリング）
91    $nonExistentMethod = 'nonExistentMethod';
92    try {
93        // 存在しないメソッド名を指定すると ReflectionException が発生します。
94        $reflectionEnum->getMethod($nonExistentMethod);
95        echo "誤って、存在しないメソッド '{$nonExistentMethod}' が取得されました。（このメッセージは通常表示されません）\n\n";
96    } catch (ReflectionException $e) {
97        echo "■ 存在しないメソッドを指定した場合\n";
98        echo "  - 想定通り、メソッド '{$nonExistentMethod}' は見つからず、ReflectionException が発生しました。\n";
99        echo "  - エラーメッセージ: " . $e->getMessage() . "\n\n";
100    }
101}
102
103// 上記で定義した関数を実行し、サンプルコードの動作を確認します。
104demonstrateReflectionEnumGetMethod();

ReflectionEnum::getMethod() は、PHP 8.1以降で利用可能なEnum（列挙型）の構造を動的に解析するための機能です。プログラムが実行中に、定義されているEnumの特定のメソッドに関する詳細な情報を取得する目的で使用されます。

このメソッドは、第一引数に調べたいメソッドの名前を文字列（string $name）で受け取ります。指定された名前のメソッドがEnum内に存在する場合、そのメソッドに関する詳細情報を提供するReflectionMethodオブジェクトを戻り値として返します。ReflectionMethodオブジェクトからは、メソッドの名前、宣言されているEnumの名前、それが静的メソッド（static）であるか、アクセス修飾子（public/protected/private）といった情報をプログラムから動的に取得し、利用することができます。

サンプルコードでは、UserRoleというEnumに定義されたgetDisplayName（インスタンスメソッド）やgetAllRoleDescriptions（静的メソッド）といった具体的なメソッドの情報を取得し、その特性を表示しています。もし指定された名前のメソッドがEnum内に存在しない場合は、ReflectionExceptionというエラーが発生し、処理を中断またはエラーハンドリングすることができます。このようにReflectionEnum::getMethod()を利用することで、Enumが持つメソッドの情報を実行時に柔軟に調べ、プログラムの動作をより動的に制御することが可能になります。