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

Copy
1<?php
2
3/**
4 * PHPインターフェースの動作と、ReflectionObject::getInterfaces() メソッドの
5 * 使用方法を示すサンプルコードです。
6 *
7 * インターフェースは、クラスが実装すべきメソッドの「契約」を定義します。
8 * これにより、異なるクラス間で共通の振る舞いを強制し、コードの構造化を助けます。
9 */
10
11// 1. まず、インターフェースを定義します。
12//    これは「UserAction」という行動に関する契約を定義しています。
13interface UserAction
14{
15    public function performAction(string $actionName): string;
16    public function getActionDescription(): string;
17}
18
19// 2. 複数のインターフェースを実装するクラスを定義します。
20//    このクラスはUserActionインターフェースの契約を満たす必要があります。
21interface Loggable
22{
23    public function log(string $message): void;
24}
25
26class SystemUser implements UserAction, Loggable
27{
28    private string $userName;
29
30    public function __construct(string $userName)
31    {
32        $this->userName = $userName;
33    }
34
35    /**
36     * UserAction インターフェースのメソッド実装。
37     */
38    public function performAction(string $actionName): string
39    {
40        return $this->userName . " がアクション '" . $actionName . "' を実行しました。";
41    }
42
43    /**
44     * UserAction インターフェースのメソッド実装。
45     */
46    public function getActionDescription(): string
47    {
48        return $this->userName . " はシステム内で様々な操作を実行できるユーザーです。";
49    }
50
51    /**
52     * Loggable インターフェースのメソッド実装。
53     */
54    public function log(string $message): void
55    {
56        echo "[LOG] " . $message . "\n";
57    }
58}
59
60// 3. SystemUser クラスのオブジェクトを作成します。
61$user = new SystemUser("Alice");
62$user->log("SystemUser オブジェクトが作成されました。");
63echo $user->performAction("ログイン") . "\n";
64echo $user->getActionDescription() . "\n\n";
65
66// 4. ReflectionObject を使用して、オブジェクトが実装しているインターフェース情報を取得します。
67//    ReflectionObject は、実行時にオブジェクトの構造（プロパティ、メソッド、インターフェースなど）を
68//    動的に調べるためのPHPの強力な機能です。
69echo "--- ReflectionObject::getInterfaces() の使用例 ---\n";
70echo "オブジェクト '" . get_class($user) . "' が実装しているインターフェースの確認:\n";
71
72// SystemUser オブジェクトのReflectionObjectを作成
73$reflector = new ReflectionObject($user);
74
75// getInterfaces() メソッドを呼び出し、実装しているインターフェースのReflectionClassオブジェクトの配列を取得
76$interfaces = $reflector->getInterfaces();
77
78if (empty($interfaces)) {
79    echo "  このオブジェクトはどのインターフェースも実装していません。\n";
80} else {
81    foreach ($interfaces as $interfaceName => $reflectionClass) {
82        // 各要素はインターフェース名（キー）とそのインターフェースのReflectionClassオブジェクト（値）です。
83        echo "  - インターフェース名: " . $interfaceName . "\n";
84        echo "    (ReflectionClass オブジェクトのインスタンス: " . get_class($reflectionClass) . ")\n";
85    }
86}
87
88// オブジェクトが特定のインターフェースを実装しているかどうかも確認できます。
89echo "\n--- 特定のインターフェース実装の確認 ---\n";
90if ($reflector->implementsInterface(UserAction::class)) {
91    echo "  '" . get_class($user) . "' は 'UserAction' インターフェースを実装しています。\n";
92} else {
93    echo "  '" . get_class($user) . "' は 'UserAction' インターフェースを実装していません。\n";
94}
95
96if ($reflector->implementsInterface(Loggable::class)) {
97    echo "  '" . get_class($user) . "' は 'Loggable' インターフェースを実装しています。\n";
98} else {
99    echo "  '" . get_class($user) . "' は 'Loggable' インターフェースを実装していません。\n";
100}
101
102?>

PHPのインターフェースは、クラスが実装すべきメソッドの「契約」を定義し、異なるクラス間で共通の振る舞いを強制するための仕組みです。これにより、コードの構造化と拡張性が向上します。ReflectionObject::getInterfaces()メソッドは、実行時に特定のオブジェクトがどのインターフェースを実装しているかを動的に調べるために使用されます。

ReflectionObjectは、PHPの強力なリフレクション機能の一部で、実行時にオブジェクトのプロパティ、メソッド、そして実装しているインターフェースなどの内部構造を調べることができます。getInterfaces()メソッドは引数を一切取らず、呼び出されたオブジェクトが実装しているすべてのインターフェースに関する情報を取得します。

