7.10. Wtyczki

7.10.1. Wprowadzenie

Architektura kontrolera zawiera także system wtyczek, który pozwala programiście na wykonanie własnego kodu, gdy następują określone zdarzenia w trakcie trwania procesu kontrolera. Kontroler frontowy używa agenta wtyczek jako rejeestru dla wtyczek programisty, a agent wtyczek jest odpowiedzialny za to, że metody zdarzeń są wywoływane dla każdej wtyczki zarejestrowanej w kontrolerze frontowym.

Metody zdarzeń są zdefiniowane w klasie abstrakcyjnej Zend_Controller_Plugin_Abstract, z której dziedziczy każda klasa wtyczki:

  • Metoda routeStartup() jest wywoływana zanim Zend_Controller_Front wywoła router w celu sprawdzenia żądania pod kątem zarejestrowanych tras.

  • Metoda routeShutdown() jest wywoływana po tym jak router zakończy routing żądania.

  • Metoda dispatchLoopStartup() jest uruchamiana zanim Zend_Controller_Front zacznie pętlę uruchamiania.

  • Metoda preDispatch() jest wywoływana zanim akcja zostanie uruchomiona przez obiekt uruchamiający. Pozwala to na stworzenie funkcjonalności proxy lub filtra. Nadpisując żądanie i resetując flagę uruchomienia (za pomocą Zend_Controller_Request_Abstract::setDispatched(false)), obecna akcja może być pominięta lub zastąpiona.

  • postDispatch() jest wywoływana po tym jak akcja zostanie uruchomiona przez obiekt uruchamiający. Pozwala to na stworzenie funkcjonalności proxy lub filtra. Nadpisując żądanie i resetując flagę uruchomienia (za pomocą Zend_Controller_Request_Abstract::setDispatched(false)), można określić nową akcję do uruchomienia.

  • Metoda dispatchLoopShutdown() jest wywoływana po tym jak Zend_Controller_Front zakończy pętlę uruchamiania.

7.10.2. Pisanie wtyczek

W celu napisania klasy wtyczki, w prosty sposób rozszerz klasę abstrakcyjną Zend_Controller_Plugin_Abstract:

<?php
require_once 'Zend/Controller/Plugin/Abstract.php';

class MyPlugin extends Zend_Controller_Plugin_Abstract
{
    // ...
}
?>

Żadna z metod klasy Zend_Controller_Plugin_Abstract nie jest abstrakcyjna, co oznacza, że nie jest konieczne implementowanie wszystkich dostępnych metod zdarzeń opisanych powyżej. Autor wtyczki może zaimplementować tylko te metody zdarzeń, które są mu rzeczywiście potrzebne.

Zend_Controller_Plugin_Abstract udostępnia także obiekty żądania i odpowiedzi wtyczkom kontrolera za pomocą metod getRequest() oraz getResponse(), odpowiednio.

7.10.3. Użycie wtyczek

Klasy wtyczek są rejestrowane za pomocą metody Zend_Controller_Front::registerPlugin() i mogą być rejestrowane w dowolnym momencie. Poniższy kod pokazuje w jaki sposób wtyczka może być użyta przez kontroler:

<?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>Wywołano metodę routeStartup()</p>\n");
    }

    public function routeShutdown($request)
    {
        $this->getResponse()->appendBody("<p>Wywołano metodę routeShutdown()</p>\n");
    }

    public function dispatchLoopStartup($request)
    {
        $this->getResponse()->appendBody("<p>Wywołano metodę dispatchLoopStartup()</p>\n");
    }

    public function preDispatch($request)
    {
        $this->getResponse()->appendBody("<p>Wywołano metodę preDispatch()</p>\n");
    }

    public function postDispatch($request)
    {
        $this->getResponse()->appendBody("<p>Wywołano metodę postDispatch()</p>\n");
    }

    public function dispatchLoopShutdown()
    {
        $this->getResponse()->appendBody("<p>Wywołano metodę dispatchLoopShutdown()</p>\n");
    }
}

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

Zakładając, że żadne wywołana akcja nie wyświetliła żadnych danych, i że tylko jedna akcja została wywołana, to funkcjonalność powyższej wtyczki spowoduje wyświetlenie takich danych:

<p>Wywołano metodę routeStartup()</p>
<p>Wywołano metodę routeShutdown()</p>
<p>Wywołano metodę dispatchLoopStartup()</p>
<p>Wywołano metodę preDispatch()</p>
<p>Wywołano metodę postDispatch()</p>
<p>Wywołano metodę dispatchLoopShutdown()</p>
[Notatka] Notatka
Wtyczki mogą być zarejestrowane w dowolnym momencie podczas uruchomienia kontrolera frontowego. Jednak jeśli zdarzenie dla którego we wtyczce była zarejestrowana metoda już minęło, to metoda ta będzie ominięta.

