class_implements

(PHP 5, PHP 7, PHP 8)

class_implements 与えられたクラスあるいはインターフェイスが実装しているインターフェイスを返す

説明

class_implements(object|string $object_or_class, bool $autoload = true): array|false

この関数は、与えられたクラス object_or_class とその親が実装しているインターフェイスを配列で返します。

パラメータ

object_or_class

オブジェクト (クラスのインスタンス) もしくは文字列 (クラス名あるいはインターフェイス名) を指定します。

autoload

まだロードされていない場合に オートロード するかどうか。

戻り値

成功した場合に配列、 指定されたクラスが存在しない場合に false を返します。

例1 class_implements() の例

<?php

interface foo { }
class
bar implements foo {}

print_r(class_implements(new bar));

// パラメータを文字列として指定しても良い
print_r(class_implements('bar'));

spl_autoload_register();

// 'not_loaded' クラスをロードするためにオートローディングを使用する
print_r(class_implements('not_loaded', true));

?>

上の例の出力は、 たとえば以下のようになります。

Array
(
    [foo] => foo
)
Array
(
    [foo] => foo
)
Array
(
    [interface_of_not_loaded] => interface_of_not_loaded
)

注意

注意: オブジェクトが、インターフェイスを実装しているかどうかを調べるには、 instanceof か、is_a() 関数を代わりに使うべきです。

参考

add a note

User Contributed Notes 4 notes

up
15
ludvig dot ericson at gmail dot nospam dot com
18 years ago
Hint:
<?php
in_array
("your-interface", class_implements($object_or_class_name));
?>
would check if 'your-interface' is ONE of the implemented interfaces.
Note that you can use something similar to be sure the class only implements that, (whyever you would want that?)
<?php
array("your-interface") == class_implements($object_or_class_name);
?>

I use the first technique to check if a module has the correct interface implemented, or else it throws an exception.
up
10
a dot panek at brainsware dot org
10 years ago
Calling class_implements with a non-loadable class name or a non-object results in a warning:

<?php
// Warning: class_implements(): Class abc does not exist and could not be loaded in /home/a.panek/Projects/sauce/lib/Sauce/functions.php on line 196

$interfaces = class_implements('abc');
?>

This is not documented and should just return FALSE as the documentation above says.
up
3
trollll23 at yahoo dot com
18 years ago
Luckily, it prints out superinterfaces as well in reverse order so iterative searching works fine:

<?php

interface InterfaceA { }

interface
InterfaceB extends InterfaceA { }

class
MyClass implements InterfaceB { }

print_r(class_implements(new MyClass()));

?>

prints out:

Array
(
[InterfaceB] => InterfaceB
[InterfaceA] => InterfaceA
)
up
-12
sam at rmcreative dot ru
4 years ago
The order of interfaces is not reliable and varies between PHP versions.
To Top