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

getDefaultPropertiesメソッドは、PHPのReflectionObjectクラスが提供する機能の一つで、特定のオブジェクトが持つデフォルトプロパティの情報を取得するメソッドです。ReflectionObjectクラスは、プログラムの実行中にオブジェクトの構造を動的に調査するためのリフレクションAPIの一部として機能します。

このメソッドを実行すると、対象となるオブジェクトが属するクラスで定義されている、非静的なすべてのプロパティとそのデフォルト値を連想配列として返します。ここでいう「デフォルトプロパティ」とは、クラス定義時に宣言されたプロパティであり、オブジェクトがインスタンス化される際に初期値が設定されるものを指します。明示的に初期値が指定されているプロパティだけでなく、初期値が未指定のためPHPによってnullで初期化されるプロパティも含まれます。

戻り値の連想配列では、プロパティ名がキーとなり、そのプロパティのデフォルト値が値となります。この機能は、実行時にオブジェクトの内部構造を深く分析したり、特定のクラスが持つプロパティの一覧とその初期値をプログラム的に把握したりする際に非常に役立ちます。例えば、フレームワークやライブラリが、ユーザー定義クラスの構成を動的に読み取り、その情報に基づいて動作を調整するような場合に活用されます。

ただし、このメソッドは、実行中にオブジェクトに動的に追加されたプロパティや、クラスの静的プロパティは取得しない点に留意が必要です。あくまでクラス定義に紐づく非静的プロパティの情報に限定されます。

Copy
1<?php
2
3class ExampleClass
4{
5    public string $name = 'Default Name';
6    protected int $id = 0;
7}
8
9$object = new ExampleClass();
10$reflector = new ReflectionObject($object);
11$defaultProperties = $reflector->getDefaultProperties();

引数なし

引数はありません

array

ReflectionObject::getDefaultProperties()は、そのクラスのデフォルトプロパティを連想配列で返します。