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

isProtectedメソッドは、指定されたプロパティがprotectedアクセス権を持っているかどうかを確認するメソッドです。このメソッドは、PHPのリフレクションAPIの一部であるReflectionPropertyクラスに属しています。リフレクションAPIは、プログラムが実行時に自身の構造（クラス、メソッド、プロパティなど）に関する情報を取得し、操作することを可能にする強力な機能です。

ReflectionPropertyクラスは、クラス内の特定のプロパティ（クラス変数）に関する詳細な情報を取得するために使用されます。その中でisProtectedメソッドを呼び出すことで、対象のプロパティがprotectedキーワードで定義されているかを判別できます。protectedアクセス権を持つプロパティは、それを宣言したクラス自身と、そのクラスを継承した子孫クラスからのみアクセスが許可されます。

このメソッドは、プロパティがprotectedアクセス権を持つ場合に真（true）を返し、それ以外の場合（publicやprivateの場合）には偽（false）を返します。したがって、プログラム実行中に動的にプロパティのアクセス修飾子を調査し、その情報に基づいて異なる処理を実行したい場合に非常に役立ちます。例えば、特定のフレームワークやライブラリを開発する際に、オブジェクトの内部構造を検査し、アクセス制限のあるプロパティに対してのみ特定の操作を行うようなシナリオで利用されます。

Copy
1<?php
2
3class MyExampleClass {
4    public $publicProperty;
5    protected $protectedProperty;
6    private $privateProperty;
7}
8
9// ReflectionProperty オブジェクトを、protected なプロパティに対して作成します。
10$reflectionProperty = new ReflectionProperty('MyExampleClass', 'protectedProperty');
11
12// isProtected() メソッドを呼び出し、プロパティが protected であるかを確認します。
13$isProtected = $reflectionProperty->isProtected();
14
15// 結果は bool 値（true または false）として得られます。
16var_dump($isProtected);
17
18// 参考：protected でないプロパティの場合
19$reflectionPropertyPublic = new ReflectionProperty('MyExampleClass', 'publicProperty');
20var_dump($reflectionPropertyPublic->isProtected());
21
22?>

引数なし

引数はありません

bool

このメソッドは、プロパティがprotectedとして宣言されている場合にtrueを返します。それ以外の場合はfalseを返します。