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

Copy
1<?php
2
3/**
4 * リフレクションの対象となるサンプルクラス
5 */
6class MyExampleClass
7{
8    /**
9     * パブリックメソッドの例
10     *
11     * @return string
12     */
13    public function publicMethod(): string
14    {
15        return "これはパブリックメソッドです。";
16    }
17
18    /**
19     * プロテクテッドメソッドの例
20     */
21    protected function protectedMethod(): void
22    {
23        // メソッドの実装
24    }
25
26    /**
27     * プライベートメソッドの例
28     *
29     * @param int $value
30     * @return int
31     */
32    private function privateMethod(int $value): int
33    {
34        return $value * 2;
35    }
36
37    /**
38     * 静的メソッドの例
39     *
40     * @return string
41     */
42    public static function staticMethod(): string
43    {
44        return "これは静的メソッドです。";
45    }
46}
47
48/**
49 * ReflectionClass::getMethod の使用例
50 * 指定されたクラスから、特定のメソッドの情報を取得します。
51 */
52try {
53    // 1. リフレクションを行う対象のクラスのReflectionClassインスタンスを作成
54    //    'MyExampleClass' はリフレクション対象のクラス名です。
55    $reflectionClass = new ReflectionClass('MyExampleClass');
56
57    // 2. getMethod() を使って、特定のメソッドのReflectionMethodインスタンスを取得
58    //    引数には取得したいメソッド名を文字列で指定します。
59    //    ここでは 'publicMethod' という名前のパブリックメソッドの情報を取得します。
60    echo "--- 'publicMethod' の情報を取得 ---" . PHP_EOL;
61    $reflectionMethod = $reflectionClass->getMethod('publicMethod');
62
63    // 3. 取得したReflectionMethodインスタンスからメソッドの情報を利用
64    echo "メソッド名: " . $reflectionMethod->getName() . PHP_EOL;
65    echo "所属クラス: " . $reflectionMethod->class . PHP_EOL;
66    echo "パブリック?: " . ($reflectionMethod->isPublic() ? 'はい' : 'いいえ') . PHP_EOL;
67    echo "プロテクテッド?: " . ($reflectionMethod->isProtected() ? 'はい' : 'いいえ') . PHP_EOL;
68    echo "プライベート?: " . ($reflectionMethod->isPrivate() ? 'はい' : 'いいえ') . PHP_EOL;
69    echo "静的メソッド?: " . ($reflectionMethod->isStatic() ? 'はい' : 'いいえ') . PHP_EOL;
70    echo "引数の数: " . $reflectionMethod->getNumberOfParameters() . PHP_EOL;
71    echo PHP_EOL;
72
73    // 別のメソッド、例えばプライベートメソッドの情報も取得してみる
74    echo "--- 'privateMethod' の情報を取得 ---" . PHP_EOL;
75    $privateMethod = $reflectionClass->getMethod('privateMethod');
76    echo "メソッド名: " . $privateMethod->getName() . PHP_EOL;
77    echo "プライベート?: " . ($privateMethod->isPrivate() ? 'はい' : 'いいえ') . PHP_EOL;
78    echo "引数の数: " . $privateMethod->getNumberOfParameters() . PHP_EOL;
79    echo PHP_EOL;
80
81    // 静的メソッドの情報も取得してみる
82    echo "--- 'staticMethod' の情報を取得 ---" . PHP_EOL;
83    $staticMethod = $reflectionClass->getMethod('staticMethod');
84    echo "メソッド名: " . $staticMethod->getName() . PHP_EOL;
85    echo "静的メソッド?: " . ($staticMethod->isStatic() ? 'はい' : 'いいえ') . PHP_EOL;
86    echo PHP_EOL;
87
88    // 存在しないメソッド名を指定した場合 (ReflectionExceptionが発生します)
89    // 以下のコードを実行するとエラーが発生するため、コメントアウトしています。
90    /*
91    echo "--- 存在しないメソッドの情報を取得しようと試みる ---" . PHP_EOL;
92    $reflectionClass->getMethod('nonExistentMethod');
93    echo "この行は実行されません。" . PHP_EOL;
94    */
95
96} catch (ReflectionException $e) {
97    // ReflectionClassのインスタンス化に失敗した場合 (クラスが見つからない)、
98    // またはgetMethod()で指定されたメソッドが見つからなかった場合に例外を捕捉します。
99    echo "エラー: " . $e->getMessage() . PHP_EOL;
100}

