PHP: Welche Interfaces implementiert eine Klasse

Auf Phpmonkeys ist letzte Woche ein Artikel über Marker Interfaces erschienen, der einem kurz die Idee dahinter erläutert und wie man sie am Beispiel eines Caches nutzen kann.

Ich selber nutze Marker Interfaces in verschiedenen Projekten um darüber zu bestimmen, ob ein bestimmtes Feature für ein Objekt zur Verfügung steht. Ich vereinfache damit u.a. die Generierung des Administrations Oberfläche. Aber wie bekommt man heraus, welche Interfaces eine Klasse implementiert?

Wir haben die Möglichkeit über instanceof und is_a zu prüfen ob eine bestimmtes Interface implementiert wird, oder wir lassen uns von den Reflection Klassen, die seit PHP 5.0 zur Verfügung stehen, alle implementierten Interfaces zurückgeben.

Unsere Testobjekte

interface AdminFeature
{
 
}
 
class Admin implements AdminFeature
{
 
}
 
$objAdmin = new Admin();

Instanz der Reflection Klasse erzeugen

$objReflection = new ReflectionClass('Admin');
 
// Oder direkt vom Objekt
// $objReflection = new ReflectionClass($objAdmin);

Die Reflection Klasse enthält die Methoden getInterfaceNames und getInterfaces, die uns alle genutzten Interfaces zurückgeben. Möchten wir auf ein bestimmtes Interface prüfen, stehen uns die Methode implementsInterface bzw. die Prüfung mittels instanceof und is_a zur Verfügung.

getInterfaceNames

getInterfaceNames gibt uns ein Array mit den Namen der Interfaces zurück.

$arrResult = $objReflection->getInterfaceNames();
 
/*
array(1) {
  [0]=>
  string(12) "AdminFeature"
}
*/

getInterfaces

getInterfaces gibt uns ein Array mit allen Interfaces zurück. Die Elemente des Arrays enthalten für jedes Interface ein Objekt der Relection Klasse.

$arrResult = $objReflection->getInterfaces();
 
/*
array(1) {
  ["AdminFeature"]=>
  &object(ReflectionClass)#3 (1) {
    ["name"]=>
    string(12) "AdminFeature"
  }
}
*/

implementsInterface, instanceof und is_a

Haben wir ein Objekt der Klasse erzeugt, können wir instanceof und is_a nutzen um herauszufinden, ob die gewünschte Klasse implementiert wird. Der Weg über die Reflection Klasse ist hier nicht nötig.

Möchten wir vor der Erzeugung des Objekts herausfinden, ob ein Interface implementiert wird, können wir die Methode implementsInterface unseres Reflection Objekts nutzen.

$boolReturn = $objReflection->implementsInterface('AdminFeature');
// bool(true)
$boolReturn = $objAdmin instanceof AdminInterface;
// bool(true)
$boolReturn = is_a($objAdmin, 'AdminInterface');
// bool(true)

is_a ist seit PHP 5.3 übrigens nicht mehr als deprecated markiert.

Über Reflection kann man aber mehr als nur die Interfaces ermitteln. Wer möchte kann sich z.B. die Kommentare zurückgeben lassen und über diese z.B Annotations implementieren. Ein Blick ins PHP Handbuch lohnt sich.