【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 * Loggable インターフェース
5 * メッセージを記録する機能を持つことを示します。
6 */
7interface Loggable
8{
9    public function log(string $message): void;
10}
11
12/**
13 * SerializableData インターフェース
14 * データを文字列としてシリアル化する機能を持つことを示します。
15 */
16interface SerializableData
17{
18    public function serialize(): string;
19}
20
21/**
22 * User クラス
23 * Loggable と SerializableData の両方のインターフェースを実装します。
24 */
25class User implements Loggable, SerializableData
26{
27    private string $name;
28
29    public function __construct(string $name)
30    {
31        $this->name = $name;
32    }
33
34    public function log(string $message): void
35    {
36        echo "[LOG] User '{$this->name}': {$message}\n";
37    }
38
39    public function serialize(): string
40    {
41        return json_encode(['type' => 'User', 'name' => $this->name]);
42    }
43
44    public function getName(): string
45    {
46        return $this->name;
47    }
48}
49
50/**
51 * Guest クラス
52 * どのインターフェースも実装しません。
53 */
54class Guest
55{
56    public function sayHello(): void
57    {
58        echo "Hello from a Guest!\n";
59    }
60}
61
62echo "--- class_implements() の使用例 --- \n\n";
63
64// 1. クラス名を文字列で指定して、実装しているインターフェースを調べる
65
66echo "■ クラス名 'User' のインターフェース:\n";
67// User::class は 'User' という文字列を返すPHP 8の推奨形式です。
68$userClassImplements = class_implements(User::class);
69if (!empty($userClassImplements)) {
70    // class_implements は、インターフェース名をキーとした連想配列を返します。
71    echo "  実装しているインターフェース: " . implode(', ', array_keys($userClassImplements)) . "\n";
72} else {
73    echo "  実装しているインターフェースはありません。\n";
74}
75echo "\n";
76
77echo "■ クラス名 'Guest' のインターフェース:\n";
78$guestClassImplements = class_implements(Guest::class);
79if (!empty($guestClassImplements)) {
80    echo "  実装しているインターフェース: " . implode(', ', array_keys($guestClassImplements)) . "\n";
81} else {
82    echo "  実装しているインターフェースはありません。\n";
83}
84echo "\n";
85
86
87// 2. オブジェクトを渡して、実装しているインターフェースを調べる
88
89echo "■ User オブジェクトのインターフェース:\n";
90$userObject = new User("Alice");
91echo "  オブジェクトのクラス: " . get_class($userObject) . " (" . $userObject->getName() . ")\n";
92$userObjectImplements = class_implements($userObject);
93if (!empty($userObjectImplements)) {
94    echo "  実装しているインターフェース: " . implode(', ', array_keys($userObjectImplements)) . "\n";
95    // Loggableインターフェースを実装しているので、logメソッドを呼び出し可能
96    $userObject->log("Alice logged in.");
97} else {
98    echo "  実装しているインターフェースはありません。\n";
99}
100echo "\n";
101
102echo "■ Guest オブジェクトのインターフェース:\n";
103$guestObject = new Guest();
104echo "  オブジェクトのクラス: " . get_class($guestObject) . "\n";
105$guestObjectImplements = class_implements($guestObject);
106if (!empty($guestObjectImplements)) {
107    echo "  実装しているインターフェース: " . implode(', ', array_keys($guestObjectImplements)) . "\n";
108} else {
109    echo "  実装しているインターフェースはありません。\n";
110    $guestObject->sayHello();
111}
112echo "\n";
113
114// class_implements は、クラスが存在しない場合はFatal Errorとなりますが、
115// 存在しないクラス名を引数に渡してオートロードが有効な場合、
116// オートローダーがそのクラスを探そうとして失敗し、Fatal Errorを発生させるため、
117// 通常は空の配列が返る状況(実装インターフェースなし)を検証します。
118// ちなみに、`class_implements` が `false` を返すのは、引数にインターフェース名自体を渡した場合など、特殊なケースに限られます。
119?>

class_implements関数は、指定されたクラスやオブジェクトがどのインターフェースを実装しているかを調べるためのPHP 8の機能です。システムエンジニアを目指す方にとって、オブジェクトが特定の機能を持つことを実行時に確認できるため、柔軟なプログラム設計に役立ちます。

この関数は、第一引数に調べたいクラスの文字列名（例: User::class）またはそのクラスのインスタンス（オブジェクト）を受け取ります。

戻り値は、実装しているインターフェースの情報を示す配列、または特定のケースでfalseです。 具体的には、クラスが一つ以上のインターフェースを実装している場合、そのインターフェース名をキーとした連想配列が返されます。例えば、サンプルコードのUserクラスはLoggableとSerializableDataインターフェースを実装しているため、これらのインターフェース名を含む配列が返されます。 もしどのインターフェースも実装していない場合は、空の配列が返されます。Guestクラスの例のように、実装インターフェースがない場合は空の配列が取得されます。 なお、引数にインターフェース名自体を渡すなどの特定の状況ではfalseが返されることがあります。

この関数を使用することで、オブジェクトが特定の機能（インターフェースで定義されたメソッド）を持っているかどうかを実行時に判断し、それに応じて安全かつ適切な処理を行うことが可能になります。

