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

Copy
1<?php declare(strict_types=1);
2
3// PHP 8.1以降で導入された列挙型（enum）を定義します。
4// 列挙型は、取りうる値を限定したい場合に、値の集合を明確に定義できる便利な型です。
5enum Status: string
6{
7    case ACTIVE = 'active';
8    case INACTIVE = 'inactive';
9    case PENDING = 'pending';
10
11    // 列挙型にメソッドを定義します。
12    // ReflectionEnum::hasMethod は、この列挙型が特定のメソッドを持っているかを確認するために使われます。
13    public function getDescription(): string
14    {
15        return match ($this) {
16            self::ACTIVE => 'アクティブ状態です',
17            self::INACTIVE => '非アクティブ状態です',
18            self::PENDING => '保留状態です',
19        };
20    }
21
22    // もう一つのメソッドを追加します。
23    public function isFinal(): bool
24    {
25        return in_array($this, [self::ACTIVE, self::INACTIVE]);
26    }
27}
28
29/**
30 * ReflectionEnum::hasMethod の使用例を示します。
31 *
32 * この関数は、指定された列挙型が特定の名前のメソッドを定義しているかどうかを確認し、
33 * その結果を出力します。システムエンジニアを目指す初心者の方でも、リフレクションAPIが
34 * プログラムの構造を動的に調べるのに役立つことを理解しやすいように設計されています。
35 */
36function checkEnumMethods(): void
37{
38    // ReflectionEnum クラスを使って、Status 列挙型のリフレクション情報を作成します。
39    // これにより、プログラムの実行中に列挙型のメソッドやプロパティなどを調べることが可能になります。
40    $reflectionEnum = new ReflectionEnum(Status::class);
41
42    // 'getDescription' メソッドが Status 列挙型に存在するかチェックします。
43    // このメソッドは上記で定義されているため、結果は 'はい' となります。
44    $hasDescriptionMethod = $reflectionEnum->hasMethod('getDescription');
45    echo "Status enum に 'getDescription' メソッドは存在しますか？ " . ($hasDescriptionMethod ? 'はい' : 'いいえ') . "\n";
46
47    // 'isFinal' メソッドが Status 列挙型に存在するかチェックします。
48    // このメソッドも上記で定義されているため、結果は 'はい' となります。
49    $hasIsFinalMethod = $reflectionEnum->hasMethod('isFinal');
50    echo "Status enum に 'isFinal' メソッドは存在しますか？ " . ($hasIsFinalMethod ? 'はい' : 'いいえ') . "\n";
51
52    // 'getDetails' という名前のメソッドが Status 列挙型に存在するかチェックします。
53    // このメソッドは定義されていないため、結果は 'いいえ' となります。
54    $hasGetDetailsMethod = $reflectionEnum->hasMethod('getDetails');
55    echo "Status enum に 'getDetails' メソッドは存在しますか？ " . ($hasGetDetailsMethod ? 'はい' : 'いいえ') . "\n";
56
57    // BackedEnum (文字列や整数に紐付けられたenum) では、`from()` メソッドがPHPによって自動生成されます。
58    // そのため、`hasMethod('from')` は存在すると判定されます。
59    $hasFromMethod = $reflectionEnum->hasMethod('from');
60    echo "Status enum に 'from' メソッドは存在しますか？ " . ($hasFromMethod ? 'はい' : 'いいえ') . "\n";
61}
62
63// 定義した関数を実行し、結果を出力します。
64checkEnumMethods();

PHP 8.1で導入された列挙型（enum）は、取りうる値を限定する際に非常に便利な機能です。ReflectionEnum::hasMethodは、PHPのリフレクションAPIの一部で、特定の列挙型が指定された名前のメソッドを持っているかどうかを、プログラムの実行中に動的に確認するために使用されます。

このメソッドは、引数としてstring $name（確認したいメソッドの名前）を受け取ります。そして、もし列挙型にその名前のメソッドが存在すればtrueを、存在しなければfalseをbool値として返します。

サンプルコードでは、まずStatusという列挙型を定義し、その中にgetDescriptionやisFinalといったメソッドを実装しています。次に、ReflectionEnum(Status::class)を使ってStatus列挙型のリフレクション情報を作成します。

$reflectionEnum->hasMethod('getDescription')や$reflectionEnum->hasMethod('isFinal')を実行すると、これらのメソッドが実際に定義されているため、trueが返されます。一方、$reflectionEnum->hasMethod('getDetails')は、Status列挙型にgetDetailsというメソッドが定義されていないため、falseを返します。

また、enum Status: stringのように基となる値を持つ列挙型（BackedEnum）では、fromメソッドがPHPによって自動的に提供されるため、$reflectionEnum->hasMethod('from')はtrueを返します。このように、hasMethodは、プログラムが列挙型の構造を動的に調べ、その存在に基づいて処理を分岐させる際に役立つ強力なツールです。

