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

getNameメソッドは、リフレクションによって取得された関数やメソッドのパラメータ（引数）の名前を取得するメソッドです。

このメソッドが所属するReflectionParameterクラスは、PHPのリフレクションAPIの一部であり、関数やメソッドの個々の引数に関する詳細な情報をプログラム上で動的に検査するために使用されます。具体的には、引数の名前、データ型、デフォルト値の有無、参照渡しであるかなど、ソースコードに記述された引数の定義情報を知ることができます。

getNameメソッドを呼び出すと、対象となるパラメータの名前を文字列として返します。例えば、function foo($param1, $param2)という関数があった場合、$param1に対応するReflectionParameterオブジェクトに対してこのメソッドを実行すると「param1」という文字列が、$param2に対応するオブジェクトからは「param2」という文字列が返されます。

このメソッドは、主にPHPプログラムが自身の構造を解析する必要がある場合に利用されます。例えば、フレームワークがユーザー定義の関数やメソッドの引数を調べて、自動的に値を注入（DI: Dependency Injection）したり、APIドキュメントを自動生成したりする際に、各引数の名前を特定するために活用されます。PHP 8で強化された型宣言など、より厳密なコード解析を行う上で、このパラメータ名は非常に重要な情報源となります。

Copy
1<?php
2// 例として、ある関数のリフレクションからパラメータを取得します
3function exampleFunction($parameterA, $parameterB) { /* ... */ }
4
5$reflectionFunction = new ReflectionFunction('exampleFunction');
6$parameters = $reflectionFunction->getParameters(); // ReflectionParameter[] を取得
7
8// 最初のパラメータのReflectionParameterオブジェクトを取得
9$reflectionParameter = $parameters[0];
10
11// ReflectionParameter::getName() メソッドを呼び出し、パラメータ名を取得します
12$parameterName = $reflectionParameter->getName(); // 例: 'parameterA'
13?>

引数なし

引数はありません

string

このメソッドは、ReflectionParameterオブジェクトが表す引数の名前を文字列として返します。