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

Copy
1<?php
2
3/**
4 * PHPのインターフェースとは、クラスが実装すべきメソッドのシグネチャ（名前、引数、戻り値の型）を定義する「契約」です。
5 * インターフェースを実装するクラスは、そのインターフェースで定義されたすべてのメソッドを実装する義務があります。
6 */
7
8// 1. インターフェースを定義します。
9// これは、何らかのメッセージを処理する機能を持つオブジェクトが満たすべき契約を示します。
10interface MessageProcessorInterface
11{
12    public function process(string $message): void;
13    public function logStatus(): void;
14}
15
16// 2. 上記のインターフェースを実装するクラスを定義します。
17// このクラスは、MessageProcessorInterface で定義されたすべてのメソッドを実装しなければなりません。
18class EmailProcessor implements MessageProcessorInterface
19{
20    public function process(string $message): void
21    {
22        echo "メールメッセージを処理中: " . $message . "\n";
23    }
24
25    public function logStatus(): void
26    {
27        echo "メールプロセッサの現在の状態をログに記録中。\n";
28    }
29}
30
31// 3. ReflectionClass を使用して、特定のクラス（例: EmailProcessor）の情報を取得します。
32// これにより、実行時にクラスの構造を調べることができます。
33$reflectionClass = new ReflectionClass(EmailProcessor::class);
34
35// 4. getInterfaces() メソッドを使用して、このクラスが実装しているインターフェースのリストを取得します。
36// 戻り値は、インターフェースの名前をキー、ReflectionClass オブジェクトを値とする配列です。
37$implementedInterfaces = $reflectionClass->getInterfaces();
38
39echo "クラス '" . $reflectionClass->getName() . "' が実装しているインターフェース:\n";
40
41// 5. 取得したインターフェースの情報を表示します。
42if (empty($implementedInterfaces)) {
43    echo "  (このクラスはインターフェースを実装していません)\n";
44} else {
45    foreach ($implementedInterfaces as $interfaceName => $reflectionInterface) {
46        echo "  - " . $interfaceName . "\n";
47    }
48}
49
50// インターフェースを実装していないクラスの例
51class SimpleClass
52{
53    public function greet(): void
54    {
55        echo "Hello from SimpleClass!\n";
56    }
57}
58
59$reflectionSimpleClass = new ReflectionClass(SimpleClass::class);
60$implementedInterfacesForSimpleClass = $reflectionSimpleClass->getInterfaces();
61
62echo "\nクラス '" . $reflectionSimpleClass->getName() . "' が実装しているインターフェース:\n";
63if (empty($implementedInterfacesForSimpleClass)) {
64    echo "  (このクラスはインターフェースを実装していません)\n";
65} else {
66    foreach ($implementedInterfacesForSimpleClass as $interfaceName => $reflectionInterface) {
67        echo "  - " . $interfaceName . "\n";
68    }
69}
70
71?>

PHPのReflectionClass::getInterfacesメソッドは、指定されたクラスが実装しているインターフェースの情報を実行時に取得するために使用されます。PHPにおけるインターフェースとは、クラスが満たすべきメソッドのシグネチャを定義する「契約」のようなもので、クラスはそのインターフェースに定義されたすべてのメソッドを実装する義務があります。

ReflectionClassは、クラスのプロパティやメソッド、実装しているインターフェースといった内部構造をプログラム上で調べることができるクラスです。getInterfacesメソッドは引数を一切取らず、呼び出すことで、対象のクラスが直接的または間接的に実装しているすべてのインターフェースのリストを返します。戻り値は連想配列となっており、配列のキーにはインターフェースの完全修飾名（文字列）が、値にはそのインターフェース自身のReflectionClassオブジェクトが格納されます。

このサンプルコードでは、まずMessageProcessorInterfaceというインターフェースと、それを実装するEmailProcessorクラスを定義しています。EmailProcessorクラスのReflectionClassオブジェクトを作成し、getInterfacesメソッドを呼び出すことで、このクラスがMessageProcessorInterfaceを実装していることが動的に確認できます。インターフェースを実装していないSimpleClassの例も示されており、getInterfacesが空の配列を返すことで、そのクラスがインターフェースを実装していないことを判断できます。

