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

Copy
1<?php
2
3/**
4 * MyParentClass を定義します。
5 * このクラスはどのクラスも継承していないため、親クラスを持ちません。
6 */
7class MyParentClass
8{
9    public function getType(): string
10    {
11        return "親クラス";
12    }
13}
14
15/**
16 * MyChildClass を定義します。
17 * MyParentClass を継承しているため、MyParentClass が親クラスになります。
18 */
19class MyChildClass extends MyParentClass
20{
21    public function getType(): string
22    {
23        return "子クラス";
24    }
25}
26
27/**
28 * ReflectionClass を使ってクラスの情報を調べます。
29 * ReflectionClass は、プログラムの実行中にクラスの構造（メソッド、プロパティ、親クラスなど）を
30 * 検査できるPHPの機能です。
31 */
32
33// --- MyChildClass の親クラスを調べる例 ---
34
35// MyChildClass の ReflectionClass オブジェクトを作成します。
36$reflectionChildClass = new ReflectionClass(MyChildClass::class);
37
38echo "「" . $reflectionChildClass->getName() . "」クラスの調査:\n";
39
40// getParentClass() メソッドは、対象クラスの親クラスの ReflectionClass オブジェクトを返します。
41// 親クラスが存在しない場合は false を返します。
42$parentOfChild = $reflectionChildClass->getParentClass();
43
44if ($parentOfChild) {
45    // 親クラスが存在する場合、その名前を表示します。
46    echo "  親クラスは「" . $parentOfChild->getName() . "」です。\n";
47} else {
48    // 親クラスが存在しない場合。
49    echo "  このクラスには親クラスがありません。\n";
50}
51echo "\n";
52
53// --- MyParentClass の親クラスを調べる例 ---
54
55// MyParentClass の ReflectionClass オブジェクトを作成します。
56$reflectionParentClass = new ReflectionClass(MyParentClass::class);
57
58echo "「" . $reflectionParentClass->getName() . "」クラスの調査:\n";
59
60// MyParentClass の親クラスを取得します。
61$parentOfParent = $reflectionParentClass->getParentClass();
62
63if ($parentOfParent) {
64    // 親クラスが存在する場合。
65    echo "  親クラスは「" . $parentOfParent->getName() . "」です。\n";
66} else {
67    // MyParentClass はどのクラスも継承していないため、親クラスはありません。
68    echo "  このクラスには親クラスがありません。\n";
69}
70
71?>

PHPのReflectionClass::getParentClass()メソッドは、プログラムの実行中にクラスの構造を調べることができる「リフレクション」という機能の一部です。このメソッドは、指定されたクラスがどのクラスを継承しているか、つまり親クラスが何かを調べるために使用されます。引数は必要ありません。

getParentClass()メソッドを実行すると、対象クラスの親クラスに関する情報を持つReflectionClassオブジェクトが戻り値として返されます。もし対象クラスがどのクラスも継承していない場合、親クラスは存在しないため、戻り値はfalseとなります。

サンプルコードでは、まずMyChildClassがMyParentClassを継承している例を示します。MyChildClassのReflectionClassオブジェクトからgetParentClass()を呼び出すと、親クラスであるMyParentClassのReflectionClassオブジェクトが返され、その名前を表示できます。次に、どのクラスも継承していないMyParentClassに対してgetParentClass()を呼び出す例を示します。この場合、親クラスが存在しないためfalseが返され、「親クラスがありません」と表示されることを確認できます。これにより、クラスの継承関係を動的に検査する方法を理解できます。

Copy
1<?php
2
3/**
4 * サンプル用の親クラスを定義します。
5 */
6class Animal
7{
8    public function run(): string
9    {
10        return "動物が走ります。";
11    }
12}
13
14/**
15 * サンプル用のDogクラス。Animalクラスを継承しています。
16 */
17class Dog extends Animal
18{
19    public function bark(): string
20    {
21        return "ワンワン！";
22    }
23}
24
25/**
26 * サンプル用のCarクラス。どのクラスも継承していません。
27 */
28class Car
29{
30    public function drive(): string
31    {
32        return "車を運転します。";
33    }
34}
35
36/**
37 * 指定されたクラスの親クラス情報を表示する関数です。
38 * getParentClassメソッドの使い方を示します。
39 *
40 * @param string $className 情報を取得したいクラスの名前
41 * @return void
42 */
43function showParentClassInfo(string $className): void
44{
45    echo "--- クラス: {$className} の親クラス情報 ---\n";
46
47    try {
48        // ReflectionClassオブジェクトを作成します。
49        // これにより、クラスの構造やメタデータ（情報）にプログラムからアクセスできるようになります。
50        $reflectionClass = new ReflectionClass($className);
51
52        // getParentClass()メソッドを呼び出します。
53        // このメソッドは、もし親クラスが存在すればそのReflectionClassオブジェクトを返し、
54        // 親クラスが存在しなければ false を返します。
55        $parentReflectionClass = $reflectionClass->getParentClass();
56
57        if ($parentReflectionClass) {
58            // 親クラスが存在する場合、その名前を表示します。
59            echo "親クラス名: " . $parentReflectionClass->getName() . "\n";
60            echo "親クラスが定義されているファイル: " . $parentReflectionClass->getFileName() . "\n";
61        } else {
62            // 親クラスが存在しない場合、その旨を表示します。
63            echo "このクラスには親クラスがありません。\n";
64        }
65    } catch (ReflectionException $e) {
66        // 指定されたクラス名が見つからない場合のエラーを処理します。
67        echo "エラー: クラス '{$className}' が見つかりません。(" . $e->getMessage() . ")\n";
68    }
69    echo "\n";
70}
71
72// 実際にいくつかのクラスで関数を呼び出し、動作を確認します。
73
74// Dogクラスの親クラス情報を表示します (Animalが表示されるはず)。
75showParentClassInfo('Dog');
76
77// Animalクラスの親クラス情報を表示します (親クラスがない旨が表示されるはず)。
78showParentClassInfo('Animal');
79
80// Carクラスの親クラス情報を表示します (親クラスがない旨が表示されるはず)。
81showParentClassInfo('Car');
82
83// 存在しないクラス名を指定した場合のエラー処理を確認します。
84showParentClassInfo('NonExistentClass');

PHPのReflectionClass::getParentClassメソッドは、指定されたクラスがどの親クラスを継承しているか、プログラムから動的に確認するために使用します。まず、調べたいクラスの名前を元にnew ReflectionClass($className)でReflectionClassオブジェクトを作成します。このオブジェクトは、クラスの構造やメタデータ（情報）にアクセスするための機能を提供します。

getParentClass()メソッドは引数を必要としません。戻り値としては、もし指定したクラスに親クラスが存在する場合、その親クラスを表すReflectionClassオブジェクトが返されます。このオブジェクトからは、親クラスの名前や定義ファイルなどの情報をさらに取得できます。もし指定したクラスがどのクラスも継承していない場合（つまり親クラスがない場合）は、falseが返されます。

サンプルコードでは、DogクラスがAnimalクラスを継承しているため、Dogに対してgetParentClass()を呼び出すとAnimalクラスのReflectionClassオブジェクトが返され、その名前が表示されます。AnimalクラスやCarクラスのように親クラスを持たない場合はfalseが返され、「親クラスがありません」と出力されます。このメソッドを使うことで、クラスの継承関係を柔軟に調べることが可能です。また、存在しないクラス名を指定した際には、ReflectionExceptionが捕捉され、適切なエラーメッセージが表示されます。