7.10.4. Wtyczki dołączone do standardowej dystrybucji

Zend Framework w standardowej dystrybucji zawiera wtyczkę służącą do obsługi błędów.

7.10.4.1. Zend_Controller_Plugins_ErrorHandler

Zend_Controller_Plugins_ErrorHandler provides a drop-in plugin for handling exceptions thrown by your application, including those resulting from missing controllers or actions; it is an alternative to the methods listed in the MVC Exceptions section.

The primary targets of the plugin are:

  • Intercept exceptions raised due to missing controllers or action methods

  • Intercept exceptions raised within action controllers

In other words, the ErrorHandler plugin is designed to handle HTTP 404-type errors (page missing) and 500-type errors (internal error). It is not intended to catch exceptions raised in other plugins or routing.

By default, Zend_Controller_Plugins_ErrorHandler will forward to ErrorController::errorAction() in the default module. You may set alternate values for these by using the various accessors available to the plugin:

  • setErrorHandlerModule() sets the controller module to use.

  • setErrorHandlerController() sets the controller to use.

  • setErrorHandlerAction() sets the controller action to use.

  • setErrorHandler() takes an associative array, which may contain any of the keys 'module', 'controller', or 'action', with which it will set the appropriate values.

Additionally, you may pass an optional associative array to the constructor, which will then proxy to setErrorHandler().

Zend_Controller_Plugin_ErrorHandler registers a postDispatch() hook and checks for exceptions registered in the response object. If any are found, it attempts to forward to the registered error handler action.

If an exception occurs dispatching the error handler, the plugin will tell the front controller to throw exceptions, and rethrow the last exception registered with the response object.

7.10.4.1.1. Using the ErrorHandler as a 404 Handler

Since the ErrorHandler plugin captures not only application errors, but also errors in the controller chain arising from missing controller classes and/or action methods, it can be used as a 404 handler. To do so, you will need to have your error controller check the exception type.

Exceptions captured are logged in an object registered in the request. To retrieve it, use Zend_Controller_Action::_getParam('error_handler'):

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

Once you have the error object, you can get the type via $errors->type. It will be one of the following:

  • Zend_Controller_Plugin_ErrorHandler::EXCEPTION_NO_CONTROLLER, indicating the controller was not found.

  • Zend_Controller_Plugin_ErrorHandler::EXCEPTION_NO_ACTION, indicating the requested action was not found.

  • Zend_Controller_Plugin_ErrorHandler::EXCEPTION_OTHER, indicating other exceptions.

You can then test for either of the first two types, and, if so, indicate a 404 page:

<?php
class ErrorController extends Zend_Controller_Action
{
    public function errorAction()
    {
        $errors = $this->_getRequest('error_handler');

        switch ($errors->type) {
            case Zend_Controller_Plugin_ErrorHandler::EXCEPTION_NO_CONTROLLER:
            case Zend_Controller_Plugin_ErrorHandler::EXCEPTION_NO_ACTION:
                // 404 error -- controller or action not found
                $this->getResponse()->setRawHeader('HTTP/1.1 404 Not Found');

                // ... get some output to display...
                break;
            default:
                // application error; display error page, but don't change
                // status code
                break;
        }
    }
}
?>
7.10.4.1.2. Plugin Usage Examples

Przykład 7.11. Standard usage

<?php
require_once 'Zend/Controller/Front.php';
require_once 'Zend/Controller/Plugin/ErrorHandler.php';

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

Przykład 7.12. Setting a different error handler

<?php
require_once 'Zend/Controller/Front.php';
require_once 'Zend/Controller/Plugin/ErrorHandler.php';

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

Przykład 7.13. Using accessors

<?php
require_once 'Zend/Controller/Front.php';
require_once 'Zend/Controller/Plugin/ErrorHandler.php';

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

$front = Zend_Controller_Front::getInstance();
$front->registerPlugin($plugin);
?>
7.10.4.1.3. Error Controller Example

In order to use the Error Handler plugin, you need an error controller. Below is a simple example.

<?php
class ErrorController extends Zend_Controller_Action
{
    public function errorAction()
    {
        $errors = $this->_getRequest('error_handler');

        switch ($errors->type) {
            case Zend_Controller_Plugin_ErrorHandler::EXCEPTION_NO_CONTROLLER:
            case Zend_Controller_Plugin_ErrorHandler::EXCEPTION_NO_ACTION:
                // 404 error -- controller or action not found
                $this->getResponse()->setRawHeader('HTTP/1.1 404 Not Found');

                $content =<<<EOH
<h1>Error!</h1>
<p>The page you requested was not found.</p>
EOH;
                break;
            default:
                // application error
                $content =<<<EOH
<h1>Error!</h1>
<p>An unexpected error occurred with your request. Please try again later.</p>
EOH;
                break;
        }
        $this->initView();
        $this->view->content = $content;
        $this->render();
    }
}
?>