Interfaces

Les interfaces d'objets permettent de créer du code qui spécifie quelles méthodes et propriétés une classe doit implémenter, sans avoir à définir comment ces méthodes ou propriétés sont implémentées. Les interfaces partagent un espace de noms avec les classes, traits et énumérations, de sorte qu'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és 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 utilise.
Pour permettre à une fonction ou méthode d'accepter et opérer sur un paramètre qui se 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ée.

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. Avant PHP 8.1.0, elles ne peuvent pas être redéfinies par une classe/interface qui les hérite.

Propriétés

À partir de PHP 8.4.0, les interfaces peuvent également déclarer des propriétés. Si elles le font, la déclaration doit spécifier si la propriété est lisible, modifiable, ou les deux. La déclaration de l'interface s'applique uniquement à l'accès en lecture et en écriture publics.

Une classe peut satisfaire une propriété d'interface de plusieurs façons. Elle peut définir une propriété publique. Elle peut définir une propriété publique virtuelle qui implémente uniquement le hook correspondant. Ou une propriété en lecture peut être satisfaite par une propriété readonly. Cependant, une propriété d'interface qui est modifiable ne peut pas être readonly.

Exemple #1 Exemple de propriétés d'interface

<?php
interface I
{
    // Une classe implémentant cette interface DOIT avoir une propriété publiquement lisible,
    // mais que celle-ci soit ou non modifiable publiquement n'est pas restreint.
    public string $readable { get; }

    // Une classe implémentant cette interface DOIT avoir une propriété publiquement modifiable,
    // mais que celle-ci soit ou non lisible publiquement n'est pas restreint.
    public string $writeable { set; }

    // Une classe implémentant cette interface DOIT avoir une propriété qui est à la fois publiquement
    // lisible et publiquement modifiable.
    public string $both { get; set; }
}

// Cette classe implémente les trois propriétés comme des propriétés traditionnelles, sans hooks.
// C'est tout à fait valide.
class C1 implements I
{
    public string $readable;

    public string $writeable;

    public string $both;
}

// Cette classe implémente les trois propriétés en utilisant uniquement les hooks
// demandés. Cela est également tout à fait valide.
class C2 implements I
{
    private string $written = '';
    private string $all = '';

    // Utilise uniquement un hook get pour créer une propriété virtuelle.
    // Cela satisfait l'exigence "get public".
    // Elle n'est pas modifiable, mais cela n'est pas exigé par l'interface.
    public string $readable { get => strtoupper($this->writeable); }

    // L'interface exige uniquement que la propriété soit modifiable,
    // mais inclure des opérations get est également tout à fait valide.
    // Cet exemple crée une propriété virtuelle, ce qui est acceptable.
    public string $writeable {
        get => $this->written;
        set {
            $this->written = $value;
        }
    }

    // Cette propriété nécessite que la lecture et l'écriture soient possibles,
    // nous devons donc soit implémenter les deux, soit permettre le comportement par défaut.
    public string $both {
        get => $this->all;
        set {
            $this->all = strtoupper($value);
        }
    }
}
?>

Exemples

Exemple #2 Exemple d'interface

<?php

// Déclaration 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
// Erreur fatale : 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 #3 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 #4 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 #5 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 #6 Interfaces avec des constantes

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

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


class B implements A
{
    const B = 'Constante de classe';
}

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

Exemple #7 Les interfaces avec les classes abstraites

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

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

// Une classe abstraite peut implémenter seulement une partie de l'interface.
// Les classes qui étendent la classe abstraite doivent implémenter le reste.
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 #8 Étendant et implémentant simultanément

<?php

class One
{
    /* ... */
}

interface Usable
{
    /* ... */
}

interface Updatable
{
    /* ... */
}

// L'ordre des mots-clés ici est important. 'extends' doit venir en premier.
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.