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

Copy
1<?php
2
3// 可変引数（variadic arguments）を持つメソッドと、持たない通常のメソッドを定義するクラス
4class ExampleClass
5{
6    /**
7     * このメソッドは可変引数（...$items）を受け取ります。
8     * 任意の数の引数を配列として受け取ることができます。
9     *
10     * @param string $prefix プレフィックス文字列
11     * @param mixed  ...$items 可変引数として渡されるアイテムのリスト
12     */
13    public function processVariadic(string $prefix, ...$items): void
14    {
15        echo "{$prefix}: " . implode(', ', $items) . "\n";
16    }
17
18    /**
19     * このメソッドは固定数の引数のみを受け取ります。
20     * 可変引数ではありません。
21     *
22     * @param int $value1 最初の数値
23     * @param int $value2 2番目の数値
24     */
25    public function processFixed(int $value1, int $value2): void
26    {
27        echo "Sum: " . ($value1 + $value2) . "\n";
28    }
29}
30
31// ReflectionClass を使って ExampleClass のリフレクションオブジェクトを作成
32$reflectionClass = new ReflectionClass(ExampleClass::class);
33
34// 'processVariadic' メソッドのリフレクションオブジェクトを取得
35$reflectionMethodVariadic = $reflectionClass->getMethod('processVariadic');
36
37// isVariadic() メソッドを使って、このメソッドが可変引数を持つかチェック
38// 結果は true となります (可変引数を持つため)
39echo "Method 'processVariadic' is variadic: " . ($reflectionMethodVariadic->isVariadic() ? 'true' : 'false') . "\n";
40
41// 'processFixed' メソッドのリフレクションオブジェクトを取得
42$reflectionMethodFixed = $reflectionClass->getMethod('processFixed');
43
44// isVariadic() メソッドを使って、このメソッドが可変引数を持つかチェック
45// 結果は false となります (固定引数のみのため)
46echo "Method 'processFixed' is variadic: " . ($reflectionMethodFixed->isVariadic() ? 'true' : 'false') . "\n";
47
48// 実際にメソッドを呼び出して動作を確認する (任意)
49$instance = new ExampleClass();
50$instance->processVariadic("Items", "apple", "banana", "orange");
51$instance->processFixed(10, 20);
52

PHPのReflectionMethod::isVariadicは、指定されたメソッドが「可変引数（variadic arguments）」を受け入れるように定義されているかを確認するためのメソッドです。可変引数とは、PHP 5.6以降で導入された機能で、メソッドが任意の数の引数をまとめて配列として受け取ることができる仕組みを指します。

このメソッドは、プログラムの実行中にクラスやメソッドの構造を動的に調べることができる「リフレクションAPI」の一部として利用されます。isVariadicメソッド自体は引数を一切取らず、戻り値として真偽値（bool）を返します。調べたメソッドが可変引数を持つ場合はtrueが、そうでない固定引数のみのメソッドの場合はfalseが返されます。

サンプルコードでは、可変引数を持つprocessVariadicメソッドと、固定引数のみのprocessFixedメソッドを定義しています。それぞれのメソッドに対してReflectionClassとReflectionMethodを使ってリフレクションオブジェクトを取得し、isVariadic()を呼び出しています。その結果、processVariadicメソッドではtrueが、processFixedメソッドではfalseが出力され、メソッドの引数形式を正確に判断できることが示されています。この機能は、フレームワーク開発などでメソッドの動的な検査や処理の分岐を行う際に特に有用です。