このPHPのサンプルコードは、リフレクションという機能を使って、クラス内の特定のメソッドに関する情報をプログラムから動的に取得する方法を示しています。ReflectionClass::getMethodは、指定されたクラスの中から、引数として渡されたメソッド名の情報を取得するためのメソッドです。

まず、new ReflectionClass('MyExampleClass')で、調べたいクラスMyExampleClassの情報を保持するReflectionClassインスタンスを作成します。次に、この$reflectionClassインスタンスのgetMethod()メソッドを呼び出します。

getMethod()の引数string $nameには、取得したいメソッドの名前を文字列で指定します。例えば、'publicMethod'と指定すると、その名前のメソッドの情報が取得されます。このメソッドは、指定されたメソッドに関する詳細な情報を持つReflectionMethodインスタンスを戻り値として返します。

取得したReflectionMethodインスタンス（例: $reflectionMethod）からは、メソッド名（getName()）、所属クラス（class）、パブリックメソッドか（isPublic()）、プライベートメソッドか（isPrivate()）、静的メソッドか（isStatic()）といった、さまざまな属性や特性を調べることができます。サンプルコードでは、publicMethod、privateMethod、staticMethodのそれぞれの情報を取得し、表示しています。

もし指定したメソッド名がクラス内に存在しない場合、ReflectionExceptionが発生します。この例外はtry-catchブロックで捕捉され、適切なエラーメッセージが表示されるようになっています。これにより、実行時にクラスの構造を調べ、動的にプログラムを制御することが可能になります。

