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

Copy
1<?php
2
3/**
4 * ReflectionClass::getModifiers の使用例を示すためのサンプルクラスA。
5 * これは通常の具象クラスです。
6 */
7class MyConcreteClass
8{
9    public string $name = 'Concrete';
10}
11
12/**
13 * ReflectionClass::getModifiers の使用例を示すためのサンプルクラスB。
14 * これは抽象クラスです。
15 */
16abstract class MyAbstractClass
17{
18    public abstract function doSomething(): void;
19}
20
21/**
22 * ReflectionClass::getModifiers の使用例を示すためのサンプルクラスC。
23 * これはfinalクラスです。
24 */
25final class MyFinalClass
26{
27    public function doSomethingElse(): void
28    {
29        // 処理
30    }
31}
32
33/**
34 * ReflectionClass::getModifiers の使用例を示すためのサンプルインターフェース。
35 */
36interface MyInterface
37{
38    public function performAction(): void;
39}
40
41/**
42 * ReflectionClass::getModifiers の使用例を示すためのサンプルトレイト。
43 */
44trait MyTrait
45{
46    public function sayHello(): void
47    {
48        echo "Hello from trait!\n";
49    }
50}
51
52/**
53 * 指定されたクラス（またはインターフェース、トレイト）の修飾子を取得し、表示する関数。
54 *
55 * @param string $className クラス（またはインターフェース、トレイト）の完全修飾名。
56 * @return void
57 */
58function displayClassModifiersInfo(string $className): void
59{
60    echo "--- クラス/インターフェース/トレイト: {$className} ---\n";
61
62    try {
63        // ReflectionClassのインスタンスを生成
64        $reflectionClass = new ReflectionClass($className);
65
66        // getModifiers() メソッドを呼び出し、クラスの修飾子を示すビットマスクを取得
67        // 戻り値は整数値で、様々な修飾子（abstract, finalなど）の組み合わせを表します。
68        $modifiers = $reflectionClass->getModifiers();
69
70        echo "  取得された修飾子 (整数値): {$modifiers}\n";
71
72        // 取得した整数値を、Reflectionクラスが提供する定数とビット演算で比較し、
73        // どの修飾子が付与されているか判定します。
74        // Reflection::IS_ABSTRACT は、クラスが抽象であることを示す定数です。
75        if (($modifiers & Reflection::IS_ABSTRACT) > 0) {
76            echo "  - この定義は抽象 (abstract) です。\n";
77        }
78
79        // Reflection::IS_FINAL は、クラスがfinalであることを示す定数です。
80        if (($modifiers & Reflection::IS_FINAL) > 0) {
81            echo "  - この定義はfinalです。\n";
82        }
83
84        // Reflection::IS_INTERFACE は、これがインターフェースであることを示す定数です。
85        if (($modifiers & Reflection::IS_INTERFACE) > 0) {
86            echo "  - この定義はインターフェースです。\n";
87        }
88
89        // Reflection::IS_TRAIT は、これがトレイトであることを示す定数です。
90        if (($modifiers & Reflection::IS_TRAIT) > 0) {
91            echo "  - この定義はトレイトです。\n";
92        }
93
94        // 具象クラス（抽象でもfinalでもインターフェースでもトレイトでもない）の場合
95        if (!($modifiers & (Reflection::IS_ABSTRACT | Reflection::IS_FINAL | Reflection::IS_INTERFACE | Reflection::IS_TRAIT))) {
96            echo "  - この定義は通常の具象クラスです。\n";
97        }
98        echo "\n";
99
100    } catch (ReflectionException $e) {
101        // 指定されたクラスが存在しない場合など、リフレクションに失敗した場合のエラー処理
102        echo "  エラー: '{$className}' のリフレクションに失敗しました。詳細: {$e->getMessage()}\n\n";
103    }
104}
105
106// 定義した各クラス、インターフェース、トレイトの修飾子情報を表示
107displayClassModifiersInfo(MyConcreteClass::class);
108displayClassModifiersInfo(MyAbstractClass::class);
109displayClassModifiersInfo(MyFinalClass::class);
110displayClassModifiersInfo(MyInterface::class);
111displayClassModifiersInfo(MyTrait::class);
112
113// 存在しないクラスを試行し、エラーハンドリングの動作を確認
114displayClassModifiersInfo('NonExistentClass');
115
116?>

PHPのReflectionClass::getModifiersメソッドは、クラス、インターフェース、トレイトといった定義が、どのような「修飾子」（特性）を持っているかを、プログラムの実行中に動的に取得するために使われます。このメソッドは引数を必要としません。戻り値はint型の整数値で、これは複数の修飾子（例えば抽象クラスであるか、finalクラスであるか、インターフェースであるか、トレイトであるかといった情報）が結合された「ビットマスク」と呼ばれる形式です。

サンプルコードでは、まずReflectionClassのインスタンスを生成し、調べたいクラスやインターフェース、トレイトの情報を取得します。そのオブジェクトに対してgetModifiers()メソッドを呼び出すことで、その定義が持つ修飾子を示す整数値を受け取っています。この整数値と、Reflection::IS_ABSTRACTやReflection::IS_FINALといった定数をビット演算子（&）で比較することで、具体的にどのような修飾子が付与されているかを判別しています。これにより、プログラムが実行時にクラスなどの種類を動的に判断し、それに応じた処理を行うことが可能になります。