Copy
1<?php
2
3// 1. まず、インターフェースを定義します。
4// インターフェースは、クラスが実装すべきメソッドの「契約」を定義します。
5interface Greeter
6{
7    public function greet(string $name): string;
8}
9
10// 2. 次に、上記のGreeterインターフェースを実装するクラスを定義します。
11// このクラスはGreeterインターフェースで定義されたgreetメソッドを必ず実装する必要があります。
12class EnglishGreeter implements Greeter
13{
14    public function greet(string $name): string
15    {
16        return "Hello, " . $name . "!";
17    }
18}
19
20// 3. ReflectionClassを使用して、対象のクラス（ここではEnglishGreeter）の情報を取得します。
21// ReflectionClassは、クラスの構造（プロパティ、メソッド、インターフェースなど）を動的に調べることができます。
22$reflectionClass = new ReflectionClass(EnglishGreeter::class);
23
24echo "--- クラス: " . $reflectionClass->getName() . " の情報 ---" . PHP_EOL;
25
26// 4. getInterfaces() メソッドを呼び出して、このクラスが実装しているインターフェースの情報を取得します。
27// 戻り値は、インターフェース名（文字列）をキーとし、ReflectionClassオブジェクト（インターフェース用）を値とする配列です。
28$interfaces = $reflectionClass->getInterfaces();
29
30if (empty($interfaces)) {
31    echo "このクラスはどのインターフェースも実装していません。" . PHP_EOL;
32} else {
33    echo "このクラスが実装しているインターフェース:" . PHP_EOL;
34    foreach ($interfaces as $interfaceName => $reflectionInterface) {
35        // 取得したReflectionClassオブジェクトからインターフェースの名前を表示します。
36        echo "  - " . $reflectionInterface->getName() . PHP_EOL;
37    }
38
39    echo PHP_EOL;
40
41    // キーワード「インスタンス化」について：
42    // インターフェース自体は直接インスタンス化できません。
43    // しかし、そのインターフェースを実装する「具象クラス」（ここではEnglishGreeter）はインスタンス化できます。
44    // ReflectionClass を使えば、クラス名から動的にインスタンスを生成することも可能です。
45    echo "--- インターフェースを実装するクラスのインスタンス化の例 ---" . PHP_EOL;
46    echo "クラス " . $reflectionClass->getName() . " をインスタンス化しています..." . PHP_EOL;
47
48    // ReflectionClass::newInstance() を使用して、対象のクラスのインスタンスを生成します。
49    $greeterInstance = $reflectionClass->newInstance();
50
51    echo "インスタンスが作成されました。実装されたメソッドを呼び出してみます:" . PHP_EOL;
52    echo $greeterInstance->greet("システムエンジニア初心者") . PHP_EOL;
53}
54
55?>

PHPのReflectionClass::getInterfaces()メソッドは、特定のクラスが「どのインターフェースを実装しているか」という情報を取得するために用いられます。インターフェースとは、クラスが実装すべきメソッドの「契約」を定義するもので、複数のクラスに共通の機能を持たせる際に役立ちます。このメソッドは引数を必要とせず、戻り値として、実装しているインターフェースの情報を格納した連想配列を返します。この配列のキーはインターフェース名（文字列）、値はそのインターフェース自体を表すReflectionClassオブジェクトとなります。

サンプルコードでは、Greeterインターフェースとその実装クラスであるEnglishGreeterを定義しています。ReflectionClassは、実行時にクラスの構造を動的に調べるための機能です。EnglishGreeterクラスのReflectionClassインスタンスを生成し、そのgetInterfaces()メソッドを呼び出すことで、EnglishGreeterがGreeterインターフェースを実装していることを確認し、その名前を表示しています。

また、「インターフェースのインスタンス化」についてですが、インターフェース自体は直接インスタンス化できません。しかし、そのインターフェースを実装する具体的なクラス（例：EnglishGreeter）はインスタンス化できます。サンプルコードの最後では、ReflectionClassのnewInstance()メソッドを使って、動的にEnglishGreeterクラスのインスタンスを生成し、そのgreetメソッドを呼び出す例を示しており、これにより実行時にクラスの柔軟な操作が可能になります。