Copy
1<?php
2
3/**
4 * MyIteratorClass は Iterator インターフェースを実装します。
5 * これにより、このクラスのオブジェクトを foreach ループで反復できるようになります。
6 * class_implements 関数でこの実装が検出されることを確認するために使用します。
7 */
8class MyIteratorClass implements Iterator
9{
10    private int $position = 0;
11    private array $data = ['Apple', 'Banana', 'Cherry'];
12
13    // イテレータを巻き戻す (先頭に戻す) メソッド
14    public function rewind(): void
15    {
16        $this->position = 0;
17    }
18
19    // 現在の要素を返すメソッド
20    public function current(): string
21    {
22        return $this->data[$this->position];
23    }
24
25    // 現在のキーを返すメソッド
26    public function key(): int
27    {
28        return $this->position;
29    }
30
31    // 次の要素に進むメソッド
32    public function next(): void
33    {
34        ++$this->position;
35    }
36
37    // 現在の要素が有効かどうかをチェックするメソッド
38    public function valid(): bool
39    {
40        return isset($this->data[$this->position]);
41    }
42}
43
44/**
45 * MyNormalClass はどのインターフェースも実装しません。
46 * class_implements 関数でインターフェースが検出されないことを確認するために使用します。
47 */
48class MyNormalClass
49{
50    public string $message = "これは通常のクラスです。";
51}
52
53// --- class_implements 関数の使用例 ---
54
55echo "### MyIteratorClass のインターフェースチェック ###\n";
56
57// class_implements() 関数は、指定されたクラスが実装しているインターフェースのリストを配列で返します。
58// クラス名には MyIteratorClass::class のように定数を使用するのが推奨されます。
59$implementedInterfacesIterator = class_implements(MyIteratorClass::class);
60
61if ($implementedInterfacesIterator === false) {
62    echo "エラー: MyIteratorClass のインターフェース情報を取得できませんでした。\n";
63} elseif (empty($implementedInterfacesIterator)) {
64    echo "MyIteratorClass はどのインターフェースも実装していません。\n";
65} else {
66    echo "MyIteratorClass が実装しているインターフェース:\n";
67    foreach ($implementedInterfacesIterator as $interface) {
68        echo "- " . $interface . "\n";
69    }
70
71    // 取得したインターフェースのリストに 'Iterator' が含まれているかを確認します。
72    if (in_array(Iterator::class, $implementedInterfacesIterator)) {
73        echo "→ MyIteratorClass は 'Iterator' インターフェースを実装しています！\n";
74    } else {
75        echo "→ MyIteratorClass は 'Iterator' インターフェースを実装していません。\n";
76    }
77}
78
79echo "\n### MyNormalClass のインターフェースチェック ###\n";
80
81// MyNormalClass が実装しているインターフェースを取得します。
82$implementedInterfacesNormal = class_implements(MyNormalClass::class);
83
84if ($implementedInterfacesNormal === false) {
85    echo "エラー: MyNormalClass のインターフェース情報を取得できませんでした。\n";
86} elseif (empty($implementedInterfacesNormal)) {
87    echo "MyNormalClass はどのインターフェースも実装していません。\n";
88    // Iterator インターフェースが含まれていないことを確認します。
89    if (in_array(Iterator::class, $implementedInterfacesNormal)) {
90        echo "→ MyNormalClass は 'Iterator' インターフェースを実装しています！\n";
91    } else {
92        echo "→ MyNormalClass は 'Iterator' インターフェースを実装していません。\n";
93    }
94} else {
95    echo "MyNormalClass が実装しているインターフェース:\n";
96    foreach ($implementedInterfacesNormal as $interface) {
97        echo "- " . $interface . "\n";
98    }
99
100    // Iterator インターフェースが含まれていないことを確認します。
101    if (in_array(Iterator::class, $implementedInterfacesNormal)) {
102        echo "→ MyNormalClass は 'Iterator' インターフェースを実装しています！\n";
103    } else {
104        echo "→ MyNormalClass は 'Iterator' インターフェースを実装していません。\n";
105    }
106}

PHP 8のclass_implements関数は、特定のクラスがどのインターフェースを実装しているかを動的に調べるために使われます。この関数は、引数としてオブジェクトまたはクラス名を文字列で受け取ります。戻り値は、そのクラスが実装しているインターフェースの完全修飾名を要素とする配列です。もしインターフェースを一つも実装していなければ空の配列を、処理に失敗した場合はfalseを返します。

サンプルコードでは、MyIteratorClassがIteratorインターフェースを実装しており、class_implements(MyIteratorClass::class)はこのインターフェース名を含む配列を返します。Iteratorインターフェースを実装することで、そのクラスのオブジェクトをforeach文で反復処理できるようになります。対照的に、MyNormalClassはどのインターフェースも実装していないため、class_implements(MyNormalClass::class)は空の配列を返します。このように、class_implements関数を利用することで、クラスの特性や利用可能な機能をプログラムの実行中に確認し、適切な処理を分岐させることが可能になります。

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を渡した場合でも、同じインターフェース情報が得られます。これにより、プログラムの実行中に、あるクラスやオブジェクトが特定の機能群（インターフェース）を提供しているかを動的に判断できるようになります。