【PHP8.x】ReflectionEnumBackedCase::IS_PROTECTED定数の使い方

Copy
1<?php
2
3/**
4 * PHPにおける`protected`メソッドの動作と、リフレクションAPIを用いたその識別方法を示すサンプルコードです。
5 * `protected`はアクセス修飾子の一つで、メソッドやプロパティが定義されたクラス自身、
6 * およびその子孫クラス（継承したクラス）からのみアクセス可能であることを意味します。
7 * クラスの外部からは直接アクセスできません。
8 */
9
10/**
11 * 親クラスの例
12 */
13class BaseClass
14{
15    /**
16     * protectedなメソッドの例です。
17     * このメソッドはBaseClass自身と、BaseClassを継承するクラスからのみ呼び出すことができます。
18     */
19    protected function getProtectedMessage(): string
20    {
21        return "このメッセージはBaseClassのprotectedメソッドから来ています。";
22    }
23
24    /**
25     * publicなメソッドです。
26     * このメソッドを通じて、クラス内部からprotectedメソッドを安全に呼び出すことができます。
27     */
28    public function callProtectedMessageFromSelf(): string
29    {
30        return "BaseClass (public) -> " . $this->getProtectedMessage();
31    }
32}
33
34/**
35 * 子クラスの例
36 * BaseClassを継承しています。
37 */
38class DerivedClass extends BaseClass
39{
40    /**
41     * 子クラスから親クラスのprotectedメソッドを呼び出す例です。
42     * `protected`なメソッドは子クラスからアクセス可能です。
43     */
44    public function callProtectedMessageFromParent(): string
45    {
46        return "DerivedClass (public) -> 親クラスの " . $this->getProtectedMessage();
47    }
48}
49
50echo "--- 1. `protected`メソッドへのアクセス ---" . PHP_EOL;
51
52// 親クラスのインスタンスを作成
53$baseInstance = new BaseClass();
54echo $baseInstance->callProtectedMessageFromSelf() . PHP_EOL; // publicメソッド経由でprotectedメソッドを呼び出し
55
56// 子クラスのインスタンスを作成
57$derivedInstance = new DerivedClass();
58echo $derivedInstance->callProtectedMessageFromParent() . PHP_EOL; // 子クラスから親のprotectedメソッドを呼び出し
59
60// 注意: クラスの外部から直接`protected`メソッドを呼び出そうとするとエラーになります。
61// 例: $baseInstance->getProtectedMessage(); // Uncaught Error: Call to protected method BaseClass::getProtectedMessage()
62
63echo PHP_EOL . "--- 2. リフレクションAPIによる`protected`メソッドの識別 ---" . PHP_EOL;
64
65try {
66    // Reflection APIを使用して、BaseClassの`getProtectedMessage`メソッドの情報を取得します。
67    $reflectionMethod = new ReflectionMethod(BaseClass::class, 'getProtectedMessage');
68
69    echo "メソッド名: " . $reflectionMethod->getName() . PHP_EOL;
70
71    // `isProtected()`メソッドを使って、そのメソッドが`protected`であるかを確認します。
72    echo "このメソッドは`protected`ですか？ " . ($reflectionMethod->isProtected() ? "はい" : "いいえ") . PHP_EOL;
73
74    // 参考: `ReflectionMethod::IS_PROTECTED` 定数を使ったビットマスク比較
75    // これは`isProtected()`メソッドの内部で使われるメカニズムに似ています。
76    // `ReflectionMethod::getModifiers()`はアクセス修飾子のビットマスクを返します。
77    echo "メソッドの修飾子 (ビットマスク): " . $reflectionMethod->getModifiers() . PHP_EOL;
78    echo "`ReflectionMethod::IS_PROTECTED`定数の値: " . ReflectionMethod::IS_PROTECTED . PHP_EOL;
79    echo "修飾子と`IS_PROTECTED`を比較: " . (($reflectionMethod->getModifiers() & ReflectionMethod::IS_PROTECTED) ? "はい" : "いいえ") . PHP_EOL;
80
81} catch (ReflectionException $e) {
82    echo "エラーが発生しました: " . $e->getMessage() . PHP_EOL;
83}
84
85?>

このサンプルコードは、PHPにおけるprotectedアクセス修飾子の動作と、リフレクションAPIを使ったメソッドの識別方法を解説しています。protectedは、クラスのメソッドやプロパティが、そのクラス自身と、そのクラスを継承した子孫クラスからのみアクセス可能であることを示す修飾子です。クラスの外部から直接アクセスしようとするとエラーとなります。コードでは、親クラスで定義されたprotectedメソッドが、自身のpublicメソッド経由や、それを継承した子クラスのpublicメソッドからどのように呼び出されるかを示しています。

また、PHPのリフレクションAPIを用いることで、プログラムの実行中にクラスやメソッドの情報を動的に取得できます。ReflectionMethodクラスは、特定のメソッドに関する情報を提供し、そのisProtected()メソッドを呼び出すことで、対象のメソッドがprotectedであるかどうかを真偽値で確認できます。ReflectionMethod::IS_PROTECTED定数は引数も戻り値もありませんが、ReflectionMethod::getModifiers()が返すビットマスク値と組み合わせて比較することで、メソッドがprotectedであるかを判定する際に利用されるフラグの一つです。これにより、実行時にメソッドのアクセス権限をプログラム的に識別できることを示しています。