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

Copy
1<?php
2
3class MySampleClass
4{
5    /**
6     * 公開メソッドの例。どこからでもアクセス可能です。
7     */
8    public function publicMethod(): string
9    {
10        return "これはpublicメソッドです。";
11    }
12
13    /**
14     * protectedメソッドの例。
15     * このクラス自身、またはこのクラスを継承した子クラスからのみアクセス可能です。
16     */
17    protected function protectedMethod(): string
18    {
19        return "これはprotectedメソッドです。";
20    }
21
22    /**
23     * privateメソッドの例。
24     * このクラスの内部からのみアクセス可能です。
25     */
26    private function privateMethod(): string
27    {
28        return "これはprivateメソッドです。";
29    }
30}
31
32/**
33 * ReflectionMethod::IS_PROTECTED を使って、メソッドが protected であるかを判定する例。
34 *
35 * Reflection API を使うと、実行時にクラスやメソッドの情報を取得・操作できます。
36 */
37
38// ReflectionMethod クラスを使って、各メソッドの情報を取得します。
39$reflectionPublicMethod = new ReflectionMethod(MySampleClass::class, 'publicMethod');
40$reflectionProtectedMethod = new ReflectionMethod(MySampleClass::class, 'protectedMethod');
41$reflectionPrivateMethod = new ReflectionMethod(MySampleClass::class, 'privateMethod');
42
43echo "--- メソッドのアクセス修飾子を判定します ---\n";
44
45// publicMethod が protected かどうかを判定します。
46// ReflectionMethod::getModifiers() は、修飾子を示すビットフラグの整数値を返します。
47// IS_PROTECTED とビットAND演算子 (&) を使って、protected フラグが立っているかを確認します。
48if (($reflectionPublicMethod->getModifiers() & ReflectionMethod::IS_PROTECTED) === ReflectionMethod::IS_PROTECTED) {
49    echo "Method 'publicMethod' は protected です。\n";
50} else {
51    echo "Method 'publicMethod' は protected ではありません。\n";
52}
53
54// protectedMethod が protected かどうかを判定します。
55if (($reflectionProtectedMethod->getModifiers() & ReflectionMethod::IS_PROTECTED) === ReflectionMethod::IS_PROTECTED) {
56    echo "Method 'protectedMethod' は protected です。\n";
57} else {
58    echo "Method 'protectedMethod' は protected ではありません。\n";
59}
60
61// privateMethod が protected かどうかを判定します。
62if (($reflectionPrivateMethod->getModifiers() & ReflectionMethod::IS_PROTECTED) === ReflectionMethod::IS_PROTECTED) {
63    echo "Method 'privateMethod' は protected です。\n";
64} else {
65    echo "Method 'privateMethod' は protected ではありません。\n";
66}
67
68?>

PHP 8のReflectionMethod::IS_PROTECTEDは、あるメソッドがprotected（保護された）アクセス修飾子を持っているかを判定するために用いられる定数です。この定数自体に引数はなく、protected修飾子を示す特定のビットフラグ値をint型で返します。protectedメソッドとは、そのメソッドが定義されたクラス自身、またはそのクラスを継承した子クラスからのみアクセスが許可されるメソッドを指します。

サンプルコードでは、MySampleClassにpublic、protected、privateの異なるアクセス修飾子を持つメソッドが定義されています。ReflectionMethodクラスは、プログラムの実行中にクラスやメソッドに関する詳細な情報を動的に取得できる「リフレクションAPI」と呼ばれる機能の一部です。

各メソッドに対してReflectionMethodのインスタンスを作成した後、そのインスタンスのgetModifiers()メソッドを呼び出すことで、メソッドのアクセス修飾子を含むビットフラグの整数値を取得できます。この整数値とReflectionMethod::IS_PROTECTED定数をビットAND演算子(&)を使って比較することで、そのメソッドがprotectedであるかどうかを正確に判定することが可能です。この仕組みにより、実行時にメソッドのアクセスレベルを動的に確認し、プログラムの柔軟な制御を実現できます。