Response-Objekt vs. echo, die() und exit

Eigentlich lohnt es sich ja fast nicht über etwas einfaches wie ein Response-Objekt einen Artikel zu schreiben. Fast, aber auch nur fast, denn die Praxis zeigt, dass es auch damit unerwartete Probleme geben kann.

Alle, die bislang nur wenig oder keine Erfahrung mit MVC-Anwendungen gesammelt haben, werden sich vielleicht nun fragen, wofür dieses Objekt gut ist. Das Response-Objekt kontrolliert die komplette Ausgabe der Anwendung an den Client (z.B. einen Browser).

Während der kompletten Laufzeit können mit dem Objekt Ausgaben gesammelt und auch nachträglich verändert werden und auch die Reihenfolge spielt keine Rolle. So kann nun zuerst die Ausgabe gemacht werden und dann die Header gesetzt werden.

So müsste es klassisch mit PHP geschrieben werden:

<?php header('Content-type: text/xml'); echo $xml;

Wenn wir nun die Reihenfolge vertauschen würden, hätte das eine Warning zur Folge.

<?php echo $xml; header('Content-type: text/xml');

Warning: Cannot modify header information - headers already sent by (output started at ####) in #### on line 3

Wenn wir uns in einer MVC-Umgebung befinden, stellt diese Reihenfolge kein Problem dar, denn das Objekt verwaltet die Ausgabe und schickt alles zur rechten Zeit raus.

So könnte es dann z.B. in einer Action des Kontrollers aussehen:

<?php public function indexAction() { // ... $this->getResponse()->appendBody($xml); $this->getResponse()->setHeader('Content-type', 'text/xml'); } 

Neben den relativ harmlosen direkten Ausgaben mit echo oder print habe ich in den vergangenen Jahren auch Ausgaben mit die() gefunden. Die offensichtliche Arbeit verrichtet die Anwendung zwar in den Actions der Kontroller, aber es passiert unter Umständen auch vor- und nachher eine Menge. Letzteres würde dann unterbunden werden und evtl. wichtige Aufgaben nicht mehr abgearbeitet werden.

Ein Beispiel sah etwa so aus:

<?php
public function jsonAction()
{
  // ...
  header('Content-type: text/json');
  die($json);
  // ...
}

Die Anwendung verliert so die Kontrolle über die Ausgabe und wird an der falschen Stelle beendet. Der richtige Weg führt auch hier zum Response-Objekt.

<?php
public function jsonAction()
{
  // ...
  $this->getResponse()->setHeader('COntent-type', 'text/json');
  $this->getResponse()->appendBody($json);
  return;  // <== falls die Bearbeitung hier enden soll
  // ...
}

So, nun gibt es in Zukunft keine Ausreden mehr, wenn irgendwo ein echo im Kontroller steht. Ich würde mich natürlich wie immer freuen eure Erfahrungen in den Kommentaren zu lesen.

Nebenbei bemerkt ist das mein 50. Artikel, also schon fast ein kleiner Grund zum Feiern.