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

Copy
1<?php
2
3/**
4 * リフレクションAPIを使ってメソッドが宣言されているクラスを特定するサンプルコード。
5 */
6class MyClass
7{
8    /**
9     * このメソッドは MyClass 内で宣言されています。
10     */
11    public function myMethod(): void
12    {
13        // メソッドの本体
14    }
15}
16
17// MyClass の 'myMethod' に対する ReflectionMethod オブジェクトを作成します。
18$reflectionMethod = new ReflectionMethod(MyClass::class, 'myMethod');
19
20// getDeclaringClass() を使用して、メソッドが宣言されているクラスの ReflectionClass オブジェクトを取得します。
21$declaringClass = $reflectionMethod->getDeclaringClass();
22
23// 取得した ReflectionClass オブジェクトから、宣言元のクラス名を表示します。
24echo "メソッド '" . $reflectionMethod->getName() . "' は、クラス '" . $declaringClass->getName() . "' で宣言されています。\n";
25
26?>

PHPのリフレクションAPIは、プログラムの構造や振る舞いを実行時に動的に調べたり操作したりするための高度な機能です。ReflectionMethod::getDeclaringClass()メソッドは、ある特定のメソッドがどのクラスで実際に定義されたのか（宣言されたのか）を特定するために利用されます。

このサンプルコードでは、MyClassというクラスとその中のmyMethodを定義しています。まず、このmyMethodについての詳細な情報を得るために、ReflectionMethodクラスのインスタンスを作成します。これは、MyClass::classとメソッド名'myMethod'を引数に指定して行われます。

作成された$reflectionMethodオブジェクトに対して、getDeclaringClass()メソッドを呼び出します。このメソッドは引数を一切取りません。そして、myMethodが最初に宣言されたクラスの情報を持つReflectionClassオブジェクトを戻り値として返します。これにより、メソッドが継承によって別のクラスで利用されている場合でも、そのオリジナルの宣言元クラスを正確に知ることができます。

最終的に、取得したReflectionClassオブジェクトのgetName()メソッドを使って、宣言元のクラス名を表示しています。この例では、myMethodはMyClass内で定義されているため、「メソッド 'myMethod' は、クラス 'MyClass' で宣言されています。」という結果が出力されます。この機能は、特に大規模なシステムでクラスの継承関係を動的に解析する際に非常に有用です。

Copy
1<?php
2
3// 親クラスを定義
4class ParentClass
5{
6    public function commonMethod(): string
7    {
8        return "This is a method from ParentClass.";
9    }
10
11    public function parentOnlyMethod(): string
12    {
13        return "This is a method only in ParentClass.";
14    }
15}
16
17// 子クラスを定義し、ParentClassを継承
18class ChildClass extends ParentClass
19{
20    public function commonMethod(): string
21    {
22        return "This is an overridden method from ChildClass.";
23    }
24
25    public function childOnlyMethod(): string
26    {
27        return "This is a method only in ChildClass.";
28    }
29}
30
31/**
32 * 指定されたクラスのメソッドの宣言元クラス情報を取得し、表示する関数
33 *
34 * @param string $className クラス名
35 * @param string $methodName メソッド名
36 */
37function demonstrateDeclaringClass(string $className, string $methodName): void
38{
39    echo "Processing class: {$className}, method: {$methodName}\n";
40
41    try {
42        // ReflectionMethodオブジェクトを作成
43        // 指定されたクラスとメソッドに関するリフレクション情報を提供します。
44        $reflectionMethod = new ReflectionMethod($className, $methodName);
45
46        // getDeclaringClass() を使用して、メソッドが実際に宣言されたクラスのReflectionClassオブジェクトを取得
47        // このメソッドは、継承されたメソッドの場合、元の宣言クラスを返します。
48        $declaringClass = $reflectionMethod->getDeclaringClass();
49
50        // 宣言元クラスの名前を表示 (ReflectionClass::getName()を使用)
51        // ReflectionClass::getName() は、ReflectionClassオブジェクトが表すクラスの名前を取得する推奨される方法です。
52        echo "  Method '{$methodName}' is declared in: " . $declaringClass->getName() . "\n\n";
53
54    } catch (ReflectionException $e) {
55        // メソッドが存在しない場合などのエラーを捕捉
56        echo "  Error: " . $e->getMessage() . "\n\n";
57    }
58}
59
60// サンプルコードの実行
61
62// ChildClassでオーバーライドされたcommonMethodの宣言元クラスを確認
63// (commonMethodはParentClassで宣言され、ChildClassでオーバーライドされていますが、
64// getDeclaringClass()はParentClassを返します)
65demonstrateDeclaringClass(ChildClass::class, 'commonMethod');
66
67// ChildClassで定義されたchildOnlyMethodの宣言元クラスを確認
68// (childOnlyMethodはChildClass自身で宣言されています)
69demonstrateDeclaringClass(ChildClass::class, 'childOnlyMethod');
70
71// 親クラスから継承されたparentOnlyMethodの宣言元クラスを確認
72// (parentOnlyMethodはParentClassで宣言されています)
73demonstrateDeclaringClass(ChildClass::class, 'parentOnlyMethod');
74
75// ParentClass自身のparentOnlyMethodの宣言元クラスを確認
76// (ParentClassは自身のparentOnlyMethodを宣言しています)
77demonstrateDeclaringClass(ParentClass::class, 'parentOnlyMethod');
78
79// 存在しないメソッドの例 (ReflectionException がスローされます)
80demonstrateDeclaringClass(ChildClass::class, 'nonExistentMethod');
81

このサンプルコードは、PHPのReflectionMethod::getDeclaringClass()メソッドの機能と使い方を、システムエンジニアを目指す初心者の方にも分かりやすく説明しています。このメソッドは、指定されたクラスのメソッドが「実際に」どのクラスで宣言されたかを調べる際に使用します。引数はなく、戻り値として宣言元クラスを表すReflectionClassオブジェクトを返します。

特にクラスの継承やメソッドのオーバーライドが行われている場合に有用で、子クラスから呼び出せるメソッドであっても、最初にそのメソッドが定義された親クラスの情報を正確に取得できます。

サンプルコードでは、ParentClassとそれを継承するChildClassを定義し、メソッドの継承やオーバーライドの状況を設定しています。demonstrateDeclaringClass関数は、指定されたクラスとメソッド名を受け取り、ReflectionMethodオブジェクトを通してgetDeclaringClass()を実行します。その結果、ReflectionClass::getName()を用いて、メソッドが定義されたオリジナルのクラス名を表示します。これにより、オーバーライドされたcommonMethodがParentClassで宣言されていることや、childOnlyMethodがChildClass自身で宣言されていることなどが確認できます。存在しないメソッドが指定された場合には、ReflectionExceptionが捕捉され、適切なエラーメッセージが表示されるようになっています。