Die 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:
routeStartup()
wird aufgerufen bevor
Zend_Controller_Front
damit startet den Request anhand der
Routen zu überprüfen.
routeShutdown()
wird aufgerufen wenn Zend_Controller_Router
beendet, nachdem Zend_Controller_Front vom das Routing beendet.
dispatchLoopStartup()
wird aufgerufen, bevor
Zend_Controller_Front
den Dispatch Loop aufnimmt.
preDispatch()
wird von Zend_Controller_Dispatcher
aufgerufen, bevor eine Aktion verarbeitet wird. Dieser Callback erlaubt ein
Proxy oder Filter Verhalten. Durch Verändern des Requests und Zurücksetzen
des Verarbeitungsstatus (mittels
Zend_Controller_Request_Abstract::setDispatched(false)
) kann
die aktuelle Aktion übersprungen werden.
postDispatch()
wird von Zend_Controller_Dispatcher
aufgerufen, nachdem eine Aktion verarbeitet wurde. Dieser Callback erlaubt
ein Proxy oder Filter Verhalten. Durch Verändern des Requests und
Zurücksetzen des Verarbeitungsstatus (mittels
Zend_Controller_Request_Abstract::setDispatched(false)
) kann
die eine neue Aktion zur Verarbeitung festgelegt werden.
dispatchLoopShutdown()
wird aufgerufen, bevor
Zend_Controller_Front
den Dispatch Loop beendet.
Um eine Plugin Klasse zu schreiben, bindet man einfach die abstrakte Klasse
Zend_Controller_Plugin_Abstract
ein und erweitert sie:
<?php require_once 'Zend/Controller/Plugin/Abstract.php'; class MyPlugin extends Zend_Controller_Plugin_Abstract { // ... }
Keine der Methoden von Zend_Controller_Plugin_Abstract
sind abstrakt, so
dass Plugin Klassen nicht gezwungen werden, irgend einen der vorhandenen
Ereignismethoden zu implemetieren, die oben gelistet wurden. Schreiber von Plugins
können genau die Methoden 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.
Plugin Klassen werden mit Zend_Controller_Front::registerPlugin()
vor dem Dispatching registriert. Der folgende Schnipsel zeigt, wie ein Plugin in der
Controllerkette verwendet werden kann:
<?php require_once 'Zend/Controller/Front.php'; require_once 'Zend/Controller/Router.php'; require_once 'Zend/Controller/Plugin/Abstract.php'; class MyPlugin extends Zend_Controller_Plugin_Abstract { public function routeStartup() { $this->getResponse()->appendBody('<p>routeStartup() called</p>'); } public function routeShutdown($request) { $this->getResponse()->appendBody('<p>routeShutdown() called</p>'); } public function dispatchLoopStartup($request) { $this->getResponse()->appendBody('<p>dispatchLoopStartup() called</p>'); } public function preDispatch($request) { $this->getResponse()->appendBody('<p>preDispatch() called</p>'); } public function postDispatch($request) { $this->getResponse()->appendBody('<p>postDispatch() called</p>'); } public function dispatchLoopShutdown() { $this->getResponse()->appendBody('<p>dispatchLoopShutdown() called</p>'); } } $controller = Zend_Controller_Front::getInstance(); $controller->setControllerDirectory('/path/to/controllers') ->setRouter(new Zend_Controller_Router()) ->registerPlugin(new MyPlugin()); $response = $controller->dispatch(); echo $response;