このメソッドの戻り値は配列です。配列の各要素は、実装しているインターフェースの名前をキーとし、そのインターフェース自体を表すReflectionClassオブジェクトを値として持ちます。サンプルコードでは、SystemUserオブジェクトがUserActionとLoggableというインターフェースを実装していることを、このメソッドを使ってプログラム実行中に動的に確認し、その情報を表示しています。この機能は、オブジェクトの特性を柔軟に検証したり、特定の「契約」に基づいた処理を動的に行ったりする際に非常に役立ちます。

Copy
1<?php
2
3/**
4 * インターフェースを定義します。
5 * インターフェースは、クラスが実装すべきメソッドのセットを定義します。
6 */
7interface MyPrintableInterface
8{
9    public function printInfo(): string;
10}
11
12/**
13 * 別のインターフェースを定義します。
14 * 1つのクラスは複数のインターフェースを実装できます。
15 */
16interface MyLoggableInterface
17{
18    public function logMessage(string $message): void;
19}
20
21/**
22 * 定義したインターフェースを実装するクラスです。
23 * インターフェースを実装すると、そのインターフェースで定義されたすべてのメソッドを
24 * クラス内で実装する必要があります。
25 */
26class MyService implements MyPrintableInterface, MyLoggableInterface
27{
28    private string $name;
29
30    public function __construct(string $name)
31    {
32        $this->name = $name;
33    }
34
35    /**
36     * MyPrintableInterface で定義されたメソッドの実装。
37     */
38    public function printInfo(): string
39    {
40        return "サービス名: " . $this->name;
41    }
42
43    /**
44     * MyLoggableInterface で定義されたメソッドの実装。
45     */
46    public function logMessage(string $message): void
47    {
48        echo "ログ: " . $message . "\n";
49    }
50}
51
52/**
53 * オブジェクトが実装しているインターフェースをReflectionAPIで取得する関数です。
54 *
55 * @param object $object 検査するオブジェクト
56 */
57function displayImplementedInterfaces(object $object): void
58{
59    echo "--- オブジェクトが実装しているインターフェースの表示 ---\n";
60
61    // ReflectionObject を使用して、オブジェクトの情報を取得します。
62    // ReflectionAPI は、実行時にクラス、メソッド、プロパティなどの情報を
63    // 取得できる強力な機能です。
64    $reflector = new ReflectionObject($object);
65
66    // getInterfaces() メソッドは、オブジェクトが実装しているすべてのインターフェースの
67    // ReflectionClass オブジェクトの配列を返します。
68    $interfaces = $reflector->getInterfaces();
69
70    if (empty($interfaces)) {
71        echo "このオブジェクトはどのインターフェースも実装していません。\n";
72        return;
73    }
74
75    echo "実装しているインターフェース:\n";
76    foreach ($interfaces as $interfaceReflection) {
77        // ReflectionClass::getName() でインターフェース名を取得します。
78        echo "- " . $interfaceReflection->getName() . "\n";
79    }
80    echo "--------------------------------------------------------\n";
81}
82
83// --- サンプルコードの実行 ---
84
85// MyService クラスのインスタンスを作成します。
86// インターフェース自体は直接インスタンス化できませんが、
87// インターフェースを実装したクラスはインスタンス化できます。
88$myServiceObject = new MyService("レポート生成サービス");
89
90// 作成したインスタンスが実装しているインターフェースを表示します。
91displayImplementedInterfaces($myServiceObject);
92
93// インターフェースを実装していない標準クラスの例
94$stdObject = new stdClass();
95displayImplementedInterfaces($stdObject);

このサンプルコードは、PHPの「リフレクションAPI」を活用し、あるオブジェクトがどのようなインターフェースを実装しているかを動的に調べる方法を示しています。まず、MyPrintableInterfaceとMyLoggableInterfaceという二つのインターフェースを定義し、MyServiceクラスがこれらを実装しています。インターフェースとは、クラスが満たすべき機能の「設計図」のようなもので、インターフェース自体は直接インスタンス化できません。しかし、この設計図に沿って作られたMyServiceクラスは、new MyService(...)のようにインスタンス化できます。

displayImplementedInterfaces関数では、検査したいオブジェクトを受け取ります。そのオブジェクトからReflectionObjectのインスタンスを作成します。ReflectionObjectは、実行時にオブジェクトの構造や挙動を詳細に検査できるPHPの強力な機能です。ここで重要なのがgetInterfaces()メソッドです。このメソッドは引数なしで呼び出され、対象のオブジェクトが実装しているすべてのインターフェースに対応するReflectionClassオブジェクトの配列を戻り値として返します。このReflectionClassオブジェクトから、getName()メソッドを使ってインターフェースの名前を取り出し、表示しています。これにより、PHPの実行時にオブジェクトがどのような「約束」を守っているか、つまりどのインターフェースを実装しているかを正確に確認することが可能です。