PHP: Interfaces

Interfaces

Les interfaces objet vous permettent de créer du code qui spécifie quelles méthodes une classe doit implémenter, sans avoir à définir comment ces méthodes fonctionneront. Les interfaces partagent l'espace de nom avec les classes et les traits, donc elles ne peuvent pas utiliser le même nom.

Les interfaces sont définies de la même façon que pour une classe, mais en utilisant le mot-clé interface à la place de class, et sans qu'aucune des méthodes n'ait son contenu de spécifié.

De par la nature même d'une interface, toutes les méthodes déclarées dans une interface doivent être publiques.

En pratique les interfaces servent deux rôles complémentaires :

Permettre aux développeurs de créer des objets de classes différentes qui peuvent être utilisé de façon interchangeable, car elles implémentent la ou les mêmes interfaces. Un exemple commun sont plusieurs services d'accès à des bases de données, plusieurs gestionnaires de paiement ou différentes stratégies de cache. Différentes implémentations peuvent être échangées sans nécessiter des changements dans le code qui les utilisent.
Pour permettre à une fonction ou méthode d'accepter et opérer sur un paramètre qui conforme à une interface, sans se soucier de quoi d'autre l'objet peut faire ou comment c'est implémenté. Ces interfaces sont souvent nommées Iterable, Cacheable, Renderable, etc. pour décrire la signification de leur comportement.

Les interfaces peuvent définir des méthodes magiques pour obliger les classes implémentant à implémenter ces méthodes.

Note:
Bien que cela soit supporté, inclure les constructeurs dans les interfaces est fortement déconseillé. Le faire réduit radicalement la flexibilité des objets implémentant l'interface. De plus, les constructeurs ne sont pas soumis aux règles d'héritage, ce qui peut causer des incohérences et des comportements inattendus.

`implements`

Pour implémenter une interface, l'opérateur implements est utilisé. Toutes les méthodes de l'interface doivent être implémentées dans une classe ; si ce n'est pas le cas, une erreur fatale sera émise. Les classes peuvent implémenter plus d'une interface, en séparant chaque interface par une virgule.

Avertissement

Une classe qui implémente une interface peut utiliser des noms différents pour ses paramètres que l'interface. Cependant, à partir de PHP 8.0, le langage supporte les arguments nommés, ce qui signifie que l'appeleur peut dépendre du nom du paramètre dans l'interface. Pour cette raison, il est fortement recommandé que les développeurs utilisent le même nom de paramètre que dans l'interface qui est implémenté.

Note:
Les interfaces peuvent être étendues comme des classes, en utilisant l'opérateur extends

Note:
La classe implémentant l'interface doit déclarer toutes les méthodes dans l'interface avec une signature compatible. Une classe peut implémenter deux interfaces qui définissent une méthode avec le même nom. Dans ce cas, l'implémentation doit suivre les règles de compatibilité des signatures pour toutes les interfaces. Ainsi, la covariance et la contravariance peuvent être appliquées.

Les constantes

Les interfaces peuvent contenir des constantes. Les constantes d'interfaces fonctionnent exactement comme les constantes de classe. Antérieur à PHP 8.1.0, elles ne peuvent pas être redéfinies par une classe/interface qui les hérite.

Exemples

Exemple #1 Exemple d'interface

<?php

// Declaration de l'interface 'Template'
interface Template
{
    public function setVariable($name, $var);
    public function getHtml($template);
}

// Implémentation de l'interface
// Ceci va fonctionner
class WorkingTemplate implements Template
{
    private $vars = [];

    public function setVariable($name, $var)
    {
        $this->vars[$name] = $var;
    }

    public function getHtml($template)
    {
        foreach($this->vars as $name => $value) {
            $template = str_replace('{' . $name . '}', $value, $template);
        }

        return $template;
    }
}

// Ceci ne fonctionnera pas
// Fatal error: Class BadTemplate contains 1 abstract methods
// and must therefore be declared abstract (Template::getHtml)
class BadTemplate implements Template
{
    private $vars = [];

    public function setVariable($name, $var)
    {
        $this->vars[$name] = $var;
    }
}
?>

Exemple #2 Les interfaces extensibles

<?php
interface A
{
    public function foo();
}

interface B extends A
{
    public function baz(Baz $baz);
}

// Ceci fonctionnera
class C implements B
{
    public function foo()
    {
    }

    public function baz(Baz $baz)
    {
    }
}

