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

Copy
1<?php
2
3/**
4 * 親クラスを定義します。
5 */
6class Animal
7{
8    // 基底クラスのため、ここではプロパティやメソッドは省略
9}
10
11/**
12 * Animalクラスを継承する子クラスを定義します。
13 */
14class Dog extends Animal
15{
16    // 子クラス固有のプロパティやメソッド
17}
18
19/**
20 * Animalクラスとは無関係な別のクラスを定義します。
21 */
22class Car
23{
24    // 無関係なクラスのため、ここではプロパティやメソッドは省略
25}
26
27/**
28 * ReflectionClass::isSubclassOf メソッドの使い方を実演する関数です。
29 * あるクラスが別のクラスのサブクラスであるかを判定します。
30 */
31function demonstrateIsSubclassOf(): void
32{
33    echo "--- ReflectionClass::isSubclassOf の使用例 ---" . PHP_EOL . PHP_EOL;
34
35    // DogクラスのReflectionClassオブジェクトを作成
36    // このオブジェクトを使って、Dogクラスが他のクラスのサブクラスであるかを調べます。
37    $reflectionDog = new ReflectionClass(Dog::class);
38
39    // 1. DogがAnimalのサブクラスであるかを確認（引数にクラス名を文字列で指定）
40    $isDogSubclassOfAnimal = $reflectionDog->isSubclassOf(Animal::class);
41    echo "Is 'Dog' a subclass of 'Animal' (using string name)? " . ($isDogSubclassOfAnimal ? "Yes" : "No") . PHP_EOL; // 出力: Yes
42
43    // 2. DogがAnimalのサブクラスであるかを確認（引数にReflectionClassオブジェクトを指定）
44    $reflectionAnimal = new ReflectionClass(Animal::class);
45    $isDogSubclassOfAnimalUsingObject = $reflectionDog->isSubclassOf($reflectionAnimal);
46    echo "Is 'Dog' a subclass of 'Animal' (using ReflectionClass object)? " . ($isDogSubclassOfAnimalUsingObject ? "Yes" : "No") . PHP_EOL; // 出力: Yes
47
48    // 3. DogがCarのサブクラスであるかを確認
49    // CarはAnimalを継承していないため、DogはCarのサブクラスではありません。
50    $isDogSubclassOfCar = $reflectionDog->isSubclassOf(Car::class);
51    echo "Is 'Dog' a subclass of 'Car'? " . ($isDogSubclassOfCar ? "Yes" : "No") . PHP_EOL; // 出力: No
52
53    // 4. 自分自身をサブクラスとして判定しないことの確認
54    // isSubclassOfは、自分自身をサブクラスとは見なしません。
55    $isDogSubclassOfDog = $reflectionDog->isSubclassOf(Dog::class);
56    echo "Is 'Dog' a subclass of 'Dog'? " . ($isDogSubclassOfDog ? "Yes" : "No") . PHP_EOL; // 出力: No
57
58    // 5. 親クラスが子クラスのサブクラスではないことの確認
59    // AnimalはDogの親クラスであり、サブクラスではありません。
60    $isAnimalSubclassOfDog = $reflectionAnimal->isSubclassOf(Dog::class);
61    echo "Is 'Animal' a subclass of 'Dog'? " . ($isAnimalSubclassOfDog ? "Yes" : "No") . PHP_EOL; // 出力: No
62
63    echo PHP_EOL . "--- 実行終了 ---" . PHP_EOL;
64}
65
66// 関数を実行して結果を表示します。
67demonstrateIsSubclassOf();

ReflectionClass::isSubclassOfメソッドは、あるクラスが、指定された別のクラスのサブクラス（子クラス）であるかを動的に判定するためのメソッドです。このメソッドは、クラスの構造に関する情報を取得・操作できるReflectionClassオブジェクトから呼び出されます。

引数には、比較対象としたい親クラスの情報を指定します。具体的には、クラス名を文字列（例: 'Animal'）で渡すか、そのクラスのReflectionClassオブジェクトを渡すことができます。戻り値はbool型で、もし呼び出し元のReflectionClassオブジェクトが表すクラスが、引数で指定されたクラスのサブクラスであればtrueを返し、そうでなければfalseを返します。

