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

Copy
1<?php
2
3// Enumの定義
4// PHP 8.1以降で導入された列挙型です。
5// このEnumには、通常のクラスと同様にメソッドを定義できます。
6enum UserStatus
7{
8    case Active;
9    case Pending;
10    case Inactive;
11
12    /**
13     * 現在のステータスに応じた説明文を返します。
14     * これはインスタンスメソッドの例です。
15     *
16     * @return string
17     */
18    public function getDescription(): string
19    {
20        return match ($this) {
21            self::Active => 'アカウントは有効です。',
22            self::Pending => 'アカウントは承認待ちです。',
23            self::Inactive => 'アカウントは無効です。',
24        };
25    }
26
27    /**
28     * すべてのステータスの名前を配列で返します。
29     * これは静的メソッドの例です。
30     *
31     * @return string[]
32     */
33    public static function getAllNames(): array
34    {
35        return array_map(fn(UserStatus $status) => $status->name, self::cases());
36    }
37
38    /**
39     * プライベートなヘルパーメソッドの例です。
40     * リフレクションでは、プライベートメソッドも取得できます。
41     */
42    private function internalHelper(): void
43    {
44        // 内部処理
45    }
46}
47
48/**
49 * ReflectionEnum::getMethods() を使用して、Enumのメソッド情報を取得するサンプル関数です。
50 * システムエンジニアを目指す初心者の方にも理解しやすいように、各メソッドの詳細を出力します。
51 *
52 * @param class-string<UserStatus> $enumClassName 対象のEnumクラスの完全修飾名
53 */
54function displayEnumMethods(string $enumClassName): void
55{
56    try {
57        // ReflectionEnumのインスタンスを作成します。
58        // これにより、Enumに関するメタデータにプログラムでアクセスできるようになります。
59        $reflectionEnum = new ReflectionEnum($enumClassName);
60
61        echo "--- Enum: {$reflectionEnum->getName()} のメソッド情報 ---\n\n";
62
63        // getMethods() メソッドを使用して、Enumが持つすべてのメソッドを取得します。
64        // 引数 `$filter` を指定しない場合、すべてのアクセス修飾子（public, protected, private）の
65        // メソッドが取得対象となります。
66        $methods = $reflectionEnum->getMethods();
67
68        if (empty($methods)) {
69            echo "このEnumにはメソッドが定義されていません。\n";
70            return;
71        }
72
73        foreach ($methods as $method) {
74            echo "メソッド名: " . $method->getName() . "\n";
75            echo "  宣言クラス: " . $method->getDeclaringClass()->getName() . "\n";
76            echo "  公開 (public): " . ($method->isPublic() ? 'はい' : 'いいえ') . "\n";
77            echo "  保護 (protected): " . ($method->isProtected() ? 'はい' : 'いいえ') . "\n";
78            echo "  非公開 (private): " . ($method->isPrivate() ? 'はい' : 'いいえ') . "\n";
79            echo "  抽象 (abstract): " . ($method->isAbstract() ? 'はい' : 'いいえ') . "\n";
80            echo "  ファイナル (final): " . ($method->isFinal() ? 'はい' : 'いいえ') . "\n";
81            echo "  静的 (static): " . ($method->isStatic() ? 'はい' : 'いいえ') . "\n";
82            echo "\n";
83        }
84
85    } catch (ReflectionException $e) {
86        echo "エラー: " . $e->getMessage() . "\n";
87    }
88}
89
90// サンプルコードを実行します。
91// UserStatus::class は、UserStatusというEnumの完全修飾名を返します。
92displayEnumMethods(UserStatus::class);

このPHPサンプルコードは、PHP 8.1以降で導入されたEnum（列挙型）のメソッド情報を、リフレクションAPIを用いて取得し表示する方法を示しています。UserStatusというEnumには、インスタンスメソッド、静的メソッド、プライベートメソッドが定義されており、これらがリフレクションによってどのように扱われるかを確認できます。

主要なメソッドはReflectionEnum::getMethods()です。このメソッドは、指定されたEnumクラスに定義されているすべてのメソッドに関する情報を持つReflectionMethodオブジェクトの配列を返します。引数$filterには、ReflectionMethod::IS_PUBLICのような定数を渡すことで、取得するメソッドの公開範囲（public, protected, private）を絞り込むことができますが、サンプルでは指定しないため、すべてのメソッドが取得されます。

コードではまずUserStatusクラスをReflectionEnumクラスのインスタンスとしてラップし、そのgetMethods()を呼び出しています。その後、取得した各ReflectionMethodオブジェクトから、メソッド名、宣言クラス、アクセス修飾子（public, protected, private）、抽象性、ファイナル性、静的かどうかといった詳細情報を取得し、画面に出力しています。これにより、実行時にEnumの構造を動的に解析し、プログラムの振る舞いを検査することが可能です。

