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

Copy
1<?php
2
3/**
4 * 参照を返す関数の例。
5 * 関数名の前に '&' をつけることで、関数が参照を返すことを示します。
6 *
7 * @return int 参照で返される整数
8 */
9function &getValueByReference(): int
10{
11    static $value = 10; // 静的変数にすることで、参照元が明確になります
12    return $value;
13}
14
15/**
16 * 値を返す関数の例。
17 * 通常の関数と同様に、値のコピーを返します。
18 *
19 * @return int 値で返される整数
20 */
21function getValueByValue(): int
22{
23    return 20;
24}
25
26/**
27 * ReflectionFunctionAbstract::returnsReference メソッドのデモンストレーション。
28 * 指定された関数が参照を返すかどうかを判別します。
29 *
30 * @param string $functionName 検査する関数の名前
31 */
32function demonstrateReturnsReference(string $functionName): void
33{
34    try {
35        // ReflectionFunction のインスタンスを作成し、関数をリフレクションします
36        $reflectionFunction = new ReflectionFunction($functionName);
37
38        // returnsReference() メソッドを呼び出し、関数が参照を返すか確認します
39        $returnsReference = $reflectionFunction->returnsReference();
40
41        echo "関数 '{$functionName}' は ";
42        echo $returnsReference ? "参照を返します。\n" : "値を返します。\n";
43
44    } catch (ReflectionException $e) {
45        echo "エラー: 関数 '{$functionName}' は存在しません。 " . $e->getMessage() . "\n";
46    }
47}
48
49// 参照を返す関数でテスト
50demonstrateReturnsReference('getValueByReference');
51
52// 値を返す関数でテスト
53demonstrateReturnsReference('getValueByValue');
54
55// 存在しない関数でエラー処理のテスト
56demonstrateReturnsReference('nonExistentFunction');
57
58?>

PHPのReflectionFunctionAbstract::returnsReferenceメソッドは、指定された関数が戻り値を参照として返すかどうかを判別するためのものです。PHPでは、関数名の前にアンパサンド（&）をつけることで、その関数が値のコピーではなく、変数そのものを指し示す「参照」を返すように定義できます。このメソッドは引数を取りませんが、対象の関数が参照を返す場合はブール型のtrueを、値を返す場合はfalseを戻り値として返します。

提供されたサンプルコードでは、このメソッドの動作を具体的に示しています。まず、getValueByReference関数は関数名の前に&が付いているため、静的変数$valueの参照を返します。一方、getValueByValue関数は通常の関数として、値のコピーを返します。demonstrateReturnsReference関数は、ReflectionFunctionクラスを使ってこれらの関数をリフレクション（検査）し、returnsReference()メソッドを呼び出しています。これにより、getValueByReferenceに対しては「参照を返します」と表示され、getValueByValueに対しては「値を返します」と表示されます。このメソッドは、プログラムの実行時に動的に関数の特性を調べたい場合に非常に有用です。

Copy
1<?php
2
3/**
4 * リファレンス (参照) を返す関数。
5 * 関数の定義時に & をつけることで、戻り値を参照として返すことを示します。
6 * この例では、静的変数 $data への参照を返します。
7 *
8 * @return array
9 */
10function &getArrayByReference(): array
11{
12    // 静的変数を使用することで、常に同じ配列インスタンスへの参照を返すことができます。
13    static $data = ['a', 'b', 'c'];
14    return $data;
15}
16
17/**
18 * 値を返す関数。
19 * 通常の関数と同じように、戻り値を値として返します。
20 * この例では、新しい配列を生成して返します。
21 *
22 * @return array
23 */
24function getArrayByValue(): array
25{
26    return [1, 2, 3];
27}
28
29// ReflectionFunction クラスを使って、関数の情報を取得します。
30// ReflectionFunctionAbstract の子クラスであり、returnsReference メソッドを持ちます。
31
32// getArrayByReference 関数のリフレクションオブジェクトを作成
33$reflectionByReference = new ReflectionFunction('getArrayByReference');
34
35// getArrayByValue 関数のリフレクションオブジェクトを作成
36$reflectionByValue = new ReflectionFunction('getArrayByValue');
37
38// returnsReference() メソッドを使用して、関数が参照を返すかどうかを確認します。
39echo "--- Function 'getArrayByReference' ---" . PHP_EOL;
40echo "Returns a reference: " . ($reflectionByReference->returnsReference() ? 'Yes' : 'No') . PHP_EOL;
41
42echo PHP_EOL;
43
44echo "--- Function 'getArrayByValue' ---" . PHP_EOL;
45echo "Returns a reference: " . ($reflectionByValue->returnsReference() ? 'Yes' : 'No') . PHP_EOL;
46
47// 戻り値が参照であることの確認（オプション）
48echo PHP_EOL;
49echo "--- Example of using the functions ---" . PHP_EOL;
50
51// getArrayByReference から取得した配列の要素を変更してみます
52$arrRef = &getArrayByReference(); // リファレンスを受け取るためここでも & をつける
53$arrRef[0] = 'changed';
54echo "Array after modifying \$arrRef: " . implode(', ', getArrayByReference()) . PHP_EOL; // 元の配列も変更されている
55
56// getArrayByValue から取得した配列の要素を変更してみます
57$arrVal = getArrayByValue();
58$arrVal[0] = 99;
59echo "Array after modifying \$arrVal: " . implode(', ', getArrayByValue()) . PHP_EOL; // 元の配列は変更されていない

ReflectionFunctionAbstract::returnsReference()メソッドは、PHPの関数が戻り値を参照として返すように定義されているかを調べるために使用します。

PHPでは、関数名の前にアンパサンド&を付けることで、その関数が値をコピーするのではなく、元のデータへの「参照」を返すように定義できます。これにより、関数から受け取った変数を変更すると、参照元のデータも直接変更されます。一方、アンパサンドがない場合は、値がコピーされて返されます。

このメソッドは、特定の関数に関する情報を提供するReflectionFunctionオブジェクト（ReflectionFunctionAbstractの子クラス）を通じて利用します。returnsReference()メソッドは引数を取らず、関数が参照を返す場合はtrueを、値を返す場合はfalseを真偽値（bool）として返します。

サンプルコードでは、&getArrayByReference()のように定義された参照を返す関数に対してはtrueが返されます。一方、getArrayByValue()のように値を返す関数に対してはfalseが返されることが確認できます。実際に参照を受け取った配列を変更すると元のデータも変わるのに対し、値を受け取った場合はコピーが変更されるだけである点も示されています。このメソッドを使うことで、動的に関数の振る舞いを検査できます。