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

Copy
1<?php
2
3/**
4 * PHP 8.1以降で導入されたバッキング型を持つEnum (Backed Enum) を定義します。
5 * このEnumはint型の値をバッキング型として持ちます。
6 */
7enum UserStatus: int
8{
9    case Active = 1;
10    case Inactive = 0;
11    case Pending = 2;
12}
13
14/**
15 * リフレクションAPIを使用して、Enumケースの型情報を取得する例です。
16 * `ReflectionEnumBackedCase::getType()`メソッドは、Enumのバッキング型を表す
17 * `ReflectionType`オブジェクトを返します。
18 */
19function demonstrateReflectionEnumBackedCaseGetType(): void
20{
21    // 1. 対象のEnumクラスをリフレクションします。
22    $reflectionEnum = new ReflectionEnum(UserStatus::class);
23
24    // 2. 特定のEnumケース（ここでは 'Active'）のReflectionEnumBackedCaseインスタンスを取得します。
25    // UserStatusはバッキング型を持つため、これはReflectionEnumBackedCaseのインスタンスになります。
26    $reflectionEnumCase = $reflectionEnum->getCase('Active');
27
28    // 3. getType()メソッドを呼び出して、Enumケースのバッキング型情報を取得します。
29    // 戻り値は ?ReflectionType なので、nullチェックまたは型チェックを推奨します。
30    $reflectionType = $reflectionEnumCase->getType();
31
32    // 4. 取得した型情報が存在し、かつそれがReflectionNamedTypeであれば詳細を表示します。
33    // Backed Enumの場合、通常はReflectionNamedType（intまたはstring）が返されます。
34    if ($reflectionType instanceof ReflectionNamedType) {
35        echo "対象のEnumケース: " . $reflectionEnumCase->getName() . PHP_EOL;
36        echo "バッキング型名: " . $reflectionType->getName() . PHP_EOL; // 例: int
37        echo "型は組み込み型か: " . ($reflectionType->isBuiltin() ? 'はい' : 'いいえ') . PHP_EOL; // 例: はい
38
39        // `ReflectionEnumBackedCase::getType()`は引数を取りません。
40        // `gettype()`というPHPの組み込み関数とは異なり、リフレクションを通じて
41        // 宣言された型情報を取得するためのメソッドです。
42    } else {
43        echo "Enumケースのバッキング型情報を取得できませんでした。" . PHP_EOL;
44    }
45
46    echo PHP_EOL; // 出力を見やすくするための改行
47
48    // 別のケースで試すことも可能です。
49    $reflectionEnumCasePending = $reflectionEnum->getCase('Pending');
50    $reflectionTypePending = $reflectionEnumCasePending->getType();
51
52    if ($reflectionTypePending instanceof ReflectionNamedType) {
53        echo "対象のEnumケース: " . $reflectionEnumCasePending->getName() . PHP_EOL;
54        echo "バッキング型名: " . $reflectionTypePending->getName() . PHP_EOL; // 例: int
55    }
56}
57
58// 関数を実行してサンプルコードの動作を確認します。
59demonstrateReflectionEnumBackedCaseGetType();
60
61?>

PHP 8.1以降で導入された「バッキング型を持つEnum（Backed Enum）」の各ケースが、どのような型の値を持っているかを知りたい場合に、ReflectionEnumBackedCase::getType()メソッドを使用します。このメソッドは、PHPのリフレクションAPIの一部であり、プログラムの構造を動的に調べることができます。

Backed Enumは、enum UserStatus: intのように、各ケースにintやstringといった具体的な値を割り当てられるEnumのことです。ReflectionEnumBackedCase::getType()メソッドは、この「int」や「string」といった、Enumケースが持つバッキング型の情報を表すReflectionTypeオブジェクトを返します。このメソッドは引数を一切取りません。戻り値が?ReflectionTypeとなっているのは、型情報が取得できない場合にnullが返される可能性があることを意味します。通常、Backed Enumに対してはこのメソッドはReflectionNamedTypeのインスタンスを返し、そのgetName()メソッドで具体的な型名（例えば "int"）を取得できます。

このメソッドは、PHPの組み込み関数であるgettype()とは異なり、変数の実行時型を取得するのではなく、Enumの定義時に宣言されたバッキング型を取得するために使われます。これにより、Enumのケースが想定通りの型を持っているかを確認したり、型情報に基づいて動的な処理を行ったりする際に役立ちます。

Copy
1<?php
2
3// PHP 8以降で利用可能なBacked Enum（バッキングされた列挙型）を定義します。
4// 各ケースは特定の型の値（この例ではstring型）に関連付けられています。
5enum UserRole: string
6{
7    case Admin = 'administrator';
8    case Editor = 'editor';
9    case Viewer = 'viewer';
10}
11
12// 検査したいEnumの特定のケースを選択します。
13$selectedCase = UserRole::Admin;
14
15// ReflectionEnumBackedCaseのインスタンスを作成します。
16// これはEnumケースの構造をプログラムで検査するためのリフレクションオブジェクトです。
17// 第一引数にはEnumのクラス名、第二引数には検査したいケースの名前を文字列で指定します。
18$reflectionEnumBackedCase = new ReflectionEnumBackedCase(UserRole::class, $selectedCase->name);
19
20// getType() メソッドを使用して、Enumケースのバッキング型に関するリフレクション情報を取得します。
21// UserRole Enumはstring型でバッキングされているため、このメソッドはstring型を示すReflectionTypeオブジェクトを返します。
22$reflectionType = $reflectionEnumBackedCase->getType();
23
24// ReflectionTypeオブジェクトが存在する場合、その型名を出力します。
25// この例では、バッキング型がstringなので 'string' と出力されます。
26if ($reflectionType !== null) {
27    echo "Enumケース '{$selectedCase->name}' のバッキング型は '{$reflectionType->getName()}' です。\n";
28} else {
29    echo "Enumケース '{$selectedCase->name}' のバッキング型は取得できませんでした。\n";
30}
31
32// このサンプルコードは、`ReflectionEnumBackedCase::getType()`が、
33// バッキング型がstringであるEnumケースに対して、その型名（'string'）を返すことを示しています。

PHP 8で導入されたReflectionEnumBackedCase::getType()メソッドは、バッキングされた列挙型（Backed Enum）の特定のケースがどのような型の値（バッキング型）に関連付けられているかを取得するための機能です。バッキングされた列挙型とは、enum UserRole: stringのように、各ケースにAdmin = 'administrator'のように具体的な型の値を割り当てられる列挙型を指します。この例ではstringがバッキング型です。

このメソッドを利用するには、まず調べたいEnumケースの情報を持つReflectionEnumBackedCaseのインスタンスを作成します。getType()メソッドは引数を取りません。呼び出すと、そのEnumケースのバッキング型に関する情報を含むReflectionTypeオブジェクトを返します。もしバッキング型が定義されていない場合はnullが返されます。

サンプルコードでは、UserRole: stringという定義を持つ列挙型のAdminケースを選び、そのバッキング型を調べています。getType()メソッドはstring型を示すReflectionTypeオブジェクトを返し、そのgetName()メソッドを通じて具体的な型名である「string」を取得し、出力しています。これにより、プログラムが実行時にEnumケースのバッキング型を動的に把握できるようになり、柔軟な処理の実装に役立ちます。