サンプルコードでは、Animalクラスを親、Dogクラスを子、Carクラスを無関係なクラスとして定義しています。DogクラスのReflectionClassオブジェクトを作成し、isSubclassOfを呼び出すことで継承関係を検証しています。例えば、DogがAnimalのサブクラスであるかはtrueを返しますが、DogがCarのサブクラスであるかはfalseを返します。また、このメソッドはクラス自身をサブクラスとは見なさないため、DogがDogのサブクラスであるかの判定はfalseになります。同様に、親クラスであるAnimalが子クラスであるDogのサブクラスであるかの判定もfalseです。このように、実行時にクラスの継承関係を柔軟に確認したい場合に役立つメソッドです。

Copy
1<?php
2
3// 親クラスを定義します
4class Animal
5{
6    public function makeSound(): string
7    {
8        return "Generic animal sound";
9    }
10}
11
12// Animal クラスを継承する子クラスを定義します
13class Dog extends Animal
14{
15    public function makeSound(): string
16    {
17        return "Woof";
18    }
19}
20
21// Animal クラスを継承する別の子クラスを定義します
22class Cat extends Animal
23{
24    public public function makeSound(): string
25    {
26        return "Meow";
27    }
28}
29
30// 関連性のないクラスを定義します
31class Vehicle
32{
33    public function drive(): string
34    {
35        return "Vroom";
36    }
37}
38
39/**
40 * 指定されたクラスが別のクラスのサブクラスであるかを判定し、結果を出力します。
41 *
42 * @param string $childClassName サブクラスか判定したいクラス名
43 * @param string $parentClassName 親クラスとして比較するクラス名
44 * @return void
45 */
46function checkSubclassRelationship(string $childClassName, string $parentClassName): void
47{
48    try {
49        // 判定したいクラスの ReflectionClass オブジェクトを作成します
50        $reflectionClass = new ReflectionClass($childClassName);
51
52        // isSubclassOf メソッドを使用して、サブクラス関係をチェックします
53        // 引数には親クラスの ReflectionClass オブジェクトかクラス名の文字列を渡せます
54        $isSubclass = $reflectionClass->isSubclassOf($parentClassName);
55
56        echo sprintf(
57            "%s は %s のサブクラスですか？: %s\n",
58            $childClassName,
59            $parentClassName,
60            $isSubclass ? 'はい' : 'いいえ'
61        );
62    } catch (ReflectionException $e) {
63        echo sprintf("エラー: クラス '%s' のリフレクションに失敗しました。詳細: %s\n", $childClassName, $e->getMessage());
64    }
65}
66
67echo "--- サブクラス関係のチェック ---\n";
68
69// Dog は Animal のサブクラスであるべきです
70checkSubclassRelationship('Dog', 'Animal');
71
72// Dog は Cat のサブクラスではありません
73checkSubclassRelationship('Dog', 'Cat');
74
75// Dog は Vehicle のサブクラスではありません
76checkSubclassRelationship('Dog', 'Vehicle');
77
78// Cat は Animal のサブクラスであるべきです
79checkSubclassRelationship('Cat', 'Animal');
80
81// Animal は Dog のサブクラスではありません (逆の関係)
82checkSubclassRelationship('Animal', 'Dog');
83
84// Dog は Dog 自身のサブクラスとは見なされません
85// (isSubclassOf は厳密に親子の関係を判定するため、自身は含まない)
86checkSubclassRelationship('Dog', 'Dog');
87
88?>

PHPのReflectionClass::isSubclassOfメソッドは、あるクラスが別の指定されたクラスのサブクラス（子クラス）であるかを、プログラム実行中に動的に判定する機能です。これは、クラスの情報を扱うReflectionClassオブジェクトのメソッドです。

引数には親クラスのReflectionClassオブジェクト、またはクラス名を文字列で渡します。戻り値はbool型で、対象のクラスが指定されたクラスのサブクラスであればtrueを、そうでなければfalseを返します。

サンプルコードでは、Animalを親クラス、Dogをその子クラスとして定義し、isSubclassOfで継承関係をチェックしています。例えば、DogがAnimalのサブクラスであるかを判定するとtrueとなります。しかし、継承関係のないクラスや逆の関係（親が子クラスのサブクラスか）、あるいは自身との比較ではfalseが返されます。これは、このメソッドが厳密な親子関係のみを判定するためです。このメソッドは、実行時にクラスの継承関係を柔軟に確認したい場合に役立ちます。