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

Copy
1<?php
2
3/**
4 * サンプルクラス
5 * メソッドの存在チェックの対象となります。
6 */
7class MyExampleClass
8{
9    /**
10     * publicなメソッド
11     */
12    public function greet(): string
13    {
14        return "Hello from MyExampleClass!";
15    }
16
17    /**
18     * privateなメソッド
19     */
20    private function calculateSum(int $a, int $b): int
21    {
22        return $a + $b;
23    }
24}
25
26/**
27 * ReflectionClass::hasMethod() の使用例
28 *
29 * この関数は、指定されたクラスが特定の名前のメソッドを持っているかどうかを
30 * Reflection API を使って確認します。
31 * システムエンジニアを目指す初心者の方でも、クラスの内部構造を
32 * プログラムから動的に調べる方法を理解するのに役立ちます。
33 */
34function demonstrateHasMethod(): void
35{
36    // MyExampleClass の ReflectionClass オブジェクトを作成します。
37    // ReflectionClass は、クラスに関する情報（メソッド、プロパティなど）を
38    // 実行時に取得するためのクラスです。
39    $reflectionClass = new ReflectionClass(MyExampleClass::class);
40
41    echo "--- メソッドの存在チェック ---" . PHP_EOL . PHP_EOL;
42
43    // 存在する public メソッドのチェック
44    $methodName1 = 'greet';
45    if ($reflectionClass->hasMethod($methodName1)) {
46        echo "クラス '" . MyExampleClass::class . "' はメソッド '{$methodName1}' を持っています。" . PHP_EOL;
47    } else {
48        echo "クラス '" . MyExampleClass::class . "' はメソッド '{$methodName1}' を持っていません。" . PHP_EOL;
49    }
50
51    // 存在する private メソッドのチェック
52    // hasMethod はアクセス修飾子（public/private/protected）に関わらず、
53    // メソッドが存在するかどうかをチェックします。
54    $methodName2 = 'calculateSum';
55    if ($reflectionClass->hasMethod($methodName2)) {
56        echo "クラス '" . MyExampleClass::class . "' はメソッド '{$methodName2}' を持っています。" . PHP_EOL;
57    } else {
58        echo "クラス '" . MyExampleClass::class . "' はメソッド '{$methodName2}' を持っていません。" . PHP_EOL;
59    }
60
61    // 存在しないメソッドのチェック
62    $methodName3 = 'nonExistentMethod';
63    if ($reflectionClass->hasMethod($methodName3)) {
64        echo "クラス '" . MyExampleClass::class . "' はメソッド '{$methodName3}' を持っています。" . PHP_EOL;
65    } else {
66        echo "クラス '" . MyExampleClass::class . "' はメソッド '{$methodName3}' を持っていません。" . PHP_EOL;
67    }
68}
69
70// 関数を実行して結果を表示します
71demonstrateHasMethod();
72
73?>

PHPのReflectionClass::hasMethodは、実行中のプログラムから特定のクラスが指定された名前のメソッドを持っているかどうかを動的に確認するための機能です。これは、PHPのリフレクションAPIの一部として提供され、クラスの内部構造をプログラムから検査することを可能にします。

まず、対象となるクラスの情報を取得するためにReflectionClassオブジェクトを作成します。このオブジェクトのhasMethodメソッドに、チェックしたいメソッドの名前を文字列（string $name）として渡します。メソッドが存在すればtrueを、存在しなければfalseをブール値（bool）として返します。

このメソッドは、publicやprivateといったアクセス修飾子に関わらず、指定された名前のメソッドがクラスに定義されているかどうかの存在そのものを確認します。例えば、サンプルコードではpublicなgreetメソッドとprivateなcalculateSumメソッドの両方が存在することを確認し、存在しないnonExistentMethodに対してはfalseを返します。これにより、システムエンジニアを目指す初心者の方でも、実行時にクラスのメソッドの有無を調べ、それに基づいて処理を柔軟に制御する方法を理解できます。