Copy
1<?php
2
3/**
4 * PHP 8.1以降で利用可能なEnum（列挙型）の定義。
5 * ReflectionEnum::hasMethodの動作を確認するために、
6 * いくつかのメソッドを含めています。
7 */
8enum Status: string
9{
10    case Active = 'active';
11    case Inactive = 'inactive';
12    case Pending = 'pending';
13
14    /**
15     * ステータスに対応するユーザーフレンドリーな説明を返すメソッド。
16     */
17    public function getDescription(): string
18    {
19        return match ($this) {
20            self::Active => '有効な状態',
21            self::Inactive => '無効な状態',
22            self::Pending => '保留中の状態',
23        };
24    }
25
26    /**
27     * すべてのステータスの値を配列で返す静的メソッド。
28     */
29    public static function getAllValues(): array
30    {
31        return array_map(fn($case) => $case->value, self::cases());
32    }
33}
34
35/**
36 * ReflectionEnum::hasMethod の使用例。
37 * 指定された名前のメソッドが列挙型に存在するかどうかをチェックします。
38 * システムエンジニアを目指す初心者の方にも理解しやすいように、
39 * 存在する場合としない場合の両方のパターンを示しています。
40 */
41function demonstrateHasMethod(): void
42{
43    echo "--- ReflectionEnum::hasMethod の使用例 ---" . PHP_EOL;
44
45    // ReflectionEnumクラスのインスタンスを生成します。
46    // 引数には、情報を取得したいEnumクラスの名前（FQCN）を渡します。
47    $reflectionEnum = new ReflectionEnum(Status::class);
48
49    // 1. 列挙型に存在するインスタンスメソッドをチェック
50    $methodName1 = 'getDescription';
51    if ($reflectionEnum->hasMethod($methodName1)) {
52        echo "列挙型 '" . Status::class . "' にメソッド '{$methodName1}' が存在します。" . PHP_EOL;
53    } else {
54        echo "列挙型 '" . Status::class . "' にメソッド '{$methodName1}' は存在しません。" . PHP_EOL;
55    }
56
57    // 2. 列挙型に存在する静的メソッドをチェック
58    $methodName2 = 'getAllValues';
59    if ($reflectionEnum->hasMethod($methodName2)) {
60        echo "列挙型 '" . Status::class . "' にメソッド '{$methodName2}' が存在します。" . PHP_EOL;
61    } else {
62        echo "列挙型 '" . Status::class . "' にメソッド '{$methodName2}' は存在しません。" . PHP_EOL;
63    }
64
65    // 3. 列挙型に存在しないメソッドをチェック
66    $methodName3 = 'doSomething';
67    if ($reflectionEnum->hasMethod($methodName3)) {
68        echo "列挙型 '" . Status::class . "' にメソッド '{$methodName3}' が存在します。" . PHP_EOL;
69    } else {
70        echo "列挙型 '" . Status::class . "' にメソッド '{$methodName3}' は存在しません。" . PHP_EOL;
71    }
72
73    // 4. Enumのケース名（Active, Inactiveなど）はメソッドとしては扱われません。
74    $methodName4 = 'Active';
75    if ($reflectionEnum->hasMethod($methodName4)) {
76        echo "列挙型 '" . Status::class . "' にメソッド '{$methodName4}' が存在します。(Enumケースはメソッドではない)" . PHP_EOL;
77    } else {
78        echo "列挙型 '" . Status::class . "' にメソッド '{$methodName4}' は存在しません。(Enumケースはメソッドではない)" . PHP_EOL;
79    }
80}
81
82// 関数を実行して結果を表示します。
83demonstrateHasMethod();
84

PHP 8で導入されたReflectionEnumクラスのhasMethodメソッドは、列挙型（Enum）に特定の名前のメソッドが存在するかどうかを確認するために使用されます。引数としてチェックしたいメソッドの名前（文字列型）を渡し、戻り値として存在すればtrue、存在しなければfalseを真偽値で返します。

このサンプルコードでは、まずStatusという列挙型を定義しています。この列挙型には、ステータスの説明を返すgetDescriptionメソッド（インスタンスメソッド）と、すべてのステータス値を配列で返すgetAllValuesメソッド（静的メソッド）が含まれています。

demonstrateHasMethod関数内で、ReflectionEnumクラスのインスタンスをnew ReflectionEnum(Status::class)として生成し、Status列挙型の情報を取得します。その後、hasMethodメソッドを使って、以下のように様々なパターンでメソッドの存在を確認しています。

1. 存在するインスタンスメソッドgetDescriptionをチェックし、trueを返します。
2. 存在する静的メソッドgetAllValuesをチェックし、trueを返します。
3. 存在しないメソッドdoSomethingをチェックし、falseを返します。
4. Enumのケース名であるActiveはメソッドではないため、falseを返します。

このように、hasMethodメソッドを使うことで、プログラムの実行中に動的に列挙型が特定の機能（メソッド）を持っているかを安全に確認できます。