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

Copy
1<?php
2
3/**
4 * プログラミング言語の専門家として、
5 * ReflectionEnum::getStaticProperties の使用例を簡潔に示します。
6 * この機能は PHP 8.1 以降で利用可能です。
7 */
8
9/**
10 * 複数の状態を持つシンプルなEnumを定義します。
11 * このEnumには、ReflectionEnum::getStaticProperties() で取得できる
12 * 静的プロパティがいくつか定義されています。
13 */
14enum TrafficLight
15{
16    case RED;
17    case YELLOW;
18    case GREEN;
19
20    // このEnumクラスの静的プロパティを定義します。
21    // ReflectionEnum::getStaticProperties() はこれらのプロパティを返します。
22    public static string $currentColor = 'RED';
23    public static int $cycleDuration = 60; // 秒
24
25    // Enumのケース (RED, YELLOW, GREEN) は静的プロパティではありません。
26    // これらは ReflectionEnum::getCases() で取得できます。
27}
28
29/**
30 * 指定されたEnumクラスの静的プロパティを取得し、表示する関数。
31 *
32 * @param string $enumClassName 静的プロパティを取得するEnumクラスの名前
33 */
34function displayEnumStaticProperties(string $enumClassName): void
35{
36    // ReflectionEnum インスタンスを作成します。
37    // これにより、Enumに関する詳細な情報にアクセスできます。
38    $reflectionEnum = new ReflectionEnum($enumClassName);
39
40    // getStaticProperties() メソッドを使用して、Enumクラスで定義された
41    // すべての静的プロパティを連想配列として取得します。
42    // 配列のキーはプロパティ名、値はプロパティの現在の値です。
43    $staticProperties = $reflectionEnum->getStaticProperties();
44
45    echo "--- Enum '" . $enumClassName . "' の静的プロパティ ---\n";
46
47    if (empty($staticProperties)) {
48        echo "  静的プロパティは見つかりませんでした。\n";
49    } else {
50        foreach ($staticProperties as $name => $value) {
51            echo "  名前: " . $name . "\n";
52            echo "  値  : " . var_export($value, true) . "\n";
53            echo "------------------------------------------\n";
54        }
55    }
56}
57
58// TrafficLight Enumの静的プロパティを表示します。
59displayEnumStaticProperties(TrafficLight::class);
60
61?>

PHPのReflectionEnum::getStaticPropertiesメソッドは、Enum（列挙型）クラスに定義されている静的プロパティの情報を取得するために用いられます。Enumは、関連する定数群を一つの型として定義できるPHP 8.1以降の機能であり、通常のクラスと同様に静的プロパティを持つことができます。

このメソッドは引数を必要とせず、呼び出すだけで対象のEnumクラスが持つすべての静的プロパティを返します。戻り値は連想配列形式で、配列のキーには静的プロパティの名前（例: $currentColor）、値にはそのプロパティが現在保持している値（例: 'RED'）が格納されています。

サンプルコードでは、TrafficLightというEnumが定義され、$currentColorや$cycleDurationといった静的プロパティが設定されています。ReflectionEnumクラスのインスタンスを生成し、そのgetStaticPropertiesメソッドを使用することで、これらの静的プロパティの名前と値が動的に取得され、コンソールに表示される様子を示しています。これにより、プログラムの実行中にEnumの内部状態や設定値を柔軟に確認・利用することが可能となります。Enumのケース（例えばTrafficLight::REDのようなメンバー）は静的プロパティとは異なるため、このメソッドでは取得対象外となる点にご留意ください。

Copy
1<?php
2
3// Enum（列挙型）の定義
4// PHP 8.1以降で導入された機能です。
5// Enumの各ケースは、そのEnumクラスの静的な「プロパティ」のように振る舞います。
6enum PaymentStatus
7{
8    case PENDING;
9    case APPROVED;
10    case REJECTED;
11    case REFUNDED;
12}
13
14/**
15 * ReflectionEnum::getStaticProperties() メソッドの使用例を示します。
16 * このメソッドは、Enumの静的プロパティ（実際にはEnumの各ケース）を取得します。
17 */
18function demonstrateReflectionEnumStaticProperties(): void
19{
20    // PaymentStatus EnumのReflectionEnumインスタンスを作成します。
21    // これにより、Enumに関するメタデータにアクセスできるようになります。
22    $reflectionEnum = new ReflectionEnum(PaymentStatus::class);
23
24    // getStaticProperties() メソッドを呼び出し、
25    // このEnumが持つ静的プロパティ（Enumの各ケース）を取得します。
26    // 戻り値は連想配列で、キーはケース名、値はEnumケースオブジェクト自身です。
27    $staticProperties = $reflectionEnum->getStaticProperties();
28
29    echo "--- Enum '" . PaymentStatus::class . "' の静的プロパティ（ケース）一覧 ---\n";
30
31    // 取得した静的プロパティ（Enumケース）をループして表示します。
32    foreach ($staticProperties as $name => $value) {
33        // $name はケース名 (例: "PENDING")
34        // $value はそのEnumケースオブジェクト (例: PaymentStatus::PENDING)
35        // Enumケースオブジェクトは `name` プロパティを通じて自身の名前を取得できます。
36        echo "  キー: $name, 値 (ケースオブジェクトのnameプロパティ): " . $value->name . "\n";
37    }
38
39    echo "----------------------------------------------------------------\n";
40
41    // 参考: Enumの特定のケースに直接アクセスする例
42    echo "  直接アクセスしたケース: " . PaymentStatus::APPROVED->name . "\n";
43}
44
45// 関数を実行し、Enumの静的プロパティの取得結果を表示します。
46demonstrateReflectionEnumStaticProperties();

PHP 8.1以降で導入されたEnum（列挙型）の情報を取得する際、ReflectionEnum::getStaticProperties()メソッドは、そのEnumが持つ「ケース」を静的プロパティとして取得するために使用されます。ReflectionEnumクラスは、Enumの構造や定義に関するメタデータ（付随情報）をプログラムから動的に検査するための機能を提供します。

このgetStaticProperties()メソッドは引数を取りません。呼び出すと、指定されたEnumの各ケースを要素とする連想配列を返します。この配列のキーはEnumのケース名（例: "PENDING"）であり、値は対応するEnumのケースオブジェクトそのものです（例: PaymentStatus::PENDING）。

サンプルコードでは、PaymentStatusというEnumを例に、ReflectionEnumインスタンスを作成し、getStaticProperties()を呼び出しています。これにより、PaymentStatusの全てのケース（PENDING, APPROVED, REJECTED, REFUNDED）が連想配列として取得されます。その後、この配列をループ処理で表示することで、各ケースの名前と対応するケースオブジェクトにアクセスできることが示されています。このメソッドを使うことで、Enumに定義された全てのケースを動的に列挙し、処理に利用することが可能になります。