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

Copy
1<?php
2
3/**
4 * この関数は参照を返します。
5 * PHPで関数が参照を返すには、関数名の前にアンパサンド (&) を付けます。
6 * 参照を返すことで、関数が返した値を直接変更できるようになります。
7 */
8function &getValueByReference(): int
9{
10    static $counter = 0; // 静的変数で値を保持
11    $counter++;
12    return $counter;
13}
14
15/**
16 * この関数は値を返します（参照ではありません）。
17 * 通常の関数は値のコピーを返します。
18 */
19function getValueByValue(): int
20{
21    return 100;
22}
23
24// getValueByReference 関数が参照を返すかReflectionFunctionで確認します
25$reflectionReferenceFunction = new ReflectionFunction('getValueByReference');
26echo "Function 'getValueByReference' returns a reference: ";
27echo $reflectionReferenceFunction->returnsReference() ? 'Yes' : 'No';
28echo PHP_EOL;
29
30// getValueByValue 関数が参照を返すかReflectionFunctionで確認します
31$reflectionValueFunction = new ReflectionFunction('getValueByValue');
32echo "Function 'getValueByValue' returns a reference: ";
33echo $reflectionValueFunction->returnsReference() ? 'Yes' : 'No';
34echo PHP_EOL;
35
36// 参照を返す関数の簡単なデモンストレーション (参考)
37// $myValue = &getValueByReference(); // 1
38// $myValue++; // $counterも2になる
39// echo getValueByReference(); // 3 ($counterは3になっている)
40
41?>

このサンプルコードは、PHPのReflectionFunctionクラスに属するreturnsReference()メソッドの利用方法を説明しています。このメソッドは、指定された関数が「参照を返す」ように定義されているかどうかを調べるために使われます。

PHPにおいて、関数名の前にアンパサンド（&）を付けると、その関数は変数の「参照」を返します。これにより、関数が返した値を変更すると、参照元の変数の値も直接変更されるようになります。これは、通常の関数が値のコピーを返す挙動とは異なります。

ReflectionFunctionクラスは、PHPの関数に関する情報をプログラム実行時に取得するための機能を提供します。returnsReference()メソッドは、このクラスのインスタンスに対して呼び出され、引数なしで動作します。戻り値はブール値（bool）であり、関数が参照を返す場合はtrueを、そうでない場合はfalseを返します。

サンプルコードでは、getValueByReference関数が参照を返すように定義されているため、returnsReference()メソッドはYesを返します。一方、通常の値を返すgetValueByValue関数に対してはNoが返され、このメソッドが関数の特性を正確に判定できることが示されています。

Copy
1<?php
2
3/**
4 * この関数は配列への参照を返します。
5 * 関数のシグネチャに '&' が付いていることに注目してください。
6 * これにより、呼び出し元は元の配列への直接的なアクセス（参照）を得られます。
7 *
8 * @return array 参照で返される配列
9 */
10function &getArrayByReference(): array
11{
12    static $data = [10, 20, 30]; // 静的変数を使用し、常に同じ配列インスタンスを返すようにする
13    return $data;
14}
15
16/**
17 * この関数は配列の値を返します（参照ではありません）。
18 * 新しい配列が作成され、そのコピーが返されます。
19 *
20 * @return array 値で返される配列
21 */
22function getArrayByValue(): array
23{
24    return [40, 50, 60];
25}
26
27// ReflectionFunction を使用して、関数が参照を返すかどうかを調べます。
28
29echo "--- ReflectionFunction::returnsReference の動作確認 ---\n\n";
30
31// 参照を返す関数 'getArrayByReference' について検査
32$reflectionRefFunction = new ReflectionFunction('getArrayByReference');
33$isRefReturning = $reflectionRefFunction->returnsReference();
34
35echo "関数 'getArrayByReference' は参照を返しますか？ ";
36var_dump($isRefReturning); // true が出力されるはず
37
38echo "\n";
39
40// 値を返す関数 'getArrayByValue' について検査
41$reflectionValueFunction = new ReflectionFunction('getArrayByValue');
42$isValueReturning = $reflectionValueFunction->returnsReference();
43
44echo "関数 'getArrayByValue' は参照を返しますか？ ";
45var_dump($isValueReturning); // false が出力されるはず
46
47echo "\n--- 動作確認終了 ---\n";
48
49// 補足: 参照で返された配列を変更する例
50$myArrayRef = &getArrayByReference(); // 参照を受け取る
51$myArrayRef[] = 77; // 配列に要素を追加
52
53echo "\n変更後の 'getArrayByReference' が返す配列の内容: ";
54var_dump(getArrayByReference()); // [10, 20, 30, 77] が出力されるはず
55
56// 値で返された配列を変更する例
57$myArrayValue = getArrayByValue(); // 値を受け取る（コピー）
58$myArrayValue[] = 88; // コピーされた配列に要素を追加
59
60echo "変更後の 'getArrayByValue' が返す配列の内容: ";
61var_dump(getArrayByValue()); // [40, 50, 60] が出力されるはず（元の関数は変更されていない）
62
63?>

このサンプルコードは、PHPのリフレクション機能の一部であるReflectionFunctionクラスと、そのreturnsReferenceメソッドの使い方を初心者の方にも分かりやすく説明しています。ReflectionFunctionクラスは、PHPの関数がどのような特性を持っているかを、プログラム実行中に調べることができる便利なクラスです。

returnsReferenceメソッドは、対象の関数が「参照」を返すように定義されているかどうかを判定します。このメソッドに引数は必要なく、関数が参照を返せばtrue、そうでなければfalseという真偽値を戻り値として返します。

「参照を返す」とは、関数が変数の「値」のコピーを渡すのではなく、その変数がメモリ上で保持している「場所」そのものを指し示す情報（参照）を呼び出し元に提供することです。これにより、呼び出し元は受け取った参照を通じて、元の変数を直接変更できるようになります。PHPでは、function &関数名(): 型のように、関数名の前に&を付けることで参照を返す関数を定義します。

コード内のgetArrayByReference関数は&が付いているため参照を返し、getArrayByValue関数は&が付いていないため値のコピーを返します。ReflectionFunctionを使ってそれぞれを検査すると、getArrayByReferenceはtrue、getArrayByValueはfalseと正しく判定されることが確認できます。これにより、関数がどのようにデータを渡すかをプログラムから動的に確認できるのです。