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

getStaticPropertyValueメソッドは、PHPのReflectionEnumクラスを通じて、列挙型（Enum）に定義された静的プロパティの値をプログラム的に取得するメソッドです。

PHP 8.1で導入された列挙型は、特定の選択肢を表現する際に利用される便利な機能ですが、ReflectionEnumクラスは、そのような列挙型の構造や情報を実行時に検査・操作するためのリフレクションAPIの一部として提供されています。このメソッドを使用することで、列挙型クラス自身に静的に定義されたプロパティ（例えば、設定値や状態を表す定数など）の名前を指定し、その保持する実際の値を取り出すことが可能になります。これは、プログラムが実行中に自身の構造を動的に解析し、それに基づいて振る舞いを変更する「リフレクション」という高度なプログラミング手法の一環です。

具体的な利用場面としては、列挙型が持つ静的なメタデータや設定値を、コードから直接参照するのではなく、実行時の状況に応じて動的に取得したい場合などに有効です。たとえば、特定の列挙型の静的プロパティに、その列挙型が表すカテゴリに対応するパスやURLを保持させておき、このメソッドでその値を取り出すといった活用が考えられます。

引数には取得したい静的プロパティの名前を文字列で渡します。戻り値としては、指定されたプロパティが保持する値が返されます。もし指定されたプロパティが存在しない場合は、ReflectionExceptionがスローされるため、適切なエラーハンドリングが必要です。このメソッドは、列挙型の柔軟な利用と動的な情報取得をサポートする重要な機能の一つです。

Copy
1<?php
2
3enum Status
4{
5    case ACTIVE;
6    case INACTIVE;
7}
8
9$reflectionEnum = new ReflectionEnum(Status::class);
10
11$reflectionEnum->getStaticPropertyValue('propertyName');
12$reflectionEnum->getStaticPropertyValue('propertyName', null);

string $name, mixed $default = null

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

mixed

指定されたEnumケースの静的プロパティの値を返します。