Copy
1<?php
2
3/**
4 * 抽象クラスの例。
5 * 'abstract' 修飾子を持ちます。
6 */
7abstract class AbstractExample
8{
9    public function hello(): string
10    {
11        return 'Hello from abstract class!';
12    }
13}
14
15/**
16 * 最終クラスの例。
17 * 'final' 修飾子を持ち、継承できません。
18 */
19final class FinalExample
20{
21    public function greet(): string
22    {
23        return 'Greetings from final class!';
24    }
25}
26
27/**
28 * 通常のクラスの例。
29 * 'abstract' や 'final' のような特殊な修飾子を持ちません。
30 */
31class SimpleExample
32{
33    public function welcome(): string
34    {
35        return 'Welcome from simple class!';
36    }
37}
38
39/**
40 * 指定されたクラスの修飾子をReflectionClass::getModifiers()を使って分析し、出力します。
41 *
42 * ReflectionClass::getModifiers()は、クラスの抽象性や最終性を示すビットマスクを整数値で返します。
43 * このビットマスクをReflectionClass::IS_ABSTRACTやReflectionClass::IS_FINALなどの定数と比較することで、
44 * 特定の修飾子が含まれているかを確認できます。
45 *
46 * @param string $className 分析するクラスの完全修飾名
47 */
48function analyzeClassModifiers(string $className): void
49{
50    try {
51        // ReflectionClassインスタンスを作成し、指定されたクラスをリフレクションする
52        $reflectionClass = new ReflectionClass($className);
53        
54        // getModifiers()メソッドを呼び出し、クラスの修飾子を示すビットマスクを取得
55        // 戻り値はint型で、複数の修飾子をビット単位で組み合わせた値です。
56        $modifiers = $reflectionClass->getModifiers();
57
58        echo "--- クラス: " . $className . " ---" . PHP_EOL;
59        echo "取得した修飾子ビットマスク (int): " . $modifiers . PHP_EOL;
60
61        // ビットマスクと定数を比較して、各修飾子の有無をチェックします。
62        // ReflectionClass::IS_ABSTRACT は、クラスが抽象クラスである場合にセットされるビットフラグです。
63        if (($modifiers & ReflectionClass::IS_ABSTRACT) === ReflectionClass::IS_ABSTRACT) {
64            echo "- 抽象クラス (abstract)" . PHP_EOL;
65        }
66
67        // ReflectionClass::IS_FINAL は、クラスが最終クラスである場合にセットされるビットフラグです。
68        if (($modifiers & ReflectionClass::IS_FINAL) === ReflectionClass::IS_FINAL) {
69            echo "- 最終クラス (final)" . PHP_EOL;
70        }
71
72        // その他の修飾子（例: readonly - PHP 8.2以降で導入）も同様にチェックできますが、
73        // PHP 8では通常、abstractとfinalが主なクラス修飾子です。
74        
75        // どの特殊な修飾子も検出されない場合
76        if ($modifiers === 0) {
77            echo "- 特殊な修飾子なし" . PHP_EOL;
78        }
79        echo PHP_EOL;
80
81    } catch (ReflectionException $e) {
82        // 指定されたクラスが見つからない場合に例外をキャッチ
83        echo "エラー: クラス '" . $className . "' が見つかりません。 " . $e->getMessage() . PHP_EOL;
84    }
85}
86
87// 定義した各クラスの修飾子を分析し、結果を出力
88analyzeClassModifiers(AbstractExample::class);
89analyzeClassModifiers(FinalExample::class);
90analyzeClassModifiers(SimpleExample::class);
91
92// 存在しないクラスを指定した場合の例
93analyzeClassModifiers('NonExistentClass');
94
95?>

ReflectionClass::getModifiersは、クラスがどのような特性を持つか（例えば、抽象クラスか、継承できない最終クラスかなど）を、プログラムの実行中に調べるためのメソッドです。このメソッドは引数を必要とせず、クラスの修飾子を表す整数値（int型）のビットマスクを返します。このビットマスクは、複数の修飾子情報がビット単位で結合された数値です。

サンプルコードでは、抽象クラス、最終クラス、そして通常のクラスという3種類のクラスを定義し、それぞれの修飾子をgetModifiersメソッドで分析しています。analyzeClassModifiers関数内で、指定されたクラス名を使ってReflectionClassのインスタンスを作成します。その後、getModifiersメソッドを呼び出すことで、そのクラスの修飾子を示すビットマスクを取得します。

取得したビットマスクは、ReflectionClass::IS_ABSTRACTやReflectionClass::IS_FINALといったPHPが用意する定数と比較することで、クラスが特定の修飾子を持つかどうかを判別できます。具体的には、ビットAND演算子（&）を用いて、ビットマスクの中に特定の修飾子を示すフラグが含まれているかを確認しています。例えば、AbstractExampleクラスが抽象クラスであることを、FinalExampleクラスが最終クラスであることを、この方法で正しく識別しています。存在しないクラスを指定した場合は、ReflectionExceptionが捕捉され、エラーメッセージが出力されます。この機能を使うことで、プログラムはクラスの定義情報を動的に把握し、それに応じた処理を行うことが可能になります。