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.
Eine Klasse kann nur dann zwei Interfaces implementieren, die eine Methode mit demselben Namen definieren, wenn die Methodendeklaration in beiden Interfaces identisch ist.
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. Vor PHP 8.1.0 können sie nicht von einer Klasse/Schnittstelle überschrieben werden, die sie erbt.
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 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 #3 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 #4 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 #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 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 #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 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.