Objekt-Interfaces (Schnittstellen)

Objekt-Interfaces ermöglichen die Erzeugung von Code, der spezifiziert, welche Methoden und Eigenschaften eine Klasse implementieren muss, ohne definieren zu müssen, wie diese Methoden und Eigenschaften implementiert werden. Interfaces teilen sich einen Namensraum mit Klassen, Traits und Aufzählungen (Enums), daher dürfen sie nicht denselben Namen verwenden.

Interfaces werden auf dieselbe Weise wie eine Klasse definiert, aber mit dem Schlüsselwort interface anstatt des Schlüsselworts class, und ohne, dass eine der Methoden ihren Inhalt definiert.

Alle in einem Interface deklarierten Methoden müssen public sein; dies liegt in der Natur eines Interfaces.

In der Praxis erfüllen die Interfaces zwei sich ergänzende Zwecke:

Um Entwicklern zu ermöglichen, Objekte verschiedener Klassen zu erstellen, die austauschbar verwendet werden können, weil sie das gleiche Interface oder die gleichen Interfaces implementieren. Ein häufiges Beispiel sind mehrere Dienste für den Datenbankzugriff, mehrere Zahlungs-Gateways oder unterschiedliche Caching-Strategien. Verschiedene Implementierungen können ausgetauscht werden, ohne dass Änderungen am Code vorgenommen werden müssen, der sie verwendet.
Um einer Funktion oder Methode zu ermöglichen, einen Parameter zu akzeptieren und zu bearbeiten, der der mit einem Interface konform ist, ohne sich darum zu kümmern, was das Objekt sonst noch tun kann oder wie es implementiert ist. Diese Interfaces werden oft benannt als Iterable, Cacheable, Renderable, oder so weiter, um die Bedeutung des des Verhaltens zu beschreiben.

Interfaces können magische Methoden definieren, um implementierende Klassen zu zwingen, diese Methoden zu implementieren.

Hinweis:
Obwohl diese unterstützt werden, wird von der Aufnahme von Konstruktoren in Interfaces dringend abgeraten. Dadurch wird die Flexibilität der Objekte, die das Interface implementieren, drastisch eingeschränkt. Außerdem werden Konstruktoren nicht durch Vererbungsregeln erzwungen, was zu Inkonsistenzen und unerwartetem Verhalten führen kann.

`implements`

Um ein Interface zu implementieren, wird der Operator implements benutzt. Alle Methoden des Interfaces müssen innerhalb der Klasse implementiert werden, andernfalls führt dies zu einem schwerwiegenden Fehler. Klassen dürfen, falls dies gewünscht wird, mehr als ein Interface implementieren, indem man die Interfaces mit einem Komma voneinander trennt.

Warnung

Eine Klasse, die ein Interface implementiert, kann für ihre Parameter einen anderen Namen verwenden als das Interface. Seit PHP 8.0 unterstützt die Sprache benannte Argumente, was bedeutet, dass sich der Aufrufende auf den Parameternamen im Interface verlassen kann. Aus diesem Grund wird dringend empfohlen, dass Entwickler die gleichen Parameternamen verwenden wie das zu implementierende Interface.

Hinweis:
Eine Schnittstelle kann ebenso wie eine Klasse mit Hilfe des Operators extends erweitert werden.

Hinweis:
Die Klasse, die die Schnittstelle implementiert, muss alle Methoden der Schnittstelle mit einer kompatiblen Signatur deklarieren. Eine Klasse kann mehrere Schnittstellen implementieren, die eine Methode mit demselben Namen deklarieren. In diesem Fall muss die Implementierung die Regeln für die Signaturkompatibilität für alle Schnittstellen befolgen. Auf diese Weise können Kovarianz und Kontravarianz angewendet werden.

Konstanten

Eine Schnittstelle kann Konstanten definieren. Schnittstellen-Konstanten funktionieren genauso wie Klassenkonstanten. Vor PHP 8.1.0 können sie nicht von einer Klasse/Schnittstelle überschrieben werden, die sie erbt.

Eigenschaften

Seit PHP 8.4.0 können Schnittstellen auch Eigenschaften deklarieren. In diesem Fall muss die Deklaration angeben, ob die Eigenschaft lesbar, schreibbar oder beides sein soll. Die Deklaration der Schnittstelle gilt nur für den öffentlichen Lese- und Schreibzugriff.

Eine Klasse kann eine Schnittstelleneigenschaft auf mehrere Arten erfüllen. Sie kann eine öffentliche Eigenschaft definieren. Sie kann eine öffentliche virtuelle Eigenschaft definieren, die nur den entsprechenden Hook implementiert. Oder eine lesbare Eigenschaft kann durch eine readonly-Eigenschaft erfüllt werden. Eine Schnittstelleneigenschaft, die gesetzt werden kann, kann jedoch nicht readonly sein.

