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

getStaticPropertyValueメソッドは、PHPのReflectionClassクラスに属し、指定されたクラスの静的プロパティの値を実行時に取得するメソッドです。ReflectionClassは、実行中のアプリケーションのクラス、メソッド、プロパティなどの構造に関する情報を動的に検査できる「リフレクション機能」を提供します。

このメソッドは、クラスに定義されている静的プロパティ、つまりstaticキーワードで宣言され、クラスのすべてのインスタンスで共有されるプロパティの現在の値を取得するために使用されます。引数として、取得したい静的プロパティの名前を文字列で指定します。さらに、オプションとして、そのプロパティが存在しない場合や初期化されていない場合に代替として返されるデフォルト値を指定することも可能です。

メソッドは、指定された静的プロパティの現在の値を返します。もし該当するプロパティが存在しない、またはアクセスできない場合に、デフォルト値が指定されていればその値が返されます。デフォルト値が指定されておらず、プロパティが見つからない場合は、ReflectionExceptionがスローされる可能性があります。

この機能は、フレームワークやライブラリ開発において、クラスの内部構造を動的に解析し、その静的設定値や状態にアクセスする必要がある場合に非常に役立ちます。開発者はこのメソッドを利用することで、コードの実行中にクラスの定義に直接手を加えることなく、静的プロパティの情報を柔軟に参照・操作できるようになります。

Copy
1<?php
2
3class ExampleClass
4{
5    public static string $staticProperty = 'Static Value';
6}
7
8$reflector = new ReflectionClass('ExampleClass');
9
10// 静的プロパティ 'staticProperty' の値を取得
11$value = $reflector->getStaticPropertyValue('staticProperty');
12
13echo $value;
14
15?>

string $name, mixed $default = null

• string $name: 取得したい静的プロパティの名前
• mixed $default = null: プロパティが存在しない場合に返されるデフォルト値

mixed

指定されたクラスの静的プロパティの値を返します。プロパティがprivateまたはprotectedの場合は、ReflectionClass::setAccessible() を使用してアクセス可能にする必要があります。