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:
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.
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.
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.
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);
}
}
}
?>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.
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;
?>Just as all interface methods are public, all interface methods are abstract as well.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.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