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

Copy
1<?php
2
3// 'protected' メソッドを持つクラスを定義します。
4// protected メソッドは、そのクラス自身と、そのクラスを継承した子クラスからのみアクセス可能です。
5// 外部からは直接呼び出すことはできません。
6class MyClass
7{
8    protected function myProtectedMethod(): string
9    {
10        return "これは protected メソッドです。";
11    }
12
13    public function callProtectedMethodInternally(): string
14    {
15        // 同じクラス内からは protected メソッドにアクセスできます。
16        return "クラス内から呼び出し: " . $this->myProtectedMethod();
17    }
18}
19
20class ChildClass extends MyClass
21{
22    public function callProtectedMethodFromChild(): string
23    {
24        // 子クラスからも protected メソッドにアクセスできます。
25        return "子クラスから呼び出し: " . $this->myProtectedMethod();
26    }
27}
28
29/**
30 * リフレクションを使ってメソッドの可視性を確認する関数。
31 * システムエンジニアを目指す初心者が、PHPのprotectedキーワードとリフレクションによるそのチェック方法を理解するのに役立ちます。
32 */
33function checkMethodProtectedVisibility(): void
34{
35    echo "--- protected メソッドの基本的な動作 ---" . PHP_EOL;
36    $myObject = new MyClass();
37    echo $myObject->callProtectedMethodInternally() . PHP_EOL; // クラス内からの呼び出しは可能
38
39    $childObject = new ChildClass();
40    echo $childObject->callProtectedMethodFromChild() . PHP_EOL; // 子クラスからの呼び出しも可能
41
42    // 以下の行はエラーになります (コメントアウトを外すと実行時エラー):
43    // echo $myObject->myProtectedMethod(); // protected メソッドは外部から直接アクセスできません
44
45    echo PHP_EOL . "--- リフレクションによる protected メソッドの確認 ---" . PHP_EOL;
46
47    // MyClass の 'myProtectedMethod' のリフレクションを取得します。
48    $reflectionMethod = new ReflectionMethod(MyClass::class, 'myProtectedMethod');
49
50    // メソッドの修飾子（public, protected, private, static, final など）を取得します。
51    // これは整数値であり、各修飾子が特定のビットフラグに対応しています。
52    $modifiers = $reflectionMethod->getModifiers();
53
54    // ReflectionEnumUnitCase::IS_PROTECTED は、protected 可視性を示す整数定数です。
55    // この定数は ReflectionMethod::IS_PROTECTED と同じ値を持ち、
56    // メソッドが protected であるかをチェックするビットマスクとして使用できます。
57    if (($modifiers & ReflectionEnumUnitCase::IS_PROTECTED) === ReflectionEnumUnitCase::IS_PROTECTED) {
58        echo "メソッド '" . $reflectionMethod->getName() . "' は protected です。" . PHP_EOL;
59    } else {
60        echo "メソッド '" . $reflectionMethod->getName() . "' は protected ではありません。" . PHP_EOL;
61    }
62
63    // 参考として、public メソッドをチェックしてみます。
64    $reflectionPublicMethod = new ReflectionMethod(MyClass::class, 'callProtectedMethodInternally');
65    $publicModifiers = $reflectionPublicMethod->getModifiers();
66    if (($publicModifiers & ReflectionEnumUnitCase::IS_PROTECTED) === ReflectionEnumUnitCase::IS_PROTECTED) {
67        echo "メソッド '" . $reflectionPublicMethod->getName() . "' は protected です。" . PHP_EOL;
68    } else {
69        echo "メソッド '" . $reflectionPublicMethod->getName() . "' は protected ではありません。" . PHP_EOL;
70    }
71}
72
73// 関数を実行して、protected メソッドの動作とリフレクションによる確認結果を表示します。
74checkMethodProtectedVisibility();

PHPのReflectionEnumUnitCase::IS_PROTECTED定数は、クラスのメソッドがprotected（保護された）アクセス権を持つかどうかをプログラムで確認するための整数定数です。protectedメソッドは、定義されたクラス自身と、そのクラスを継承した子クラスからのみアクセスが可能であり、外部からは直接呼び出すことはできません。

この定数自体は引数を取らず、int型の整数値を返します。この戻り値は、メソッドのアクセス修飾子を示すビットフラグの一つとして使われます。

サンプルコードでは、まずprotectedメソッドの基本的な動作として、クラス内や子クラスからの呼び出しは可能であること、しかし外部からの直接アクセスはエラーとなることを示します。

続いて、リフレクション機能を利用してメソッドの可視性を動的に確認する方法を提示します。ReflectionMethodクラスを使って特定のメソッド（例: myProtectedMethod）のリフレクション情報を取得し、getModifiers()メソッドでそのメソッドが持つ修飾子（public、protected、privateなど）を表す整数値を得ます。この整数値とReflectionEnumUnitCase::IS_PROTECTED定数をビット論理積（&）で比較することで、対象のメソッドがprotectedであるかをプログラムで正確に判定できる仕組みです。

これにより、PHPのオブジェクト指向におけるアクセス制御の概念と、それをリフレクションによって実行時に検証する高度なテクニックを学ぶことができます。