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

Copy
1<?php
2
3/**
4 * 親クラスの例。
5 */
6class ParentClass
7{
8    // 親クラス独自のプロパティやメソッドがあってもよい
9}
10
11/**
12 * 親クラスを継承する子クラスの例。
13 */
14class ChildClass extends ParentClass
15{
16    // 子クラス独自のプロパティやメソッド
17}
18
19/**
20 * 親クラスを持たないクラスの例。
21 */
22class StandaloneClass
23{
24    // 親クラスを持たないクラス
25}
26
27/**
28 * 指定されたオブジェクトの親クラス情報を取得し、表示します。
29 * ReflectionObject::getParentClass メソッドの使用例を示します。
30 *
31 * @param object $object 親クラス情報を調べたいオブジェクト
32 * @return void
33 */
34function displayParentClassInfo(object $object): void
35{
36    // オブジェクトのReflectionObjectインスタンスを作成します。
37    // これにより、オブジェクトとそのクラスに関する情報を取得できるようになります。
38    $reflectionObject = new ReflectionObject($object);
39
40    // オブジェクト自身のクラス名を表示します。
41    echo "オブジェクトのクラス名: " . $reflectionObject->getName() . "\n";
42
43    // getParentClassメソッドを呼び出し、親クラスのReflectionClassオブジェクトを取得します。
44    // 親クラスが存在しない場合、このメソッドは false を返します。
45    $parentReflectionClass = $reflectionObject->getParentClass();
46
47    if ($parentReflectionClass) {
48        // 親クラスが存在する場合、その名前を表示します。
49        echo "親クラス名: " . $parentReflectionClass->getName() . "\n";
50        // さらに、親クラスのReflectionClassオブジェクトから様々な情報を取得できます
51        // 例: echo "親クラスが抽象クラスか: " . ($parentReflectionClass->isAbstract() ? 'はい' : 'いいえ') . "\n";
52    } else {
53        // 親クラスが存在しない場合、その旨を表示します。
54        echo "親クラスは存在しません。\n";
55    }
56    echo "--------------------\n";
57}
58
59// ChildClass のインスタンスを作成し、親クラス情報を表示します。
60// ChildClass は ParentClass を継承しているので、ParentClass の情報が表示されます。
61echo "--- ChildClass の情報 ---\n";
62displayParentClassInfo(new ChildClass());
63
64// StandaloneClass のインスタンスを作成し、親クラス情報を表示します。
65// StandaloneClass はどのクラスも継承していないため、親クラスは存在しません。
66echo "--- StandaloneClass の情報 ---\n";
67displayParentClassInfo(new StandaloneClass());
68

PHPのReflectionObject::getParentClassメソッドは、あるオブジェクトが「どの親クラスを継承しているか」という情報を、プログラムの実行中に動的に取得するための機能です。ReflectionObjectは、PHPのリフレクションAPIの一部であり、オブジェクトやそのクラスに関する詳細な情報を調べることができます。

このgetParentClassメソッドは引数を必要としません。戻り値は、指定されたオブジェクトに親クラスが存在する場合、その親クラスの情報を保持するReflectionClassオブジェクトを返します。もし親クラスが存在しない場合は、falseを返します。

サンプルコードでは、ParentClassを継承するChildClassと、どのクラスも継承しないStandaloneClassの2つのクラスを定義しています。displayParentClassInfo関数内で、まずnew ReflectionObject($object)として、調査したいオブジェクトのリフレクション情報を取得します。その後、$reflectionObject->getParentClass()を呼び出します。

ChildClassのインスタンスに対してこのメソッドを呼び出すと、ParentClassのReflectionClassオブジェクトが返されるため、その親クラス名が表示されます。一方、StandaloneClassのインスタンスに対して呼び出すと、親クラスがないためfalseが返され、「親クラスは存在しません。」というメッセージが表示されます。このように、getParentClassメソッドを活用することで、オブジェクトの継承関係をプログラム上で判断し、柔軟な処理を行うことが可能になります。

