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

Copy
1<?php
2
3/**
4 * 親クラスを定義します。
5 */
6class Vehicle
7{
8    public function getWheels(): int
9    {
10        return 0;
11    }
12}
13
14/**
15 * Vehicleクラスを継承する子クラスを定義します。
16 */
17class Car extends Vehicle
18{
19    public function getWheels(): int
20    {
21        return 4;
22    }
23}
24
25/**
26 * Vehicleクラスを継承する別の子クラスを定義します。
27 */
28class Bicycle extends Vehicle
29{
30    public function getWheels(): int
31    {
32        return 2;
33    }
34}
35
36/**
37 * 継承関係のない独立したクラスを定義します。
38 */
39class House
40{
41    public function getRooms(): int
42    {
43        return 1;
44    }
45}
46
47/**
48 * ReflectionObject::isSubclassOf メソッドのデモンストレーション関数です。
49 *
50 * この関数は、あるオブジェクトが特定のクラスの子孫であるかを確認する方法を示します。
51 * システムエンジニア初心者向けに、具体的な例を用いて解説します。
52 */
53function demonstrateIsSubclassOf(): void
54{
55    // Carクラスのインスタンスを作成します
56    $myCar = new Car();
57    // Bicycleクラスのインスタンスを作成します
58    $myBicycle = new Bicycle();
59    // Vehicleクラスのインスタンスを作成します
60    $myVehicle = new Vehicle();
61    // Houseクラスのインスタンスを作成します
62    $myHouse = new House();
63
64    // ReflectionObjectを作成します。これにより、実行時にオブジェクトの情報を取得できます。
65    $carReflection = new ReflectionObject($myCar);
66    $bicycleReflection = new ReflectionObject($myBicycle);
67    $vehicleReflection = new ReflectionObject($myVehicle);
68    $houseReflection = new ReflectionObject($myHouse);
69
70    echo "--- isSubclassOf() の使用例 ---\n\n";
71
72    // 1. CarオブジェクトがVehicleクラスの子孫であるかチェック
73    echo "CarオブジェクトはVehicleクラスの子孫ですか？\n";
74    // isSubclassOfの引数にはクラス名を文字列で渡すことができます。
75    if ($carReflection->isSubclassOf('Vehicle')) {
76        echo "-> はい、CarはVehicleの子孫です。\n\n"; // 期待される結果
77    } else {
78        echo "-> いいえ、CarはVehicleの子孫ではありません。\n\n";
79    }
80
81    // 2. BicycleオブジェクトがVehicleクラスの子孫であるかチェック
82    echo "BicycleオブジェクトはVehicleクラスの子孫ですか？\n";
83    // isSubclassOfの引数にはReflectionClassオブジェクトも渡すことができます。
84    $vehicleClassReflection = new ReflectionClass('Vehicle');
85    if ($bicycleReflection->isSubclassOf($vehicleClassReflection)) {
86        echo "-> はい、BicycleはVehicleの子孫です。(ReflectionClassオブジェクトを使用)\n\n"; // 期待される結果
87    } else {
88        echo "-> いいえ、BicycleはVehicleの子孫ではありません。(ReflectionClassオブジェクトを使用)\n\n";
89    }
90
91    // 3. CarオブジェクトがBicycleクラスの子孫であるかチェック
92    echo "CarオブジェクトはBicycleクラスの子孫ですか？\n";
93    if ($carReflection->isSubclassOf('Bicycle')) {
94        echo "-> はい、CarはBicycleの子孫です。\n\n";
95    } else {
96        echo "-> いいえ、CarはBicycleの子孫ではありません。\n\n"; // 期待される結果
97    }
98
99    // 4. Vehicleオブジェクト自身がVehicleクラスの子孫であるかチェック
100    echo "VehicleオブジェクトはVehicleクラスの子孫ですか？\n";
101    // isSubclassOfは、自身を自身の子孫とはみなしません。
102    if ($vehicleReflection->isSubclassOf('Vehicle')) {
103        echo "-> はい、VehicleはVehicleの子孫です。\n\n";
104    } else {
105        echo "-> いいえ、VehicleはVehicleの子孫ではありません。(親クラスは自身の子孫ではないと判断されます)\n\n"; // 期待される結果
106    }
107
108    // 5. HouseオブジェクトがVehicleクラスの子孫であるかチェック
109    echo "HouseオブジェクトはVehicleクラスの子孫ですか？\n";
110    if ($houseReflection->isSubclassOf('Vehicle')) {
111        echo "-> はい、HouseはVehicleの子孫です。\n\n";
112    } else {
113        echo "-> いいえ、HouseはVehicleの子孫ではありません。(全く関係のないクラスです)\n\n"; // 期待される結果
114    }
115}
116
117// デモンストレーション関数を実行します。
118demonstrateIsSubclassOf();
119
120?>

