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

Copy
1<?php
2
3// PHP 8.1以降で導入された列挙型 (Enum) を定義します。
4// 通常、Enumはケースとそれに付随するメソッドを持ちますが、
5// ユーザーが直接プロパティを定義することは稀です。
6enum UserStatus
7{
8    case Active;
9    case Inactive;
10    case Pending;
11
12    // Enum内にメソッドを定義することは可能ですが、プロパティとは異なります。
13    public function getLabel(): string
14    {
15        return match ($this) {
16            self::Active => '有効',
17            self::Inactive => '無効',
18            self::Pending => '保留中',
19        };
20    }
21}
22
23// ReflectionEnumクラスは、Enumの構造に関する情報を取得するためのリフレクションAPIです。
24// ReflectionEnumのインスタンスを作成するには、Enumクラス名を引数に渡します。
25$reflectionEnum = new ReflectionEnum(UserStatus::class);
26
27// getProperties() メソッドは、Enumクラスに定義されているプロパティの配列を返します。
28// Enumの一般的な使用法では、ユーザー定義のプロパティは持たないため、
29// 通常は空の配列が返されます。
30// $filter引数は、ReflectionProperty::IS_PUBLIC などの定数で
31// 取得するプロパティの可視性をフィルタリングできますが、
32// デフォルト (0) ではすべてのプロパティを返そうとします。
33$properties = $reflectionEnum->getProperties();
34
35echo "Enum 'UserStatus' のプロパティ情報:\n";
36
37// 取得したプロパティの配列が空かどうかを確認します。
38if (empty($properties)) {
39    echo "  このEnumにはユーザーが定義したプロパティはありません。\n";
40    echo "  (PHPのEnumは、通常、値の集合を定義するものであり、\n";
41    echo "  直接プロパティを持つことは一般的ではありません。)\n";
42} else {
43    // プロパティが見つかった場合、その名前を出力します。
44    foreach ($properties as $property) {
45        echo "  - プロパティ名: " . $property->getName() . "\n";
46        echo "    可視性: " . ($property->isPublic() ? 'public' : '')
47                           . ($property->isProtected() ? 'protected' : '')
48                           . ($property->isPrivate() ? 'private' : '') . "\n";
49    }
50}
51
52// バッキング値を持つEnumの例:
53// バッキング値 (例: OK = 200) はEnumのケースに紐づく値であり、
54// Enum自体のプロパティとしては扱われません。
55enum HttpCode: int
56{
57    case OK = 200;
58    case NotFound = 404;
59}
60
61$reflectionBackedEnum = new ReflectionEnum(HttpCode::class);
62$backedProperties = $reflectionBackedEnum->getProperties();
63
64echo "\nEnum 'HttpCode' (バッキング値あり) のプロパティ情報:\n";
65if (empty($backedProperties)) {
66    echo "  このEnumにもユーザーが定義したプロパティはありません。\n";
67    echo "  (バッキング値はケースの値であり、Enumのプロパティではありません。)\n";
68} else {
69    foreach ($backedProperties as $property) {
70        echo "  - プロパティ名: " . $property->getName() . "\n";
71    }
72}
73

PHPのReflectionEnum::getPropertiesメソッドは、PHP 8.1以降で導入された列挙型（Enum）の構造に関する情報を取得するために利用されるリフレクション機能の一部です。このメソッドは、指定されたEnumクラス内に定義されているプロパティのリストを取得することを目的としています。

引数$filterは整数値をとり、ReflectionProperty::IS_PUBLICのような定数を使って、取得するプロパティの可視性をフィルタリングできます。デフォルト値の0では、可視性に関わらずすべてのプロパティを返そうとします。戻り値は、ReflectionPropertyオブジェクトの配列です。

しかし、PHPのEnumは通常、値の集合を定義するものであり、一般的なクラスのようにユーザーが直接プロパティを定義することは稀です。そのため、このメソッドを呼び出した場合、ほとんどのケースで空の配列が返されます。Enumのケースや、case OK = 200; のようなバッキング値は、Enum自体のプロパティとしては扱われません。このメソッドは、開発者がEnumに意図しないプロパティが存在しないかを確認する際などに利用できます。

