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

Copy
1<?php
2
3// PHP 8.1以降で導入されたEnum（列挙型）を定義します。
4// Enumは、関連する定数の集合を表現するのに役立ちます。
5enum UserRole
6{
7    case Administrator;
8    case Editor;
9    case Viewer;
10}
11
12/**
13 * UserRole Enumの全てのケースを取得して表示する関数です。
14 *
15 * Enumの静的メソッド `cases()` を使用して、定義されている全てのケースを配列として取得します。
16 */
17function displayEnumCases(): void
18{
19    echo "UserRole Enumの全ケース:\n";
20
21    // `UserRole::cases()` は、UserRole Enumの全てのケースを
22    // UserRoleインスタンスの配列として返します。
23    $allCases = UserRole::cases();
24
25    foreach ($allCases as $case) {
26        // 各ケースの名前 (例: "Administrator") にアクセスします。
27        echo "- " . $case->name . "\n";
28    }
29}
30
31// 関数を実行してEnumのケースを表示します。
32displayEnumCases();
33

PHP 8.1で導入されたEnum（列挙型）は、関連する定数の集合をひとまとめに定義する仕組みです。例えば、ユーザーの役割を示す「Administrator」「Editor」「Viewer」のような定数を、UserRoleというEnumで管理できます。

このサンプルコードでは、UserRoleというEnumを定義し、その全てのケースをプログラムで取得して表示する方法を示しています。Enumに定義された全てのケースを取得したい場合に利用するのが、cases()メソッドです。cases()メソッドは、Enumの静的メソッドとして提供されており、引数は不要です。呼び出すと、そのEnumで定義された全てのケース（例: UserRole::Administrator、UserRole::Editor、UserRole::Viewer）が、それぞれのEnumインスタンスとして格納された配列を返します。

サンプルコード内のdisplayEnumCases関数では、UserRole::cases()を呼び出して取得した配列を$allCases変数に代入し、foreachループを使って各ケースにアクセスしています。各ケースはEnumのインスタンスなので、そのnameプロパティを参照することで、ケースの名前（例: "Administrator"）を表示しています。このようにcases()メソッドを利用することで、プログラム実行時にEnumの定義内容を動的に把握し、柔軟な処理を実装することが可能になります。

Copy
1<?php
2
3/**
4 * PHP 8.1 で導入された Enum (列挙型) の定義。
5 * この Enum は、色の種類を表します。
6 * 'case' キーワードは、個々の列挙値を定義します。
7 */
8enum Color: string
9{
10    case Red = 'red';
11    case Green = 'green';
12    case Blue = 'blue';
13    case Yellow = 'yellow';
14}
15
16/**
17 * Enum の全てのケースを配列として取得し、表示する関数。
18 *
19 * PHP 8.1 以降で利用可能な Enum の `cases()` メソッドは、
20 * その列挙型に定義されている全てのケースを配列として返します。
21 * これは、引数なしで配列を返す典型的なメソッドの例であり、
22 * 「php case式」というキーワードにも関連性が高い使用方法です。
23 *
24 * @return array<Color> Enum の全てのケースの配列。
25 */
26function displayAllColorCases(): array
27{
28    // Color::cases() を呼び出し、Color Enum のすべてのケースを配列で取得します。
29    // 戻り値は、各ケース（Colorオブジェクト）を含む配列です。
30    $allCases = Color::cases();
31
32    echo "利用可能な色のケース:\n";
33    foreach ($allCases as $case) {
34        // 各ケースの 'name' (定数名) と 'value' (割り当てられた値) にアクセスして表示
35        echo "- " . $case->name . " (値: " . $case->value . ")\n";
36    }
37
38    return $allCases;
39}
40
41// 関数を実行し、Enumの全てのケースを表示
42displayAllColorCases();

PHP 8.1で導入されたEnum（列挙型）は、事前に定義された複数の定数値をまとめて扱うための機能です。このサンプルコードは、特定のEnumであるColor型を定義し、その全ての列挙値（ケース）を動的に取得する方法を示しています。

Color Enumは、caseキーワードを使ってRed、Green、Blue、Yellowといった色の種類を定数として定義しています。各ケースには、文字列の値が割り当てられています。

Color::cases()メソッドは、このColor Enumに定義されている全てのケースを配列として取得するための静的なメソッドです。このメソッドは引数なしで呼び出すことができ、戻り値として、各ケースを表すColorオブジェクトが格納された配列を返します。これにより、「php case式」で定義された列挙値の選択肢をプログラムで一覧化することが可能になります。

displayAllColorCases関数内では、Color::cases()を呼び出して$allCases変数に全ケースの配列を格納しています。その後、この配列をループ処理し、各ケースの定数名（例: Red）と、それに割り当てられた値（例: 'red'）を画面に表示しています。このメソッドは、列挙型の利用可能な選択肢を動的に取得し、アプリケーション内で活用する際に非常に役立ちます。