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

Copy
1<?php
2
3/**
4 * PHP 8.1で導入されたEnum (列挙型) の使用例です。
5 * RoundingMode Enumは、数値の丸め方を定義するための架空の Enum として作成します。
6 * 実際には、PHPの拡張機能やライブラリに具体的な RoundingMode が存在する場合もあります。
7 */
8enum RoundingMode
9{
10    case HalfUp;    // 最も近い整数に丸める（.5 は切り上げ）
11    case HalfDown;  // 最も近い整数に丸める（.5 は切り下げ）
12    case HalfEven;  // 最も近い偶数に丸める（銀行型丸め）
13    case Up;        // ゼロから遠ざかる方向に丸める
14    case Down;      // ゼロに近づく方向に丸める
15    case Ceiling;   // 正の無限大の方向に丸める
16    case Floor;     // 負の無限大の方向に丸める
17}
18
19/**
20 * RoundingMode Enumの全てのケースを表示する関数。
21 *
22 * Enum::cases() メソッドは、PHP 8.1以降で導入され、
23 * そのEnumに定義された全てのケースを配列として返します。
24 * この関数は、システムエンジニアを目指す初心者がEnumの基本的な使い方と
25 * cases() メソッドの役割を理解するのに役立ちます。
26 */
27function displayAllRoundingModes(): void
28{
29    echo "--- RoundingMode Enum の全ケース一覧 ---\n";
30
31    // RoundingMode::cases() を呼び出すと、Enumの各ケースを表すオブジェクトの配列が返されます。
32    $allRoundingModes = RoundingMode::cases();
33
34    // 返された配列をループし、各Enumケースの情報を表示します。
35    foreach ($allRoundingModes as $mode) {
36        // Enumケースオブジェクトの 'name' プロパティは、そのケースの定数名を示します。
37        echo "ケース名: " . $mode->name . "\n";
38    }
39
40    echo "-----------------------------------------\n";
41}
42
43// 関数を実行して、RoundingMode Enumの全てのケースを表示します。
44displayAllRoundingModes();
45
46?>

PHP 8.1で導入されたEnum（列挙型）は、事前に定義された固定の選択肢を扱うための便利な機能です。ここでご紹介するRoundingMode::cases()メソッド（実際には任意のEnumでEnumName::cases()として使用）は、このEnumに定義された全ての選択肢（ケース）を簡単に取得するために使用されます。

cases()メソッドは引数を一切必要とせず、呼び出すだけで対象のEnumに定義されている全てのケースを配列として返します。この配列の各要素は、そのEnumの特定のケースを表すオブジェクトです。例えば、サンプルコードのRoundingMode Enumでは、HalfUpやHalfDownといった丸めモードが定義されていますが、RoundingMode::cases()を呼び出すと、これらの全てのモードが配列にまとめられて手に入ります。

取得した配列は、foreachループなどで一つずつ取り出し、各ケースの名前（$mode->nameのようにアクセス）や値をプログラム内で利用できます。これにより、Enumの定義内容を動的に把握したり、全てのケースに対して一括で処理を行ったりすることが可能になります。このcases()メソッドは、Enumの全体像を理解し、より柔軟なコードを書くための基礎となる重要な機能です。

Copy
1<?php
2
3// PHP 8.1以降で利用可能なRoundingMode enum（列挙型）を使用します。
4// RoundingModeは、数値の丸め処理における挙動を定義する定数セットです。
5
6/**
7 * RoundingMode enumのすべてのケースを取得し、表示するサンプルです。
8 *
9 * RoundingMode::cases() メソッドは、RoundingMode enumで定義されている
10 * すべての丸めモードのインスタンスを配列として返します。
11 * これは、利用可能なすべてのオプションをプログラム的に取得したい場合に便利です。
12 */
13function displayRoundingModes(): void
14{
15    // RoundingMode::cases() を呼び出し、すべての丸めモードの配列を取得します。
16    // 返される配列の各要素は RoundingMode のインスタンスです。
17    $allRoundingModes = RoundingMode::cases();
18
19    echo "利用可能な丸めモードの一覧:\n";
20
21    // 取得した配列をループ処理し、各丸めモードの名前を表示します。
22    // enumの各ケースは 'name' プロパティを通じて自身の名前（文字列）にアクセスできます。
23    foreach ($allRoundingModes as $mode) {
24        echo "- " . $mode->name . "\n";
25    }
26}
27
28// 関数を実行して、丸めモードを表示します。
29displayRoundingModes();
30
31?>

PHP 8.1で導入されたRoundingModeは、数値の丸め処理における挙動を定義する列挙型（enum）です。このサンプルコードは、RoundingMode enumで利用可能なすべての丸めモードをプログラム的に取得し、その名前を表示する方法を示しています。

RoundingMode::cases()メソッドは、特定の引数を必要とせず、RoundingMode enumに定義されているすべてのメンバー（ケース）のインスタンスを配列として返します。これにより、利用可能なすべての丸めオプションを動的に取得し、表示したり、プログラムのロジックで利用したりすることが可能になります。

サンプルコードでは、まずdisplayRoundingModes()関数内でRoundingMode::cases()を呼び出し、その戻り値であるRoundingModeインスタンスの配列を$allRoundingModes変数に格納しています。次に、この配列をforeachループで順番に処理し、各RoundingModeインスタンスのnameプロパティを通じて、それぞれの丸めモードの名称（例: "HALF_UP"）を取得しています。取得した名称は、echo文を使ってコンソールに出力され、利用可能な丸めモードの一覧が分かりやすく表示されます。この機能は、設定画面で丸めオプションを選択肢として提示する場合など、動的にオプションリストを生成する際に特に役立ちます。