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

Copy
1<?php
2
3// PHP 8.1で導入された列挙型 (Enum) を定義します。
4// ReflectionEnumUnitCase クラスは、引数を持たない列挙ケース（ユニットケース）のリフレクションに使用されます。
5enum UserRole: string
6{
7    case Admin = 'administrator';
8    case Editor = 'editor';
9    case Viewer = 'viewer';
10}
11
12/**
13 * 指定された列挙型ユニットケースが public として定義されているかを確認し、結果を表示します。
14 *
15 * ReflectionEnumUnitCase::isPublic() メソッドは、リフレクション対象の列挙ケースが
16 * public な可視性を持つかどうかを返します。
17 * PHPの列挙型ケースは、デフォルトで常に public として定義されるため、
18 * このメソッドは常に true を返します。
19 *
20 * @param UnitEnum $enumCase 可視性をチェックする列挙型ユニットケース。
21 */
22function checkEnumUnitCaseVisibility(UnitEnum $enumCase): void
23{
24    try {
25        // ReflectionEnumUnitCase オブジェクトを作成し、列挙型ケースをリフレクションします。
26        // これにより、列挙型ケースの様々なプロパティやメソッドにアクセスできるようになります。
27        $reflectionCase = new ReflectionEnumUnitCase($enumCase::class, $enumCase->name);
28
29        // isPublic() メソッドを呼び出し、列挙型ケースが public であるかを確認します。
30        $isPublic = $reflectionCase->isPublic();
31
32        echo "列挙型ケース '" . $enumCase->name . "' は public ですか？ " . ($isPublic ? 'はい' : 'いいえ') . PHP_EOL;
33
34    } catch (ReflectionException $e) {
35        // リフレクション処理中にエラーが発生した場合の例外処理
36        echo "リフレクションエラー: " . $e->getMessage() . PHP_EOL;
37    }
38}
39
40// UserRole::Admin ケースの可視性をチェックします。
41checkEnumUnitCaseVisibility(UserRole::Admin);
42
43// UserRole::Viewer ケースの可視性をチェックします。
44checkEnumUnitCaseVisibility(UserRole::Viewer);
45
46?>

PHPのサンプルコードは、PHP 8.1で導入された列挙型（Enum）のケースが「public」であるかどうかを調べる方法を示しています。

ReflectionEnumUnitCaseクラスは、引数を持たない列挙型のケース（例: UserRole::Admin）について、その内部情報を動的に取得するための機能（リフレクション）を提供します。このリフレクション機能を利用することで、プログラムの実行中に列挙型の詳細を調べることが可能になります。

本コードで利用しているisPublic()メソッドは、引数を一切取らず、調査対象の列挙型ケースがpublicな可視性を持つ場合にtrueを、そうでない場合にfalseを真偽値として返します。PHPの列挙型ケースは、言語仕様により常にpublicとして定義されるため、isPublic()メソッドはどのような列挙型ケースに対しても、常にtrueを返します。

このサンプルコードでは、UserRole::AdminとUserRole::Viewerという二つの列挙型ケースに対してisPublic()メソッドを実行し、その結果を表示しています。どちらのケースもPHPの仕様通りに「public」と判断され、「はい」という結果が出力されます。これにより、列挙型ケースの可視性をリフレクションで確認する基本的な仕組みを理解できます。

Copy
1<?php
2
3// 列挙型を定義します。
4// PHP 8.1以降で導入されたEnum機能を使用します。
5enum Status
6{
7    case PENDING;
8    case APPROVED;
9    case REJECTED;
10}
11
12/**
13 * ReflectionEnumUnitCase::isPublic() メソッドの利用例。
14 *
15 * このメソッドは、PHPのReflection API を使って列挙型（Enum）の
16 * 特定のケース（引数を持たないユニットケース）が public であるかを判定します。
17 * Enum のケースはデフォルトで public として定義されるため、このメソッドは常に true を返します。
18 *
19 * キーワード `is_page` のように、`isPublic` メソッドも特定の状態
20 * （この場合は列挙型のケースが公開されているか）を真偽値で判定するという点で、
21 * 同様のパターンを持つメソッドです。
22 */
23function demonstrateReflectionEnumUnitCaseIsPublic(): void
24{
25    // ReflectionEnumUnitCase のインスタンスを作成します。
26    // ここでは、Status::PENDING ケースをリフレクションします。
27    try {
28        $reflectionCase = new ReflectionEnumUnitCase(Status::class, 'PENDING');
29
30        // isPublic() メソッドを呼び出して、ケースが public であるかを判定します。
31        $isPublic = $reflectionCase->isPublic();
32
33        echo "Enumケース 'PENDING' は public ですか？: " . ($isPublic ? 'はい' : 'いいえ') . PHP_EOL;
34
35        // 別のケースも確認してみます。
36        $reflectionCaseApproved = new ReflectionEnumUnitCase(Status::class, 'APPROVED');
37        $isPublicApproved = $reflectionCaseApproved->isPublic();
38        echo "Enumケース 'APPROVED' は public ですか？: " . ($isPublicApproved ? 'はい' : 'いいえ') . PHP_EOL;
39
40    } catch (ReflectionException $e) {
41        // リフレクション中にエラーが発生した場合の処理
42        echo "リフレクションエラー: " . $e->getMessage() . PHP_EOL;
43    }
44}
45
46// 関数を実行します。
47demonstrateReflectionEnumUnitCaseIsPublic();
48

ReflectionEnumUnitCase::isPublic()メソッドは、PHP 8.1以降で導入された列挙型（Enum）の特定のケースがpublicとして定義されているかを判定するものです。このメソッドは引数を取らず、戻り値として真偽値（bool）を返します。該当のEnumケースがpublicであればtrueを、そうでなければfalseを返しますが、PHPのEnumケースは常にpublicとして定義されるため、実際には常にtrueが返されます。

サンプルコードでは、Statusという列挙型を定義し、その後ReflectionEnumUnitCaseクラスを用いてStatus::PENDINGケースの情報を動的に取得しています。取得した情報に対してisPublic()メソッドを呼び出し、その結果を変数$isPublicに格納しています。実行すると「Enumケース 'PENDING' は public ですか？: はい」と出力され、trueが返されていることが分かります。

このisPublicメソッドは、PHPのis_page関数が現在のページが特定のタイプか否かを真偽値で判断するように、Enumのケースが公開状態であるかという特定の状態を真偽値で判定するために使用されます。主に、プログラムが実行時にEnumケースの内部構造を調べたい場合に活用されます。