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

Copy
1<?php
2
3/**
4 * カラーを表す列挙型を定義します。
5 * PHP 8.1以降で導入されたEnumの機能を使用しています。
6 */
7enum Color
8{
9    case Red;
10    case Green;
11    case Blue;
12    case Yellow;
13}
14
15/**
16 * Enumの全てのケースを取得し、表示するサンプルコードです。
17 * UnitEnum::cases() メソッドは、Enumの全ケースを配列として返します。
18 */
19
20// Color Enumの全てのケースを配列として取得します。
21// UnitEnum::cases()は、Enumクラス名::cases()のように静的に呼び出します。
22$allColors = Color::cases();
23
24echo "利用可能な色の一覧:\n";
25
26// 取得した各ケースをループで処理し、名前を表示します。
27foreach ($allColors as $colorCase) {
28    // $colorCaseはColor Enumのインスタンスです。
29    // ->nameプロパティでケースの名前（文字列）にアクセスできます。
30    echo "- " . $colorCase->name . "\n";
31}
32
33// 戻り値がarrayであることを確認するために、var_dumpで型を確認することもできます。
34// var_dump($allColors);
35
36?>

PHP 8.1以降で利用可能なEnum（列挙型）は、事前に定義された固定の選択肢を扱うための機能です。例えば、曜日の種類や色の種類など、決まった値を表現する際に利用します。

UnitEnum::cases()メソッドは、このEnumに定義されている全てのケース（項目）を配列として取得するための便利な方法です。このメソッドは、対象のEnumクラス名に続けて静的に呼び出します。引数は不要で、呼び出すだけで全てのケースが配列として返されます。

サンプルコードでは、Red、Green、Blue、Yellowといった色を表すColorというEnumが定義されています。Color::cases()を呼び出すことで、これら4つのケース全てが配列$allColorsに格納されます。この配列の各要素はColor Enumのインスタンスであり、それぞれのインスタンスが持つ->nameプロパティにアクセスすることで、"Red"や"Green"といったケースの名前（文字列）を取得できます。取得した配列はforeachループで処理され、「利用可能な色の一覧」として各ケースの名前が表示されます。これにより、Enumにどのような選択肢が定義されているかをプログラム内で簡単に一覧表示し、活用することが可能になります。

Copy
1<?php
2
3/**
4 * PHP 8で導入されたEnum（列挙型）のシンプルな定義例です。
5 * これは「Unit Enum」と呼ばれ、バックアップ値（stringやintなど）を持たないタイプです。
6 * ファイルの種類を表すEnumとして使用します。
7 */
8enum FileType
9{
10    case Text;    // テキストファイル
11    case Image;   // 画像ファイル
12    case Video;   // 動画ファイル
13    case Audio;   // 音声ファイル
14    case Other;   // その他のファイル
15}
16
17/**
18 * UnitEnum::cases() メソッドの使用例。
19 * 定義されたEnumの全てのケース（メンバ）を配列として取得し、表示します。
20 *
21 * このメソッドは、例えばWebアプリケーションでドロップダウンリストの選択肢を動的に生成する際などに役立ちます。
22 */
23// FileType Enumの全てのケースを配列として取得します。
24// UnitEnum::cases() メソッドは引数なしで呼び出され、Enumの全てのケースインスタンスを含む配列を返します。
25$allFileTypes = FileType::cases();
26
27echo "システムでサポートされているファイルタイプ一覧:\n";
28
29// 取得した各Enumケースをループで処理し、その名前を表示します。
30foreach ($allFileTypes as $fileTypeCase) {
31    // Enumのケースはオブジェクトとして扱われます。
32    // その->name プロパティを通じて、定義されたケース名（文字列）を取得できます。
33    echo "- " . $fileTypeCase->name . "\n";
34}
35
36?>

PHP 8で導入されたEnum（列挙型）は、事前に決められた選択肢をまとめて扱うための機能です。このサンプルコードでは、バックアップ値を持たない「Unit Enum」としてFileTypeという列挙型を定義しており、ファイルの種類を明確に表現しています。UnitEnum::cases()メソッドは、このように定義されたEnumの全てのケース（メンバ）を配列として取得するために利用されます。このメソッドは引数を一切受け取らず、呼び出すだけで、Enumの各ケースのインスタンスを含む配列を戻り値として返します。サンプルでは、FileType::cases()を呼び出すことで、FileTypeに定義された「Text」「Image」などの全ケースを$allFileTypesという配列として取得しています。取得した配列は、foreachループで一つずつ取り出し、それぞれのEnumケースインスタンスが持つ->nameプロパティを参照することで、ケースの名前（文字列）を取得し表示できます。この機能は、Webアプリケーションなどで、ドロップダウンリストの選択肢をEnumの定義から動的に生成する際など、定数の一覧をコードから柔軟に利用したい場面で非常に有用です。