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

Copy
1<?php
2
3// インターフェースを定義します。このインターフェースを実装するクラスは、interfaceMethod() を提供する必要があります。
4interface MyInterface
5{
6    public function interfaceMethod(): void;
7}
8
9// 抽象クラスを定義します。このクラスを継承する具象クラスは、abstractMethod() を実装する必要があります。
10abstract class AbstractClass
11{
12    abstract public function abstractMethod(): void;
13    // これは抽象クラス内の具象メソッドです。
14    public function concreteMethodFromAbstract(): void {}
15}
16
17// 親クラスを定義します。
18class ParentClass
19{
20    // 親クラスのメソッド
21    public function parentMethod(): void {}
22}
23
24// MyClassはParentClassを継承し、AbstractClassの抽象メソッドを実装し、MyInterfaceを実装します。
25class MyClass extends ParentClass implements MyInterface
26{
27    // ParentClass::parentMethod をオーバーライド（上書き）します。
28    public function parentMethod(): void {}
29
30    // MyInterface::interfaceMethod を実装します。
31    public function interfaceMethod(): void {}
32
33    // AbstractClass::abstractMethod を実装します。
34    public function abstractMethod(): void {}
35
36    // MyClass自身で新しく定義されたメソッドです。
37    public function myOwnMethod(): void {}
38}
39
40/**
41 * ReflectionMethod::hasPrototype() の動作を示す関数です。
42 *
43 * hasPrototype() は、現在のメソッドが、親クラスやインターフェースから継承・実装された
44 * 「プロトタイプ」（原型）を持つかどうかを判定します。
45 * つまり、メソッドがオーバーライドされたものか、インターフェースや抽象クラスのメソッドを
46 * 実装したものである場合に true を返します。
47 */
48function demonstrateReflectionHasPrototype(): void
49{
50    // MyClass のリフレクション（実行時のクラス情報）を取得します。
51    $refClass = new ReflectionClass(MyClass::class);
52
53    echo "--- ReflectionMethod::hasPrototype() のデモンストレーション ---" . PHP_EOL . PHP_EOL;
54
55    // ケース1: 親クラスのメソッドをオーバーライドしたメソッド
56    $methodParent = $refClass->getMethod('parentMethod');
57    echo "メソッド: " . MyClass::class . "::" . $methodParent->getName() . PHP_EOL;
58    echo "  - hasPrototype(): " . ($methodParent->hasPrototype() ? 'true' : 'false') . PHP_EOL;
59    echo "  （親クラスのメソッドをオーバーライドしているので 'true' となります）" . PHP_EOL . PHP_EOL;
60
61    // ケース2: インターフェースのメソッドを実装したメソッド
62    $methodInterface = $refClass->getMethod('interfaceMethod');
63    echo "メソッド: " . MyClass::class . "::" . $methodInterface->getName() . PHP_EOL;
64    echo "  - hasPrototype(): " . ($methodInterface->hasPrototype() ? 'true' : 'false') . PHP_EOL;
65    echo "  （インターフェースのメソッドを実装しているので 'true' となります）" . PHP_EOL . PHP_EOL;
66
67    // ケース3: 抽象クラスの抽象メソッドを実装したメソッド
68    $methodAbstract = $refClass->getMethod('abstractMethod');
69    echo "メソッド: " . MyClass::class . "::" . $methodAbstract->getName() . PHP_EOL;
70    echo "  - hasPrototype(): " . ($methodAbstract->hasPrototype() ? 'true' : 'false') . PHP_EOL;
71    echo "  （抽象クラスの抽象メソッドを実装しているので 'true' となります）" . PHP_EOL . PHP_EOL;
72
73    // ケース4: そのクラスで新しく定義された、継承や実装とは無関係なメソッド
74    $methodOwn = $refClass->getMethod('myOwnMethod');
75    echo "メソッド: " . MyClass::class . "::" . $methodOwn->getName() . PHP_EOL;
76    echo "  - hasPrototype(): " . ($methodOwn->hasPrototype() ? 'true' : 'false') . PHP_EOL;
77    echo "  （このクラスで新しく定義されたメソッドなので 'false' となります）" . PHP_EOL . PHP_EOL;
78}
79
80// デモンストレーション関数を実行します。
81demonstrateReflectionHasPrototype();
82
83?>

PHPのReflectionMethod::hasPrototype()メソッドは、特定のクラスのメソッドが、親クラスのメソッドをオーバーライドしたものか、またはインターフェースや抽象クラスのメソッドを実装したものかどうかを判定するために使用されます。

このメソッドにおける「プロトタイプ」とは、そのメソッドが持つ「原型」となる定義のことです。つまり、親クラスで定義された同名のメソッドや、インターフェース・抽象クラスで宣言されたメソッドが、そのメソッドのプロトタイプに該当します。

hasPrototype()メソッドは引数を取らず、戻り値として真偽値（bool）を返します。現在のメソッドがプロトタイプを持つ場合、つまり親クラスのメソッドをオーバーライドしている、あるいはインターフェースや抽象クラスのメソッドを実装している場合にtrueを返します。逆に、そのクラスで完全に新しく定義されたメソッドであり、親クラスやインターフェースからの継承・実装関係がない場合にはfalseを返します。

