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

getDefaultValueConstantNameメソッドは、PHPのリフレクションAPIの一部であるReflectionParameterクラスに属し、関数の引数（パラメータ）に設定されているデフォルト値が定数である場合に、その定数の名前を取得するメソッドです。

このメソッドは、引数にデフォルト値が指定されており、それが数値や文字列などの直接的なリテラル値ではなく、PHPの定数（例: MY_CONSTANT）として定義されている場合にのみ有効です。具体的には、function example($param = MY_CONSTANT)のように定義された引数から、デフォルト値であるMY_CONSTANTという定数名を文字列として返します。

もし、引数のデフォルト値が定数ではない場合（例えば、function example($param = 123)のようにリテラル値が設定されている場合や、デフォルト値が全く設定されていない場合）には、ReflectionExceptionがスローされますので注意が必要です。引数のデフォルト値が定数であるかどうかを事前に確認したい場合は、同じReflectionParameterクラスのisDefaultValueConstantメソッドを利用することができます。このメソッドを使うことで、プログラムの実行中に、関数の引数の定義情報を動的に分析し、定数として設定されたデフォルト値の詳細な情報を取得することが可能になります。

Copy
1<?php
2
3class MyClass
4{
5    const DEFAULT_CONST = 'Hello';
6    public function myMethod(string $param = self::DEFAULT_CONST) {}
7}
8
9$reflector = new ReflectionMethod('MyClass', 'myMethod');
10$parameter = $reflector->getParameters()[0];
11
12$parameter->getDefaultValueConstantName();

引数なし

引数はありません

string

ReflectionParameter::getDefaultValueConstantName() メソッドは、パラメータが定数でデフォルト値を持つ場合に、その定数名を文字列として返します。定数でデフォルト値を持たない場合は null を返します。