【PHP8.x】ReflectionMethod::IS_ABSTRACT定数の使い方

Copy
1<?php
2
3// 抽象クラスを定義します。
4// 抽象メソッドは、子クラスで必ず実装される必要があります。
5abstract class Shape
6{
7    abstract public function getArea(): float; // 抽象メソッド
8    abstract protected function calculatePerimeter(): float; // 別の抽象メソッド
9
10    public function getDescription(): string // 具象メソッド
11    {
12        return "これは図形クラスです。\n";
13    }
14}
15
16/**
17 * 指定されたクラスから抽象メソッドを検出し、その名前を表示する関数です。
18 * ReflectionMethod::IS_ABSTRACT 定数を使用してメソッドをフィルターします。
19 *
20 * @param string $className 検査対象のクラス名
21 */
22function demonstrateAbstractMethodDetection(string $className): void
23{
24    echo "--- クラス: {$className} の抽象メソッド検出 ---\n";
25
26    try {
27        // ReflectionClass を使用して、クラスのメタ情報を取得します。
28        $reflectionClass = new ReflectionClass($className);
29
30        // ReflectionMethod::IS_ABSTRACT 定数をフィルターとして getMethods() に渡すことで、
31        // そのクラスが持つ抽象メソッドのみを ReflectionMethod オブジェクトの配列として取得します。
32        // この定数自体は、メソッドが抽象であるかどうかを識別するための内部的な整数値であり、
33        // それ自体が何か値を返す関数ではありません。
34        $abstractMethods = $reflectionClass->getMethods(ReflectionMethod::IS_ABSTRACT);
35
36        if (empty($abstractMethods)) {
37            echo "  このクラスには抽象メソッドが見つかりませんでした。\n";
38        } else {
39            echo "  検出された抽象メソッド:\n";
40            foreach ($abstractMethods as $method) {
41                echo "    - " . $method->getName() . "()\n";
42            }
43        }
44    } catch (ReflectionException $e) {
45        echo "  エラー: クラス '{$className}' が存在しません。 " . $e->getMessage() . "\n";
46    }
47    echo "\n";
48}
49
50// サンプル1: 抽象クラス 'Shape' の抽象メソッドを検出します。
51demonstrateAbstractMethodDetection(Shape::class);
52
53// 抽象メソッドをすべて実装した具象クラスの例。
54// このクラス自体には新たな抽象メソッドがないため、フィルターでは検出されません。
55class Circle extends Shape
56{
57    private float $radius;
58
59    public function __construct(float $radius)
60    {
61        $this->radius = $radius;
62    }
63
64    public function getArea(): float
65    {
66        return M_PI * $this->radius * $this->radius;
67    }
68
69    protected function calculatePerimeter(): float
70    {
71        return 2 * M_PI * $this->radius;
72    }
73}
74
75// サンプル2: 具象クラス 'Circle' の抽象メソッドを検出します。
76// 親クラスの抽象メソッドを実装済みなので、このクラス自身には抽象メソッドはありません。
77demonstrateAbstractMethodDetection(Circle::class);
78
79// 抽象メソッドを全く持たない通常のクラスの例。
80class Rectangle
81{
82    public function getWidth(): float { return 10.0; }
83    public function getHeight(): float { return 5.0; }
84}
85
86// サンプル3: 通常のクラス 'Rectangle' の抽象メソッドを検出します。
87demonstrateAbstractMethodDetection(Rectangle::class);
88
89?>

PHPのReflectionMethod::IS_ABSTRACTは、リフレクション機能において、メソッドが抽象メソッドであるかどうかを識別するための定数です。この定数自体に引数や直接の戻り値はありませんが、ReflectionClass::getMethods()メソッドの引数として利用することで、クラスが持つメソッドの中から抽象メソッドのみを効率的に抽出するフィルターとして機能します。

サンプルコードでは、まず抽象メソッドを持つShape抽象クラスを定義しています。demonstrateAbstractMethodDetection関数は、指定されたクラスのメタ情報を取得するReflectionClassを使用し、getMethods(ReflectionMethod::IS_ABSTRACT)を呼び出すことで、そのクラスに定義されている抽象メソッドの一覧を取得し、名前を表示します。

具体的には、Shapeクラスに対してこの関数を実行すると、getArea()とcalculatePerimeter()という抽象メソッドが検出されます。一方、Shapeを継承し全ての抽象メソッドを実装したCircleクラスや、抽象メソッドを全く持たないRectangleクラスに対して実行した場合、抽象メソッドは検出されないことが示されています。これにより、ReflectionMethod::IS_ABSTRACTがクラス階層における抽象メソッドの有無を正確に判別できることが確認できます。この機能は、フレームワークやライブラリ開発で、特定の条件を満たすメソッドを動的に探索する際に役立ちます。