Previous Next

Plugins

Einführung

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 den Router aufruft, um den Request anhand der registrierten Routen zu überprüfen.

  • routeShutdown() wird aufgerufen, nachdem der Router das Routing der Anfrage beendet.

  • dispatchLoopStartup() wird aufgerufen, bevor Zend_Controller_Front den Dispatch Loop aufnimmt.

  • preDispatch() wird von dem 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 abgebrochen oder ersetzt werden.

  • postDispatch() wird von dem 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 eine neue Aktion für die Verarbeitung angegeben werden.

  • dispatchLoopShutdown() wird aufgerufen, nachdem Zend_Controller_Front den Dispatch Loop beendet.

Plugins schreiben

Um eine Plugin Klasse zu schreiben, bindet man einfach die abstrakte Klasse Zend_Controller_Plugin_Abstract ein und erweitert sie:

class MyPlugin extends Zend_Controller_Plugin_Abstract
{
    // ...
}

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 verwenden

Plugin 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:

class MyPlugin extends Zend_Controller_Plugin_Abstract
{
    public function routeStartup(Zend_Controller_Request_Abstract $request)
    {
        $this->getResponse()
             ->appendBody("

routeStartup() called

\n"); } public function routeShutdown(Zend_Controller_Request_Abstract $request) { $this->getResponse() ->appendBody("

routeShutdown() called

\n"); } public function dispatchLoopStartup(Zend_Controller_Request_Abstract $request) { $this->getResponse() ->appendBody("

dispatchLoopStartup() called

\n"); } public function preDispatch(Zend_Controller_Request_Abstract $request) { $this->getResponse() ->appendBody("

preDispatch() called

\n"); } public function postDispatch(Zend_Controller_Request_Abstract $request) { $this->getResponse() ->appendBody("

postDispatch() called

\n"); } public function dispatchLoopShutdown() { $this->getResponse() ->appendBody("

dispatchLoopShutdown() called

\n"); } } $front = Zend_Controller_Front::getInstance(); $front->setControllerDirectory('/path/to/controllers') ->setRouter(new Zend_Controller_Router_Rewrite()) ->registerPlugin(new MyPlugin()); $front->dispatch();

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:

routeStartup() aufgerufen

routeShutdown() aufgerufen

dispatchLoopStartup() aufgerufen

preDispatch() aufgerufen

postDispatch() aufgerufen

dispatchLoopShutdown() aufgerufen

Note:

Plugins können jederzeit wärend der Ausführung des Frontkontrollers registriert werden. Wenn trotzdem ein Event ausgeführt wurde für das das Plugin eine registrierte Eventmethode enthält, wird diese Methode nicht getriggert.

Empfangen und Manipulieren von Plugins

Fallweise kann es notwendig sein ein Plugin zu entfernen oder empfangen. Die folgenden Methoden des Frontkontrollers erlauben dies:

  • getPlugin($class) erlaubt es ein Plugin durch den Klassennamen zu empfangen. Wenn kein Plugin entspricht, wird false zurückgegeben. Wenn mehr als ein Plugin dieser Klasse registriert ist, wird ein Array zurückgegeben.

  • getPlugins() empfängt den kompletten Plugin Stack.

  • unregisterPlugin($plugin) erlaubt die Entfernung eines Plugins vom Stack. Es kann ein Plugin Objekt oder der Klassenname des Plugins, das entfernt werden soll, übergeben werden. Wenn der Klassenname übergeben wird, wird jedes Plugin dieser Klasse entfernt.

Plugins die in der Standard Distribution enthalten sind

Zend Framework enthält ein Plugin für die Fehlerbehandlung in der Standard Distribution.

ActionStack

DasActionStack 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 Kontroller 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.

  • getRegistry() und setRegistry(). Intern verwendet ActionStack eine Instanz von Zend_Registry um den Stack zu speichern. Diese kann durch eine andere Registry Instanz ersetzt werden oder dieselbe mit diesen Zugriffsmethoden empfangen.

  • getRegistryKey() und setRegistryKey(). Diese können verwendet werden um anzuzeigen welcher Registryschlüssel verwendet wird wenn der Stack herausgenommen wird. Der Standardwert ist 'Zend_Controller_Plugin_ActionStack'.

  • getStack() erlaubt es den Stack von Aktionen in seiner Ganzheit zu empfangen.

  • pushStack() und popStack() erlauben es dem Stack etwas hinzuzufügen und auch zu entfernen. pushStack() akzeptiert ein Anfrageobjekt.

Eine zusätzliche Methode, forward(), erwartet ein Anfrageobjekt, und setzt den Status des aktellen Anfrageobjektes im Front Kontroller auf den Status des angegebenen Anfrageobjekts, und markiert dieses als unerledigt (das forciert einen weiteren Durchlauf der Dispatch Schleife).

Zend_Controller_Plugin_ErrorHandler

Zend_Controller_Plugin_ErrorHandler biete ein Einwurf Plugin für die Handhabung von Ausnahmen die von der Anwendung geworfen werden, inklusive denen die aus fehlenden Kontrollern 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:

  • Abfangen von Ausnahmen die durch fehlende Kontroller oder Aktionsmethoden auftreten

  • Abfangen von Ausnahmen die innerhalb von Kontrollern aufrufen

Mit anderen Worten ist das ErrorHandler Plugin kreiert worden um HTTP 404 Typ Fehler zu behandeln (fehlende Seite) und 500 Typ Fehler (interner Fehler). Es ist nicht dazu gedacht Ausnahmen zu fangen die in anderen Plugins oder durch das Routen 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 Pligin existieren:

  • setErrorHandlerModule() setzt das Kontroller Modul das verwendet werden soll.

  • setErrorHandlerController() setzt den Kontroller der verwendet werden soll.

  • setErrorHandlerAction() setzt die Kontroller Aktion die verwendet werden soll.

  • setErrorHandler() nimmt ein assoziatives Array, welches einen der Schlüssel 'module', 'controller', oder 'action' enthalten kann und mit denen es die gewünschten Werte setzt.

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ärend der Abarbeitung des Error Handlers auftritt, teilt das Plugin dem Front Kontroller mit das eine Ausnahme geworfen werden muß, und die letzte registrierte Ausnahme im Antwort Objekt wird nocheinmal geworfen.

Den Fehler Handler als 404 Handler verwenden

Da das ErrorHandler Plugin nicht nur Anwendungsfehler erfasst, sondern auch Fehler in der Kontroller Kette die durch fehlende Kontroller Klassen und/oder Aktions Methoden auftreten, kann es als 404 Handler verwendet werden. Hierfür muß der eigene Fehler Kontroller 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:

class ErrorController extends Zend_Controller_Action
{
    public function errorAction()
    {
        $errors = $this->_getParam('error_handler');
    }
}

Sobald das Fehler Objekt vorhanden ist, kann man es über den Typ mit $errors->type erhalten. Es wird eines der folgenden sein:

  • Zend_Controller_Plugin_ErrorHandler::EXCEPTION_NO_CONTROLLER, zeigt das der Kontroller nicht gefunden wurde.

  • Zend_Controller_Plugin_ErrorHandler::EXCEPTION_NO_ACTION, zeigt das die angefragte Aktion nicht gefunden wurde.

  • Zend_Controller_Plugin_ErrorHandler::EXCEPTION_OTHER, zeigt andere Ausnahmen.

Man kann auf eine der ersten Typen testen, und wenn dem so ist, eine 404 Seite anzeigen:

class ErrorController extends Zend_Controller_Action
{
    public function errorAction()
    {
        $errors = $this->_getParam('error_handler');

        switch ($errors->type) {
            case Zend_Controller_Plugin_ErrorHandler::EXCEPTION_NO_CONTROLLER:
            case Zend_Controller_Plugin_ErrorHandler::EXCEPTION_NO_ACTION:
                // 404 Fehler -- Kontroller oder Aktion nicht gefunden
                $this->getResponse()
                     ->setRawHeader('HTTP/1.1 404 Not Found');

                // ... Ausgabe für die Anzeige erzeugen...
                break;
            default:
                // Anwendungsfehler; Fehler Seite anzeigen, aber den
                // Status Code nicht ändern
                break;
        }
    }
}

Letztendlich kann die Anwendung die den Fehler Handler verursacht hat, empfangen werden indem die exception Eigenschaft des error_handler Objektes genommen wird:

public function errorAction()
{
        $errors = $this->_getParam('error_handler');


        switch ($errors->type) {
            case Zend_Controller_Plugin_ErrorHandler::EXCEPTION_NO_CONTROLLER:
            case Zend_Controller_Plugin_ErrorHandler::EXCEPTION_NO_ACTION:
                // 404 Fehler -- Kontroller oder Aktion nicht gefunden
                $this->getResponse()
                     ->setRawHeader('HTTP/1.1 404 Not Found');

                // ... Ausgabe für die Anzeige erzeugen...
                break;
            default:
                // Anwendungsfehler; Fehler Seite anzeigen, aber den
                // Status Code nicht ändern

                // ...

                // Ausnahme loggen:
                $exception = $errors->exception;
                $log = new Zend_Log(
                    new Zend_Log_Writer_Stream(
                        '/tmp/applicationException.log'
                    )
                );
                $log->debug($exception->getMessage() . "\n" .
                            $exception->getTraceAsString());
                break;
        }
}

Zuvor gerenderte Ausgaben erhalten

Wenn mehrfache Aktionen in einer Anfrage behandelt werden, oder wenn die Aktion mehrere Aufrufe zu render() macht, ist es möglich das das Antwort Objekt bereits Inhalt in sich gespeichert hat. Das kann dazu führen das eine Mixtur vin 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:

$this->getResponse()->clearBody();

Beispiele für die Verwendung des Plugins

Example #1 Standardverwendung

$front = Zend_Controller_Front::getInstance();
$front->registerPlugin(new Zend_Controller_Plugin_ErrorHandler());

Example #2 Einen anderen Fehler Handler setzen

$front = Zend_Controller_Front::getInstance();
$front->registerPlugin(new Zend_Controller_Plugin_ErrorHandler(array(
    'module'     => 'mystuff',
    'controller' => 'static',
    'action'     => 'error'
)));

Example #3 Zugriffsmethoden verwenden

$plugin = new Zend_Controller_Plugin_ErrorHandler();
$plugin->setErrorHandlerModule('mystuff')
       ->setErrorHandlerController('static')
       ->setErrorHandlerAction('error');

$front = Zend_Controller_Front::getInstance();
$front->registerPlugin($plugin);

Beispiel für den Fehler Kontroller

Um das Fehler Handler Plugin zu verwenden, benötigt man einen Fehler Kontroller. Nachfolgend ist ein einfaches Beispiel.

class ErrorController extends Zend_Controller_Action
{
    public function errorAction()
    {
        $errors = $this->_getParam('error_handler');

        switch ($errors->type) {
            case Zend_Controller_Plugin_ErrorHandler::EXCEPTION_NO_CONTROLLER:
            case Zend_Controller_Plugin_ErrorHandler::EXCEPTION_NO_ACTION:
                // 404 Fehler -- Kontroller oder Aktion nicht gefunden
                $this->getResponse()->setRawHeader('HTTP/1.1 404 Not Found');

                $content =<<Error!

Die angefragte Seite konnte nicht gefunden werden.

EOH; break; default: // Anwendungsfehler $content =<<Fehler!

Ein unerwarteter Fehler trat auf. Bitte versuchen Sie es etwas später nocheinmal.

EOH; break; } // Vorherige Inhalte löschen $this->getResponse()->clearBody(); $this->view->content = $content; } }
Previous Next
Introduction to Zend Framework
Übersicht
Installation
Zend_Acl
Einführung
Verfeinern der Zugriffskontrolle
Fortgeschrittene Verwendung
Zend_Amf
Einführung
Zend_Amf_Server
Zend_Auth
Einführung
Datenbanktabellen Authentifizierung
Digest Authentication
HTTP Authentication Adapter
LDAP Authentifizierung
Open ID Authentifikation
Zend_Cache
Einführung
Die Theorie des Cachens
Zend_Cache Frontends
Zend_Cache Backends
Zend_Captcha
Einführung
Captcha Anwendung
Captcha Adapter
Zend_Config
Einleitung
Theory of Operation
Zend_Config_Ini
Zend_Config_Xml
Zend_Config_Writer
Zend_Config_Writer
Zend_Console_Getopt
Einführung in Getopt
Definieren von Getopt Regeln
Holen von Optionen und Argumenten
Konfigurieren von Zend_Console_Getopt
Zend_Controller
Zend_Controller Schnellstart
Zend_Controller Grundlagen
Der Front Controller
Das Request Objekt
Der Standard Router
Der Dispatcher
Action Kontroller
Action Helfer
Das Response Objekt
Plugins
Eine konventionelle modulare Verzeichnis Struktur verwenden
MVC Ausnahmen
Migration von vorhergehenden Versionen
Zend_Currency
Einführung in Zend_Currency
Arbeiten mit Währungen
Migration von vorhergehenden Versionen
Zend_Date
Einführung
Theorie der Arbeitsweise
Basis Methoden
Zend_Date API Übersicht
Erstellen von Datumswerten
Konstanten für generelle Datums Funktionen
Funktionierende Beispiele
Zend_Db
Zend_Db_Adapter
Zend_Db_Statement
Zend_Db_Profiler
Zend_Db_Select
Zend_Db_Table
Zend_Db_Table_Row
Zend_Db_Table_Rowset
Zend_Db_Table Relationships
Zend_Debug
Variablen ausgeben
Zend_Dojo
Einführung
Zend_Dojo_Data: dojo.data Envelopes
Dojo View Helfer
Dojo Form Elemente und Dekoratore
Zend_Dom
Einführung
Zend_Dom_Query
Zend_Exception
Verwenden von Ausnahmen
Zend_Feed
Einführung
Feeds importieren
Feeds von Websites abrufen
Einen RSS Feed konsumieren
Einen Atom Feed konsumieren
Einen einzelnen Atom Eintrag konsumieren
Verändern der Feed- und Eintragsstruktur
Eigene Klassen für Feeds und Einträge
Zend_File
Zend_File_Transfer
Prüfungen für Zend_File_Transfer
Filter für Zend_File_Transfer
Migration von vorhergehenden Versionen
Zend_Filter
Einführung
Standard Filter Klassen
Filter Ketten
Filter schreiben
Zend_Filter_Input
Zend_Filter_Inflector
Zend_Form
Zend_Form
Schnellstart mit Zend_Form
Erstellen von Form Elementen mit Hilfe von Zend_Form_Element
Erstellen von Form durch Verwendung von Zend_Form
Erstellen von eigenem Form Markup durch Zend_Form_Decorator
Standard Form Elemente die mit dem With Zend Framework ausgeliefert werden
Standard Form Dekoratore die mit dem Zend Framework ausgeliefert werden
Internationalisierung von Zend_Form
Fortgeschrittene Verwendung von Zend_Form
Zend_Gdata
Einführung zu Gdata
Authentifizierung mit AuthSub
Die Buchsuche Daten API verwenden
Authentifizieren mit ClientLogin
Google Kalender verwenden
Verwenden der Google Dokumente Listen Daten API
Using Google Health
Google Tabellenkalkulation verwenden
Google Apps Provisionierung verwenden
Google Base verwenden
Picasa Web Alben verwenden
Verwenden der YouTube Daten API
Gdata Ausnahmen auffangen
Zend_Http
Zend_Http_Client - Einführung
Zend_Http_Client - Fortgeschrittende Nutzung
Zend_Http_Client - Verbindungsadapter
Zend_Http_Cookie und Zend_Http_CookieJar
Zend_Http_Response
Zend_InfoCard
Einführung
Zend_Json
Einführung
Grundlegende Verwendung
JSON Objects
XML zu JSON Konvertierung
Zend_Json_Server - JSON-RPC server
Zend_Layout
Einführung
Zend_Layout Schnellstart
Zend_Layout Konfigurations Optionen
Erweiterte Verwendung von Zend_Layout
Zend_Ldap
Einleitung
Zend_Loader
Dynamisches Laden von Dateien und Klassen
Plugins laden
Zend_Locale
Einführung
Zend_Locale verwenden
Normalisierung und Lokalisierung
Arbeiten mit Daten und Zeiten
Unterstützte Gebietsschemata
Migrieren von vorhergehenden Versionen
Zend_Log
Übersicht
Writer
Formatter
Filter
Zend_Mail
Einführung
Versand über SMTP
Versand von mehreren E-Mails über eine SMTP Verbindung
Verwendung von unterschiedlichen Versandwegen
HTML E-Mail
Anhänge
Empfänger hinzufügen
Die MIME Abgrenzung kontrollieren
Zusätzliche Kopfzeilen
Zeichensätze
Kodierung
SMTP Authentifizierung
SMTP Übertragungen sichern
Lesen von Mail Nachrichten
Zend_Measure
Einführung
Erstellung einer Maßeinheit
Ausgabe von Maßeinheiten
Manipulation von Maßeinheiten
Arten von Maßeinheiten
Zend_Memory
Übersicht
Memory Manager
Memory Objekte
Zend_Mime
Zend_Mime
Zend_Mime_Message
Zend_Mime_Part
Zend_OpenId
Einführung
Zend_OpenId_Consumer Grundlagen
Zend_OpenId_Provider
Zend_Paginator
Einführung
Verwendung
Konfiguration
Advanced usage
Zend_Pdf
Einführung
Erstellen und Laden von PDF Dokumenten
Änderungen von PDF Dokumenten speichern
Dokument Seiten
Zeichnen
Dokument Informationen und Metadaten
Anwendungsbeispiel für die Zend_Pdf Komponente
Zend_ProgressBar
Zend_ProgressBar
Zend_Registry
Die Registry verwenden
Zend_Rest
Einführung
Zend_Rest_Client
Zend_Rest_Server
Zend_Search_Lucene
Überblick
Indexerstellung
Einen Index durchsuchen
Abfragesprache
Abfrage Erzeugungs API
Zeichensätze
Erweiterbarkeit
Zusammenarbeit Mit Java Lucene
Erweitert
Die besten Anwendungen
Zend_Server
Einführung
Zend_Server_Reflection
Zend_Service
Einführung
Zend_Service_Akismet
Zend_Service_Amazon
Zend_Service_Audioscrobbler
Zend_Service_Delicious
Zend_Service_Flickr
Zend_Service_Nirvanix
Zend_Service_ReCaptcha
Zend_Service_Simpy
Einführung
Zend_Service_StrikeIron
Zend_Service_StrikeIron: Mitgelieferte Services
Zend_Service_StrikeIron: Erweiterte Verwendung
Zend_Service_Technorati
Zend_Service_Twitter
Zend_Service_Yahoo
Zend_Session
Einführung
Grundsätzliche Verwendung
Fortgeschrittene Benutzung
Globales Session Management
Zend_Session_SaveHandler_DbTable
Zend_Soap
Zend_Soap_Server
Zend_Soap_Client
WSDL Zugriffsmethoden
AutoDiscovery
Zend_Test
Einführung
Zend_Test_PHPUnit
Zend_Text
Zend_Text_Figlet
Zend_Text_Table
Zend_TimeSync
Einführung
Arbeiten mit Zend_TimeSync
Zend_Translate
Einführung
Adapter für Zend_Translate
Benutzen von Übersetzungs Adaptoren
Migration von vorhergehenden Versionen
Zend_Uri
Zend_Uri
Zend_Validate
Einführung
Standard Prüfklassen
Kettenprüfungen
Schreiben von Prüfern
Zend_Version
Auslesen der Version des Zend Frameworks
Zend_View
Einführung
Controller Skripte
View Scripte
View Helfer
Zend_View_Abstract
Zend_Wildfire
Zend_Wildfire
Zend_XmlRpc
Einführung
Zend_XmlRpc_Client
Zend_XmlRpc_Server
Zend Framework Voraussetzungen
PHP Version
PHP Erweiterungen
Zend Framework Komponenten
Zend Framework Abhängigkeiten
Zend Framework Coding Standard für PHP
Übersicht
PHP Dateiformatierung
Namens Konventionen
Code Stil
Zend Framework Performance Guide
Einführung
Laden von Klassen
Internationalisierung (I18n) und Lokalisierung (L10n)
Darstellen der View
Urheberrecht Informationen