【PHP8.x】class_implements関数の使い方

Copy
1<?php
2
3/**
4 * プログラミング言語のインターフェースの例。
5 * クラスがこのインターフェースを実装することで、特定の機能を提供することを保証します。
6 */
7interface LoggerInterface
8{
9    /**
10     * メッセージを記録するメソッド。
11     *
12     * @param string $message 記録するメッセージ
13     */
14    public function log(string $message): void;
15}
16
17/**
18 * 別のインターフェースの例。
19 */
20interface CacheableInterface
21{
22    /**
23     * データをキャッシュに保存するメソッド。
24     *
25     * @param string $key   キー
26     * @param mixed  $value 値
27     * @return bool
28     */
29    public function set(string $key, mixed $value): bool;
30}
31
32/**
33 * LoggerInterface を実装するクラスの例。
34 * このクラスはログ機能を持ちます。
35 */
36class DatabaseLogger implements LoggerInterface
37{
38    public function log(string $message): void
39    {
40        echo "データベースにログを記録: " . $message . PHP_EOL;
41    }
42}
43
44/**
45 * 複数のインターフェースを実装するクラスの例。
46 * このクラスはログ機能とキャッシュ機能の両方を持ちます。
47 */
48class DataManager implements LoggerInterface, CacheableInterface
49{
50    public function log(string $message): void
51    {
52        echo "DataManagerがログを記録: " . $message . PHP_EOL;
53    }
54
55    public function set(string $key, mixed $value): bool
56    {
57        echo "DataManagerがデータをキャッシュに保存: キー = '{$key}', 値 = '{$value}'" . PHP_EOL;
58        return true;
59    }
60}
61
62echo "--- DatabaseLogger クラスが実装しているインターフェース ---" . PHP_EOL;
63// class_implements を使って、指定したクラスがどのインターフェースを実装しているか取得します。
64// クラス名を文字列で渡すことも、`ClassName::class`のようにクラス定数で渡すこともできます。
65$interfacesOfDbLogger = class_implements(DatabaseLogger::class);
66
67// 戻り値は配列、または失敗した場合は false です。
68if ($interfacesOfDbLogger !== false) {
69    // 取得したインターフェースの配列を出力します。
70    // キーと値が同じインターフェース名になる連想配列です。
71    print_r($interfacesOfDbLogger);
72} else {
73    echo "DatabaseLogger クラスのインターフェース取得に失敗しました。" . PHP_EOL;
74}
75
76echo PHP_EOL;
77
78echo "--- DataManager オブジェクトが実装しているインターフェース ---" . PHP_EOL;
79// オブジェクトのインスタンスを class_implements に渡すこともできます。
80$dataManager = new DataManager();
81$interfacesOfDataManager = class_implements($dataManager);
82
83if ($interfacesOfDataManager !== false) {
84    print_r($interfacesOfDataManager);
85} else {
86    echo "DataManager オブジェクトのインターフェース取得に失敗しました。" . PHP_EOL;
87}
88
89echo PHP_EOL;
90
91echo "--- 存在しないクラスを指定した場合 ---" . PHP_EOL;
92// 存在しないクラス名を指定すると false が返されます。
93$nonExistentClassInterfaces = class_implements('NonExistentClass');
94
95if ($nonExistentClassInterfaces === false) {
96    echo "存在しないクラス 'NonExistentClass' のインターフェース取得に失敗しました (期待される結果)。" . PHP_EOL;
97} else {
98    print_r($nonExistentClassInterfaces);
99}

PHPのclass_implements関数は、指定されたクラスまたはオブジェクトがどのインターフェースを実装しているかを確認するために利用されます。インターフェースとは、クラスが特定のメソッド（機能）を持つことを保証するための「設計図」や「契約」のようなもので、例えばLoggerInterfaceはログ機能の、CacheableInterfaceはキャッシュ機能の提供をクラスに義務付けます。

この関数は、第1引数にクラス名（文字列形式、例: DatabaseLogger::class）またはオブジェクトのインスタンス（例: $dataManager）を取ります。サンプルコードでは、DatabaseLoggerクラスがLoggerInterfaceを、DataManagerクラスが複数のインターフェースを実装している例が示されています。

class_implements()を実行すると、そのクラスやオブジェクトが実装しているインターフェースの名前が、キーと値が同じ連想配列として戻り値で得られます。例えば、DatabaseLoggerの場合は['LoggerInterface' => 'LoggerInterface']のような配列が返されます。もし指定されたクラスが存在しないなど、インターフェースの取得に失敗した場合はfalseが返されるため、戻り値の確認は重要です。この関数を使うことで、実行時にクラスの機能性を動的に判断できるようになります。