サンプルコードでは、MyClassというクラスに様々な種類のメソッドを定義し、それぞれについてhasPrototype()の挙動を確認しています。parentMethod（親クラスをオーバーライド）、interfaceMethod（インターフェースを実装）、abstractMethod（抽象クラスの抽象メソッドを実装）の各メソッドではtrueが返され、myOwnMethod（MyClassで独自に定義）ではfalseが返されることが示されており、hasPrototype()がメソッドの継承・実装関係をどのように判断するかが具体的に理解できます。

Copy
1<?php
2
3/**
4 * ReflectionMethod::hasPrototype() の使用例を示す関数
5 *
6 * この関数は、指定されたクラスとメソッドが「プロトタイプ」を持っているか
7 * どうかを判定します。プロトタイプを持つとは、そのメソッドが
8 * 親クラスのメソッドをオーバーライドしているか、
9 * あるいはインターフェースのメソッドを実装している場合に該当します。
10 *
11 * @param string $className  チェック対象のクラス名
12 * @param string $methodName チェック対象のメソッド名
13 * @return void
14 */
15function demonstrateHasPrototype(string $className, string $methodName): void
16{
17    try {
18        // ReflectionMethod オブジェクトを作成し、特定のメソッドを反映 (リフレクション) させます。
19        $reflectionMethod = new ReflectionMethod($className, $methodName);
20
21        // hasPrototype() メソッドを呼び出し、プロトタイプを持つか確認します。
22        $hasPrototype = $reflectionMethod->hasPrototype();
23
24        echo "クラス: {$className}, メソッド: {$methodName}\n";
25        echo "  -> hasPrototype(): " . ($hasPrototype ? 'true' : 'false') . "\n";
26
27        if ($hasPrototype) {
28            echo "  (このメソッドは、親クラスやインターフェースで定義されたメソッドを\n";
29            echo "   オーバーライドまたは実装しているため、プロトタイプを持ちます。)\n";
30        } else {
31            echo "  (このメソッドは、このクラスで独自に定義されており、\n";
32            echo "   親クラスやインターフェースとは関係なく新しいメソッドとして存在します。)\n";
33        }
34        echo "---------------------------------------------------------\n";
35
36    } catch (ReflectionException $e) {
37        // メソッドが見つからないなどのエラーが発生した場合に捕捉します。
38        echo "エラー: {$e->getMessage()}\n";
39    }
40}
41
42// --- hasPrototype() の動作を確認するためのクラス定義 ---
43
44// 親クラス: 基本的なアクションを定義します。
45class BaseAction
46{
47    public function doAction(): string
48    {
49        return "基本のアクション";
50    }
51}
52
53// 子クラス: 親クラスを継承し、メソッドをオーバーライドし、新しいメソッドも追加します。
54class SpecificAction extends BaseAction
55{
56    // doAction は親クラスの doAction をオーバーライドしています。
57    public function doAction(): string
58    {
59        return "特定のアクション (オーバーライド)";
60    }
61
62    // newSpecificAction はこのクラスで初めて定義される独自のメソッドです。
63    public function newSpecificAction(): string
64    {
65        return "新しい特定のアクション";
66    }
67}
68
69// インターフェース: 契約としてメソッドを定義します。
70interface Greeter
71{
72    public function greet(string $name): string;
73}
74
75// インターフェースを実装するクラス: インターフェースのメソッドを具体化します。
76class MyGreeter implements Greeter
77{
78    // greet は Greeter インターフェースの greet を実装しています。
79    public function greet(string $name): string
80    {
81        return "こんにちは、{$name}さん！";
82    }
83}
84
85// --- サンプル実行 ---
86
87echo "--- ReflectionMethod::hasPrototype() のサンプル実行 ---\n\n";
88
89// 例1: 親クラスのメソッドをオーバーライドしているメソッドの場合
90// SpecificAction::doAction() は BaseAction::doAction() をオーバーライドしているので、プロトタイプを持ちます。
91demonstrateHasPrototype(SpecificAction::class, 'doAction');
92
93// 例2: そのクラスで初めて定義された独自のメソッドの場合
94// SpecificAction::newSpecificAction() は BaseAction には存在しないため、プロトタイプを持ちません。
95demonstrateHasPrototype(SpecificAction::class, 'newSpecificAction');
96
97// 例3: インターフェースのメソッドを実装しているメソッドの場合
98// MyGreeter::greet() は Greeter::greet() を実装しているので、プロトタイプを持ちます。
99demonstrateHasPrototype(MyGreeter::class, 'greet');
100
101?>

ReflectionMethod::hasPrototype() は、PHPプログラムの実行中にクラスやメソッドの情報を動的に調べる「リフレクション」機能の一部です。このメソッドは、特定のクラスに存在するメソッドが「プロトタイプ」を持っているかどうかを真偽値（bool）で判定します。

プロトタイプを持つメソッドとは、そのメソッドが親クラスで定義された同名のメソッドを「オーバーライド」している場合、またはインターフェースで定義されたメソッドを「実装」している場合を指します。つまり、このメソッドは、既存の定義を継承または実現している、という起源を持ちます。

一方、hasPrototype() が false を返す場合、そのメソッドは現在のクラスで初めて独自に定義されたものであり、親クラスやインターフェースから継承・実装されたものではないことを示します。

このメソッドは引数を一切取りません。戻り値は true または false のブール値で、プロトタイプを持つ場合は true、持たない場合は false を返します。サンプルコードでは、親クラスのメソッドをオーバーライドした場合、インターフェースのメソッドを実装した場合、そしてそのクラスで独自に定義されたメソッドの場合について、それぞれの hasPrototype() の結果を示しており、メソッドの成り立ちを動的に判別する際に役立ちます。