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

isVariadicメソッドは、PHPのReflectionParameterクラスに属し、特定の引数が可変引数であるかどうかを判定するメソッドです。

ReflectionParameterクラスは、PHPの関数やメソッドが受け取る引数に関する詳細な情報を、プログラムの実行中に動的に取得するために利用されます。例えば、引数の名前、型、デフォルト値、参照渡しであるかなど、多岐にわたる情報を調べることが可能です。

ここでいう「可変引数」とは、関数やメソッドが、あらかじめ決められた数ではなく、任意の数の引数を受け取れる仕組みを指します。PHPでは、引数名の前に...（三点リーダー）を付けることで可変引数を定義します。例えば、function exampleMethod(...$arguments)のように記述された場合、$argumentsには渡されたすべての引数が配列として格納されます。

isVariadicメソッドは、このリフレクション機能を使って検査している引数が、まさにこの「可変引数」として定義されている場合にtrue（真）を返します。もし通常の固定引数である場合や、可変引数ではないと判断された場合はfalse（偽）を返します。

このメソッドは、引数の情報を実行時に詳細に分析し、特に可変引数を伴う関数やメソッドの挙動を動的に制御する必要がある場合に役立ちます。例えば、汎用的なライブラリやフレームワークを開発する際に、渡される引数の形式に応じて処理を分岐させたり、引数に対するバリデーション（検証）を行ったりする場面で、コードの柔軟性と堅牢性を高めるために活用されます。

Copy
1<?php
2
3function exampleFunction(string $name, int ...$values): void
4{
5    // ...
6}
7
8$reflectionFunction = new ReflectionFunction('exampleFunction');
9$parameters = $reflectionFunction->getParameters();
10
11foreach ($parameters as $parameter) {
12    if ($parameter->isVariadic()) {
13        echo "Parameter '{$parameter->getName()}' is a variadic parameter." . PHP_EOL;
14    } else {
15        echo "Parameter '{$parameter->getName()}' is not a variadic parameter." . PHP_EOL;
16    }
17}
18
19?>

引数なし

引数はありません

bool

このメソッドは、引数が可変長引数（...$args）である場合にtrueを、そうでない場合にfalseを返します。