Copy
1<?php
2
3/**
4 * 親クラスを定義します。
5 * このクラスは他のクラスの基盤となることができます。
6 */
7class MyParentClass
8{
9    public function getParentClassName(): string
10    {
11        return "MyParentClass";
12    }
13}
14
15/**
16 * 子クラスを定義します。
17 * MyParentClass を継承しており、親クラスの機能を引き継ぎます。
18 */
19class MyChildClass extends MyParentClass
20{
21    public function getChildClassName(): string
22    {
23        return "MyChildClass";
24    }
25}
26
27/**
28 * どのクラスも継承していない独立したクラスを定義します。
29 * このクラスには親クラスが存在しません。
30 */
31class MyStandaloneClass
32{
33    public function getStandaloneClassName(): string
34    {
35        return "MyStandaloneClass";
36    }
37}
38
39/**
40 * 指定されたオブジェクトの親クラス情報を取得し、表示する関数です。
41 * ReflectionObject::getParentClass() メソッドの使用例を示します。
42 *
43 * @param object $obj 親クラス情報を調べたいオブジェクト
44 */
45function displayParentClassInfo(object $obj): void
46{
47    // オブジェクトのReflectionObjectインスタンスを作成します。
48    // ReflectionObject は、実行時にクラスやオブジェクトに関する情報を取得するためのPHPの機能です。
49    $reflector = new ReflectionObject($obj);
50
51    echo "--- オブジェクト情報 ---\n";
52    echo "対象オブジェクトのクラス名: " . $reflector->getName() . "\n";
53
54    // getParentClass() メソッドを呼び出し、親クラスのReflectionClassを取得します。
55    // 親クラスが存在しない場合（例: MyStandaloneClass）、このメソッドは false を返します。
56    $parentClassReflection = $reflector->getParentClass();
57
58    if ($parentClassReflection) {
59        // 親クラスが見つかった場合、そのクラス名を表示します。
60        echo "親クラス名: " . $parentClassReflection->getName() . "\n";
61    } else {
62        // 親クラスが見つからなかった場合（どのクラスも継承していない場合）、その旨を表示します。
63        echo "このオブジェクト (" . $reflector->getName() . ") は親クラスを持ちません。\n";
64    }
65    echo "------------------------\n\n";
66}
67
68// --- 使用例 ---
69
70// 1. 親クラスを持つオブジェクト（MyChildClassのインスタンス）の例
71$childObject = new MyChildClass();
72displayParentClassInfo($childObject);
73
74// 2. 親クラスを持たないオブジェクト（MyStandaloneClassのインスタンス）の例
75$standaloneObject = new MyStandaloneClass();
76displayParentClassInfo($standaloneObject);
77

ReflectionObject::getParentClass()は、PHPの「Reflection」機能を使って、プログラムが実行されている最中に、あるオブジェクトが「どのクラスを継承しているか」という親クラスの情報を取得するためのメソッドです。

ReflectionObjectは、オブジェクトやクラスの構造を動的に調べることができるPHPの強力な機能の一部です。このメソッドはReflectionObjectインスタンスから呼び出され、特定のオブジェクトに関する情報を取得する際に利用されます。

引数は不要で、呼び出すだけで対象オブジェクトの親クラス情報を調べます。戻り値としては、もし対象のオブジェクトが親クラスを持つ場合、その親クラスに関する詳細な情報を持つReflectionClassオブジェクトが返されます。しかし、もし親クラスが存在しない場合（つまり、どのクラスも継承していない独立したクラスの場合）はfalseが返されます。

サンプルコードでは、MyChildClassがMyParentClassを継承しているため、displayParentClassInfo関数内でgetParentClass()を呼び出すと、MyParentClassのReflectionClassオブジェクトが返され、その名前が表示されます。一方、MyStandaloneClassはどのクラスも継承していないため、getParentClass()はfalseを返し、親クラスがないことが示されます。これにより、実行時にオブジェクトの継承関係を動的に確認できることがわかります。