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

Copy
1<?php
2
3// MyLoggerInterfaceという名前のインターフェースを定義します。
4// インターフェースは、それを実装するクラスがどのような機能（メソッド）を持つべきか、という「契約」を定義します。
5interface MyLoggerInterface
6{
7    public function log(string $message): void;
8}
9
10// FileLoggerという名前のクラスを定義します。
11// このクラスはMyLoggerInterfaceを実装しているため、logメソッドを持つ必要があります。
12class FileLogger implements MyLoggerInterface
13{
14    public function log(string $message): void
15    {
16        echo "ファイルにログを記録: " . $message . PHP_EOL;
17    }
18}
19
20// SimpleCalculatorという名前の別のクラスを定義します。
21// このクラスはどのインターフェースも実装していません。
22class SimpleCalculator
23{
24    public function add(int $a, int $b): int
25    {
26        return $a + $b;
27    }
28}
29
30/**
31 * 指定された名前がインターフェースであるかどうかをReflection APIを使って確認し、結果を表示する関数。
32 *
33 * @param string $name 確認したいインターフェースまたはクラスの完全修飾名（例: MyLoggerInterface::class）
34 */
35function demonstrateIsInterface(string $name): void
36{
37    echo "--- 確認対象: " . $name . " ---" . PHP_EOL;
38
39    try {
40        // ReflectionClassのインスタンスを作成します。
41        // これにより、プログラムの実行時にクラスやインターフェースの情報を動的に調べることができます。
42        $reflection = new ReflectionClass($name);
43
44        // isInterface()メソッドは、このReflectionClassオブジェクトがインターフェースを表している場合にtrueを返します。
45        if ($reflection->isInterface()) {
46            echo "  '" . $name . "' は **インターフェース** です。" . PHP_EOL;
47        } else {
48            echo "  '" . $name . "' はインターフェースでは**ありません**（通常のクラスです）。" . PHP_EOL;
49        }
50    } catch (ReflectionException $e) {
51        // 指定された名前のクラスやインターフェースが見つからない場合の例外処理
52        echo "  エラー: '" . $name . "' は見つかりませんでした。" . PHP_EOL;
53    }
54    echo PHP_EOL;
55}
56
57// 定義したインターフェースとクラスについて、isInterfaceの動作を試します。
58demonstrateIsInterface(MyLoggerInterface::class); // インターフェースとして定義されたもの
59demonstrateIsInterface(FileLogger::class);        // インターフェースを実装するクラス
60demonstrateIsInterface(SimpleCalculator::class);  // インターフェースを実装しない通常のクラス
61
62?>

PHPのReflectionClass::isInterface()メソッドは、プログラムの実行中に指定した名前がインターフェースであるかどうかを動的に判定するための機能です。ReflectionClassは、クラスやインターフェース、関数など、プログラムの構造に関する情報を実行時に取得するためのクラスです。

このisInterface()メソッドは引数を一切取りません。呼び出されたReflectionClassオブジェクトがインターフェースを表している場合にtrue（真）を、インターフェースではない通常のクラスである場合にはfalse（偽）をブール値として返します。

サンプルコードでは、MyLoggerInterfaceというインターフェースと、それを実装するFileLoggerクラス、さらに通常のSimpleCalculatorクラスを定義しています。demonstrateIsInterface関数では、これらの名前を使ってReflectionClassのインスタンスを作成し、isInterface()メソッドの結果を表示しています。

実際にMyLoggerInterface::classを渡すと、このメソッドはtrueを返し、「インターフェースです」と表示されます。一方、FileLogger::classやSimpleCalculator::classのような通常のクラス名を渡すとfalseを返し、「インターフェースではありません」と表示されることが確認できます。このメソッドは、実行時に型がインターフェースかどうかを判別したい場合に利用されます。

Copy
1<?php
2
3/**
4 * サンプルインターフェース
5 */
6interface MyInterface
7{
8    public function doSomething(): void;
9}
10
11/**
12 * サンプル抽象クラス
13 */
14abstract class MyAbstractClass
15{
16    abstract public function calculate(): int;
17
18    public function getDescription(): string
19    {
20        return "This is an abstract class.";
21    }
22}
23
24/**
25 * サンプル通常クラス
26 */
27class MyConcreteClass
28{
29    public function greet(): string
30    {
31        return "Hello from concrete class!";
32    }
33}
34
35/**
36 * ReflectionClass::isInterface() の使用例
37 *
38 * 指定されたクラス名がインターフェースであるかどうかを判定します。
39 * システムエンジニアを目指す初心者の方にも分かりやすいように、
40 * インターフェース、抽象クラス、通常のクラスのそれぞれで結果を確認します。
41 */
42function demonstrateIsInterface(): void
43{
44    // 判定対象となる型を配列に格納
45    $types = [
46        MyInterface::class,     // インターフェース
47        MyAbstractClass::class, // 抽象クラス
48        MyConcreteClass::class, // 通常のクラス
49        stdClass::class,        // PHP標準ライブラリのクラス
50    ];
51
52    echo "--- ReflectionClass::isInterface() のデモンストレーション ---" . PHP_EOL;
53    echo "インターフェース、抽象クラス、通常のクラスの判定結果を確認します。" . PHP_EOL . PHP_EOL;
54
55    foreach ($types as $type) {
56        try {
57            // ReflectionClass オブジェクトを作成
58            $reflectionClass = new ReflectionClass($type);
59
60            // isInterface() メソッドを呼び出し、結果を出力
61            // true ならインターフェース、false ならそれ以外（クラス、抽象クラスなど）
62            $isInterface = $reflectionClass->isInterface();
63
64            echo "型: " . $type . PHP_EOL;
65            echo "  isInterface() の結果: " . ($isInterface ? "true (インターフェースです)" : "false (インターフェースではありません)") . PHP_EOL;
66
67            // 補足情報として、クラスの種類も出力
68            if ($reflectionClass->isInterface()) {
69                echo "  -> これはインターフェースです。" . PHP_EOL;
70            } elseif ($reflectionClass->isAbstract()) {
71                echo "  -> これは抽象クラスです。" . PHP_EOL;
72            } else {
73                echo "  -> これは通常の（具象）クラスです。" . PHP_EOL;
74            }
75            echo PHP_EOL;
76
77        } catch (ReflectionException $e) {
78            echo "エラー: 型 '{$type}' のリフレクション中に問題が発生しました - " . $e->getMessage() . PHP_EOL . PHP_EOL;
79        }
80    }
81
82    echo "--- デモンストレーション終了 ---" . PHP_EOL;
83}
84
85// 関数を実行して結果を表示
86demonstrateIsInterface();

PHP 8のReflectionClass::isInterface()メソッドは、プログラムの実行中に特定のクラスやインターフェースが「インターフェース」であるかどうかを判別するために使用されます。このメソッドはReflectionClassという、クラスやインターフェースに関する詳細な情報を取得するための機能を持つクラスに属しています。引数は必要なく、戻り値は真偽値（bool）です。指定された対象がインターフェースであればtrueを、インターフェースでなければfalseを返します。

提供されたサンプルコードでは、MyInterfaceというインターフェース、MyAbstractClassという抽象クラス、MyConcreteClassという通常のクラス、そしてPHP標準のstdClassという計4種類の型に対してisInterface()を呼び出しています。実行結果として、MyInterfaceに対してのみtrueが返され、「インターフェースである」と判断されます。一方、抽象クラスや通常のクラス、標準クラスに対してはすべてfalseが返され、「インターフェースではない」と判断されることが示されています。このように、このメソッドを使うことで、プログラム実行時に動的にクラスの種類を正確に識別することが可能になります。