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

getStaticPropertyValueメソッドは、ReflectionObjectクラスに属し、実行中のPHPオブジェクトが定義しているクラスの静的プロパティの値を安全に取得するメソッドです。

ReflectionObjectは、PHPの「リフレクションAPI」と呼ばれる機能の一部で、プログラムの実行中にオブジェクト自身の構造（プロパティ、メソッドなど）を調べたり操作したりすることを可能にします。このメソッドは、その調べられる情報の一つとして、対象オブジェクトのクラスに定義された静的プロパティに焦点を当てます。

「静的プロパティ」とは、特定のオブジェクトのインスタンスに属する通常のプロパティとは異なり、クラス自体に属するプロパティのことです。そのため、クラスをインスタンス化しなくても直接アクセスできます。

このメソッドを使用すると、動的に取得したオブジェクトがどのようなクラスに属し、そのクラスがどのような静的プロパティを持っているかを実行時に調査し、その値を取得できます。たとえば、クラス名が変数に格納されている場合や、特定のオブジェクトの振る舞いを分析したい場合に非常に役立ちます。

メソッドは、取得したい静的プロパティの名前を文字列で第一引数として受け取ります。第二引数にはオプションでデフォルト値を指定でき、指定した名前の静的プロパティが存在しない場合にそのデフォルト値が返されます。デフォルト値が指定されておらず、かつプロパティが見つからない場合は、ReflectionExceptionがスローされます。戻り値は、指定された静的プロパティの現在の値です。

このメソッドは、public、protected、privateといったアクセス指定子に関わらず、指定された静的プロパティの値を取得できるため、通常のアクセス制限を迂回して内部状態を調査するデバッグや解析の用途にも利用されます。

Copy
1<?php
2
3class MyClass {
4    public static string $myStaticProperty = 'Hello PHP 8';
5}
6
7$object = new MyClass();
8$reflector = new ReflectionObject($object);
9
10// 静的プロパティ 'myStaticProperty' の値を取得
11$propertyValue = $reflector->getStaticPropertyValue('myStaticProperty');
12
13// 存在しない静的プロパティの場合にデフォルト値を指定して取得
14$nonExistentPropertyValue = $reflector->getStaticPropertyValue('anotherStaticProperty', 'Default Value');

string $name, mixed $default = null

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

mixed

ReflectionObject::getStaticPropertyValue は、指定された静的プロパティの現在の値を返します。値はプロパティの型に応じて mixed 型となります。