ReflectionObject::isSubclassOfメソッドは、あるオブジェクトが特定のクラスの「子孫」（サブクラス）であるかどうかを、プログラムの実行中に動的に確認するために使用されます。これは、PHPのリフレクションAPIが提供する機能の一つで、クラスやオブジェクトの内部構造を調べることができます。

このメソッドは引数として、調べたいクラスの情報をReflectionClassオブジェクトとして渡すか、あるいはクラス名を文字列で指定することができます。そして、呼び出し元のReflectionObjectが表すクラスが、引数で指定されたクラスの直接的または間接的な子孫である場合にtrueを、そうでない場合にはfalseをブール値で返します。ただし、親クラス自身は自身の子孫とはみなされない点に注意が必要です。

サンプルコードでは、Vehicleクラスを親とし、CarやBicycleをその子クラスとして定義しています。demonstrateIsSubclassOf関数内で、CarオブジェクトがVehicleの子孫であるか、BicycleオブジェクトがVehicleの子孫であるかなどをisSubclassOfを使って確認しています。CarがBicycleの子孫ではないことや、Vehicle自身がVehicleの子孫ではないこと、全く関係のないHouseクラスがVehicleの子孫ではないことも、このメソッドで正確に判定できることが示されています。これにより、オブジェクトの継承関係を柔軟に判断する場面で活用できます。

