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

Copy
1<?php
2
3/**
4 * 抽象クラスの例。
5 * 抽象メソッドを含むことができる。
6 */
7abstract class ReportGenerator
8{
9    /**
10     * 抽象メソッド。
11     * 処理内容はサブクラスで実装される必要があるため、ここでは実装を持たない。
12     * このメソッドは必ず抽象メソッドとして定義される。
13     */
14    abstract public function generateReport(array $data): string;
15
16    /**
17     * 非抽象メソッド。
18     * このメソッドは具体的な実装を持つ。
19     */
20    public function getReportTitle(): string
21    {
22        return "汎用レポート";
23    }
24}
25
26/**
27 * ReflectionMethod::isAbstract() の使用例を示す関数。
28 * 特定のメソッドが抽象メソッドであるかどうかのチェックを行います。
29 */
30function demonstrateIsAbstract(): void
31{
32    // ReportGenerator クラスの抽象メソッド 'generateReport' のリフレクションを作成
33    $abstractMethodReflection = new ReflectionMethod(ReportGenerator::class, 'generateReport');
34
35    // isAbstract() を呼び出し、メソッドが抽象であるかを確認
36    $isGenerateReportAbstract = $abstractMethodReflection->isAbstract();
37
38    echo "メソッド '{$abstractMethodReflection->getName()}' は抽象メソッドですか？ ";
39    echo ($isGenerateReportAbstract ? 'はい' : 'いいえ') . PHP_EOL;
40
41    // ReportGenerator クラスの非抽象メソッド 'getReportTitle' のリフレクションを作成
42    $concreteMethodReflection = new ReflectionMethod(ReportGenerator::class, 'getReportTitle');
43
44    // isAbstract() を呼び出し、メソッドが抽象であるかを確認
45    $isGetReportTitleAbstract = $concreteMethodReflection->isAbstract();
46
47    echo "メソッド '{$concreteMethodReflection->getName()}' は抽象メソッドですか？ ";
48    echo ($isGetReportTitleAbstract ? 'はい' : 'いいえ') . PHP_EOL;
49}
50
51// 関数を実行し、結果を出力
52demonstrateIsAbstract();

ReflectionMethod::isAbstract()は、PHPのリフレクション機能を利用して、特定のクラスに属するメソッドが「抽象メソッド」であるかどうかを判別するメソッドです。リフレクションとは、プログラムの実行中にクラスやメソッドなどの構造を調べ、操作できる機能のことを指します。

抽象メソッドとは、具体的な処理内容を持たず、そのメソッドを宣言する「抽象クラス」を継承した子クラスで、必ず実装される必要があるメソッドのことです。これにより、サブクラスに特定のメソッドの実装を強制することができます。

このisAbstract()メソッドは引数を一切取りません。戻り値は真偽値（bool）で、調べたいメソッドが抽象メソッドであればtrueを、そうでなければfalseを返します。

サンプルコードでは、ReportGeneratorという抽象クラスを定義し、抽象メソッドであるgenerateReportと、具体的な実装を持つ非抽象メソッドgetReportTitleを用意しています。その後、それぞれのメソッドに対してReflectionMethodオブジェクトを作成し、isAbstract()を呼び出すことで、どちらが抽象メソッドであるかをプログラムで確認しています。実行結果から、generateReportは抽象メソッドであるためtrue、getReportTitleは非抽象メソッドであるためfalseが返されることがわかります。

このように、isAbstract()は、メソッドの特性に基づいて処理を動的に変更したい場合などに活用できます。

Copy
1<?php
2
3// 抽象クラスの定義
4// 抽象クラスは、直接インスタンス化できず、他のクラスに継承されることを前提としたクラスです。
5// 少なくとも1つ抽象メソッドを持つ場合、そのクラスは抽象として宣言する必要があります。
6abstract class Animal
7{
8    // 抽象メソッド
9    // 抽象メソッドは実装を持たず、シグネチャ（名前、引数、戻り値の型）のみを定義します。
10    // この抽象クラスを継承する具象クラスは、このメソッドを必ず実装しなければなりません。
11    abstract public function makeSound(): string;
12
13    // 具象メソッド
14    // 通常のメソッドと同様に、実装を持ちます。
15    public function eat(): string
16    {
17        return "This animal is eating.";
18    }
19}
20
21// 抽象クラス `Animal` を継承する具象クラス `Dog` の定義
22// 抽象クラスを継承するクラスは、そのすべての抽象メソッドを実装する必要があります。
23class Dog extends Animal
24{
25    // `Animal` クラスの抽象メソッド `makeSound()` を実装します。
26    public function makeSound(): string
27    {
28        return "Woof!";
29    }
30}
31
32// ReflectionMethod を使用して、特定のメソッドが抽象メソッドであるかどうかを判定します。
33
34// 1. 抽象クラス `Animal` の抽象メソッド `makeSound()` をリフレクション
35//    `isAbstract()` は true を返します。
36$reflectionAnimalMakeSound = new ReflectionMethod(Animal::class, 'makeSound');
37echo "メソッド " . Animal::class . "::makeSound() は抽象メソッドですか？ ";
38echo $reflectionAnimalMakeSound->isAbstract() ? "はい\n" : "いいえ\n";
39
40echo "----------------------------------------\n";
41
42// 2. 具象クラス `Dog` で実装されたメソッド `makeSound()` をリフレクション
43//    これは抽象メソッドの実装であり、具象メソッドなので `isAbstract()` は false を返します。
44$reflectionDogMakeSound = new ReflectionMethod(Dog::class, 'makeSound');
45echo "メソッド " . Dog::class . "::makeSound() は抽象メソッドですか？ ";
46echo $reflectionDogMakeSound->isAbstract() ? "はい\n" : "いいえ\n";
47
48echo "----------------------------------------\n";
49
50// 3. 抽象クラス `Animal` 内の具象メソッド `eat()` をリフレクション
51//    これは実装を持つ具象メソッドなので `isAbstract()` は false を返します。
52$reflectionAnimalEat = new ReflectionMethod(Animal::class, 'eat');
53echo "メソッド " . Animal::class . "::eat() は抽象メソッドですか？ ";
54echo $reflectionAnimalEat->isAbstract() ? "はい\n" : "いいえ\n";
55
56?>

PHP 8のReflectionMethod::isAbstract()メソッドは、特定のメソッドが抽象メソッドであるかを判定します。このメソッドは引数を受け取らず、bool型の戻り値を返します。対象のメソッドが抽象メソッドであればtrueを、そうでなければfalseを返します。

抽象メソッドとはabstractキーワードで宣言され、具体的な実装を持たず、そのメソッドを継承するクラスに実装が義務付けられるメソッドのことです。抽象メソッドを含むクラスも、自身がabstractキーワードで宣言された抽象クラスとなります。

サンプルコードでは、isAbstract()の具体的な挙動を示します。抽象クラスAnimalの抽象メソッドmakeSound()に対して適用すると、実装がないためtrueを返します。一方、Animalクラスを継承したDogクラスのmakeSound()メソッドや、抽象クラスAnimal内の具象メソッドeat()に対して適用した場合、これらは具体的な実装を持つためfalseを返します。このように、ReflectionMethod::isAbstract()は、プログラム実行時にメソッドが抽象的に定義されているかどうかを動的に確認する際に役立ちます。