class_implements

(PHP 5, PHP 7, PHP 8)

class_implements — Retourne les interfaces implémentées par une classe ou une interface donnée

Description

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

Cette fonction retourne un tableau avec les noms des interfaces que la classe object_or_class ainsi que ses parents implémentent.

Liste de paramètres

object_or_class: Un objet (instance) ou une chaîne de caractères (nom de la classe ou de l'interface).
autoload: Défini s'il faut autocharger si pas déjà autochargé.

Valeurs de retour

Un tableau en cas de succès, ou false quand la classe donnée n'existe pas.

Exemples

Exemple #1 Exemple avec class_implements()

<?php

interface foo { }
class bar implements foo {}

print_r(class_implements(new bar));

// vous pouvez aussi spécifier le paramètre comme une chaîne de caractères
print_r(class_implements('bar'));

spl_autoload_register();

// Utilisation de l'autoloading pour charger la classe 'not_loaded'
print_r(class_implements('not_loaded', true));

?>

Résultat de l'exemple ci-dessus est similaire à :

Array
(
    [foo] => foo
)
Array
(
    [foo] => foo
)
Array
(
    [interface_de_non_chargée] => interface_de_non_chargée
)

Notes

Note: Il est préférable d'utiliser instanceof ou la fonction is_a() pour vérifier qu'un objet implémente une interface.

Voir aussi

class_parents() - Retourne les classes parentes d'une classe
get_declared_interfaces() - Retourne un tableau avec toutes les interfaces déclarées
is_a() - Vérifie si l'objet est d'un certain type ou sous-type.
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 ¶

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.

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