【PHP8.x】casesメソッドの使い方

Copy
1<?php
2
3/**
4 * Dom\AdjacentPosition::cases() メソッドの使用例。
5 *
6 * このメソッドは、Dom\AdjacentPosition Enum のすべてのケースを配列として返します。
7 * Dom\AdjacentPosition は PHP 8.3 で導入されました。
8 *
9 * システムエンジニアを目指す初心者向けに、Enum のケースの取得方法とその利用例を示します。
10 */
11
12// Dom\AdjacentPosition Enum のすべてのケースを取得します。
13// cases() メソッドは引数を取らず、Enum ケースの配列を返します。
14$allAdjacentPositions = Dom\AdjacentPosition::cases();
15
16echo "Dom\\AdjacentPosition のすべてのケース:\n";
17
18// 取得したケースをループして表示します。
19foreach ($allAdjacentPositions as $position) {
20    // Enum のケースはオブジェクトとして扱われ、'name' プロパティでケース名にアクセスできます。
21    // 'value' プロパティで基となる値（定義されていれば）にアクセスできますが、
22    // Dom\AdjacentPosition はバッキング型を持たない純粋な Enum なので 'name' を使用します。
23    echo "- " . $position->name . "\n";
24}
25
26?>

このサンプルコードは、PHP 8.3で導入されたDom\AdjacentPosition::cases()メソッドの利用方法を示しています。このメソッドは、Dom\AdjacentPositionというEnum（列挙型）に定義されているすべての定数（ケース）を配列として取得するために使用されます。

cases()メソッドは引数を一切取らず、戻り値としてDom\AdjacentPositionの各ケースが格納された配列を返します。この配列の各要素は、それぞれのEnumケースを表すオブジェクトです。

サンプルコードでは、まずDom\AdjacentPosition::cases()を呼び出して、すべてのケースを$allAdjacentPositions変数に格納しています。次に、この配列をforeachループで順番に処理し、各ケースの名前を表示しています。Enumのケースはオブジェクトとして扱われるため、$position->nameのように.nameプロパティにアクセスすることで、そのケースの名称を取得できます。この機能は、Enumに定義された選択肢を動的に取得し、例えばドロップダウンリストの選択肢として利用する際などに役立ちます。

Copy
1<?php
2
3/**
4 * Dom\AdjacentPosition Enum のすべてのケースを表示する関数
5 *
6 * この関数は、PHP 8.3 で導入された Dom\AdjacentPosition Enum の
7 * 定義されているすべての列挙ケースを取得し、それぞれのケースの名前を表示します。
8 * PHP 8.3 以降のバージョンで実行する必要があります。
9 */
10function displayAdjacentPositionCases(): void
11{
12    echo "Dom\\AdjacentPosition のすべての列挙ケース:\n";
13
14    // Dom\AdjacentPosition::cases() メソッドを呼び出し、
15    // 定義されているすべての列挙ケース（Enumインスタンス）を含む配列を取得します。
16    $cases = Dom\AdjacentPosition::cases();
17
18    foreach ($cases as $case) {
19        // 各 $case は Dom\AdjacentPosition のインスタンスです。
20        // ->name プロパティで列挙子の文字列名を取得できます。
21        echo "- " . $case->name . "\n";
22    }
23}
24
25// 関数を実行して、Dom\AdjacentPosition のすべての列挙ケースを表示します。
26displayAdjacentPositionCases();
27
28?>

このサンプルコードは、PHP 8.3で導入されたEnum（列挙型）の一つであるDom\AdjacentPositionの、定義されているすべての「ケース」（選択肢）を取得して表示する方法を示しています。Dom\AdjacentPosition::cases()メソッドは、引数を一切取らずに呼び出すことができ、そのEnumに定義されているすべての列挙ケースのインスタンスを含む配列を戻り値として返します。

具体的には、displayAdjacentPositionCases関数内でDom\AdjacentPosition::cases()メソッドを呼び出すことで、Dom\AdjacentPositionEnumに存在するすべてのケース（例えばBeforeBeginやAfterEndといった特定の定数）がオブジェクトとして配列に格納されます。その後、foreachループを使って配列の各要素を順番に取り出し、それぞれのケースが持つnameプロパティを通じて文字列名を取得し、画面に表示しています。これにより、Dom\AdjacentPositionEnumがどのような有効な選択肢を持っているかを一覧で簡単に確認できます。これは、Enumの利用可能な値を動的に知りたい場合に非常に便利な機能です。