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

Copy
1<?php
2
3/**
4 * サンプルクラス
5 * メソッドのパラメータ数を取得するデモンストレーションに使用します。
6 */
7class SampleClass
8{
9    /**
10     * 複数の必須パラメータとオプションパラメータを持つメソッド。
11     *
12     * @param string $firstName ユーザーの姓
13     * @param string $lastName ユーザーの名
14     * @param int $age ユーザーの年齢 (オプション、デフォルトは0)
15     * @param bool $isActive ユーザーがアクティブかどうか (オプション、デフォルトはtrue)
16     * @return string
17     */
18    public function getUserInfo(string $firstName, string $lastName, int $age = 0, bool $isActive = true): string
19    {
20        return "{$firstName} {$lastName} ({$age}歳, アクティブ: " . ($isActive ? 'はい' : 'いいえ') . ")";
21    }
22
23    /**
24     * パラメータを持たないメソッド。
25     *
26     * @return string
27     */
28    public function getAppName(): string
29    {
30        return "MyApp";
31    }
32}
33
34// ReflectionClassを使ってSampleClassの情報を取得
35$reflectionClass = new ReflectionClass(SampleClass::class);
36
37// --- 複数のパラメータを持つメソッドの例 ---
38$methodNameWithParams = 'getUserInfo';
39try {
40    // ReflectionMethodインスタンスを取得
41    $reflectionMethodWithParams = $reflectionClass->getMethod($methodNameWithParams);
42
43    // getNumberOfParameters() を呼び出してパラメータの総数を取得
44    $paramCountWithParams = $reflectionMethodWithParams->getNumberOfParameters();
45
46    echo "メソッド '{$methodNameWithParams}' のパラメータ数: {$paramCountWithParams}\n"; // 出力: 4
47
48} catch (ReflectionException $e) {
49    echo "エラー: メソッド '{$methodNameWithParams}' が見つかりません。\n";
50}
51
52// --- パラメータを持たないメソッドの例 ---
53$methodNameWithoutParams = 'getAppName';
54try {
55    // ReflectionMethodインスタンスを取得
56    $reflectionMethodWithoutParams = $reflectionClass->getMethod($methodNameWithoutParams);
57
58    // getNumberOfParameters() を呼び出してパラメータの総数を取得
59    $paramCountWithoutParams = $reflectionMethodWithoutParams->getNumberOfParameters();
60
61    echo "メソッド '{$methodNameWithoutParams}' のパラメータ数: {$paramCountWithoutParams}\n"; // 出力: 0
62
63} catch (ReflectionException $e) {
64    echo "エラー: メソッド '{$methodNameWithoutParams}' が見つかりません。\n";
65}
66
67?>

PHP 8のReflectionMethod::getNumberOfParametersメソッドは、プログラムの実行中に、特定のクラスメソッドがいくつの引数（パラメータ）を持っているかを調べるために使われます。これはPHPのリフレクションAPIの一部で、コードの構造を動的に分析する際に非常に役立つ機能です。

このgetNumberOfParameters()メソッドは、引数を一切必要としません。呼び出すと、対象のメソッドが定義しているパラメータの総数を整数値（int）として返します。必須パラメータとオプションパラメータの区別なく、メソッドが受け入れ可能なすべての引数が数えられます。

上記のサンプルコードでは、SampleClassというクラスに、複数のパラメータを持つgetUserInfoメソッドと、パラメータを持たないgetAppNameメソッドが定義されています。コードはまずReflectionClassを使用してSampleClassの情報を取得し、次にgetMethod()で個々のメソッドのReflectionMethodインスタンスを作成しています。

例えば、getUserInfoメソッドは$firstName、$lastName、$age、$isActiveという4つのパラメータを持ちます。このメソッドに対応するReflectionMethodインスタンスに対してgetNumberOfParameters()を呼び出すと、「4」という結果が出力されます。一方、getAppNameメソッドはパラメータを一切持たないため、同様にgetNumberOfParameters()を呼び出すと「0」という結果が返されます。

このように、このメソッドは、メソッドの引数に関する情報をプログラムで動的に把握したい場合に非常に便利です。

