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

Copy
1<?php
2
3/**
4 * `protected` 可視性のプロパティとメソッドを持つサンプルクラスです。
5 *
6 * `protected` メンバーは、定義されたクラス自身と、その子クラスからのみアクセス可能です。
7 * このクラスの外からは直接アクセスできません。
8 * これは「カプセル化」と「継承」の原則をサポートします。
9 */
10class MyClass
11{
12    public string $publicProperty = 'これはpublicなプロパティです。';
13    protected string $protectedProperty = 'これはprotectedなプロパティです。'; // protectedプロパティ
14    private string $privateProperty = 'これはprivateなプロパティです。';
15
16    /**
17     * protectedなメソッドの例。
18     * このメソッドはMyClass内またはMyClassを継承した子クラスからのみ呼び出せます。
19     * (キーワード「protected function」に関連する概念です)
20     */
21    protected function getProtectedInfo(): string
22    {
23        return 'Protectedメソッドが ' . $this->protectedProperty . ' を利用して情報を返しました。';
24    }
25
26    /**
27     * クラス内部からprotectedメソッドを呼び出すためのpublicメソッド。
28     */
29    public function accessProtectedInternally(): string
30    {
31        return $this->getProtectedInfo();
32    }
33}
34
35/**
36 * MyClassを継承する子クラス。
37 * 子クラスからは親クラスのprotectedメンバーにアクセスできます。
38 */
39class ChildClass extends MyClass
40{
41    /**
42     * 親クラスのprotectedプロパティとメソッドにアクセスする例。
43     */
44    public function accessParentProtectedMembers(): string
45    {
46        // 親クラスのprotectedプロパティにアクセス
47        $propertyAccess = "子クラスから親のprotectedプロパティにアクセス: " . $this->protectedProperty . PHP_EOL;
48        // 親クラスのprotectedメソッドにアクセス
49        $methodAccess = "子クラスから親のprotectedメソッドにアクセス: " . $this->getProtectedInfo();
50        return $propertyAccess . $methodAccess;
51    }
52}
53
54/**
55 * 指定されたクラスの`protected`なプロパティをリフレクションAPIを使って検査し表示する関数。
56 *
57 * `ReflectionProperty::IS_PROTECTED` 定数は、`ReflectionClass::getProperties()` メソッドの
58 * フィルターとして使用され、`protected` アクセス修飾子を持つプロパティのみを取得します。
59 * これは整数値です。
60 *
61 * (キーワード「php what is protected function」について: `protected`という可視性修飾子は
62 * プロパティにもメソッド(関数)にも適用されます。このサンプルは主にプロパティに焦点を当てますが、
63 * 概念はメソッドにも共通です。メソッドについては `ReflectionMethod::IS_PROTECTED` が存在します。)
64 *
65 * @param string $className 検査するクラスの完全修飾名
66 */
67function inspectProtectedProperties(string $className): void
68{
69    echo "--- クラス '{$className}' のprotectedプロパティを検査 ---" . PHP_EOL;
70
71    try {
72        $reflector = new ReflectionClass($className);
73
74        // ReflectionProperty::IS_PROTECTED 定数を使って、protectedプロパティのみを取得
75        // この定数は整数値であり、ReflectionClass::getProperties() メソッドのフィルターとして利用されます。
76        $protectedProperties = $reflector->getProperties(ReflectionProperty::IS_PROTECTED);
77
78        if (empty($protectedProperties)) {
79            echo "このクラスにはprotectedなプロパティは見つかりませんでした。" . PHP_EOL;
80        } else {
81            echo "発見された protected プロパティ:" . PHP_EOL;
82            foreach ($protectedProperties as $property) {
83                echo "- " . $property->getName() . PHP_EOL;
84            }
85        }
86    } catch (ReflectionException $e) {
87        echo "エラーが発生しました: " . $e->getMessage() . PHP_EOL;
88    }
89    echo PHP_EOL;
90}
91
92// --- サンプルコードの実行 ---
93
94// MyClassのprotectedプロパティを検査
95inspectProtectedProperties(MyClass::class);
96
97// ChildClassのprotectedプロパティを検査
98// 親クラスのprotectedプロパティは子クラスにも継承されているため、ここでも検出されます。
99inspectProtectedProperties(ChildClass::class);
100
101echo "--- protectedメンバーのアクセス例 ---" . PHP_EOL;
102
103$myObject = new MyClass();
104// protectedプロパティやメソッドはクラス外部から直接アクセスできません。
105// 以下の行を実行すると、致命的なエラー (Fatal error) が発生します。
106// 例: echo $myObject->protectedProperty;
107// 例: echo $myObject->getProtectedInfo();
108
109// クラス内部からのprotectedメソッドの呼び出しは可能です。
110echo "MyClass内部からのprotectedメソッドの呼び出し: " . $myObject->accessProtectedInternally() . PHP_EOL;
111
112$childObject = new ChildClass();
113// 子クラスからは親クラスのprotectedメンバーにアクセスできます。
114echo $childObject->accessParentProtectedMembers() . PHP_EOL;
115
116?>

ReflectionProperty::IS_PROTECTED は、PHPのリフレクションAPIで使用される定数です。この定数は、クラスのプロパティがprotectedアクセス修飾子を持つかどうかを識別するために利用されます。protectedなメンバー（プロパティやメソッド）は、定義されたクラス自身と、そのクラスを継承した子クラスからのみアクセス可能です。これにより、オブジェクト指向における「カプセル化」と「継承」の原則が守られ、クラス外部からの意図しない変更を防ぎつつ、子クラスには内部の実装を共有できます。

この定数自体は引数を取らず、整数値を返します。主にReflectionClass::getProperties()メソッドの引数として用いられ、クラスからprotectedなプロパティのみを効率的に取得するフィルターの役割を果たします。

サンプルコードでは、MyClassでprotectedプロパティとメソッドを定義し、ChildClassがそれを継承してアクセスできる様子を示しています。また、inspectProtectedProperties関数ではReflectionProperty::IS_PROTECTED定数を利用して、指定されたクラスからprotectedプロパティを抽出し、その名前を表示しています。これはprotectedプロパティの存在をプログラム的に確認する方法です。外部から直接protectedメンバーにアクセスできないことや、子クラスからのアクセス方法も具体的に示されており、protectedの概念とその検査方法が理解できます。