PHP 7.4.24 Released!

Objekt-Interfaces (Schnittstellen)

Objekt-Interfaces ermöglichen die Erzeugung von Code, der spezifiziert, welche Methoden eine Klasse implementieren muss, ohne definieren zu müssen, wie diese Methoden implementiert werden. Interfaces teilen sich einen Namensraum mit Klassen und Traits, 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 kann nur dann zwei Interfaces implementieren, die eine Methode mit demselben Namen definieren, wenn die Methodendeklaration in beiden Interfaces identisch ist.

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:

Ein Interface kann ebenso wie eine Klasse mit Hilfe des Operators extends erweitert werden.

Hinweis:

Die Klasse, die das Interface implementiert, muss alle Methoden des Interfaces mit einer kompatiblen Signatur deklarieren.

Konstanten

Ein Interface kann Konstanten definieren. Interface-Konstanten funktionieren genauso wie Klassenkonstanten, außer dass sie von anderen Interfaces oder Klassen, die von diesem Interface erben, nicht verändert werden können.

Beispiele

Beispiel #1 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 #2 Erweiterbare Interfaces

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

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

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

    public function 
baz(Baz $baz)
    {
    }
}

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

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

Beispiel #3 Interface-Mehrfachvererbung

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

interface 
B
{
    public function 
bar();
}

interface 
extends AB
{
    public function 
baz();
}

class 
implements C
{
    public function 
foo()
    {
    }

    public function 
bar()
    {
    }

    public function 
baz()
    {
    }
}
?>

Beispiel #4 Interfaces mit Konstanten

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

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

// Der folgende Abschnitt wird nicht funktionieren, da
// ein Überschreiben der Konstanten nicht gestattet ist.
class implements A
{
    const 
'Class-Konstante';
}
?>

Beispiel #5 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 implements A
{
    public function 
foo(string $s): string
    
{
        return 
$s PHP_EOL;
    }
}

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

Beispiel #6 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 UsableUpdatable
{
    
/* ... */
}
?>

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.

add a note add a note

User Contributed Notes 3 notes

up
18
thanhn2001 at gmail dot com
10 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;
?>
up
1
williebegoode at att dot net
7 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.
up
-1
xedin dot unknown at gmail dot com
6 months 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
To Top