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

isDefaultValueConstantメソッドは、PHPのReflectionParameterクラスに属し、関数の引数（パラメータ）が持つデフォルト値が「定数式」であるかどうかを判定するメソッドです。ReflectionParameterクラスは、PHPのプログラムが自身の構造（リフレクション）を実行時に調査するための機能を提供し、特定の関数の引数に関する詳細な情報を取得する際に利用されます。

このisDefaultValueConstantメソッドは、取得した引数情報において、もしその引数にデフォルト値が設定されている場合、そのデフォルト値がリテラル値（例: 数字、文字列、真偽値、配列など）や、事前に定義された定数（defineやconstで宣言されたもの）、あるいはクラス定数などの「定数式」で構成されているかを真偽値（trueまたはfalse）で返します。例えば、function example($param = 123)のような場合、デフォルト値123は定数式なのでtrueを返します。一方、function another($param = time())のように、デフォルト値が関数呼び出しやオブジェクトの生成といった動的な処理の結果である場合はfalseを返します。

この機能は、プログラムの構造を動的に解析し、特定の引数のデフォルト値が固定的な定数であるか、それとも実行時に評価される必要がある複雑な式であるかを判断したい場合に非常に有用です。コードの自動生成ツール、フレームワークでの型チェック、静的解析などで、より詳細なパラメータ情報の取得が必要な場面で活用されます。

Copy
1<?php
2
3const DEFAULT_PAGE_SIZE = 25;
4
5function fetchItems(int $pageSize = DEFAULT_PAGE_SIZE): array
6{
7    // アイテムを取得する処理
8    return range(1, $pageSize);
9}
10
11$reflectionFunction = new ReflectionFunction('fetchItems');
12$reflectionParameter = $reflectionFunction->getParameters()[0]; // $pageSize パラメータを取得
13
14$isDefaultValueConstant = $reflectionParameter->isDefaultValueConstant();

引数なし

引数はありません

bool

このメソッドは、引数が定数としてデフォルト値を持つ場合に true を、そうでない場合に false を返します。