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().

Смотрите также

class_parents() - Возвращает список родительских классов заданного класса
get_declared_interfaces() - Возвращает массив всех объявленных интерфейсов
is_a() - Проверяет, принадлежит ли объект к типу или подтипу
instanceof

add a note

User Contributed Notes 4 notes

down

ludvig dot ericson at gmail dot nospam dot com ¶

19 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.

down

a dot panek at brainsware dot org ¶

11 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.

down

trollll23 at yahoo dot com ¶

19 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
    )

down

-10

sam at rmcreative dot ru ¶

5 years ago


The order of interfaces is not reliable and varies between PHP versions.

add a note