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

canBePassedByValueメソッドは、PHPの関数やメソッドが受け取る引数（パラメータ）が、「値渡し（Pass by Value）」という方式で渡すことが可能であるかどうかを判断し、その結果を真偽値で返すメソッドです。

このメソッドは、対象の引数が値として渡せる場合にはtrueを返し、値渡しが不可能である（つまり、参照渡しのみ可能な）場合にはfalseを返します。PHPにおいて、数値や文字列などの基本的なデータ型は通常、値渡しで扱われます。また、オブジェクトの場合も、オブジェクト自体が複製されるわけではなく、そのオブジェクトを識別するための情報（オブジェクト識別子）が値として渡されるため、このメソッドは多くの場合trueを返します。

しかし、関数の引数が&（アンパサンド）記号を使用して明示的に「参照渡し（Pass by Reference）」として宣言されている場合、その引数は値としてではなく、元の変数を直接操作する形で渡されるため、このcanBePassedByValueメソッドはfalseを返します。

このメソッドはReflectionParameterクラスの一部として提供されており、プログラムの実行時に、関数やメソッドの引数の詳細な情報を動的に分析する「リフレクション」という機能の中で利用されます。これにより、開発者はPHPコードの内部構造をプログラムから調べ、引数の渡し方の特性を理解したり、それに基づいて動的な処理を行ったりする際に役立てることができます。

Copy
1<?php
2
3class MyExampleClass {
4    public function myMethod(int $valueParam, string &$refParam) {}
5}
6
7$reflector = new ReflectionMethod('MyExampleClass', 'myMethod');
8$parameters = $reflector->getParameters();
9
10$reflectionParameter = $parameters[0]; // $valueParam に対応する ReflectionParameter オブジェクト
11$isPassableByValue = $reflectionParameter->canBePassedByValue();
12
13// $isPassableByValue は bool 型の値を持ちます。
14// このメソッドは、引数が値渡し可能である場合に true を、そうでない場合に false を返します。
15
16?>

引数なし

引数はありません

bool

このメソッドは、ReflectionParameterオブジェクトで表される引数が値渡し可能かどうかを示す真偽値を返します。