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

returnsReferenceメソッドは、ReflectionMethodクラスに属し、特定のメソッドが戻り値を「参照」として返すかどうかを判定するメソッドです。

PHPでは、メソッドが値を返す際に、その値のコピーを返す「値渡し」が一般的です。しかし、メソッドの宣言時に戻り値の型宣言の前に&記号を記述することで、そのメソッドが戻り値を「参照渡し」で返すように設定できます。この「参照を返す」とは、メソッドが返した値が、呼び出し元の変数とメモリ上の同じ場所を共有することを意味します。つまり、呼び出し元がその戻り値を変更すると、メソッドの内部で使われていた元のデータも直接変更されることになります。

returnsReferenceメソッドは、対象となるメソッドがこのように参照を返すように定義されている場合にtrueを、そうでない場合にfalseを返します。

この機能は、特に他のライブラリやフレームワークのメソッドの挙動を動的に解析する際に役立ちます。メソッドが参照を返すかどうかを事前に知ることで、呼び出し側は戻り値の扱い方を適切に判断し、予期せぬ副作用を防ぐためのコードを記述できます。PHP 8においても、このメソッドはメソッドの動的な検査を支援する重要なツールとして利用されます。

Copy
1<?php
2
3class MyClass {
4    public function &myMethod(): int {
5        static $value = 0;
6        return $value;
7    }
8}
9
10$reflectionMethod = new ReflectionMethod('MyClass', 'myMethod');
11$returnsReference = $reflectionMethod->returnsReference();

引数なし

引数はありません

bool

このメソッドは、メソッドが参照を返すかどうかを示すブール値を返します。