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

Copy
1<?php
2
3/**
4 * リフレクションの例として使用するサンプルクラス。
5 * さまざまなアクセス修飾子を持つメソッドを含みます。
6 */
7class MySampleClass
8{
9    /**
10     * public メソッドの例。
11     *
12     * @return void
13     */
14    public function publicMethod(): void
15    {
16        // 何らかの処理
17    }
18
19    /**
20     * protected メソッドの例。
21     *
22     * @return void
23     */
24    protected function protectedMethod(): void
25    {
26        // 何らかの処理
27    }
28
29    /**
30     * private メソッドの例。
31     *
32     * @return void
33     */
34    private function privateMethod(): void
35    {
36        // 何らかの処理
37    }
38
39    /**
40     * static メソッドの例。
41     *
42     * @return void
43     */
44    public static function staticMethod(): void
45    {
46        // 何らかの処理
47    }
48
49    /**
50     * final メソッドの例。
51     *
52     * @return void
53     */
54    final public function finalMethod(): void
55    {
56        // 何らかの処理
57    }
58}
59
60/**
61 * 指定されたクラスとメソッドの修飾子を取得し、表示します。
62 * ReflectionMethod::getModifiers() の使用例を示します。
63 *
64 * @param string $className クラス名
65 * @param string $methodName メソッド名
66 * @return void
67 */
68function displayMethodModifiers(string $className, string $methodName): void
69{
70    try {
71        // ReflectionMethod インスタンスを作成し、メソッドの情報を取得
72        $reflectionMethod = new ReflectionMethod($className, $methodName);
73
74        // getModifiers() を呼び出し、メソッドの修飾子をビットマスクとして取得
75        $modifiers = $reflectionMethod->getModifiers();
76
77        echo "クラス: {$className}, メソッド: {$methodName}\n";
78        echo "取得された修飾子 (ビットマスク): " . sprintf("0x%x", $modifiers) . "\n";
79        echo "認識された修飾子: ";
80
81        $detectedModifiers = [];
82
83        // 取得したビットマスクと ReflectionMethod::IS_* 定数を比較し、各修飾子を識別
84        if (($modifiers & ReflectionMethod::IS_PUBLIC) === ReflectionMethod::IS_PUBLIC) {
85            $detectedModifiers[] = 'public';
86        }
87        if (($modifiers & ReflectionMethod::IS_PROTECTED) === ReflectionMethod::IS_PROTECTED) {
88            $detectedModifiers[] = 'protected';
89        }
90        if (($modifiers & ReflectionMethod::IS_PRIVATE) === ReflectionMethod::IS_PRIVATE) {
91            $detectedModifiers[] = 'private';
92        }
93        if (($modifiers & ReflectionMethod::IS_STATIC) === ReflectionMethod::IS_STATIC) {
94            $detectedModifiers[] = 'static';
95        }
96        if (($modifiers & ReflectionMethod::IS_ABSTRACT) === ReflectionMethod::IS_ABSTRACT) {
97            $detectedModifiers[] = 'abstract';
98        }
99        if (($modifiers & ReflectionMethod::IS_FINAL) === ReflectionMethod::IS_FINAL) {
100            $detectedModifiers[] = 'final';
101        }
102
103        if (empty($detectedModifiers)) {
104            echo "なし\n";
105        } else {
106            echo implode(', ', $detectedModifiers) . "\n";
107        }
108        echo "----------------------------------------\n";
109
110    } catch (ReflectionException $e) {
111        // メソッドが見つからない場合などのエラーを捕捉
112        echo "エラー: クラス {$className} のメソッド {$methodName} をリフレクトできませんでした: " . $e->getMessage() . "\n";
113        echo "----------------------------------------\n";
114    }
115}
116
117// サンプルクラスの各メソッドについて修飾子を表示
118displayMethodModifiers(MySampleClass::class, 'publicMethod');
119displayMethodModifiers(MySampleClass::class, 'protectedMethod');
120displayMethodModifiers(MySampleClass::class, 'privateMethod');
121displayMethodModifiers(MySampleClass::class, 'staticMethod');
122displayMethodModifiers(MySampleClass::class, 'finalMethod');
123
124// 存在しないメソッドを指定してエラーハンドリングの動作を確認
125displayMethodModifiers(MySampleClass::class, 'nonExistentMethod');
126

PHPのReflectionMethod::getModifiersメソッドは、クラスのメソッドに関する情報をプログラムの実行中に動的に取得する「リフレクション」という機能の一部です。このメソッドは、引数を一切取らず、戻り値として整数型（int）の値を返します。この整数は、対象のメソッドに設定されているアクセス修飾子（public、protected、private）や、その他の特性（static、final、abstractなど）をまとめて表現する「ビットマスク」と呼ばれる特殊な形式です。

サンプルコードでは、まずMySampleClassというクラスが、さまざまなアクセス修飾子を持つメソッドを定義しています。displayMethodModifiers関数は、指定されたクラスとメソッド名を用いてReflectionMethodオブジェクトを生成します。その後、そのオブジェクトのgetModifiers()メソッドを呼び出すことで、対象メソッドの修飾子を表すビットマスクを取得しています。取得されたビットマスクは、ReflectionMethod::IS_PUBLICのようなPHPが定義する定数とビット単位の論理AND演算（&）を使って比較することで、どの修飾子が付与されているかを個別に判別し、その結果を表示しています。