// Ceci ne fonctionnera pas et entrainera une erreur fatale
class D implements B
{
    public function foo()
    {
    }

    public function baz(Foo $foo)
    {
    }
}
?>

Exemple #3 Compatibilité de la variance avec plusieurs interfaces

<?php
class Foo {}
class Bar extends Foo {}

interface A {
    public function myfunc(Foo $arg): Foo;
}

interface B {
    public function myfunc(Bar $arg): Bar;
}

class MyClass implements A, B
{
    public function myfunc(Foo $arg): Bar
    {
        return new Bar();
    }
}
?>

Exemple #4 Héritage de plusieurs interfaces

<?php
interface A
{
    public function foo();
}

interface B
{
    public function bar();
}

interface C extends A, B
{
    public function baz();
}

class D implements C
{
    public function foo()
    {
    }

    public function bar()
    {
    }

    public function baz()
    {
    }
}
?>

Exemple #5 Interfaces avec des constantes

<?php
interface A
{
    const B = 'Constante de l\'interface';
}

// Affiche : Constante de l'interface
echo A::B;


// Par contre, ceci ne fonctionnera pas, puisqu'il n'est pas permis
// d'écraser des constantes.
class B implements A
{
    const B = 'Constante de classe';
}

// Affiche : Constante de classe
// Antérieur à PHP 8.1.0, ceci ne fonctionnera pas, puisqu'il n'était pas permis
// de redéfinir des constantes.
echo B::B;
?>

Exemple #6 Les interfaces avec les classes abstraites

<?php
interface A
{
    public function foo(string $s): string;

    public function bar(int $i): int;
}

// An abstract class may implement only a portion of an interface.
// Classes that extend the abstract class must implement the rest.
abstract class B implements A
{
    public function foo(string $s): string
    {
        return $s . PHP_EOL;
    }
}

class C extends B
{
    public function bar(int $i): int
    {
        return $i * 2;
    }
}
?>

Exemple #7 Étendant et implémentant simultanément

<?php

class One
{
    /* ... */
}

interface Usable
{
    /* ... */
}

interface Updatable
{
    /* ... */
}

// The keyword order here is important. 'extends' must come first.
class Two extends One implements Usable, Updatable
{
    /* ... */
}
?>

Une interface, avec les déclarations de types, fournit une bonne manière pour s'assurer qu'un objet particulier contient des méthodes particulières. Voir l'opérateur instanceof et les déclarations de type.

add a note

User Contributed Notes 4 notes

down

thanhn2001 at gmail dot com ¶

13 years ago


PHP prevents interface a contant to be overridden by a class/interface that DIRECTLY inherits it.  However, further inheritance allows it.  That means that interface constants are not final as mentioned in a previous comment.  Is this a bug or a feature?

<?php

interface a
{
    const b = 'Interface constant';
}

// Prints: Interface constant
echo a::b;

class b implements a
{
}

// This works!!!
class c extends b
{
    const b = 'Class constant';
}

echo c::b;
?>

down

vcnbianchi ¶

2 years ago


Just as all interface methods are public, all interface methods are abstract as well.

down

williebegoode at att dot net ¶

10 years ago


In their book on Design Patterns, Erich Gamma and his associates (AKA: "The Gang of Four") use the term "interface" and "abstract class" interchangeably. In working with PHP and design patterns, the interface, while clearly a "contract" of what to include in an implementation is also a helpful guide for both re-use and making changes. As long as the implemented changes follow the interface (whether it is an interface or abstract class with abstract methods), large complex programs can be safely updated without having to re-code an entire program or module.

In PHP coding with object interfaces (as a keyword) and "interfaces" in the more general context of use that includes both object interfaces and abstract classes, the purpose of "loose binding" (loosely bound objects) for ease of change and re-use is a helpful way to think about both uses of the  term "interface." The focus shifts from "contractual" to "loose binding" for the purpose of cooperative development and re-use.

down

xedin dot unknown at gmail dot com ¶

3 years ago


This page says that if extending multiple interfaces with the same methods, the signature must be compatible. But this is not all there is to it: the order of `extends` matters. This is a known issue, and while it is disputable whether or not it is a bug, one should be aware of it, and code interfaces with this in mind.

https://bugs.php.net/bug.php?id=67270
https://bugs.php.net/bug.php?id=76361
https://bugs.php.net/bug.php?id=80785

add a note