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

Copy
1<?php
2
3// Enumの定義
4// Status Enum は 'string' 型のバックアップ型を持ちます。
5enum Status: string
6{
7    case Active = 'active';
8    case Inactive = 'inactive';
9    case Pending = 'pending';
10}
11
12// Role Enum はバックアップ型を持ちません。
13enum Role
14{
15    case Admin;
16    case User;
17    case Guest;
18}
19
20/**
21 * 指定されたEnumのリフレクション情報から、各ケース名とその型情報を連想配列（ハッシュテーブル）として取得します。
22 * ReflectionEnumUnitCase::hasType() メソッドを使用して、ケースがバックアップ型を持つかチェックします。
23 *
24 * システムエンジニアを目指す初心者の方へ：
25 *   PHPの「連想配列」は、内部的には「ハッシュテーブル」というデータ構造で実装されています。
26 *   この関数は、Enumの各「ケース」をキーとした連想配列を生成し、それぞれのケースが持つ「型」の情報を格納します。
27 *   これにより、プログラム実行時にEnumの構造を動的に調べることができます。
28 *
29 * @param string $enumClassName Enumの完全修飾クラス名 (例: `Status::class`)
30 * @return array<string, array{hasType: bool, type: ?string}> ケース名（string）と、その型情報（連想配列）のマップ。
31 *                                                                型情報は 'hasType' (bool) と 'type' (?string) を含む。
32 */
33function getEnumCaseTypeInfoAsHashtable(string $enumClassName): array
34{
35    $enumCaseTypeInfo = []; // 結果を格納する連想配列（ハッシュテーブル）
36
37    try {
38        $reflectionEnum = new ReflectionEnum($enumClassName);
39        $cases = $reflectionEnum->getCases(); // Enumの全てのケースを取得します。
40
41        // Enumが全体としてバックアップ型を持つかどうかを確認し、その型名を取得します。
42        // ReflectionEnumBackedCase の場合、Enum全体がバックアップ型を持ちます。
43        $backingType = $reflectionEnum->getBackingType();
44        $enumBackingTypeName = $backingType ? $backingType->getName() : null;
45
46        foreach ($cases as $case) {
47            // $case は ReflectionEnumUnitCase のインスタンス（または ReflectionEnumBackedCase のインスタンス）です。
48            // hasType() メソッドは、このケースが宣言されたバックアップ型を持つEnumに属している場合に true を返します。
49            // (バックアップ型を持たないEnumのケースでは常に false を返します。)
50            $hasType = $case->hasType();
51
52            // ケースが型を持つ場合、そのEnum全体のバックアップ型情報を利用します。
53            $caseTypeName = $hasType ? $enumBackingTypeName : null;
54
55            // ケース名（連想配列のキー）と、型情報（連想配列の値）をハッシュテーブルに追加します。
56            $enumCaseTypeInfo[$case->getName()] = [
57                'hasType' => $hasType,
58                'type' => $caseTypeName,
59            ];
60        }
61    } catch (ReflectionException $e) {
62        // リフレクションに失敗した場合のエラー処理
63        error_log("Failed to reflect enum '{$enumClassName}': " . $e->getMessage());
64        return [];
65    }
66
67    return $enumCaseTypeInfo;
68}
69
70// --- サンプルコードの実行 ---
71
72// 1. バックアップ型を持つ Status Enum の型情報を取得して表示
73echo "--- Status Enum Type Info (string backed) ---\n";
74$statusInfoMap = getEnumCaseTypeInfoAsHashtable(Status::class);
75foreach ($statusInfoMap as $caseName => $info) {
76    echo "Case: {$caseName}\n";
77    echo "  - Has Type: " . ($info['hasType'] ? 'Yes' : 'No') . "\n";
78    if ($info['type']) {
79        echo "  - Type: {$info['type']}\n"; // 'string' と表示されます。
80    }
81    echo "\n";
82}
83
84// 2. バックアップ型を持たない Role Enum の型情報を取得して表示
85echo "--- Role Enum Type Info (no backing type) ---\n";
86$roleInfoMap = getEnumCaseTypeInfoAsHashtable(Role::class);
87foreach ($roleInfoMap as $caseName => $info) {
88    echo "Case: {$caseName}\n";
89    echo "  - Has Type: " . ($info['hasType'] ? 'Yes' : 'No') . "\n";
90    if ($info['type']) {
91        // この条件は常に false になるため、この行は表示されません。
92        echo "  - Type: {$info['type']}\n";
93    }
94    echo "\n";
95}
96

このサンプルコードは、PHP 8で導入されたEnum（列挙型）の各ケースがバックアップ型を持つかどうかを、ReflectionEnumUnitCase::hasType()メソッドを使って動的に判断し、その情報を連想配列（ハッシュテーブル）として取得する方法を示しています。hasType()メソッドは引数を取らず、戻り値としてブール型（trueまたはfalse）を返します。具体的には、このケースが文字列や整数などのバックアップ型を持つEnumに属している場合にtrueを返し、バックアップ型を持たないEnumのケースであればfalseを返します。

