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

Copy
1<?php
2
3/**
4 * サンプルインターフェースを定義します。
5 */
6interface MyInterface
7{
8    public function doSomething(): void;
9}
10
11/**
12 * MyInterface を実装するクラスです。
13 */
14class MyClass implements MyInterface
15{
16    public function doSomething(): void
17    {
18        echo "MyClass が MyInterface の doSomething を実行しました。" . PHP_EOL;
19    }
20}
21
22/**
23 * MyInterface を実装しない別のクラスです。
24 */
25class AnotherClass
26{
27    public function greet(): void
28    {
29        echo "こんにちは、私は AnotherClass です。" . PHP_EOL;
30    }
31}
32
33// MyClass のインスタンスを作成
34$myObject = new MyClass();
35// AnotherClass のインスタンスを作成
36$anotherObject = new AnotherClass();
37
38echo "--- ReflectionObject::implementsInterface の使用例 ---" . PHP_EOL;
39
40// MyClass オブジェクトの ReflectionObject を作成
41$reflectionMyObject = new ReflectionObject($myObject);
42
43// MyClass オブジェクトが MyInterface を実装しているかチェック
44echo "オブジェクトが MyInterface を実装しているか確認 (MyClass):" . PHP_EOL;
45if ($reflectionMyObject->implementsInterface(MyInterface::class)) {
46    echo "  はい、MyClass は MyInterface を実装しています。" . PHP_EOL;
47} else {
48    echo "  いいえ、MyClass は MyInterface を実装していません。" . PHP_EOL;
49}
50
51echo PHP_EOL;
52
53// AnotherClass オブジェクトの ReflectionObject を作成
54$reflectionAnotherObject = new ReflectionObject($anotherObject);
55
56// AnotherClass オブジェクトが MyInterface を実装しているかチェック
57echo "オブジェクトが MyInterface を実装しているか確認 (AnotherClass):" . PHP_EOL;
58if ($reflectionAnotherObject->implementsInterface(MyInterface::class)) {
59    echo "  はい、AnotherClass は MyInterface を実装しています。" . PHP_EOL;
60} else {
61    echo "  いいえ、AnotherClass は MyInterface を実装していません。" . PHP_EOL;
62}
63

PHPのReflectionObject::implementsInterfaceメソッドは、あるオブジェクトが特定のインターフェースを実装しているかどうかを動的に確認するための機能です。ReflectionObjectは、実行中のプログラムの構造を調べたり操作したりできるPHPのリフレクションAPIの一部です。

このimplementsInterfaceメソッドは、ReflectionObjectのインスタンスに対して呼び出されます。引数には、確認したいインターフェースの名前を文字列またはReflectionClassオブジェクトとして渡します。通常はMyInterface::classのようにクラス定数で指定します。戻り値はブール値で、指定されたインターフェースをオブジェクトが実装していればtrue、実装していなければfalseが返されます。

サンプルコードでは、MyInterfaceというインターフェースを定義し、それを実装するMyClassと、実装しないAnotherClassを用意しています。MyClassのオブジェクトに対してReflectionObjectを作成しimplementsInterface(MyInterface::class)を実行するとtrueが返され、MyInterfaceを実装していることが確認できます。一方、AnotherClassのオブジェクトに対して同様に確認するとfalseが返され、実装していないことが確認できます。この機能は、プログラム実行時にオブジェクトの型情報を検証する際に非常に役立ちます。

Copy
1<?php
2
3// インターフェースの定義:
4// クラスが満たすべき「規約」を定義します。
5interface LoggerInterface
6{
7    public function log(string $message): void;
8}
9
10// LoggerInterface を実装するクラス:
11// `implements` キーワードを使って、このクラスが LoggerInterface の規約に従うことを宣言します。
12class ConsoleLogger implements LoggerInterface
13{
14    public function log(string $message): void
15    {
16        echo "ConsoleLogger: " . $message . PHP_EOL;
17    }
18}
19
20// LoggerInterface を実装しないクラス:
21// このクラスは LoggerInterface の規約に従いません。
22class SimpleClass
23{
24    public function doSomething(): void
25    {
26        echo "SimpleClass: Doing something..." . PHP_EOL;
27    }
28}
29
30// --- ReflectionObject::implementsInterface の使用例 ---
31
32// 各クラスのオブジェクトを作成します。
33$consoleLogger = new ConsoleLogger();
34$simpleClass = new SimpleClass();
35
36// ReflectionObject を作成し、オブジェクトの情報を動的に調べられるようにします。
37$reflectionConsoleLogger = new ReflectionObject($consoleLogger);
38$reflectionSimpleClass = new ReflectionObject($simpleClass);
39
40// チェックしたいインターフェース名を指定します。
41// LoggerInterface::class は、PHP 5.5 以降でインターフェース名を文字列として取得するのに推奨されます。
42$interfaceToCheck = LoggerInterface::class;
43
44echo "--- インターフェース実装の動的チェック ---" . PHP_EOL;
45
46// ConsoleLogger オブジェクトが LoggerInterface を実装しているか確認します。
47$isConsoleLoggerImplementing = $reflectionConsoleLogger->implementsInterface($interfaceToCheck);
48echo "ConsoleLogger は '{$interfaceToCheck}' を実装していますか？ "
49    . ($isConsoleLoggerImplementing ? 'はい (true)' : 'いいえ (false)') . PHP_EOL;
50
51// SimpleClass オブジェクトが LoggerInterface を実装しているか確認します。
52$isSimpleClassImplementing = $reflectionSimpleClass->implementsInterface($interfaceToCheck);
53echo "SimpleClass は '{$interfaceToCheck}' を実装していますか？ "
54    . ($isSimpleClassImplementing ? 'はい (true)' : 'いいえ (false)') . PHP_EOL;
55

PHPのimplementsキーワードは、クラスが「インターフェース」という特定の規約に従い、定義されたメソッドを必ず実装することを宣言するものです。インターフェースは、クラスが持つべきメソッドの署名（引数や戻り値の型）を定義する設計図のような役割を果たします。

ReflectionObject::implementsInterfaceメソッドは、実行中のプログラムにおいて、あるオブジェクトが特定のインターフェースを実装しているかどうかを動的に検査するために使用されます。このメソッドを使うには、まず調べたいオブジェクトをReflectionObjectクラスのインスタンスとして作成します。

implementsInterfaceメソッドの引数には、チェックしたいインターフェースの名前を文字列、またはReflectionClassオブジェクトとして渡します。そして、このメソッドは、対象のオブジェクトが指定されたインターフェースを実装していればtrueを、実装していなければfalseをブール値として返します。

サンプルコードでは、LoggerInterfaceを実装するConsoleLoggerと、実装しないSimpleClassを用意しています。それぞれのオブジェクトに対しReflectionObjectを使いimplementsInterfaceメソッドでLoggerInterfaceを実装しているかを調べた結果、ConsoleLoggerに対してはtrueが、SimpleClassに対してはfalseが返されており、メソッドが正しく動作していることを示しています。これにより、プログラムの実行中にオブジェクトの型情報を柔軟に確認できるようになります。