Copy
1<?php
2
3/**
4 * リフレクションの対象となるサンプルクラス。
5 * クラス内のメソッド情報を動的に取得するために使用します。
6 */
7class MyReflectionTargetClass
8{
9    private string $name;
10
11    /**
12     * コンストラクタ。
13     * @param string $name クラスインスタンスの名前
14     */
15    public function __construct(string $name)
16    {
17        $this->name = $name;
18    }
19
20    /**
21     * 自己紹介をする公開メソッド。
22     */
23    public function introduce(): void
24    {
25        echo "こんにちは、私の名前は {$this->name} です。\n";
26    }
27
28    /**
29     * 秘密のメッセージを返すプライベートメソッド。
30     * このメソッドは外部からは直接呼び出せません。
31     *
32     * @return string 秘密のメッセージ
33     */
34    private function getSecretMessage(): string
35    {
36        return "これはクラス内の秘密のメッセージです。\n";
37    }
38
39    /**
40     * プロテクトされた設定メソッド。
41     * @param string $value 設定値
42     */
43    protected function configure(string $value): void
44    {
45        echo "設定値: {$value}\n";
46    }
47}
48
49// リフレクションの対象とするクラス名
50$className = MyReflectionTargetClass::class;
51
52try {
53    // ReflectionClassのインスタンスを生成。
54    // これにより、指定したクラスに関する詳細な情報を動的に取得できるようになります。
55    $reflectionClass = new ReflectionClass($className);
56
57    echo "--- クラス '{$className}' のメソッド一覧 ---\n";
58    // getMethods() は、クラス内の全てのメソッドを表すReflectionMethodオブジェクトの配列を返します。
59    // これにより、クラスが持つ機能（メソッド）の全体像を把握できます。
60    $allMethods = $reflectionClass->getMethods();
61    foreach ($allMethods as $method) {
62        $visibility = 'public';
63        if ($method->isProtected()) {
64            $visibility = 'protected';
65        } elseif ($method->isPrivate()) {
66            $visibility = 'private';
67        }
68        echo "  - " . $method->getName() . " ({$visibility})\n";
69    }
70    echo "\n";
71
72    // 特定のメソッド名を指定してReflectionMethodオブジェクトを取得します。
73    // getMethod() は、指定された名前のメソッドを表すReflectionMethodオブジェクトを返します。
74    // これを使って、特定のメソッドの詳細な情報を調べたり、動的に呼び出したりできます。
75    $targetMethodName = 'introduce';
76    echo "--- メソッド '{$targetMethodName}' の詳細情報 ---\n";
77
78    $reflectionMethod = $reflectionClass->getMethod($targetMethodName);
79
80    echo "  メソッド名: " . $reflectionMethod->getName() . "\n";
81    echo "  定義クラス: " . $reflectionMethod->getDeclaringClass()->getName() . "\n";
82    echo "  公開状態: " . ($reflectionMethod->isPublic() ? "public" : ($reflectionMethod->isProtected() ? "protected" : "private")) . "\n";
83    echo "  静的メソッドか: " . ($reflectionMethod->isStatic() ? "はい" : "いいえ") . "\n";
84    echo "  パラメータ数: " . $reflectionMethod->getNumberOfParameters() . "\n";
85
86    // メソッドのパラメータ情報を表示 (もしあれば)
87    if ($reflectionMethod->getNumberOfParameters() > 0) {
88        echo "  パラメータ:\n";
89        foreach ($reflectionMethod->getParameters() as $param) {
90            $paramInfo = "    - $" . $param->getName();
91            if ($param->hasType()) {
92                $paramInfo .= " (型: " . $param->getType()->getName() . ")";
93            }
94            if ($param->isOptional()) {
95                $paramInfo .= " [任意]";
96            }
97            echo $paramInfo . "\n";
98        }
99    }
100
101    // リフレクションを使ってメソッドを動的に呼び出す例
102    echo "\n--- メソッド '{$targetMethodName}' の動的呼び出し ---\n";
103    $instance = new MyReflectionTargetClass("リフレクション太郎"); // 対象クラスのインスタンスを作成
104    $reflectionMethod->invoke($instance); // インスタンスに対してメソッドを呼び出す
105
106    // 存在しないメソッドを取得しようとした場合のエラーハンドリング
107    echo "\n--- 存在しないメソッドの取得試行 ---\n";
108    $nonExistentMethod = 'nonExistentMethod';
109    try {
110        $reflectionClass->getMethod($nonExistentMethod);
111    } catch (ReflectionException $e) {
112        echo "  エラー: メソッド '{$nonExistentMethod}' は存在しません。(" . $e->getMessage() . ")\n";
113    }
114
115} catch (ReflectionException $e) {
116    // ReflectionClassのインスタンス化失敗やgetMethodでの例外を捕捉
117    echo "リフレクションエラーが発生しました: " . $e->getMessage() . "\n";
118}
119
120?>

PHP 8のReflectionClass::getMethod()は、プログラムの実行中にクラスの構造や振る舞いを動的に調べる「リフレクション」という機能を提供するメソッドです。このメソッドは、ReflectionClassクラスのインスタンスから呼び出され、特定のメソッドに関する詳細な情報を取得するために使用されます。

引数string $nameには、調べたいメソッドの名前を文字列で指定します。例えば、'introduce'というメソッド名を渡すことで、そのメソッドの情報にアクセスできます。

戻り値はReflectionMethodオブジェクトです。このオブジェクトを通じて、指定したメソッドがpublic、protected、privateのいずれであるか、引数や戻り値の型、さらにはそのメソッドをプログラムから動的に呼び出す（invoke）といった操作が可能になります。これにより、クラスの内部構造を深く解析したり、柔軟な処理を実装したりすることができます。

クラス内の全てのメソッドを取得するgetMethods()とは異なり、getMethod()は特定の一つのメソッドに焦点を当てて情報を得る際に役立ちます。もし指定した名前のメソッドがクラス内に存在しない場合は、ReflectionExceptionという例外が発生し、エラーとして処理されます。