PHPにおける連想配列は内部的にハッシュテーブルとして実装されており、この関数はEnumのケース名をキー、その型情報を値とする連想配列を生成します。これにより、プログラムの実行中にEnumの構造を柔軟に調べることができます。

コードでは、string型のバックアップ型を持つStatus Enumと、バックアップ型を持たないRole Enumの二つを例に挙げています。getEnumCaseTypeInfoAsHashtable関数は、指定されたEnumの各ケースについて、hasType()の結果と、もし型があればその型名を取得し、連想配列として返します。出力部分では、それぞれのEnumのケースが型を持つかどうかの情報と、持っている場合の型名が表示され、リフレクションAPIを用いた動的な型情報の取得方法を具体的に確認できます。

Copy
1<?php
2
3// PHP 8.1以降で導入されたEnumを定義します。
4
5/**
6 * バックアップ型 (int) を持つEnum。
7 * 各ケースは整数値を持ちます。
8 */
9enum Status: int
10{
11    case Active = 1;
12    case Inactive = 0;
13}
14
15/**
16 * バックアップ型を持たないEnum (純粋なEnum)。
17 * 各ケースはそれ自体が値であり、特定の型に紐づきません。
18 */
19enum Role
20{
21    case Admin;
22    case User;
23}
24
25/**
26 * ReflectionEnumUnitCase::hasType() メソッドの使用例を示します。
27 * このメソッドは、Enumの特定のケースがバックアップ型を持っているかどうかを判定します。
28 *
29 * @param string $enumClassName Enumのクラス名（例: Status::class）
30 * @param string $caseName チェックするEnumケースの名前（例: 'Active'）
31 */
32function demonstrateHasType(string $enumClassName, string $caseName): void
33{
34    echo "--- {$enumClassName}::{$caseName} の型チェック ---\n";
35    try {
36        // Enum全体の情報を取得するためのリフレクションインスタンスを作成します。
37        $enumReflection = new ReflectionEnum($enumClassName);
38        
39        // 特定のEnumケースのリフレクションインスタンスを取得します。
40        // これは ReflectionEnumUnitCase または ReflectionEnumBackedCase のインスタンスです。
41        $caseReflection = $enumReflection->getCase($caseName);
42
43        // hasType() メソッドを呼び出し、そのEnumケースが型を持っているかを確認します。
44        // 型がある場合、ReflectionTypeオブジェクトが返されます。
45        if ($caseReflection->hasType()) {
46            $type = $caseReflection->getType(); // 型の情報を取得
47            echo "{$enumClassName}::{$caseName} はバックアップ型を持っています: " . $type->getName() . "\n";
48        } else {
49            echo "{$enumClassName}::{$caseName} はバックアップ型を持っていません。\n";
50        }
51    } catch (ReflectionException $e) {
52        // リフレクション処理中にエラーが発生した場合のハンドリング
53        echo "エラー: " . $e->getMessage() . "\n";
54    }
55    echo "\n";
56}
57
58// バックアップ型を持つEnumケースの例
59demonstrateHasType(Status::class, 'Active');
60
61// バックアップ型を持たないEnumケースの例
62demonstrateHasType(Role::class, 'Admin');
63

ReflectionEnumUnitCase::hasType()メソッドは、PHP 8.1以降で導入されたEnum（列挙型）の特定のケースが、バックアップ型（例えばintやstringなどの基底型）を持っているかどうかを判定するために使用されます。

Enumには、enum Status: intのように基底の型を指定して定義される「バックアップ型を持つEnum」と、enum Roleのように型指定なしで定義される「バックアップ型を持たない（純粋な）Enum」の2種類があります。このhasType()メソッドは引数を取らず、対象のEnumケースがバックアップ型を持っていればtrueを、持っていなければfalseをブール値として返します。

サンプルコードでは、まずReflectionEnumクラスを利用して指定されたEnum全体の情報を取得します。続いて、そのEnumの中からgetCase()メソッドを用いて特定のケース（例えばStatus::ActiveやRole::Admin）の情報をReflectionEnumUnitCaseインスタンスとして取得します。そして、この$caseReflectionインスタンスに対してhasType()を呼び出すことで、そのEnumケースがバックアップ型を持っているかを判定しています。

例えば、Status::Activeはint型のバックアップ型を持つためtrueが返され、その型名が表示されます。一方、Role::Adminはバックアップ型を持たないためfalseが返され、その旨が表示されます。これにより、プログラム実行時にEnumの構造を動的に確認し、異なる種類のEnumケースを適切に処理する実装が可能になります。