Zend Framework 0.6

Wenn man von einem älteren Release auf Zend Framework 0.6 oder höher hochrüstet sollte man die folgenden Migrations Hinweise beachten.

Zend_Controller

Die grundlegende Verwendung der MVC Komponenten hat sich nicht verändert; man kann immer noch das folgende machen:

  1. require_once 'Zend/Controller/Front.php';
  2. Zend_Controller_Front::run('/path/to/controllers');
  1. /* -- Erstelle einen Router -- */
  2. $router = new Zend_Controller_RewriteRouter();
  3. $router->addRoute('user',
  4.                   'user/:username',
  5.                   array('controller' => 'user', 'action' => 'info')
  6. );
  7.  
  8. /* -- Setze ihn im Controller -- */
  9. $ctrl = Zend_Controller_Front::getInstance();
  10. $ctrl->setRouter($router);
  11.  
  12. /* -- Setze da Controller Verzeichnis und starte die Verarbeitung -- */
  13. $ctrl->setControllerDirectory('/path/to/controllers');
  14. $ctrl->dispatch();

Wir empfehlen die Verwendung des Response Objektes, um Inhalte und Header zu sammeln. Dies erlaubt den flexibleren Wechsel von Ausgabeformaten (z.B. JSON oder XML statt XHTML) in deiner Applikation. Standardmäßig verarbeitet dispatch() die Antwort, sendet Header und gibt die Inhalte aus. Man kann den Front Controller auch auffordern, die Antwort durch returnResponse() zurückzugeben und die Antwort dann auf eigene Weise ausgeben. Eine zukünftige Version des Front Controllers könnte die Verwendung des Response Objektes durch Output Buffering erzwingen.

Es gibt viele weitere zusätzliche Funktionalitäten, welche die vorherige API erweitern. Diese sind in der Dokumentation aufgeführt.

Die meisten Änderungen, die man beachten muss, betreffen das Erweitern der diversen Komponenten. Die wichtigsten davon sind:

  • Zend_Controller_Front::dispatch() fängt standardmäßig die Ausnahmen im Response Objekt ab und gibt sie nicht aus, um sicherzugehen, dass keine sensitiven Systeminformationen ausgegeben werden. Man kann dies auf mehrere Arten überschreiben:

    • Setzen von throwExceptions() im Front Controller:

      1. $front->throwExceptions(true);
    • Setzen von renderExceptions() im Response Objekt:

      1. $response->renderExceptions(true);
      2. $front->setResponse($response);
      3. $front->dispatch();
      4.  
      5. // oder:
      6. $front->returnResponse(true);
      7. $response = $front->dispatch();
      8. $response->renderExceptions(true);
      9. echo $response;
  • Zend_Controller_Dispatcher_Interface::dispatch() akzeptiert und gibt nun ein Anfrage Objekt anstelle eines Dispatcher Token zurück.

  • Zend_Controller_Router_Interface::route() akzeptiert und gibt nun ein Anfrage Objekt anstelle eines Dispatcher Token zurück.

  • Zend_Controller_Action Änderungen beinhalten:

    • Der Konstruktur akzeptiert nun genau drei Argumente, Zend_Controller_Request_Abstract $request, Zend_Controller_Response_Abstract $response, und Array $params (Optional). Zend_Controller_Action::__construct() verwendet diese, um die Request, Response und invokeArgs Eigenschaften für das Objekt zu setzen, und beim Überschreiben des Konstrukturs sollte man dies ebenfalls tun. Besser ist es, die init() Methode zu verwenden, um jedwede Instanzkonfiguration durchzuführen, weil diese Methode als letzte Methode des Konstrukturs aufgerufen wird.

    • run() ist nicht länger als final definiert, wird aber auch nicht länger vom Front Controller verwendet; sein einziger Zweck ist, dass die Klasse auch als Page Controller verwendet werden kann. Sie nimmt nun zwei optionale Argument an, ein Zend_Controller_Request_Abstract $request und ein Zend_Controller_Response_Abstract $response.

    • indexAction() muss nicht mehr länger definiert werden, aber wird als Standardaktion empfohlen. Dies erlaubt dem RewriteRouter und den Action Controllern andere Standardaktionsmethoden zu definieren.

    • __call() sollte überschrieben werden, um jede undefinierte Aktion automatisch verarbeiten zu können.

    • _redirect() nimmt nun ein optionales zweites Argument entgegen, den HTTP Code, der mit dem Redirect zurückgegeben werden soll, und ein optionales drittes Argument $prependBase, das angibt, dass die im Request Objekt registrierte Basis URL der übergebenen URL voran gestellt werden soll.

    • Die $_action Eigenschaft wird nicht mehr gesetzt. Diese Eigenschaft war ein Zend_Controller_Dispatcher_Token, der in der aktuellen Inkarnation nicht mehr länger existiert. Der einzige Zweck des Tokens war, Informationen über angeforderte Controller, Aktion und URL Parameter bereit zu stellen. Diese Infrmationen ist nun im Request Objekt verfügbar und kann wie folgt abgerufen werden:

      1. // Hole den angeforderten Controllernamen
      2. // Der Zugriff erfolgte bisher über: $this->_action->getControllerName().
      3. // Das Beispiel unten verwendet getRequest(), obwohl man auch direkt auf die
      4. // $_request Eigenschaft zugreifen kann; die Verwendung von getRequest() wird
      5. // empfohlen, da eine Elternklasse den Zugriff auf das Request Objekt
      6. // überschreiben könnte
      7. $controller = $this->getRequest()->getControllerName();
      8.  
      9. // Hole den angeforderten Aktionsnamen
      10. // Der Zugriff erfolgte bisher über: $this->_action->getActionName().
      11. $action = $this->getRequest()->getActionName();
      12.  
      13. // Hole die Anfrageparameter
      14. // Dies hat sich nicht verändert; die _getParams() und _getParam()
      15. // Methoden leiten nun einfach auf das Request Objekt weiter.
      16. $params = $this->_getParams();
      17. // fordere den 'foo' Parameter an und verwende
      18. // 'default', wenn kein Standardwert gefunden werden kann
      19. $foo = $this->_getParam('foo', 'default');
    • noRouteAction() wurde entfernt. Der geeignete Weg, um nicht vorhandene Aktionsmethoden abzufangen, wenn man sie an eine Standardaktion weiter leiten möchte, sollte die Verwendung von __call() sein:

      1. public function __call($method, $args)
      2. {
      3.     // Wenn eine nicht vorhandene 'Action' Methode angefordert wurde,
      4.     // leite auf die Standard Aktionsmethode um:
      5.     if ('Action' == substr($method, -6)) {
      6.         return $this->defaultAction();
      7.     }
      8.  
      9.     throw new Zend_Controller_Exception('Invalid method called');
      10. }
  • Zend_Controller_RewriteRouter::setRewriteBase() wurde entfernt. Stattdessen soll Zend_Controller_Front::setBaseUrl() verwendet werden (oder Zend_Controller_Request_Http::setBaseUrl(), wenn die Request Klasse verwendet wird).

  • Zend_Controller_Plugin_Interface wurde durch Zend_Controller_Plugin_Abstract ersetzt. Alle Methoden nehmen nun ein Request Objekt statt eines Dispatcher Tokens entgegen bzw. geben es zurück.

blog comments powered by Disqus