Copy
1<?php
2
3/**
4 * ReflectionMethod::getNumberOfParameters() の使用例を示すクラス
5 */
6class MyParameterExample
7{
8    /**
9     * 引数を持たないメソッドです。
10     */
11    public function noParametersMethod(): void
12    {
13        // このメソッドは引数を一切取りません。
14    }
15
16    /**
17     * 2つの必須引数を持つメソッドです。
18     *
19     * @param string $name ユーザーの名前
20     * @param int    $age  ユーザーの年齢
21     */
22    public function withTwoParameters(string $name, int $age): void
23    {
24        // このメソッドは $name と $age の2つの引数を取ります。
25    }
26
27    /**
28     * デフォルト値が null の引数を持つメソッドです。
29     *
30     * キーワード「null」に関連する例として、このメソッドはデフォルト値が null の
31     * オプショナルな引数を持っています。
32     *
33     * @param string|null $message オプショナルなメッセージ、デフォルトは null
34     */
35    public function withNullableDefaultParameter(?string $message = null): void
36    {
37        // このメソッドは1つの引数 $message を取ります。
38        // $message は省略可能で、省略された場合は null が入ります。
39    }
40}
41
42/**
43 * ReflectionMethod::getNumberOfParameters() のデモンストレーション関数。
44 * システムエンジニアを目指す初心者向けに、各メソッドのパラメータ数を取得する方法を示します。
45 */
46function demonstrateReflectionParameters(): void
47{
48    echo "--- ReflectionMethod::getNumberOfParameters() デモンストレーション ---" . PHP_EOL;
49    echo "メソッドの定義から、そのメソッドがいくつの引数を取るかをプログラムで取得する方法を示します。" . PHP_EOL;
50    echo PHP_EOL;
51
52    // 1. 引数を持たないメソッドのパラメータ数を取得
53    try {
54        $reflectionMethodNoParams = new ReflectionMethod(MyParameterExample::class, 'noParametersMethod');
55        $numParamsNoParams = $reflectionMethodNoParams->getNumberOfParameters();
56        echo sprintf(
57            "メソッド '%s' のパラメータ数: %d個 (引数なし)",
58            $reflectionMethodNoParams->getName(),
59            $numParamsNoParams
60        ) . PHP_EOL; // 期待値: 0
61        echo "  -> このメソッドは引数を取らないため、パラメータ数は0です。" . PHP_EOL;
62    } catch (ReflectionException $e) {
63        echo "エラー: " . $e->getMessage() . PHP_EOL;
64    }
65    echo PHP_EOL;
66
67    // 2. 2つの必須引数を持つメソッドのパラメータ数を取得
68    try {
69        $reflectionMethodTwoParams = new ReflectionMethod(MyParameterExample::class, 'withTwoParameters');
70        $numParamsTwoParams = $reflectionMethodTwoParams->getNumberOfParameters();
71        echo sprintf(
72            "メソッド '%s' のパラメータ数: %d個 (2つの必須引数)",
73            $reflectionMethodTwoParams->getName(),
74            $numParamsTwoParams
75        ) . PHP_EOL; // 期待値: 2
76        echo "  -> このメソッドは2つの引数 (name, age) を取るため、パラメータ数は2です。" . PHP_EOL;
77    } catch (ReflectionException $e) {
78        echo "エラー: " . $e->getMessage() . PHP_EOL;
79    }
80    echo PHP_EOL;
81
82    // 3. デフォルト値が null の引数を持つメソッドのパラメータ数を取得 (キーワード 'null' に関連)
83    try {
84        $reflectionMethodNullableParam = new ReflectionMethod(MyParameterExample::class, 'withNullableDefaultParameter');
85        $numParamsNullableParam = $reflectionMethodNullableParam->getNumberOfParameters();
86        echo sprintf(
87            "メソッド '%s' のパラメータ数: %d個 (デフォルト値が null の引数)",
88            $reflectionMethodNullableParam->getName(),
89            $numParamsNullableParam
90        ) . PHP_EOL; // 期待値: 1
91        echo "  -> デフォルト値が null であっても、'message' という引数が存在するため、パラメータ数は1としてカウントされます。" . PHP_EOL;
92    } catch (ReflectionException $e) {
93        echo "エラー: " . $e->getMessage() . PHP_EOL;
94    }
95    echo PHP_EOL;
96
97    echo "--- デモンストレーション終了 ---" . PHP_EOL;
98}
99
100// デモンストレーションを実行します。
101demonstrateReflectionParameters();
102

PHP 8のReflectionMethod::getNumberOfParameters()メソッドは、特定のクラスメソッドが定義している引数の総数を取得するために使用されます。このメソッドは引数を一切取らず、戻り値として引数の数を整数（int）で返します。

サンプルコードでは、MyParameterExampleクラス内の複数のメソッドについて、getNumberOfParameters()を使って引数数を取得する例を示しています。例えば、引数を全く持たないnoParametersMethodからは0が返されます。withTwoParametersのように2つの必須引数を持つメソッドからは、その数である2が返されます。特に、withNullableDefaultParameterのようにデフォルト値がnullの引数を持つ場合でも、引数として存在するため1としてカウントされ、その総数が戻り値となります。このように、このメソッドを利用することで、プログラム実行時にメソッドが受け入れる引数の数を動的に、かつ正確に把握することが可能です。