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

Copy
1<?php
2
3/**
4 * サンプルで使用する基底クラスを定義します。
5 * これは、動物一般を表すクラスです。
6 */
7class Animal
8{
9    public string $name;
10
11    public function __construct(string $name)
12    {
13        $this->name = $name;
14    }
15}
16
17/**
18 * Animalクラスを継承するクラスを定義します。
19 * 犬は動物の一種です。
20 */
21class Dog extends Animal
22{
23    // 犬固有のプロパティやメソッドはここに追加できます
24}
25
26/**
27 * 全く関係のない別のクラスを定義します。
28 * 車は動物ではありません。
29 */
30class Car
31{
32    public string $model;
33
34    public function __construct(string $model)
35    {
36        $this->model = $model;
37    }
38}
39
40// 様々なオブジェクトのインスタンスを作成します。
41$myDog = new Dog("Buddy");
42$myAnimal = new Animal("Lion");
43$myCar = new Car("Toyota");
44
45// ReflectionClass を使用して Animal クラスの情報を取得します。
46// ReflectionClass は、実行時にクラスの構造を調べることができる強力なツールです。
47$animalReflection = new ReflectionClass(Animal::class);
48
49echo "--- ReflectionClass::isInstance の使用例 ---" . PHP_EOL;
50echo "確認対象のクラス: " . $animalReflection->getName() . PHP_EOL . PHP_EOL;
51
52// ReflectionClass::isInstance() メソッドは、
53// 指定されたオブジェクトが、この ReflectionClass が表すクラス（ここでは 'Animal'）の
54// インスタンスであるかどうかを真偽値（true/false）で返します。
55// これは、PHPの `instanceof` 演算子と似た働きをします。
56
57// 1. $myDog オブジェクトが Animal クラスのインスタンスか？
58// (Dog は Animal を継承しているので、結果は true になります)
59if ($animalReflection->isInstance($myDog)) {
60    echo "'{$myDog->name}' は {$animalReflection->getName()} クラスのインスタンスです。（DogはAnimalを継承）" . PHP_EOL;
61} else {
62    echo "'{$myDog->name}' は {$animalReflection->getName()} クラスのインスタンスではありません。" . PHP_EOL;
63}
64
65// 2. $myAnimal オブジェクトが Animal クラスのインスタンスか？
66// (Animal は Animal なので、結果は true になります)
67if ($animalReflection->isInstance($myAnimal)) {
68    echo "'{$myAnimal->name}' は {$animalReflection->getName()} クラスのインスタンスです。" . PHP_EOL;
69} else {
70    echo "'{$myAnimal->name}' は {$animalReflection->getName()} クラスのインスタンスではありません。" . PHP_EOL;
71}
72
73// 3. $myCar オブジェクトが Animal クラスのインスタンスか？
74// (Car は Animal と関係ないので、結果は false になります)
75if ($animalReflection->isInstance($myCar)) {
76    echo "'{$myCar->model}' は {$animalReflection->getName()} クラスのインスタンスです。" . PHP_EOL;
77} else {
78    echo "'{$myCar->model}' は {$animalReflection->getName()} クラスのインスタンスではありません。" . PHP_EOL;
79}
80
81?>

ReflectionClass::isInstanceメソッドは、PHPのReflectionClassが提供する機能の一つで、あるオブジェクトが特定のクラスのインスタンスであるかどうかを判定します。ReflectionClassは、プログラムが実行されている最中にクラスの情報を動的に取得・操作するための強力なツールです。

このisInstanceメソッドは、引数として確認したいオブジェクトを受け取り、そのオブジェクトが、このReflectionClassが表すクラス（またはその子クラス）のインスタンスであればtrueを、そうでなければfalseを真偽値として返します。

例えば、AnimalクラスのReflectionClassオブジェクトを使ってisInstanceを呼び出すと、渡されたオブジェクトがAnimalクラスそのものか、あるいはDogのようにAnimalを継承したクラスのインスタンスであるかを判別できます。これは、PHPに標準で備わっているinstanceof演算子と非常によく似た働きをしますが、ReflectionClassを用いることで、クラス名を動的に指定してインスタンスチェックを行える点が特徴です。サンプルコードでは、Animalクラスのリフレクション情報を用いて、異なるオブジェクトがAnimalクラスに属するかどうかを判定する具体的な例が示されています。