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

Copy
1<?php
2
3/**
4 * このクラスは抽象クラスです。
5 * 抽象クラスは直接インスタンス化できず、継承されることを意図しています。
6 * 少なくとも1つの抽象メソッドを持つか、抽象メソッドを持たない場合でも抽象として宣言できます。
7 */
8abstract class DatabaseConnector
9{
10    /**
11     * 抽象メソッドは、シグネチャのみを持ち、実装は派生クラスに任されます。
12     */
13    abstract public function connect(): string;
14
15    /**
16     * 通常の（非抽象）メソッドも持つことができます。
17     */
18    public function disconnect(): string
19    {
20        return "データベースから切断しました。\n";
21    }
22}
23
24/**
25 * このクラスは具象（非抽象）クラスです。
26 * 直接インスタンス化でき、すべてのメソッドに実装を持ちます。
27 */
28class MyServiceClass
29{
30    public function execute(): string
31    {
32        return "サービス処理を実行しました。\n";
33    }
34}
35
36/**
37 * 指定されたクラスが抽象クラスであるかどうかを判定し、結果を表示する関数。
38 * システムエンジニアを目指す初心者にも分かりやすいように、ReflectionClass の基本的な使い方と
39 * isAbstract メソッドの動作を示します。
40 *
41 * @param string $className 判定したいクラス名
42 */
43function displayAbstractionStatus(string $className): void
44{
45    try {
46        // ReflectionClass を使用して、クラスの情報を取得します。
47        // これにより、クラスの構造（メソッド、プロパティ、抽象性など）を調べることができます。
48        $reflector = new ReflectionClass($className);
49
50        // isAbstract メソッドを呼び出し、そのクラスが抽象クラスであるかを確認します。
51        if ($reflector->isAbstract()) {
52            echo "クラス '{$className}' は抽象クラスです。\n";
53            echo "抽象クラスは直接オブジェクトを作成できません。\n";
54        } else {
55            echo "クラス '{$className}' は具象クラス（非抽象クラス）です。\n";
56            echo "具象クラスは直接オブジェクトを作成できます。\n";
57        }
58    } catch (ReflectionException $e) {
59        // 指定されたクラス名が見つからない場合のエラーを処理します。
60        echo "エラー: クラス '{$className}' が見つかりません。メッセージ: " . $e->getMessage() . "\n";
61    }
62}
63
64// 定義した抽象クラスと具象クラスに対して、抽象性ステータスを表示します。
65displayAbstractionStatus('DatabaseConnector');
66displayAbstractionStatus('MyServiceClass');
67
68?>

PHPのReflectionClass::isAbstractメソッドは、指定されたクラスが抽象クラスであるかどうかを判定するために利用します。ReflectionClassは、プログラムの実行中にクラスの構造や属性、メソッドなどの情報を動的に調べることができるPHPの機能です。

抽象クラスは、abstractキーワードを用いて宣言され、直接インスタンス（オブジェクト）を作成できない特別なクラスです。主に、共通のインターフェースや部分的な実装を提供し、他の具象クラスに継承されることを意図しています。一方、具象クラス（非抽象クラス）は、通常のクラスであり、直接インスタンスを作成して利用できます。

isAbstractメソッドは引数を取らず、調査対象のクラスが抽象クラスであればtrueを、具象クラスであればfalseをブール値として返します。

サンプルコードでは、displayAbstractionStatus関数がReflectionClassを生成し、そのクラスが抽象クラスであるかをisAbstractメソッドで確認しています。DatabaseConnectorクラスはabstractキーワードで定義されているため、isAbstractはtrueを返し、「抽象クラスです」と表示されます。対照的に、MyServiceClassは具象クラスであるため、isAbstractはfalseを返し、「具象クラス（非抽象クラス）です」と表示され、それぞれのクラスのインスタンス化の可否についても説明されています。この方法で、クラスの抽象性をプログラムから動的に確認できます。

Copy
1<?php
2
3/**
4 * 抽象クラスの例
5 * 直接インスタンス化することはできず、必ず子クラスで実装されることを前提とする
6 */
7abstract class AbstractShape
8{
9    /**
10     * このメソッドは子クラスで必ず実装される
11     * @return float
12     */
13    abstract public function getArea(): float;
14}
15
16/**
17 * 具象クラスの例 (抽象クラスを継承)
18 * AbstractShapeの抽象メソッドを実装することで、インスタンス化可能になる
19 */
20class Circle extends AbstractShape
21{
22    public function __construct(private float $radius) {}
23
24    public function getArea(): float
25    {
26        return M_PI * $this->radius * $this->radius;
27    }
28}
29
30/**
31 * 別の具象クラスの例 (抽象クラスを継承しない)
32 * このクラスは元から抽象メソッドを持たないため、直接インスタンス化可能
33 */
34class Rectangle
35{
36    public function __construct(private float $width, private float $height) {}
37
38    public function getArea(): float
39    {
40        return $this->width * $this->height;
41    }
42}
43
44// ReflectionClass を使用して、各クラスが抽象クラスであるかを確認する
45
46// 抽象クラス AbstractShape をリフレクションで分析
47$reflectionAbstractShape = new ReflectionClass(AbstractShape::class);
48echo "Class " . AbstractShape::class . " is abstract: ";
49var_dump($reflectionAbstractShape->isAbstract()); // 期待値: true
50
51// 具象クラス Circle をリフレクションで分析
52$reflectionCircle = new ReflectionClass(Circle::class);
53echo "Class " . Circle::class . " is abstract: ";
54var_dump($reflectionCircle->isAbstract()); // 期待値: false
55
56// 具象クラス Rectangle をリフレクションで分析
57$reflectionRectangle = new ReflectionClass(Rectangle::class);
58echo "Class " . Rectangle::class . " is abstract: ";
59var_dump($reflectionRectangle->isAbstract()); // 期待値: false
60
61?>

ReflectionClass::isAbstractは、PHPのプログラム実行中に、特定のクラスが「抽象クラス」であるかどうかを判別するためのメソッドです。

抽象クラスとは、それ自体ではオブジェクトを直接作成できない（インスタンス化できない）クラスのことを指します。主に、子クラスに特定のメソッドの実装を強制したり、共通のインターフェースを提供したりするために利用されます。abstractキーワードを用いて定義されます。

このisAbstractメソッドは引数を一切取りません。戻り値はbool型で、対象のクラスが抽象クラスであればtrueを、そうでなければfalseを返します。

サンプルコードでは、まずAbstractShapeという抽象クラスが定義されています。次に、AbstractShapeを継承し、抽象メソッドを実装した具象クラスCircleと、全く独立した具象クラスRectangleがあります。これらのクラスに対してReflectionClassのインスタンスを作成し、isAbstract()メソッドを呼び出すことで、各クラスの抽象性を確認しています。結果として、AbstractShapeからはtrue、CircleとRectangleからはfalseが返され、それぞれが抽象クラスであるかどうかが正しく判断されていることがわかります。このように、isAbstractメソッドは、クラスの設計や動的な処理において、クラスの特性を判別する際に役立ちます。