この機能を使うことで、例えばフレームワークなどがクラスやメソッドの定義を解析し、その特性に応じて異なる動作をさせるといった、高度で柔軟な処理を実現できます。また、存在しないメソッドを指定した場合には、ReflectionExceptionが捕捉され、エラーが適切に処理される仕組みも示されています。

Copy
1<?php
2
3/**
4 * システム関連のユーティリティ関数をまとめるクラスの例。
5 * ReflectionMethod::getModifiers() のターゲットとして使用します。
6 */
7class SystemHelper
8{
9    /**
10     * 現在のプロセスのIDを取得します。
11     * これはPHPのgetpid()関数をラップしたものです。
12     *
13     * @return int プロセスID
14     */
15    public static function getProcessId(): int
16    {
17        return getpid();
18    }
19
20    /**
21     * プライベートなインスタンスメソッドの例。
22     *
23     * @return string
24     */
25    private function somePrivateMethod(): string
26    {
27        return "これはプライベートメソッドです。";
28    }
29
30    /**
31     * プロテクトされた抽象メソッドの例（このクラスでは実装されない）。
32     *
33     * @abstract
34     * @return void
35     */
36    // protected abstract function someAbstractMethod(); // このクラスを抽象クラスにする必要あり
37}
38
39/**
40 * ReflectionMethod を使用してメソッドの修飾子を取得する例。
41 * システムエンジニアを目指す初心者向けに、リフレクションの基本的な使い方を示します。
42 */
43
44// ReflectionMethod のインスタンスを作成
45// 対象となるクラス名とメソッド名を指定します。
46$reflectionMethodGetProcessId = new ReflectionMethod(SystemHelper::class, 'getProcessId');
47
48// getModifiers() を呼び出して、修飾子を表す整数値を取得
49$modifiersGetProcessId = $reflectionMethodGetProcessId->getModifiers();
50
51echo "メソッド名: " . $reflectionMethodGetProcessId->getName() . "\n";
52echo "修飾子の値 (getProcessId): " . $modifiersGetProcessId . " (整数値)\n";
53
54// 取得した整数値を Reflection クラスの静的メソッドと比較して、
55// どのような修飾子が付与されているかを確認します。
56if (Reflection::isPublic($modifiersGetProcessId)) {
57    echo " - Public メソッドです。\n";
58}
59if (Reflection::isStatic($modifiersGetProcessId)) {
60    echo " - Static メソッドです。\n";
61}
62if (Reflection::isAbstract($modifiersGetProcessId)) {
63    echo " - Abstract メソッドです。\n";
64}
65if (Reflection::isFinal($modifiersGetProcessId)) {
66    echo " - Final メソッドです。\n";
67}
68if (Reflection::isPrivate($modifiersGetProcessId)) {
69    echo " - Private メソッドです。\n";
70}
71if (Reflection::isProtected($modifiersGetProcessId)) {
72    echo " - Protected メソッドです。\n";
73}
74
75echo "\n----------------------------------------\n";
76
77// 別のメソッド (プライベートメソッド) に対しても試してみる
78$reflectionMethodPrivate = new ReflectionMethod(SystemHelper::class, 'somePrivateMethod');
79$modifiersPrivate = $reflectionMethodPrivate->getModifiers();
80
81echo "メソッド名: " . $reflectionMethodPrivate->getName() . "\n";
82echo "修飾子の値 (somePrivateMethod): " . $modifiersPrivate . " (整数値)\n";
83
84if (Reflection::isPublic($modifiersPrivate)) {
85    echo " - Public メソッドです。\n";
86}
87if (Reflection::isStatic($modifiersPrivate)) {
88    echo " - Static メソッドです。\n";
89}
90if (Reflection::isPrivate($modifiersPrivate)) {
91    echo " - Private メソッドです。\n";
92}
93if (Reflection::isProtected($modifiersPrivate)) {
94    echo " - Protected メソッドです。\n";
95}

PHPのReflectionMethod::getModifiersメソッドは、プログラムの実行中にクラスのメソッドが持つ「修飾子」に関する情報を動的に取得するための機能です。ここでいう修飾子とは、メソッドがpublic、private、static、abstractなどのどの属性を持っているかを示すものです。これは「リフレクション」と呼ばれる仕組みの一部で、クラスやメソッドの構造を検査する際に役立ちます。

このメソッドは引数を必要とせず、呼び出すと対象のメソッドに設定されている修飾子を表す整数値が返されます。例えば、サンプルコードにあるSystemHelperクラスのgetProcessIdメソッドはpublicかつstaticであるため、これらの属性を示す整数値が戻り値として得られます。

返された整数値は、そのままでは具体的な修飾子の種類を直接判別しにくい形式です。そのため、取得した整数値をReflection::isPublic()やReflection::isStatic()といった静的メソッドと組み合わせて利用します。これらのメソッドにgetModifiers()で得られた整数値を渡すことで、対象のメソッドがpublicであるか、staticであるかなどを個別に正確に判別することができます。somePrivateMethodのようにprivate修飾子を持つメソッドの場合も同様に、Reflection::isPrivate()でその属性を確認できます。