Copy
1<?php
2
3/**
4 * カラーを表すシンプルな列挙型 (Enum)
5 * PHP 8.1で導入された列挙型を使用します。
6 */
7enum Color: string
8{
9    case RED = '赤';
10    case GREEN = '緑';
11    case BLUE = '青';
12}
13
14/**
15 * ReflectionEnum::getProperties() メソッドのサンプルコード
16 * 列挙型（Enum）のプロパティ（この場合はケース自体）をリフレクションで取得します。
17 */
18function demonstrateReflectionEnumGetProperties(): void
19{
20    echo "--- ReflectionEnum::getProperties() のデモンストレーション ---" . PHP_EOL;
21    echo "対象Enum: Color" . PHP_EOL . PHP_EOL;
22
23    try {
24        // ReflectionEnum クラスのインスタンスを生成
25        // Color Enumに関するリフレクション情報にアクセスできるようになります
26        $reflectionEnum = new ReflectionEnum(Color::class);
27
28        // getProperties() メソッドを呼び出し、Enumのプロパティ（ケース）を取得
29        // デフォルトのフィルター (0) は、すべてのプロパティ（public staticなケース）を返します。
30        $properties = $reflectionEnum->getProperties();
31
32        echo "取得されたプロパティの数: " . count($properties) . PHP_EOL;
33
34        if (empty($properties)) {
35            echo "プロパティが見つかりませんでした。" . PHP_EOL;
36            return;
37        }
38
39        echo "各プロパティの詳細:" . PHP_EOL;
40        foreach ($properties as $property) {
41            // 各プロパティは ReflectionProperty オブジェクトです
42            echo "  - 名前: " . $property->getName() . PHP_EOL;
43            echo "    宣言クラス: " . $property->getDeclaringClass()->getName() . PHP_EOL;
44            echo "    静的プロパティ: " . ($property->isStatic() ? 'はい' : 'いいえ') . PHP_EOL;
45            // Enumケースはpublic staticプロパティとして扱われます
46            echo "    public: " . ($property->isPublic() ? 'はい' : 'いいえ') . PHP_EOL;
47            echo PHP_EOL;
48        }
49
50    } catch (ReflectionException $e) {
51        echo "リフレクションエラーが発生しました: " . $e->getMessage() . PHP_EOL;
52    }
53}
54
55// サンプル関数を実行
56demonstrateReflectionEnumGetProperties();
57
58?>

このサンプルコードは、PHP 8.1で導入された「列挙型（Enum）」の情報を、プログラムから動的に取得する方法を示しています。ReflectionEnum::getProperties()メソッドは、リフレクションAPIの一部として、指定された列挙型に定義されている「ケース」（例：Color::REDのような選択肢）をプロパティとして取得するために使用されます。

まず、Colorというシンプルな列挙型が定義されており、これにはRED、GREEN、BLUEという3つのケースがあります。ReflectionEnumクラスのインスタンスをnew ReflectionEnum(Color::class)のように作成することで、Color列挙型に関する詳細な情報にアクセスできるようになります。

次に、$reflectionEnum->getProperties()を呼び出すことで、Color列挙型に定義されたすべてのケースがReflectionPropertyオブジェクトの配列として取得されます。このメソッドの引数$filterは、取得するプロパティの種類を絞り込むために使われますが、サンプルコードではデフォルト値（0）を使用しているため、すべてのpublic staticなプロパティ、つまり列挙型の全ケースが返されます。

取得された各ReflectionPropertyオブジェクトからは、getName()メソッドでケース名（例：「RED」）を取得できるほか、そのプロパティが静的であるか、publicであるかなどの詳細な情報を確認できます。この機能は、プログラムが実行時に列挙型の定義を動的に分析し、その内容に基づいて処理を変更するような高度な場面で役立ちます。