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

Copy
1<?php
2
3/**
4 * リフレクションを使って引数情報を取得する対象となるサンプル関数。
5 * 複数の引数を持ち、それぞれ異なる特性（型、デフォルト値、必須/任意）を示します。
6 *
7 * @param string $name ユーザーの名前 (必須引数)
8 * @param int $age ユーザーの年齢 (任意引数、デフォルト値あり)
9 * @param bool $isActive ユーザーがアクティブかどうか (任意引数、デフォルト値あり)
10 * @return string 生成されたメッセージ
11 */
12function displayUserInfo(string $name, int $age = 30, bool $isActive = true): string
13{
14    $status = $isActive ? 'アクティブ' : '非アクティブ';
15    return "名前: {$name}, 年齢: {$age}歳, 状態: {$status}";
16}
17
18// ReflectionFunctionクラスのインスタンスを作成し、
19// 'displayUserInfo' 関数のリフレクション情報にアクセスできるようにします。
20$reflectionFunction = new ReflectionFunction('displayUserInfo');
21
22echo "--- 関数 'displayUserInfo' のパラメータ情報 ---" . PHP_EOL;
23
24// getParameters() メソッドを呼び出し、関数のすべてのパラメータ情報を取得します。
25// このメソッドは、各パラメータを表す ReflectionParameter オブジェクトの配列を返します。
26$parameters = $reflectionFunction->getParameters();
27
28// 取得した各パラメータについて、その詳細情報をループで表示します。
29foreach ($parameters as $parameter) {
30    echo "  - パラメータ名: " . $parameter->getName() . PHP_EOL;
31
32    // パラメータに型が宣言されているか確認し、その型名を表示します。
33    if ($parameter->hasType()) {
34        echo "    型: " . $parameter->getType()->getName() . PHP_EOL;
35    } else {
36        echo "    型: (型宣言なし)" . PHP_EOL;
37    }
38
39    // パラメータがオプション（任意引数）であるか、必須引数であるかを表示します。
40    if ($parameter->isOptional()) {
41        echo "    オプション: はい";
42        // オプション引数で、かつデフォルト値が設定されている場合はその値も表示します。
43        if ($parameter->isDefaultValueAvailable()) {
44            echo " (デフォルト値: " . var_export($parameter->getDefaultValue(), true) . ")";
45        }
46        echo PHP_EOL;
47    } else {
48        echo "    オプション: いいえ (必須引数)" . PHP_EOL;
49    }
50    echo PHP_EOL; // 各パラメータ情報の区切りとして空行を挿入
51}
52
53// リフレクションは関数のメタデータを調べるためのものですが、
54// 実際の関数がどのように動作するかを示すために、呼び出し例も示します。
55echo "--- 関数の実行例 ---" . PHP_EOL;
56echo displayUserInfo('山田太郎') . PHP_EOL;
57echo displayUserInfo('鈴木花子', 25, false) . PHP_EOL;
58

PHP 8のReflectionFunction::getParametersメソッドは、定義されている関数がどのような引数を持つかをプログラムから詳細に調べるための機能です。このメソッドはReflectionFunctionクラスのインスタンスに対して呼び出され、特定の関数の引数情報を取得できます。引数は特に指定せず、戻り値として、関数の各引数に関する情報を持つReflectionParameterオブジェクトの配列が返されます。

サンプルコードでは、displayUserInfoという関数を対象に、ReflectionFunctionクラスのインスタンスを作成しています。そして、そのインスタンスからgetParameters()メソッドを呼び出すことで、displayUserInfo関数の全ての引数に関する情報を配列として取得しています。

取得したReflectionParameterオブジェクトの配列をループで処理することにより、各引数の名前、型宣言（存在する場合）、その引数が必須か任意か、さらに任意引数に設定されているデフォルト値など、さまざまなメタデータを動的に取得し表示できます。この機能は、関数の構造を解析して自動処理を行うフレームワークやツールなどで活用されます。

Copy
1<?php
2
3/**
4 * この関数は、リフレクションの対象となるシンプルな例です。
5 * 複数の引数を持ち、そのうちの1つはデフォルト値を持つオプショナルな引数です。
6 *
7 * @param int    $num1      最初の整数
8 * @param int    $num2      2番目の整数
9 * @param string $operation 実行する操作 ('add' または 'subtract')。デフォルトは 'add'。
10 * @return int 計算結果
11 */
12function performCalculation(int $num1, int $num2, string $operation = 'add'): int
13{
14    if ($operation === 'add') {
15        return $num1 + $num2;
16    } elseif ($operation === 'subtract') {
17        return $num1 - $num2;
18    }
19    throw new InvalidArgumentException("Unsupported operation: " . $operation);
20}
21
22// ReflectionFunctionクラスのインスタンスを作成し、
23// 'performCalculation' 関数の情報を取得します。
24$reflectionFunction = new ReflectionFunction('performCalculation');
25
26echo "--- 関数 'performCalculation' の引数情報 ---" . PHP_EOL;
27
28// getParameters() メソッドを呼び出し、関数の引数に関する情報を含む
29// ReflectionParameter オブジェクトの配列を取得します。
30$parameters = $reflectionFunction->getParameters();
31
32// 取得した引数情報をループ処理で表示します。
33if (empty($parameters)) {
34    echo "この関数には引数がありません。" . PHP_EOL;
35} else {
36    foreach ($parameters as $parameter) {
37        echo "  引数名: " . $parameter->getName() . PHP_EOL;
38        
39        // 引数の型ヒントが存在するかチェックし、表示します。
40        if ($parameter->hasType()) {
41            echo "  型ヒント: " . $parameter->getType()->getName() . PHP_EOL;
42        } else {
43            echo "  型ヒント: なし" . PHP_EOL;
44        }
45
46        // 引数がオプショナル（デフォルト値を持つ）かどうかをチェックします。
47        if ($parameter->isOptional()) {
48            echo "  オプショナル: はい" . PHP_EOL;
49            // デフォルト値が存在する場合、その値を表示します。
50            if ($parameter->isDefaultValueAvailable()) {
51                echo "  デフォルト値: " . var_export($parameter->getDefaultValue(), true) . PHP_EOL;
52            }
53        } else {
54            echo "  オプショナル: いいえ" . PHP_EOL;
55        }
56        echo PHP_EOL; // 各引数の情報を区切るための改行
57    }
58}
59
60echo "--- リフレクション完了 ---" . PHP_EOL;
61
62?>

PHP 8のReflectionFunction::getParameters()メソッドは、指定された関数の引数に関する詳細な情報を動的に取得するために使用されます。このメソッドはReflectionFunctionクラスに属し、引数なしで呼び出すことができます。

getParameters()を呼び出すと、その関数が定義している引数ごとにReflectionParameterオブジェクトの配列が返されます。これにより、引数名、型ヒント、引数が必須かオプショナルか、そしてオプショナルな場合はそのデフォルト値といった情報を、プログラムの実行中に取得することが可能になります。

サンプルコードでは、performCalculationという関数を例に、ReflectionFunctionのインスタンスを作成し、getParameters()メソッドを実行しています。これにより、performCalculation関数が受け取る3つの引数（$num1、$num2、$operation）について、それぞれの名前、型ヒント（intやstring）、そして$operation引数が'add'というデフォルト値を持つオプショナルな引数であることなどが表示されています。

この機能は、プログラムが自身の構造を解析したり、外部から与えられた情報に基づいて動的に処理を分岐させたりする際に非常に役立ちます。