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

Copy
1<?php
2
3/**
4 * リフレクション機能で関数名を調べるサンプルコード
5 *
6 * ReflectionFunction::getName() メソッドは、
7 * ReflectionFunction オブジェクトが表す関数の名前を取得します。
8 *
9 * この例では、定義済みの関数の名前をリフレクションを使って取得する方法を示します。
10 */
11
12// 1. リフレクションの対象となる関数を定義します。
13function calculateSum(int $a, int $b): int
14{
15    return $a + $b;
16}
17
18try {
19    // 2. ReflectionFunction オブジェクトを作成します。
20    //    コンストラクタには、リフレクションしたい関数の名前（文字列）を渡します。
21    $reflectionFunction = new ReflectionFunction('calculateSum');
22
23    // 3. getName() メソッドを呼び出して、関数名を取得します。
24    $functionName = $reflectionFunction->getName();
25
26    // 4. 取得した関数名を出力します。
27    echo "リフレクションで取得した関数名: " . $functionName . "\n";
28
29} catch (ReflectionException $e) {
30    // 関数が見つからない場合などに ReflectionException がスローされます。
31    echo "エラーが発生しました: " . $e->getMessage() . "\n";
32}
33

PHPのReflectionFunction::getName()メソッドは、プログラムの実行中に、定義された関数に関する詳細な情報を調べる「リフレクション機能」の一部です。このメソッドは、ReflectionFunctionクラスのオブジェクトが表す特定の関数の名前を、文字列として取得するために使用されます。

まず、ReflectionFunctionオブジェクトを作成するには、調べたい関数の名前を文字列で指定してコンストラクタに渡します。例えば、new ReflectionFunction('calculateSum')と記述すると、「calculateSum」という関数に関する情報を扱うオブジェクトが生成されます。

その後、このオブジェクトからgetName()メソッドを呼び出すことで、引数を渡すことなく、リフレクションの対象となっている関数の名前が文字列として返されます。サンプルコードでは、定義済みのcalculateSum関数を対象としたReflectionFunctionオブジェクトを作成し、getName()メソッドを呼び出すことで「calculateSum」という関数名が取得され、画面に出力される様子を示しています。このように、リフレクション機能を使うことで、実行中のプログラムが自身の関数情報を動的に調べることが可能になります。

Copy
1<?php
2
3// 名前空間を定義します。これは `getnamespace php` キーワードに関連するデモンストレーションの一部です。
4namespace MyApplication\Utility;
5
6/**
7 * ReflectionFunction::getName() で情報取得の対象となるサンプル関数。
8 * この関数は MyApplication\Utility 名前空間に属しています。
9 *
10 * @param string $input 処理する文字列
11 * @return string 処理された文字列
12 */
13function processString(string $input): string
14{
15    return strtoupper($input) . " (PROCESSED)";
16}
17
18/**
19 * ReflectionFunction::getName() メソッドの使用例をデモンストレーションします。
20 * このメソッドは、リフレクション対象の関数の短縮名（名前空間を含まない名前）を返します。
21 */
22function demonstrateReflectionFunctionGetName(): void
23{
24    // リフレクション対象の関数の完全修飾名を指定します。
25    // PHP 8では、名前空間付きの関数を指定する際に、先頭のバックスラッシュを省略できますが、
26    // 明示的に完全修飾であることを示すために含めることもできます。
27    $functionFullyQualifiedName = 'MyApplication\\Utility\\processString';
28
29    try {
30        // ReflectionFunction オブジェクトを作成します。
31        // これにより、指定された関数に関する詳細な情報をプログラムで取得できるようになります。
32        $reflectionFunction = new \ReflectionFunction($functionFullyQualifiedName);
33
34        // getName() メソッドを使用して、関数の短縮名（名前空間部分を含まない名前）を取得します。
35        // この例では 'processString' が返されます。
36        $functionShortName = $reflectionFunction->getName();
37
38        // 取得した短縮名と元の完全修飾名を出力します。
39        echo "リフレクション対象の関数 (完全修飾名): " . $functionFullyQualifiedName . "\n";
40        echo "ReflectionFunction::getName() で取得した短縮名: " . $functionShortName . "\n";
41
42        // (キーワード `getnamespace php` に関連付ける補足情報):
43        // 関数が属する名前空間名を取得することも可能です。
44        // getName() は短縮名を返すため、名前空間名は含まれません。
45        $namespaceName = $reflectionFunction->getNamespaceName();
46        echo "ReflectionFunction::getNamespaceName() で取得した名前空間名: " . ($namespaceName ?: "なし") . "\n";
47
48    } catch (\ReflectionException $e) {
49        // 指定された関数が見つからないなどのエラーが発生した場合に捕捉します。
50        echo "エラー: 関数のリフレクションに失敗しました - " . $e->getMessage() . "\n";
51    }
52}
53
54// デモンストレーション関数を実行します。
55demonstrateReflectionFunctionGetName();

PHP 8のReflectionFunction::getName()メソッドは、プログラムの実行中に特定の関数に関する詳細な情報を取得できるReflectionFunctionクラスのメンバーです。このメソッドは、対象となる関数の名前空間部分を含まない「短縮名」を文字列として返します。引数を必要とせず、戻り値は常に文字列型です。

サンプルコードでは、MyApplication\Utilityという名前空間内に定義されたprocessString関数を例にしています。まず、この関数をReflectionFunctionオブジェクトとして生成し、その情報にアクセスできるようにします。次に、getName()メソッドを呼び出すことで、関数名であるprocessStringという短縮名を取得し、それを画面に出力しています。

getName()メソッドが返すのは関数の名前そのものであり、名前空間の情報は含まれません。もし「getnamespace php」というキーワードに関連して、関数がどの名前空間に属しているかを知りたい場合は、同じReflectionFunctionクラスが提供するgetNamespaceName()メソッドを使用します。このように、リフレクション機能を利用することで、プログラム実行中に動的に関数の名前やその詳細を検査し、活用することが可能になります。