Copy
1<?php
2
3/**
4 * MyClassというサンプルクラスを定義します。
5 * 複数の異なる可視性を持つメソッドを含んでいます。
6 */
7class MyClass
8{
9    /**
10     * 公開メソッド
11     */
12    public function publicMethod(): void
13    {
14        echo "This is a public method.\n";
15    }
16
17    /**
18     * 保護されたメソッド
19     */
20    protected function protectedMethod(): void
21    {
22        echo "This is a protected method.\n";
23    }
24
25    /**
26     * プライベートメソッド
27     */
28    private function privateMethod(): void
29    {
30        echo "This is a private method.\n";
31    }
32
33    /**
34     * 静的メソッド
35     */
36    public static function staticMethod(): void
37    {
38        echo "This is a static method.\n";
39    }
40}
41
42/**
43 * ReflectionClass を使用して、MyClass のリフレクションオブジェクトを作成します。
44 * これにより、実行時にクラスの構造（メソッド、プロパティなど）を調べることができます。
45 */
46$reflectionClass = new ReflectionClass(MyClass::class);
47
48echo "--- ReflectionClass::hasMethod の使用例 ---\n";
49
50/**
51 * hasMethod() を使用して、指定された名前のメソッドがクラスに存在するかどうかを確認します。
52 * 戻り値は `bool` (真偽値) です。
53 */
54
55// 存在するメソッドの確認
56$hasPublicMethod = $reflectionClass->hasMethod('publicMethod');
57echo "クラス 'MyClass' に 'publicMethod' が存在しますか？ " . ($hasPublicMethod ? "はい" : "いいえ") . "\n"; // 出力: はい
58
59$hasProtectedMethod = $reflectionClass->hasMethod('protectedMethod');
60echo "クラス 'MyClass' に 'protectedMethod' が存在しますか？ " . ($hasProtectedMethod ? "はい" : "いいえ") . "\n"; // 出力: はい
61
62$hasPrivateMethod = $reflectionClass->hasMethod('privateMethod');
63echo "クラス 'MyClass' に 'privateMethod' が存在しますか？ " . ($hasPrivateMethod ? "はい" : "いいえ") . "\n"; // 出力: はい
64
65$hasStaticMethod = $reflectionClass->hasMethod('staticMethod');
66echo "クラス 'MyClass' に 'staticMethod' が存在しますか？ " . ($hasStaticMethod ? "はい" : "いいえ") . "\n"; // 出力: はい
67
68// 存在しないメソッドの確認
69$hasNonExistentMethod = $reflectionClass->hasMethod('nonExistentMethod');
70echo "クラス 'MyClass' に 'nonExistentMethod' が存在しますか？ " . ($hasNonExistentMethod ? "はい" : "いいえ") . "\n"; // 出力: いいえ
71
72// メソッド名は大文字・小文字を区別します (case-sensitive)。
73$hasPublicMethodWithWrongCase = $reflectionClass->hasMethod('PublicMethod');
74echo "クラス 'MyClass' に 'PublicMethod' (大文字P) が存在しますか？ " . ($hasPublicMethodWithWrongCase ? "はい" : "いいえ") . "\n"; // 出力: いいえ
75
76echo "\n--- hasMethod の戻り値の型 --- \n";
77echo "hasPublicMethod の型: " . gettype($hasPublicMethod) . "\n";     // 出力: boolean
78echo "hasNonExistentMethod の型: " . gettype($hasNonExistentMethod) . "\n"; // 出力: boolean
79
80?>

PHPのReflectionClassは、プログラムが実行されている最中に、クラスの内部構造、例えばどんなメソッドやプロパティがあるか、といった情報を調べることができる機能です。このReflectionClassクラスのhasMethodメソッドは、指定した名前のメソッドがそのクラス内に存在するかどうかをチェックするために利用されます。

引数には、確認したいメソッドの名前を文字列で渡します。このメソッドは、指定された名前のメソッドがクラス内に見つかればtrue（真）を、見つからなければfalse（偽）を真偽値（bool）として返します。

サンプルコードでは、MyClassに定義されているpublicMethodやprivateMethodといったメソッド名をhasMethodに渡すと、それぞれtrueが返されます。これは、アクセス権（public, protected, private）や静的メソッド（static）の種類に関わらず、メソッドが存在することを示します。一方、存在しないnonExistentMethodを渡すとfalseが返されます。また、hasMethodはメソッド名の大文字・小文字を厳密に区別するため、publicMethodとPublicMethodは異なるものとして扱われる点にも注意が必要です。

このように、ReflectionClass::hasMethodを使うことで、プログラムは動的にクラスのメソッドの有無を判断し、より柔軟な処理を実装できるようになります。