Copy
1<?php
2
3/**
4 * --- サンプル用のクラス定義 ---
5 * オブジェクト指向プログラミングにおけるクラスの継承関係を示します。
6 * ReflectionObject::isSubclassOf の動作確認に使用します。
7 */
8class Vehicle {}          // 親クラス（乗り物）
9class Car extends Vehicle {} // Vehicleを継承する子クラス（車）
10class Truck extends Vehicle {} // Vehicleを継承するもう一つの子クラス（トラック）
11class Bicycle {}          // Vehicleとは全く関係ない別のクラス（自転車）
12
13/**
14 * ReflectionObject::isSubclassOf メソッドの使用例を初心者向けに示します。
15 * この関数は、PHPの「リフレクションAPI」を使って、オブジェクトが特定のクラスの
16 * サブクラス（子孫クラス）であるかどうかをプログラム的にチェックする方法を解説します。
17 *
18 * リフレクションAPIは、プログラムの実行中に、クラス、メソッド、プロパティなどの
19 * 構造に関する情報を取得したり、操作したりするための高度な機能です。
20 */
21function demonstrateIsSubclassOfExample(): void
22{
23    // --- 1. 各クラスのオブジェクトを作成します ---
24    // 実際にオブジェクトを生成し、その型を後でリフレクションAPIで調べます。
25    $myCar = new Car();
26    $myTruck = new Truck();
27    $myBicycle = new Bicycle(); // このオブジェクト自体は isSubclassOf の呼び出し元にはしません
28
29    // --- 2. ReflectionObject のインスタンスを作成します ---
30    // 特定のオブジェクトに関する情報を取得するためのリフレクションオブジェクトです。
31    // これを使って、$myCar や $myTruck がどのようなクラスのオブジェクトかを調べます。
32    $reflectionCar = new ReflectionObject($myCar);
33    $reflectionTruck = new ReflectionObject($myTruck);
34
35    echo "--- ReflectionObject::isSubclassOf のデモンストレーション ---" . PHP_EOL . PHP_EOL;
36
37    // --- 3. isSubclassOf メソッドの使用例 ---
38    // isSubclassOf は、ReflectionObject が表すオブジェクト（ここでは $myCar や $myTruck）
39    // のクラスが、指定されたクラス（引数）のサブクラスである場合に true を返します。
40    // そうでない場合（親クラスや兄弟クラス、全く関係のないクラスの場合）は false を返します。
41
42    // 例1: $myCar (Carクラスのインスタンス) は Vehicle のサブクラスか？
43    // CarクラスはVehicleクラスを「extends」しているので、trueを返します。
44    echo "Is \$myCar (Car) a subclass of Vehicle? ";
45    var_dump($reflectionCar->isSubclassOf(Vehicle::class)); // Vehicle::class は 'Vehicle' という文字列と同じ意味です
46    echo PHP_EOL;
47
48    // 例2: $myCar (Carクラスのインスタンス) は Truck のサブクラスか？
49    // CarとTruckはどちらもVehicleを継承していますが、互いに直接の継承関係はありません（兄弟関係）。
50    // そのため、falseを返します。
51    echo "Is \$myCar (Car) a subclass of Truck? ";
52    var_dump($reflectionCar->isSubclassOf(Truck::class));
53    echo PHP_EOL;
54
55    // 例3: $myCar (Carクラスのインスタンス) は Bicycle のサブクラスか？
56    // CarとBicycleは全く異なるクラスで、継承関係がありません。
57    // そのため、falseを返します。
58    echo "Is \$myCar (Car) a subclass of Bicycle? ";
59    var_dump($reflectionCar->isSubclassOf(Bicycle::class));
60    echo PHP_EOL;
61
62    // 例4: 引数として ReflectionClass オブジェクトを渡す場合
63    // isSubclassOf メソッドは、クラス名の文字列だけでなく、ReflectionClass のインスタンスも引数として受け取れます。
64    // まず、Vehicleクラス自体のリフレクションオブジェクトを作成します。
65    $reflectionVehicleClass = new ReflectionClass(Vehicle::class);
66    // $myTruck (Truckクラスのインスタンス) は ReflectionClass で指定された Vehicle のサブクラスか？
67    // TruckクラスはVehicleクラスを継承しているので、trueを返します。
68    echo "Is \$myTruck (Truck) a subclass of Vehicle (using ReflectionClass object)? ";
69    var_dump($reflectionTruck->isSubclassOf($reflectionVehicleClass));
70    echo PHP_EOL;
71
72    // 例5: 自身のクラスを指定した場合
73    // isSubclassOf メソッドは「サブクラスであるか」をチェックします。
74    // 自身は自身のサブクラスではないため、この場合は false を返します。
75    echo "Is \$myCar (Car) a subclass of Car? ";
76    var_dump($reflectionCar->isSubclassOf(Car::class));
77    echo PHP_EOL;
78
79    echo "--- デモンストレーション終了 ---" . PHP_EOL;
80}
81
82// 上記の関数を実行して、isSubclassOf メソッドの動作を確認します。
83demonstrateIsSubclassOfExample();

ReflectionObject::isSubclassOfは、PHPのリフレクションAPIを使って、あるオブジェクトのクラスが、指定された別のクラスのサブクラス（子孫クラス）であるかを判定するメソッドです。リフレクションAPIは、プログラムの実行中にクラスやオブジェクトの構造を動的に調べるための高度な機能です。

このメソッドはReflectionObjectクラスに属し、特定のオブジェクトに関する情報を取得する際に利用されます。引数には、比較対象としたいクラスの名前を文字列（例: 'Vehicle'やVehicle::class）で指定するか、そのクラスを表すReflectionClassオブジェクトを渡します。

戻り値は真偽値（bool）です。もし対象のオブジェクトのクラスが指定されたクラスのサブクラスであればtrueを返し、そうでなければfalseを返します。例えば、CarクラスがVehicleクラスを継承している場合、Carオブジェクトに対してisSubclassOf(Vehicle::class)を呼び出すとtrueとなります。一方、CarとTruckは共にVehicleのサブクラスですが、互いに直接の継承関係はなく兄弟関係であるため、isSubclassOf(Truck::class)はfalseを返します。また、自身のクラスを指定した場合も、自身は自身のサブクラスではないためfalseが返される点に注意が必要です。サンプルコードでは、これらの継承関係を具体的に確認する例が示されています。