PluginsEinführungDie Controller Architektur beinhaltet ein Pluginsystem, das den Aufruf von Anwendercode ermöglicht, wenn bestimmte Ereignisse im Controller Prozess auftreten. Der Front Controller verwendet einen Plugin Broker als eine Registry für User Plugins und der Plugin Broker stellt sicher, dass die Ereignismethoden von jedem Plugin aufgerufen werden, die im Front Controller registriert worden sind. Die Ereignismethoden sind in der abstrakten Klasse Zend_Controller_Plugin_Abstract definiert, von dem User Plugin Klassen angeleitet werden müssen:
Plugins schreibenUm eine Plugin Klasse zu schreiben, bindet man einfach die abstrakte Klasse Zend_Controller_Plugin_Abstract ein und erweitert sie:
Keine der Methoden von Zend_Controller_Plugin_Abstract ist abstrakt, so dass Plugin Klassen nicht gezwungen werden, irgend einen der vorhandenen Ereignismethoden zu implemetieren, die oben gelistet wurden. Schreiber von Plugins brauchen nur die Methoden zu implementieren, die sie für ihre speziellen Bedürfnisse benötigen. Zend_Controller_Plugin_Abstract stellt den Controller Plugins außerdem die Request und Response Objekte über die getRequest() und getResponse() Methoden zur Verfügung. Plugins verwendenPlugin Klassen werden mit Zend_Controller_Front::registerPlugin() registriert und können jederzeit registriert werden. Der folgende Schnipsel zeigt, wie ein Plugin in der Controllerkette verwendet werden kann:
Angenommen das keine der Aktionen igendeine Ausgabe produzieren, und nur eine Aktion aufgerufen wurde, dann erzeugt die Funktionalität des obigen Plugins trotzdem die folgende Ausgabe:
Empfangen und Manipulieren von PluginsFallweise kann es notwendig sein ein Plugin zu entfernen oder empfangen. Die folgenden Methoden des Frontcontrollers erlauben dies:
Plugins die in der Standard Distribution enthalten sindZend Framework enthält ein Plugin für die Fehlerbehandlung in der Standard Distribution. ActionStackDas ActionStack Plugin erlaubt es einen Stack von Anfragen zu verwalten, und operiert als postDispatch Plugin. Wenn eine Weiterleitung (z.B. ein Aufruf zu einer anderen Aktion) bereits im aktuellen Anfrage Objekt gefunden wurde, führt es nicht durch. Trotzdem, wenn nicht, prüft es seinen Stack und entfernt den obersten Teil von Ihm und leitet diesen zu der Aktion weiter die in dieser Anfrage spezifiziert ist. Der Stack wird in der LIFO Reihenfolge bearbeitet. Das Plugin kann jederzeit vom Front Controller empfangen werden indem Zend_Controller_Front::getPlugin('Zend_Controller_Plugin_ActionStack') verwendet wird. Sobald das Plugin Objekt vorliegt, gibt es eine Anzahl von Mechanisman die verwendet werden können, um es zu manipulieren.
Eine zusätzliche Methode, forward(), erwartet ein Anfrageobjekt, und setzt den Status des aktellen Anfrageobjektes im Front Controller auf den Status des angegebenen Anfrageobjekts, und markiert dieses als unerledigt (das forciert einen weiteren Durchlauf der Dispatch Schleife). Zend_Controller_Plugin_ErrorHandlerZend_Controller_Plugin_ErrorHandler bietet ein Plugin für die Handhabung von Ausnahmen die von der Anwendung geworfen werden, inklusive denen die aus fehlenden Controllern oder Aktionen resultieren; das ist eine Alternative zu den Methoden die in der Sektion MVC Ausnahmen aufgeführt sind. Die primären Ziele dieses Plugins sind:
Mit anderen Worten ist das ErrorHandler Plugin kreiert worden um HTTP 404 Fehler zu behandeln (fehlende Seite) und 500 Fehler (interner Fehler). Es ist nicht dazu gedacht Ausnahmen zu fangen die in anderen Plugins verursacht werden. Standardmäßig leitet Zend_Controller_Plugin_ErrorHandler auf ErrorController::errorAction() im Standardmodul weiter. Es kann ein alternativer Wert für dieses gesetzt werden durch Verwendung der diversen Zugriffsmethoden die zu dem Plugin existieren:
Zusätzlich kann ein optionales assoziatives Array an den Konstruktor übergeben werden, welches dann an den setErrorHandler() weitergeleitet wird. Zend_Controller_Plugin_ErrorHandler benötigt einen postDispatch() Hook und prüft auf Ausnahmen die im Antwort Objekt registriert sind. Wenn welche gefunden werden, versucht es zur registrieren Fehler Handler Aktion weiterzuleiten. Wenn eine Ausnahme während der Abarbeitung des Error Handlers auftritt, teilt das Plugin dem Front Controller mit das eine Ausnahme geworfen werden muß, und die letzte registrierte Ausnahme im Antwort Objekt wird nocheinmal geworfen. Den Fehler Handler als 404 Handler verwendenDa das ErrorHandler Plugin nicht nur Anwendungsfehler erfasst, sondern auch Fehler in der Controller Kette die durch fehlende Controller Klassen und/oder Aktions Methoden auftreten, kann es als 404 Handler verwendet werden. Hierfür muß der eigene Fehler Controller den Typ der Ausnahme prüfen. Aufgefangene Ausnahmen werden in einem in der Anfrage registrierten Objekt geloggt. Um dieses zu empfangen kann Zend_Controller_Action::_getParam('error_handler') verwendet werden:
Sobald das Fehler Objekt vorhanden ist, kann man es über den Typ mit $errors->type; erhalten. Es wird eines der folgenden sein:
Man kann auf jeden der ersten drei Typen testen, und wenn dem so ist, eine 404 Seite anzeigen:
Letztendlich kann die Anwendung die den Fehler Handler verursacht hat, empfangen werden indem die exception Eigenschaft des error_handler Objektes genommen wird:
Zuvor gerenderte Ausgaben erhaltenWenn mehrfache Aktionen in einer Anfrage behandelt werden, oder wenn die Aktion mehrere Aufrufe zu render() macht, ist es möglich dass das Antwort Objekt bereits Inhalt in sich gespeichert hat. Das kann dazu führen das eine Mixtur von erwartetem Inhalt und Fehler Inhalt gerendert wird. Wenn Fehler innerhalb solcher Seiten gerendert werden, ist keine Änderung notwendig. Wenn solche Inhalte nicht gerendert werden sollen, muß der Antwort Body vor dem rendern jeglicher Views gelöscht werden:
Beispiele für die Verwendung des PluginsExample #1 Standardverwendung Example #2 Einen anderen Fehler Handler setzen
Example #3 Zugriffsmethoden verwenden
Beispiel für den Fehler ControllerUm das Fehler Handler Plugin zu verwenden, benötigt man einen Fehler Controller. Nachfolgend ist ein einfaches Beispiel.
Zend_Controller_Plugin_PutHandlerZend_Controller_Plugin_PutHandler bietet ein Drop-In Plugin für die Verwendung von PUT Request Bodies in Anfrage Parametern, so wie POST Anfrage Parameter. Er betrachtet die Anfrage und, wenn diese PUT ist, wird parse_str verwendet um den rohen PUT Body in ein Array von Parametern zu parsen welches dann bei der Anfrage gesetzt wird. z.B.,
Um die 'title' und 'body' Parameter als reguläre Anfrage Parameter zu erhalten muss das Plugin registriert werden: Anschließend kann man auf die Parameter des PUT Bodies durch Ihren Namen zugreifen, von der Anfrage im eigenen Controller aus:
|
|