Beispiel #1 Beispiel für Schnittstelleneigenschaften

<?php
interface I
{
    // Eine implementierende Klasse MUSS eine öffentlich lesbare Eigenschaft
    // haben, wobei es keine Rolle spielt, ob sie öffentlich gesetzt werden kann.
    public string $readable { get; }

    // Eine implementierende Klasse MUSS eine öffentlich schreibbare Eigenschaft
    // haben, wobei es keine Rolle spielt, ob sie öffentlich lesbar ist oder nicht.
    public string $writeable { set; }

    // Eine implementierende Klasse MUSS eine Eigenschaft haben, die sowohl
    // öffentlich lesbar als auch öffentlich schreibbar ist.
    public string $both { get; set; }
}

// Diese Klasse implementiert alle drei Eigenschaften als konventionelle, nicht
// eingehängte Eigenschaften. Dies ist absolut gültig.
class C1 implements I
{
    public string $readable;

    public string $writeable;

    public string $both;
}

// Diese Klasse implementiert alle drei Eigenschaften, indem sie nur die
// angeforderten Hooks verwendet. Dies ist auch absolut gültig.
class C2 implements I
{
    private string $written = '';
    private string $all = '';

    // Verwendet nur einen get-Hook, um eine virtuelle Eigenschaft zu erstellen.
    // Damit wird die Anforderung "public get" erfüllt.
    // Sie ist nicht schreibbar, aber das ist für die Schnittstelle nicht
    // erforderlich.
    public string $readable { get => strtoupper($this->writeable); }

    // Die Schnittstelle verlangt nur, dass die Eigenschaft gesetzt werden
    // kann, aber auch get-Operationen sind absolut zulässig.
    // Dieses Beispiel erzeugt eine virtuelle Eigenschaft, was in Ordnung ist.
    public string $writeable {
        get => $this->written;
        set {
            $this->written = $value;
        }
    }

    // Diese Eigenschaft verlangt, dass sowohl Lesen als auch Schreiben
    // möglich ist, sodass entweder beides implementiert werden muss
    // oder das Standardverhalten beibehalten werden kann.
    public string $both {
        get => $this->all;
        set {
            $this->all = strtoupper($value);
        }
    }
}
?>

Beispiele

Beispiel #2 Interface-Beispiel

<?php
// Deklariere das Interface 'Template'
interface Template
{
    public function setVariable($name, $var);
    public function getHtml($template);
}

// Implementiere das Interface
// Dies funktioniert
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;
    }
}

// Dies wird nicht funktionieren
// 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;
    }
}
?>

Beispiel #3 Erweiterbare Interfaces

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

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

// Dies Funktioniert
class C implements B
{
    public function foo()
    {
    }

    public function baz(Baz $baz)
    {
    }
}

// Dies funktioniert nicht und führt zu einem schwerwiegenden Fehler
class D implements B
{
    public function foo()
    {
    }

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

Beispiel #4 Varianzkompatibilität mit mehreren Schnittstellen

<?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();
    }
}
?>

Beispiel #5 Interface-Mehrfachvererbung

<?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()
    {
    }
}
?>

Beispiel #6 Interfaces mit Konstanten

<?php
interface A
{
    const B = 'Interface-Konstante';
}

// Ausgabe: Interface-Konstante
echo A::B;

class B implements A
{
    const B = 'Klassen-Konstante';
}

// Ausgabe: Klassen-Konstante
// Vor PHP 8.1.0 funktioniert dies allerdings nicht, da es nicht erlaubt
// war, Konstanten zu überschreiben.
echo B::B;
?>

Beispiel #7 Interfaces mit abstrakten Klassen

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

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

// Eine abstrakte Klasse muss ein Interface nicht komplett implementieren.
// Klassen, die die abstrakte Klasse erweitern, müssen den Rest implementieren.
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;
    }
}
?>

Beispiel #8 Gleichzeitiges Erweitern und Implementieren

<?php

class One
{
    /* ... */
}

interface Usable
{
    /* ... */
}

interface Updatable
{
    /* ... */
}

// Die Reihenfolge der Schlüsselwörter ist hier wichtig. 'extends' muss an
// erster Stelle stehen.
class Two extends One implements Usable, Updatable
{
    /* ... */
}
?>

Ein Interface bietet in Verbindung mit Typ-Deklarationen eine gute Möglichkeit, um sicherzustellen, dass ein bestimmtes Objekt bestimmte Methoden enthält. Siehe instanceof-Operator und Typdeklarationen.