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

Copy
1<?php
2
3/**
4 * リフレクションAPIのReflectionMethod::getName()メソッドの利用例。
5 *
6 * この例では、簡単なクラスを定義し、そのメソッドの名前を
7 * ReflectionMethod::getName() を使って取得する方法を示します。
8 * システムエンジニアを目指す初心者の方でも理解しやすいように、
9 * 各ステップをコメントで説明しています。
10 */
11
12// 1. リフレクションの対象となるクラスを定義します。
13class SampleClassForReflection
14{
15    /**
16     * このメソッドの名前をリフレクションで取得します。
17     */
18    public function executeTask()
19    {
20        // このメソッドは具体的な処理は行いませんが、
21        // その名前がリフレクションでどのように取得されるかを示します。
22    }
23
24    /**
25     * プライベートメソッドもリフレクションの対象にできます。
26     */
27    private function internalHelperMethod()
28    {
29        // 内部的な処理を行うメソッド
30    }
31}
32
33// 2. ReflectionMethod オブジェクトを作成します。
34//    これは、特定のクラスの特定のメソッドに関する情報を提供するオブジェクトです。
35//    第一引数にクラス名、第二引数にメソッド名を指定します。
36try {
37    $reflectionMethod = new ReflectionMethod(SampleClassForReflection::class, 'executeTask');
38
39    // 3. getName() メソッドを呼び出して、リフレクション対象のメソッド名を取得します。
40    //    getName() は引数を取りません。
41    //    戻り値はメソッドの名前を表す文字列です。
42    $methodName = $reflectionMethod->getName();
43
44    // 4. 取得したメソッド名を出力して確認します。
45    echo "取得されたメソッド名: " . $methodName . PHP_EOL;
46
47    // 別のメソッドでも試してみましょう。
48    $reflectionPrivateMethod = new ReflectionMethod(SampleClassForReflection::class, 'internalHelperMethod');
49    $privateMethodName = $reflectionPrivateMethod->getName();
50    echo "取得されたプライベートメソッド名: " . $privateMethodName . PHP_EOL;
51
52} catch (ReflectionException $e) {
53    // 指定したクラスやメソッドが存在しない場合にReflectionExceptionが発生します。
54    echo "エラー: " . $e->getMessage() . PHP_EOL;
55}

PHP 8のReflectionMethod::getName()メソッドは、プログラムの実行中に、特定のクラスに定義されたメソッドの正確な名前を取得するために利用されます。これは、PHPのリフレクションAPIと呼ばれる機能の一部で、クラスやメソッド、プロパティといったプログラムの構造に関する情報を動的に調べたり操作したりする際に使用します。

まず、ReflectionMethodオブジェクトは、調査したい特定のメソッドに関する情報を保持する役割を担います。例えば、サンプルコードで定義されているSampleClassForReflectionクラス内のexecuteTaskメソッドについて調べたい場合、そのメソッドを指定してReflectionMethodオブジェクトを作成します。

このReflectionMethodオブジェクトからgetName()メソッドを呼び出すことで、それが表しているメソッドの実際の名前を取得できます。getName()メソッドは、引数を一切取りません。そして、戻り値として、対象メソッドの名前を表す文字列を返します。サンプルコードでは、executeTaskやinternalHelperMethodといったメソッドの名前を、このgetName()メソッドを使って取得し、出力しています。このように、コード内で動的にメソッド名を把握したい場面などで活用されます。

Copy
1<?php
2
3namespace MyNamespace\Utility; // 名前空間を定義
4
5/**
6 * サンプルクラス
7 * メソッド名取得の対象として使用します。
8 */
9class StringHelper
10{
11    /**
12     * 文字列を大文字に変換します。
13     *
14     * @param string $input 変換する文字列
15     * @return string 大文字に変換された文字列
16     */
17    public function toUpperCase(string $input): string
18    {
19        return strtoupper($input);
20    }
21
22    /**
23     * 文字列を小文字に変換します。
24     *
25     * @param string $input 変換する文字列
26     * @return string 小文字に変換された文字列
27     */
28    protected function toLowerCase(string $input): string
29    {
30        return strtolower($input);
31    }
32}
33
34/**
35 * ReflectionMethod::getName() の使用例
36 * 指定されたクラスのメソッド名をリフレクションAPIを使って取得します。
37 */
38function demonstrateReflectionMethodGetName(): void
39{
40    // リフレクション対象のクラスとメソッドを指定
41    $className = MyNamespace\Utility\StringHelper::class;
42    $methodName = 'toUpperCase';
43
44    echo "--- ReflectionMethod::getName() の使用例 ---\n";
45    echo "対象クラス: " . $className . "\n";
46    echo "対象メソッド: " . $methodName . "\n\n";
47
48    try {
49        // ReflectionMethod インスタンスを作成
50        // クラス名とメソッド名を指定して、そのメソッドのリフレクション情報を取得します。
51        $reflectionMethod = new \ReflectionMethod($className, $methodName);
52
53        // getName() メソッドを呼び出して、メソッド名を取得
54        // このメソッドは引数を取らず、メソッド名を文字列で返します。
55        $actualMethodName = $reflectionMethod->getName();
56
57        echo "ReflectionMethod::getName() で取得したメソッド名: " . $actualMethodName . "\n\n";
58
59        // 別のメソッドでも試してみる
60        $anotherMethodName = 'toLowerCase';
61        echo "別のメソッドで試行: " . $anotherMethodName . "\n";
62        $reflectionMethod2 = new \ReflectionMethod($className, $anotherMethodName);
63        $actualMethodName2 = $reflectionMethod2->getName();
64        echo "ReflectionMethod::getName() で取得したメソッド名: " . $actualMethodName2 . "\n";
65
66    } catch (\ReflectionException $e) {
67        // 指定されたクラスやメソッドが存在しない場合などに発生
68        echo "エラー: 指定されたメソッドのリフレクション情報を取得できませんでした。\n";
69        echo "詳細: " . $e->getMessage() . "\n";
70    }
71}
72
73// 関数を実行して、サンプルコードの動作を確認
74demonstrateReflectionMethodGetName();

PHPのReflectionMethod::getName()は、リフレクションAPIを利用して、クラスが持つ特定のメソッドの名前を文字列として取得するために使われるメソッドです。このメソッドはReflectionMethodクラスに属しています。

この機能を使うには、まず調べたいクラス名とそのメソッド名を指定して、ReflectionMethodのインスタンスを作成します。その後、そのインスタンスに対してgetName()メソッドを呼び出すことで、対象のメソッド名を取得することができます。getName()メソッドは引数を一切取らず、取得したメソッド名を文字列（string）として返します。

サンプルコードでは、MyNamespace\Utility\StringHelperクラスに定義されたtoUpperCaseメソッドを例に、その名前をリフレクションによって取得する様子が示されています。new \ReflectionMethod()で対象メソッドの情報を持つインスタンスを作り、そのインスタンスのgetName()を呼び出すことで、「toUpperCase」というメソッド名が正確に取得され、出力されることを確認できます。これにより、プログラムの実行中に動的にメソッドの情報を調べ、利用する柔軟な処理が可能となります。