Fluent Interface

Verfasst von benjamin am 15. Mai 2008 - 22:02

Fluent Interfaces (fließende Schnittstellen) haben nichts mit den seit PHP5 bekannten Interfaces zu tun, so viel vorne weg.
Hinter diesem Begriff birgt sich die Möglichkeit aufeinander folgende Methodenaufrufe einer Klasse zu verketten. Dies erspart einerseits redundanten Code (wenn auch minimal) und erhöht zudem die Lesbarkeit. Ermöglicht wird dieses Vorgehen dadurch, indem die Methoden $this, also die eigene Instanz zurückgeben. Dies ist natürlich nur dann möglich, wenn es sich um Methoden handelt, welche sonst keinen Rückgabewert, also void zurückgeben (zum Beispiel Set-Methoden).

Klasse ohne Fluent Interface

Als Beispiel eine einfache Klasse ohne konkrete Implementierung zum Versenden einer Email.

class Mail {
 
  private $_to;
 
  private $_subject;
 
  private $_message;
 
  public function setTo($to) {
    $this->_to = $to;
  }
 
  public function setSubject($subject) {
    $this->_subject = $subject;
  }
 
  public function setMessage($message) {
    $this->_message = $message;
  }
 
  public function send() {
    mail($this->_to, $this->_subject, $this->_message);
  }
}

Klasse mit Fluent Interface

Die gleiche Klasse nun unter der Verwendung des Fluent Interface was sich lediglich in der Rückgabe der eigenen Instanz in den Setter-Methoden auswirkt.

class MailFluent {
 
  private $_to;
 
  private $_subject;
 
  private $_message;
 
  public function setTo($to) {
    $this->_to = $to;
 
    return $this; // Rückgabe der eigenen Instanz
  }
 
  public function setSubject($subject) {
    $this->_subject = $subject;
 
    return $this;
  }
 
  public function setMessage($message) {
    $this->_message = $message;
 
    return $this;
  }
 
  public function send() {
    mail($this->_to, $this->_subject, $this->_message);
  }
}

Anwendung

Nun der Aufruf der beiden vorangegangen Beispiele.

// ohne Fluent Interface
$mail = new Mail();
$mail->setTo('mail@example.com');
$mail->setSubject('Irgendein Betreff');
$mail->setMessage('Hallo, diese Email wurde ohne Fluent Interface verschickt!');
$mail->send();
 
// und nun mit Fluent Interface
$mail = new MailFluent();
$mail->setTo('mail@example.com')->setSubject('Irgendein Betreff')->setMessage('Hallo, diese Email wurde mit Fluent Interface verschickt!')->send();
 
// oder
$mail = new MailFluent();
$mail
  ->setTo('mail@example.com')
  ->setSubject('Irgendein Betreff')
  ->setMessage('Hallo, diese Email wurde mit Fluent Interface verschickt!')
  ->send();

Das Fluent Interface könnte zusätzlich noch elegant mit dem Singleton Pattern verknüpft werden:

// Instantiierung eines Datenbankobjektes und anschließendes
// zusammensetzen und senden der Query
MySQL::getInstance()->select('*')->from('example')->execute();

Bookmark/Search this post with:
  • Delicious
  • Digg
  • Google
  • Yahoo