# Zend_Controller_Plugin_ErrorHandler

`Zend_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:

- Abfangen von Ausnahmen welche auftreten wenn keine passende Route existiert

- Abfangen von Ausnahmen die durch fehlende Controller oder Aktionsmethoden auftreten

- Abfangen von Ausnahmen die innerhalb von Controllern aufrufen

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:

- `setErrorHandlerModule()` setzt das Controller Modul das verwendet werden soll.

- `setErrorHandlerController()` setzt den Controller der verwendet werden soll.

- `setErrorHandlerAction()` setzt die Controller 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ä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 verwenden

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

    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_ROUTE`, zeigt das keine passende Route existiert.

- `Zend_Controller_Plugin_ErrorHandler::EXCEPTION_NO_CONTROLLER`, zeigt das der Controller 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 jeden der ersten drei 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_ROUTE:
                case Zend_Controller_Plugin_ErrorHandler::EXCEPTION_NO_CONTROLLER:
                case Zend_Controller_Plugin_ErrorHandler::EXCEPTION_NO_ACTION:
                    // 404 Fehler -- Controller 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_ROUTE:
                case Zend_Controller_Plugin_ErrorHandler::EXCEPTION_NO_CONTROLLER:
                case Zend_Controller_Plugin_ErrorHandler::EXCEPTION_NO_ACTION:
                    // 404 Fehler -- Controller 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 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:

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

## Beispiele für die Verwendung des Plugins

### Standardverwendung

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

### Einen anderen Fehler Handler setzen

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

### 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 Controller

Um das Fehler Handler Plugin zu verwenden, benötigt man einen Fehler Controller. 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_ROUTE:
                case Zend_Controller_Plugin_ErrorHandler::EXCEPTION_NO_CONTROLLER:
                case Zend_Controller_Plugin_ErrorHandler::EXCEPTION_NO_ACTION:
                    // 404 Fehler -- Controller oder Aktion nicht gefunden
                    $this->getResponse()->setRawHeader('HTTP/1.1 404 Not Found');

                    $content =<<<EOH
    <h1>Error!</h1>
    <p>Die angefragte Seite konnte nicht gefunden werden.</p>
    EOH;
                    break;
                default:
                    // Anwendungsfehler
                    $content =<<<EOH
    <h1>Fehler!</h1>
    <p>Ein unerwarteter Fehler trat auf.
    Bitte versuchen Sie es etwas später nocheinmal.</p>
    EOH;
                    break;
            }

            // Vorherige Inhalte löschen
            $this->getResponse()->clearBody();

            $this->view->content = $content;
        }
    }