Copy
1<?php
2
3/**
4 * このクラスは、リフレクションAPIを使用してメソッドの情報を取得する例で使用されます。
5 */
6class ExampleMethods
7{
8    /**
9     * このメソッドは固定数の引数を受け取ります。
10     *
11     * @param string $name 名前
12     * @param int $age 年齢
13     */
14    public function greet(string $name, int $age): void
15    {
16        echo "Hello, $name. You are $age years old.\n";
17    }
18
19    /**
20     * このメソッドは可変長引数（任意の数の引数）を受け取ります。
21     * 可変長引数は常に配列として渡されます。
22     *
23     * @param string $prefix 接頭辞
24     * @param mixed ...$items 可変長引数として渡されるアイテム群
25     */
26    public function processItems(string $prefix, ...$items): void
27    {
28        echo "Prefix: $prefix\n";
29        echo "Number of items received: " . count($items) . "\n";
30
31        // ここで可変長引数 $items が配列かどうかをチェックします。
32        // 可変長引数は常に配列として渡されるため、これは常にtrueになります。
33        if (is_array($items)) {
34            echo "  The variadic argument \$items is indeed an array.\n";
35            foreach ($items as $index => $item) {
36                echo "  - Item " . ($index + 1) . ": " . (is_scalar($item) ? $item : gettype($item)) . "\n";
37            }
38        }
39    }
40
41    /**
42     * このメソッドは引数を受け取りません。
43     */
44    public function noArguments(): void
45    {
46        echo "This method takes no arguments.\n";
47    }
48}
49
50/**
51 * ReflectionMethod::isVariadic の使い方と、php isarray との関連性を示す関数です。
52 */
53function demonstrateReflectionMethodIsVariadic(): void
54{
55    echo "--- Demonstrating ReflectionMethod::isVariadic ---\n\n";
56
57    $className = ExampleMethods::class;
58
59    // 1. 固定数の引数を持つメソッドの場合
60    $methodName1 = 'greet';
61    echo "Checking method: {$methodName1}\n";
62    try {
63        $reflectionMethod1 = new ReflectionMethod($className, $methodName1);
64        // isVariadic() は、メソッドが可変長引数を持つかどうかを返します。
65        // このメソッドは固定数の引数のため、falseを返します。
66        echo "  Is '{$methodName1}' variadic? " . ($reflectionMethod1->isVariadic() ? 'Yes' : 'No') . "\n\n";
67    } catch (ReflectionException $e) {
68        echo "  Error reflecting method '{$methodName1}': " . $e->getMessage() . "\n\n";
69    }
70
71    // 2. 可変長引数を持つメソッドの場合
72    $methodName2 = 'processItems';
73    echo "Checking method: {$methodName2}\n";
74    try {
75        $reflectionMethod2 = new ReflectionMethod($className, $methodName2);
76        // このメソッドは可変長引数 (...$items) を持つため、trueを返します。
77        echo "  Is '{$methodName2}' variadic? " . ($reflectionMethod2->isVariadic() ? 'Yes' : 'No') . "\n";
78
79        // 可変長引数を持つメソッドの実行例
80        echo "  Executing '{$methodName2}' with some items:\n";
81        $exampleObject = new ExampleMethods();
82        $exampleObject->processItems("My List", "Apple", 123, true, ["nested array"]);
83        echo "\n";
84    } catch (ReflectionException $e) {
85        echo "  Error reflecting method '{$methodName2}': " . $e->getMessage() . "\n\n";
86    }
87
88    // 3. 引数を持たないメソッドの場合
89    $methodName3 = 'noArguments';
90    echo "Checking method: {$methodName3}\n";
91    try {
92        $reflectionMethod3 = new ReflectionMethod($className, $methodName3);
93        // このメソッドは引数を持たないため、可変長引数でもなく、falseを返します。
94        echo "  Is '{$methodName3}' variadic? " . ($reflectionMethod3->isVariadic() ? 'Yes' : 'No') . "\n\n";
95    } catch (ReflectionException $e) {
96        echo "  Error reflecting method '{$methodName3}': " . $e->getMessage() . "\n\n";
97    }
98}
99
100// 関数を実行して、上記の説明とコードの動作を確認します。
101demonstrateReflectionMethodIsVariadic();
102
103?>

PHPのReflectionMethod::isVariadicメソッドは、特定のメソッドが可変長引数（任意の数の引数を受け取る定義）を持っているかどうかを調べるために使用されます。このメソッドは引数を取らず、その結果を真偽値（trueまたはfalse）で返します。

サンプルコードでは、ExampleMethodsクラスの三つのメソッドを用いてisVariadicの動作を説明しています。例えば、greetメソッドのように引数の数が固定されている場合や、noArgumentsメソッドのように引数自体を持たない場合はfalseが返されます。これに対し、processItemsメソッドのように...$itemsという形式で可変長引数を定義しているメソッドではtrueが返されます。

ここで、可変長引数（...$items）は、メソッドの内部で常に配列として扱われます。そのため、processItemsメソッド内ではis_array($items)を使って、実際に渡された引数の集合が配列であることを確認しています。isVariadicがメソッドの「定義」が可変長引数であるかをチェックするのに対し、is_arrayはプログラム実行時に特定の変数が「配列型」であるかをチェックする役割を持っています。つまり、isVariadicはメソッドの静的な特徴を、is_arrayは変数の動的な型情報を判断する際にそれぞれ活用されます。