Copy
1<?php
2
3/**
4 * このコードは、PHP 8 で導入された Enum (列挙型) のメソッドをリフレクションAPIを使って取得する方法を示します。
5 * ReflectionEnum::getMethods() メソッドは、Enum に定義されているメソッドの ReflectionMethod オブジェクトの配列を返します。
6 * オプションの $filter 引数を使用すると、特定の種類のメソッド（例: public, static）のみを取得できます。
7 */
8
9// サンプルとして使用するEnumを定義します。
10// EnumはPHP 8.1以降で利用可能です。
11enum UserStatus
12{
13    case Active;
14    case Inactive;
15    case Pending;
16
17    // public メソッド
18    public function getDescription(): string
19    {
20        return match ($this) {
21            self::Active => 'ユーザーはアクティブです。',
22            self::Inactive => 'ユーザーは非アクティブです。',
23            self::Pending => 'ユーザーは承認待ちです。',
24        };
25    }
26
27    // private メソッド (リフレクションでのみアクセス可能)
28    private function internalHelper(): string
29    {
30        return '内部ヘルパー関数';
31    }
32
33    // static メソッド
34    public static function getDefaultStatus(): self
35    {
36        return self::Pending;
37    }
38}
39
40/**
41 * UserStatus Enum のメソッド情報を取得して表示する関数。
42 */
43function demonstrateReflectionEnumMethods(): void
44{
45    echo "--- ReflectionEnum::getMethods() のデモンストレーション ---" . PHP_EOL . PHP_EOL;
46
47    try {
48        // UserStatus Enum の ReflectionEnum インスタンスを作成します。
49        $reflectionEnum = new ReflectionEnum(UserStatus::class);
50
51        echo "Enum名: " . $reflectionEnum->getName() . PHP_EOL . PHP_EOL;
52
53        // 1. フィルタなしで全てのメソッドを取得します。
54        echo "--- 全てのメソッド ---" . PHP_EOL;
55        $allMethods = $reflectionEnum->getMethods();
56        if (empty($allMethods)) {
57            echo "メソッドは見つかりませんでした。" . PHP_EOL;
58        } else {
59            foreach ($allMethods as $method) {
60                echo "  メソッド名: " . $method->getName() . PHP_EOL;
61            }
62        }
63        echo PHP_EOL;
64
65        // 2. public メソッドのみを取得します。
66        echo "--- public メソッド ---" . PHP_EOL;
67        $publicMethods = $reflectionEnum->getMethods(ReflectionMethod::IS_PUBLIC);
68        if (empty($publicMethods)) {
69            echo "public メソッドは見つかりませんでした。" . PHP_EOL;
70        } else {
71            foreach ($publicMethods as $method) {
72                echo "  メソッド名: " . $method->getName() . PHP_EOL;
73            }
74        }
75        echo PHP_EOL;
76
77        // 3. static メソッドのみを取得します。
78        echo "--- static メソッド ---" . PHP_EOL;
79        $staticMethods = $reflectionEnum->getMethods(ReflectionMethod::IS_STATIC);
80        if (empty($staticMethods)) {
81            echo "static メソッドは見つかりませんでした。" . PHP_EOL;
82        } else {
83            foreach ($staticMethods as $method) {
84                echo "  メソッド名: " . $method->getName() . PHP_EOL;
85            }
86        }
87        echo PHP_EOL;
88
89        // 4. private メソッドのみを取得します。
90        echo "--- private メソッド ---" . PHP_EOL;
91        $privateMethods = $reflectionEnum->getMethods(ReflectionMethod::IS_PRIVATE);
92        if (empty($privateMethods)) {
93            echo "private メソッドは見つかりませんでした。" . PHP_EOL;
94        } else {
95            foreach ($privateMethods as $method) {
96                echo "  メソッド名: " . $method->getName() . PHP_EOL;
97            }
98        }
99        echo PHP_EOL;
100
101    } catch (ReflectionException $e) {
102        echo "リフレクションエラー: " . $e->getMessage() . PHP_EOL;
103    }
104}
105
106// 関数の実行
107demonstrateReflectionEnumMethods();
108
109?>

PHPのReflectionEnum::getMethodsメソッドは、PHP 8.1で導入されたEnum（列挙型）に定義されているメソッドに関する情報を取得するために使用されます。このメソッドは、指定されたEnumの各メソッドを表すReflectionMethodオブジェクトの配列を返します。

引数$filterを省略するかnullを指定した場合、そのEnumに定義されている全てのメソッド（public, protected, private, staticなど）の情報が取得されます。この引数にReflectionMethodクラスの定数、例えばReflectionMethod::IS_PUBLICやReflectionMethod::IS_STATICなどを指定することで、取得するメソッドを特定の種類に絞り込むことができます。これにより、Enumのpublicメソッドだけを一覧表示したり、staticメソッドだけを確認したりすることが可能になります。

戻り値はReflectionMethodオブジェクトの配列で、各オブジェクトからはメソッド名や引数、戻り値の型といった詳細な情報をプログラムから動的に参照できます。サンプルコードでは、UserStatusというEnumを例に、フィルタなしで全てのメソッド、ReflectionMethod::IS_PUBLICで公開メソッド、ReflectionMethod::IS_STATICで静的メソッド、ReflectionMethod::IS_PRIVATEでプライベートメソッドを取得し、それぞれのメソッド名を表示することで、このメソッドの挙動を具体的に示しています。これは、プログラムの実行時にEnumの構造を解析したい場合に非常に役立ちます。