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

Copy
1<?php
2
3/**
4 * isProtected() メソッドの動作を確認するためのサンプルクラス。
5 */
6class ExampleClass
7{
8    /**
9     * public アクセス修飾子を持つメソッド。
10     */
11    public function publicMethod(): void
12    {
13        // このメソッドはどこからでもアクセス可能です。
14    }
15
16    /**
17     * protected アクセス修飾子を持つメソッド。
18     */
19    protected function protectedMethod(): void
20    {
21        // このメソッドはクラス自身、またはその子クラスからのみアクセス可能です。
22    }
23
24    /**
25     * private アクセス修飾子を持つメソッド。
26     */
27    private function privateMethod(): void
28    {
29        // このメソッドはクラス自身からのみアクセス可能です。
30    }
31}
32
33// ReflectionClass を使って ExampleClass のリフレクション情報を取得します。
34$reflectionClass = new ReflectionClass(ExampleClass::class);
35
36// 各メソッドの protected 状態を確認し、結果を出力します。
37
38// publicMethod の ReflectionMethod インスタンスを取得
39$publicMethod = $reflectionClass->getMethod('publicMethod');
40echo "Method '{$publicMethod->getName()}' is protected: " . ($publicMethod->isProtected() ? 'Yes' : 'No') . PHP_EOL;
41
42// protectedMethod の ReflectionMethod インスタンスを取得
43$protectedMethod = $reflectionClass->getMethod('protectedMethod');
44echo "Method '{$protectedMethod->getName()}' is protected: " . ($protectedMethod->isProtected() ? 'Yes' : 'No') . PHP_EOL;
45
46// privateMethod の ReflectionMethod インスタンスを取得
47$privateMethod = $reflectionClass->getMethod('privateMethod');
48echo "Method '{$privateMethod->getName()}' is protected: " . ($privateMethod->isProtected() ? 'Yes' : 'No') . PHP_EOL;
49
50?>

PHP 8のReflectionMethod::isProtected()メソッドは、指定されたクラスメソッドがprotectedアクセス修飾子を持っているかどうかをプログラムから確認するために使用されます。ここでいうprotectedとは、そのメソッドが定義されたクラス自身、またはそのクラスを継承した子クラスからのみアクセス可能であることを意味します。

このメソッドは引数を一切取りません。戻り値はブール型で、対象のメソッドがprotectedであればtrueを、そうでなければfalseを返します。例えば、publicやprivate修飾子を持つメソッドに対してはfalseが返されます。

サンプルコードでは、public、protected、privateという異なるアクセス修飾子を持つメソッドを定義したExampleClassを用意し、それぞれのメソッドに対してisProtected()の動作を検証しています。ReflectionClassを使ってクラス情報を取得した後、各メソッドのReflectionMethodインスタンスを生成し、isProtected()を呼び出しています。その結果、実際にprotected修飾子を持つprotectedMethodに対してのみtrueが、publicMethodとprivateMethodに対してはfalseが正しく出力されることが確認できます。これにより、PHPでクラスメソッドのアクセスレベルを動的に検査する具体的な方法を学ぶことができます。

Copy
1<?php
2
3// システムエンジニアを目指す初心者向けに、
4// PHPのReflectionMethod::isProtected() メソッドの使用例を示します。
5// このメソッドは、指定されたメソッドが protected (保護された) であるかどうかを判定します。
6
7/**
8 * 様々なアクセス修飾子を持つメソッドを含むクラスの例です。
9 */
10class ExampleClass
11{
12    /**
13     * これは公開 (public) メソッドです。
14     */
15    public function publicMethod()
16    {
17        // このメソッドはどこからでもアクセス可能です。
18    }
19
20    /**
21     * これは保護 (protected) されたメソッドです。
22     */
23    protected function protectedMethod()
24    {
25        // このメソッドは、クラス自身およびその子クラスからのみアクセス可能です。
26    }
27
28    /**
29     * これはプライベート (private) メソッドです。
30     */
31    private function privateMethod()
32    {
33        // このメソッドは、クラス自身からのみアクセス可能です。
34    }
35}
36
37// ReflectionMethod::isProtected() を使って、各メソッドのアクセス修飾子を調べます。
38
39echo "--- ReflectionMethod::isProtected() の使用例 ---\n\n";
40
41// publicMethod のリフレクションオブジェクトを作成
42$reflectionPublic = new ReflectionMethod('ExampleClass', 'publicMethod');
43// publicMethod が protected かどうかを判定し、結果を出力
44echo "メソッド 'publicMethod' は protected ですか？: " . ($reflectionPublic->isProtected() ? 'はい' : 'いいえ') . "\n";
45
46// protectedMethod のリフレクションオブジェクトを作成
47$reflectionProtected = new ReflectionMethod('ExampleClass', 'protectedMethod');
48// protectedMethod が protected かどうかを判定し、結果を出力
49echo "メソッド 'protectedMethod' は protected ですか？: " . ($reflectionProtected->isProtected() ? 'はい' : 'いいえ') . "\n";
50
51// privateMethod のリフレクションオブジェクトを作成
52$reflectionPrivate = new ReflectionMethod('ExampleClass', 'privateMethod');
53// privateMethod が protected かどうかを判定し、結果を出力
54echo "メソッド 'privateMethod' は protected ですか？: " . ($reflectionPrivate->isProtected() ? 'はい' : 'いいえ') . "\n";
55
56echo "\n------------------------------------------------\n";
57
58?>

PHPのReflectionMethod::isProtected()は、メソッドが「保護された (protected)」アクセス修飾子を持つか判定します。これは、プログラム実行中にクラスやメソッドの情報を調べるリフレクション機能の一部です。

protectedメソッドは、定義クラス自身やその子クラスからのみアクセス可能で、外部からの直接呼び出しはできません。

引数はなく、対象がprotectedならtrue、そうでなければfalseをbool値で返します。

サンプルコードでは、ExampleClassのpublic、protected、privateメソッドについてReflectionMethodオブジェクトを作成し、isProtected()で判定結果を出力します。protectedMethodのみ「はい」と表示され、他は「いいえ」となることで、本メソッドがprotectedメソッドを正確に識別することを示します。実行時にメソッドのアクセス権限を動的に確認する際に役立ちます。