Copy
1<?php
2
3/**
4 * Interface 1: ロギング機能を提供します。
5 */
6interface LoggerInterface
7{
8    public function log(string $message): void;
9}
10
11/**
12 * Interface 2: 実行可能な機能を提供します。
13 */
14interface RunnableInterface
15{
16    public function run(): void;
17}
18
19/**
20 * Interface 3: 設定可能な機能を提供します。
21 */
22interface ConfigurableInterface
23{
24    public function configure(array $settings): void;
25}
26
27/**
28 * 複数のインターフェースを実装するクラスの例です。
29 * MyServiceはLoggerInterface, RunnableInterface, ConfigurableInterfaceの全ての契約を満たします。
30 */
31class MyService implements LoggerInterface, RunnableInterface, ConfigurableInterface
32{
33    public function log(string $message): void
34    {
35        echo "[LOG] " . $message . PHP_EOL;
36    }
37
38    public function run(): void
39    {
40        echo "[RUN] サービスが実行されました。" . PHP_EOL;
41    }
42
43    public function configure(array $settings): void
44    {
45        echo "[CONFIG] サービスが以下の設定で構成されました: " . json_encode($settings) . PHP_EOL;
46    }
47}
48
49// MyServiceクラスのインスタンスを作成します。
50$myService = new MyService();
51
52echo "--- クラス名 (文字列) を使用して実装インターフェースを取得 ---" . PHP_EOL;
53// class_implements関数を使用して、MyServiceクラスが実装しているインターフェースを調べます。
54// MyService::class は 'MyService' という文字列を返します。
55$implementedInterfacesByClassName = class_implements(MyService::class);
56
57if ($implementedInterfacesByClassName !== false) {
58    echo "クラス '" . MyService::class . "' が実装しているインターフェース:" . PHP_EOL;
59    foreach ($implementedInterfacesByClassName as $interfaceName) {
60        echo "- " . $interfaceName . PHP_EOL;
61    }
62} else {
63    echo "クラス '" . MyService::class . "' のインターフェース情報を取得できませんでした。" . PHP_EOL;
64}
65echo PHP_EOL;
66
67echo "--- オブジェクトインスタンスを使用して実装インターフェースを取得 ---" . PHP_EOL;
68// オブジェクトインスタンスを渡して、実装しているインターフェースを調べます。
69$implementedInterfacesByObject = class_implements($myService);
70
71if ($implementedInterfacesByObject !== false) {
72    echo "オブジェクト (クラス '" . get_class($myService) . "') が実装しているインターフェース:" . PHP_EOL;
73    foreach ($implementedInterfacesByObject as $interfaceName) {
74        echo "- " . $interfaceName . PHP_EOL;
75    }
76} else {
77    echo "オブジェクトのインターフェース情報を取得できませんでした。" . PHP_EOL;
78}
79
80echo PHP_EOL;
81
82// 実際にサービス機能を使ってみる例
83$myService->log("アプリケーション開始...");
84$myService->run();
85$myService->configure(['debug_mode' => true, 'port' => 8080]);
86$myService->log("アプリケーション終了。");
87
88?>

PHPのclass_implements関数は、指定されたクラスやオブジェクトがどのインターフェースを実装しているかを確認するための関数です。PHPでは、一つのクラスが複数のインターフェースを実装し、それぞれのインターフェースが定める契約（メソッドの定義）を全て満たすことができます。この関数は、引数としてクラス名を表す文字列、またはクラスのオブジェクトインスタンスのいずれかを受け取ります。戻り値は、実装されているインターフェースの完全修飾名がキーと値として含まれる連想配列です。もし、指定されたクラスがインターフェースを実装していない場合や、クラスが存在しない場合はfalseが返されます。

サンプルコードでは、MyServiceクラスがLoggerInterface、RunnableInterface、ConfigurableInterfaceという3つのインターフェースを実装しています。class_implements関数にMyService::class（クラス名を表す定数）を渡すと、このクラスが実装している全てのインターフェースの名前が配列として取得されます。同様に、MyServiceクラスのインスタンスである$myServiceを渡した場合でも、同じインターフェース情報が得られます。これにより、プログラムの実行中に、あるクラスやオブジェクトが特定の機能群（インターフェース）を提供しているかを動的に判断できるようになります。