Action Controller

Einführung

Zend_Controller_Action ist eine abstrakte Klasse die verwendet werden kann um Aktion Controller zu implementieren die mit dem Front Controller verwendet werden können um eine WebSeite zu erstellen die auf dem Model-View-Controller (MVC) Pattern basiert.

Um Zend_Controller_Action zu verwenden, muß von dieser in der eigenen aktuellen Aktions Controller Klasse ererbt werden (oder von dieser erben um eine eigene Basisklasse für Aktion Controller zu erstellen). Die grundsätzlichste Operation ist es von Ihr zu erben und Aktions Methoden zu erstellen die den verschiedenen Aktionen entsprechen die der Controller der eigenen Seite handhaben soll. Das Handhaben von Routen und Dispatchen des Zend_Controller's wird automatisch jegliche Methode die in der eigenen Klasse auf 'Action' endet, als potentielle Controller Aktion herausfinden.

Soll unsere Klasse, zum Beispiel, wie folgt definiert sein:

  1. class FooController extends Zend_Controller_Action
  2. {
  3.     public function barAction()
  4.     {
  5.         // mach irgendwas
  6.     }
  7.  
  8.     public function bazAction()
  9.     {
  10.         // mach irgendwas
  11.     }
  12. }

Die obige FooController Klasse (Controller foo)´definiert zwei Aktionen, bar und baz.

Da gibt es viel mehr das damit getan werden kann als das, wie eigene Initialisierungs Aktionen, Standardaktionen die aufgerufen werden wenn keine Aktion (oder eine ungültige Aktion) spezifiziert wird, pre- und post Dispatch Hooks, und eine Vielzahl von Helfer Methoden. Dieses Kapitel arbeitet als eine Übersicht der Aktion Controller Funktionalitäten.

Note: Standardverhalten
Standardmäßig aktiviert der Front Controller den Aktion Helfer des ViewRenderer's. Dieser Helfer übernimmt das Einfügen des View Objekts in den Controller, sowie das automatische Darstellen der View. Er kann innerhalb des Aktion Controllers mit einer der folgenden Methoden ausgeschaltet werden:

  1. class FooController extends Zend_Controller_Action
  2. {
  3.     public function init()
  4.     {
  5.         // Lokal nur bei diesem Controller; beeinflußt alle Aktionen die mit
  6.         // init geladen wurden:
  7.         $this->_helper->viewRenderer->setNoRender(true);
  8.  
  9.         // Global:
  10.         $this->_helper->removeHelper('viewRenderer');
  11.  
  12.         // Auch global, muß aber in Verbindung mit der Lokalen Version sein um
  13.         // für diesen Controller zu gelten:
  14.         Zend_Controller_Front::getInstance()
  15.             ->setParam('noViewRenderer', true);
  16.     }
  17. }
initView(), getViewScript(), render(), und renderScript() handeln alle in Vertretung zum ViewRenderer solange der Helfer nicht im Helfer Broker ist oder das noViewRenderer Flag nicht gesetzt wurde.
Das rendern kann für individuelle Views auch ganz einfach ausgeschaltet werden durch Setzen des noRender Flags des ViewRenderer's:
  1. class FooController extends Zend_Controller_Action
  2. {
  3.     public function barAction()
  4.     {
  5.         // Nur für diese Aktion das automatische Rendern ausschalten:
  6.         $this->_helper->viewRenderer->setNoRender();
  7.     }
  8. }
Der primäre Grund um den ViewRenderer auszuschalten ist, wenn einfach kein View Objekt benötigt wird, oder wenn nicht über ein View Skript gerendert werden soll (zum Beispiel wenn ein Aktion Controller verwendet wird um Web Service Protokolle wie SOAP, XML-RPC oder REST anzubieten. In den meisten Fällen wird man den ViewRenderer nie global ausschalten müssen, nur selektiv innerhalb einzelner Controller oder Aktionen.

Objekt Initialisierung

Wärend man immer den Konstruktor des Aktion Controller's überschreiben kann ist das nicht notwendig. Zend_Controller_Action::__construct() führt einige wichtige Aufgabe aus, wie das registrieren der Anfrage und Antwort Objekte, sowie alle eigene einleitenden Argumente die von Front Controller übergeben wurden. Wenn der Konstruktor überschrieben werden muß, muß sichergestellt sein das parent::__construct($request, $response, $invokeArgs) aufgerufen wird.

Der bessere Weg als die Instanzierung zu ändern ist die Verwendung der init() Methode, welche nach der letzten Aufgabe von __construct() aufgerufen wird. Zum Beispiel wenn man sich zu einer Datenbank bei der Instanzierung verbinden will:

  1. class FooController extends Zend_Controller_Action
  2. {
  3.     public function init()
  4.     {
  5.         $this->db = Zend_Db::factory('Pdo_Mysql', array(
  6.             'host'     => 'myhost',
  7.             'username' => 'user',
  8.             'password' => 'XXXXXXX',
  9.             'dbname'   => 'website'
  10.         ));
  11.     }
  12. }

Pre- und Post-Dispatch Hooks

Zend_Controller_Action spezifiziert zwei Methoden die aufgerufen werden können um eine angefragte Aktion fertigzustellen, preDispatch() und postDispatch(). Diese können auf viele Wege nützlich sein: zum Beispiel um Authentifizierungen und ACL's prüfen bevor eine Aktion ausgeführt wird (durch Aufruf von _forward() in preDispatch() wird die Aktion übersprungen), oder erzeugte Inhalte in einem seitenweiten Template zu plazieren ( postDispatch()).

Note: Verwendung von of init() vs. preDispatch()
In der vorigen Sektion haben wir die init() Methode eingeführt, und in dieser Sektion die preDispatch() Methode. Was ist der Unterschied zwischen Ihnen, und welche Aktionen kann man in jeder von Ihnen durchführen?
Die init() Methode ist primär dafür gedacht den Constructor zu erweitern. Typischerweise sollte der Constructor einfach den Status des Objekts setzen und keine weitere Logik ausführen. Das kann die Initialisierung von Ressourcen enthalten die im Kontroller verwendet werden (wie Modelle, Konfigurations Objekte, usw.), oder die Zuordnung von Werten die vom Front Controller, der Bootstrap oder einer Registry empfangenen wurden.
Die preDispatch() Methode kann auch verwendet werden um den Status des Objekts oder der Umgebung (z.B. View, Action Helfer, usw.) zu setzen, aber sein primärer Zweck besteht darin Annahme darüber zu treffen, ob eine angefragte Aktion ausgeführt werden sollte oder nicht. Wenn nicht, dann sollte _forward() auf eine andere Aktion ausgeführt, oder eine Exception geworfen werden.
Beachte: _forward() arbeitet aktuell nicht korrekt wenn es von init() ausgeführt wird, das die Formalisierung der Annahmen beider Methoden ist.

Zugriffe

Eine Anzahl von Objekten und Variablen werden im Objekt registriert, und jede hat Zugriffsmethoden.

  • Anfrage Objekt: getRequest() kann verwendet werden um das Anfrage Objekt zu erhalten das verwendet wurde um die Aktion aufzurufen.

  • Antwort Objekt: getResponse() kann verwendet werden um das Antwort Objekt zu erhalten das die letztendliche Antwort erzeugt. Einige typische Aufrufe können wie folgt aussehen:

    1. $this->getResponse()->setHeader('Content-Type', 'text/xml');
    2. $this->getResponse()->appendBody($content);
  • Aufgerufene Argumente: Der Front Controller kann Parameter in den Router, Dispatcher und Aktion Controller einfügen. Um diese zu erhalten kann getInvokeArg($key) verwendet werden; alternativ kann man die komplette Liste mit getInvokeArgs() erhalten.

  • Anfrage Parameter: Das Anfrage Objekt liefert die Anfrage Parameter, wie alle _GET oder _POST Parameter, oder Benutzer Parameter die in der Information des URL Pfades spezifiziert sind. Um diese zu erhalten kann _getParam($key) oder _getAllParams() verwendet werden. Es können auch Anfrage Parameter gesetzt werden indem _setParam() verwendet wird; das ist nützlich wenn an zusätzliche Aktionen weitergeleitet werden soll.

    Um zu Testen ob ein Parameter existiert (nützlich für logische Auswahlen), kann _hasParam($key) verwendet werden.

    Note: _getParam() kann ein optionales zweites Argument nehmen das einen Standardwert enthält der verwendet wird wenn der Parameter nicht gesetzt oder leer ist. Wenn er verwendet wird ist es nicht mehr notwendig _hasParam() vor dem Empfangen eines Wertes aufzurufen:

    1. // Verwende des Standardwert 1 wenn id nicht gesetzt wurde
    2. $id = $this->_getParam('id', 1);
    3.  
    4. // Statt:
    5. if ($this->_hasParam('id') {
    6.     $id = $this->_getParam('id');
    7. } else {
    8.     $id = 1;
    9. }

View Integration

Note: Standard View Integration über den ViewRenderer
Der Inhalt dieses Kapitel ist nur gültig wenn man den ViewRenderer explizit deaktiviert hat. Andernfalls kann man dieses kapitel ohne Bedenken überspringen.

Zend_Controller_Action bietet einen rudimentären und flexiblen Mechanismus für View Integration. Zwei Methoden machen das möglich, initView() und render(); die erste Methode lädt die öffentliche Eigenschaft $view träge, und die zweite rendert eine View basierend auf der aktuell angefragen Aktion, wobei die Verzeichnis Hirarchie verwendet wird um den Pfad des Skripts zu ermitteln.

View Initialisierung

initView() initialisiert das View Objekt. render() ruft initView() auf um das View Objekt zu erhalten, aber es kann jederzeit initialisiert werden; standardmäßig wird die $view Eigenschaft mit einem Zend_View Objekt bekanntgegeben, aber jede Klasse die Zend_View_Interface implementiert kann verwendet werden. Wenn $view bereits initialisiert wurde, wird diese Eigenschaft einfach zurückgegeben.

Die Standardimplementation macht die folgenden Annahmen über die Verzeichnisstruktur:

  1. applicationOrModule/
  2.     controllers/
  3.         IndexController.php
  4.     views/
  5.         scripts/
  6.             index/
  7.                 index.phtml
  8.         helpers/
  9.         filters/

In anderen Worten, wird angenommen das View Skripte im /views/scripts/ Unterverzeichnis sind, und das /views/ Unterverzeichnis weitere Funktionalitäten enthält (helpers, filters). Wenn der Name und der Pfad des View Skripts ermittelt wird, wird das /views/scripts/ Verzeichnis als Basispfad verwendet, mit einem Verzeichnis das nach dem individuellen Controller benannt ist und eine Hierarchie von View Skripten bietet.

Rendern von Views

render() hat die folgende Signatur:

  1. string render(string $action = null,
  2.               string $name = null,
  3.               bool $noController = false);

render() rendert ein View Skript. Wenn keine Argumente übergeben werden, wird angenommen dass das angefragte Skript [controller]/[action].phtml ist (wobei .phtml der Wert der $viewSuffix Eigenschaft ist). Wenn ein Wert für $action angegeben wird, wird das Template im /[controller]/ Unterverzeichnis gerendert. Um die Verwendung des /[controller]/ Unterverzeichnisses zu überschreiben kann ein TRUE Wert für $noController übergeben werden. Zuletzt werden templates in das Antwort Objekt gerendert; wenn zu einem spezifischen benannten Segment im Antwort Objekt dargestellt werden soll, kann ein Wert an $name übergeben werden.

Note: Da Controller- und Aktionsnamen Wort Begrenzer Zeichen enthalten können wie z.B. '_', '.' und '-', normalisiert render() diese zu '-' wenn der Skript Name eruiert wird. Intern werden die Wort- und Pfadbegrenzer vom Dispatcher verwendet um die Normalisierung durchzuführen. Deshalb wird eine Anfrage auf /foo.bar/baz-bat das Skript auf foo-bar/baz-bat.phtml rendern. Wenn eine Aktionsmethode camelCase Zeichen enthält, muß beachtet werden das diese in '-' seperierten Wörter umgewandelt werden wenn der Dateiname des View Skripts eruiert wird.

Einige Beispiele:

  1. class MyController extends Zend_Controller_Action
  2. {
  3.     public function fooAction()
  4.     {
  5.         // Rendert my/foo.phtml
  6.         $this->render();
  7.  
  8.         // Rendert my/bar.phtml
  9.         $this->render('bar');
  10.  
  11.         // Rendert baz.phtml
  12.         $this->render('baz', null, true);
  13.  
  14.         // Rendert my/login.phtml in das 'form' Segment des Antwort Objektes
  15.         $this->render('login', 'form');
  16.  
  17.         // Rendert site.phtml in das 'page' Segmetn des Antwort Objektes;
  18.         // verwendet nicht das 'my/' Unterverzeichnis
  19.         $this->render('site', 'page', true);
  20.     }
  21.  
  22.     public function bazBatAction()
  23.     {
  24.         // Rendert my/baz-bat.phtml
  25.         $this->render();
  26.     }
  27. }

Nützliche Methoden

Neben den Zugriffs- und View Integrationsmethoden, hat Zend_Controller_Action verschiedene nützliche Methoden für die Durchführung üblicher Aufgaben von innerhalb der Aktionsmethoden (oder vom Pre- und Post-Dispatch).

  • _forward($action, $controller = null, $module = null, array $params = null): führt eine weitere Aktion aus. Wenn in preDispatch() aufgerufen, wird die aktuelle aufgerufene Aktion übersprungen zugunsten der neuen. Andererseits, wenn die aktuelle Aktion durchgeführt wurde, wird die Aktion die in _forward() angefragt wird, ausgeführt.

  • _redirect($url, array $options = array()): leitet zu einem anderen Ort um. Diese Methode nimmt eine URL und ein optionales Set von Optionen. Standardmäßig führt Sie eine HTTP 302 Umleitung durch.

    Diese Optionen können ein oder mehrere der folgenden enthalten:

    • exit: ob oder ob nicht sofort ausgestiegen werden soll. Wenn angefragt, wird jede offene Session sauber beendet und die Umleitung durchgeführt.

      Diese Option kann global im Controller gesetzt werden indem der setRedirectExit() Zugriff verwendet wird.

    • prependBase: ob oder ob nicht, die im Anfrage Objekt registrierte Basis URL, dem angebotenen URL angehängt wird.

      Diese Option kann gobal im Controller gesetzt werden indem der setRedirectPrependBase() Zugriff verwendet wird.

    • code: welche HTTP Code für die Umleitung verwendet wird. Standardmäßig wird ein HTTP 302 erstellt; jeder Code zwischen 301 und 306 kann verwendet werden.

      Diese Option kann global im Controller gesetzt werden indem der setRedirectCode() Zugriff verwendet wird.

Erweitern des Aktion Controllers

Vom Design her muß Zend_Controller_Action erweitert werden um einen Aktion Controller zu erstellen. Als Minimum, muß eine Aktions Methode definiert werden die der Controller aufrufen kann.

Neben dem erstellen von nützlichen Funktionalitäten für Web Anwendungen, wird auch die Notwendigkeit bestehen das vom gleichen Setup oder von den nützlichen Funktionen vieles in verschiedenen Controllern wiederholt wird; wenn dem so ist, löst die Erstellung einer gemeinsamen Basis Controller Klasse die Zend_Controller_Action erweitert zu einer Lösung dieser Redundanz.

Example #1 Behandeln nicht-vorhandener Aktionen

Wenn eine Anfrage an einen Controller durchgeführt wird die eine undefinierte Aktions Methode enthält, kommt Zend_Controller_Action::__call() zum Einsatz. __call() ist natürlich PHP's magische Methode für das Überladen von Methoden.

Standardmäßig wirft diese Methode eine Zend_Controller_Action_Exception die anzeigt das die angefragte Aktion nicht im Controller gefunden werden konnte. Wenn die angefragte Methode mit 'Action' endet, wird angenommen das eine Aktion angefragt wurde die nicht existiert; solch ein Fehler resultiert in einer Ausnahme mit dem Code 404. Alle anderen Methoden resultieren in einer Ausnahme mit dem Code 500. Das erlaubt die einfache Differenzierung zwischen Seiten die nicht gefunden wurden und Anwendungsfehlern in der Fehlerbehandlung.

Diese Funktionalität sollte überschrieben werden wenn eine andere Operation ausgeführt werden soll. Wenn zum Beispiel eine Fehlermeldung angezeigt werden soll kann etwas die das folgende geschrieben werden:

  1. class MyController extends Zend_Controller_Action
  2. {
  3.     public function __call($method, $args)
  4.     {
  5.         if ('Action' == substr($method, -6)) {
  6.             // Wenn die Aktionsmethode nicht gefunden wurde,
  7.             // das error Template darstellen
  8.             return $this->render('error');
  9.         }
  10.  
  11.         // Alle anderen Methoden werfen eine Ausnahme
  12.         throw new Exception('Invalid method "'
  13.                             . $method
  14.                             . '" called',
  15.                             500);
  16.     }
  17. }

Eine andere Möglichkeit ist, dass man zu einer standardmäßigen Controller Seiten weiterleiten will:

  1. class MyController extends Zend_Controller_Action
  2. {
  3.     public function indexAction()
  4.     {
  5.         $this->render();
  6.     }
  7.  
  8.     public function __call($method, $args)
  9.     {
  10.         if ('Action' == substr($method, -6)) {
  11.             // Wenn die Aktionsmethode nicht gefunden wurde,
  12.             // leite zur Index Aktion weiter
  13.             return $this->_forward('index');
  14.         }
  15.  
  16.         // Alle anderen Methoden werden eine Ausnahme
  17.         throw new Exception('Invalid method "'
  18.                             . $method
  19.                             . '" called',
  20.                             500);
  21.     }
  22. }

Neben dem überschreiben von __call(), kann jede der Initialisierungs-, Utility-, Zugriffs-, View- und Dispatch-Hook Methoden die vorher in diesem Kapitel beschrieben wurden, überschrieben werden um eigene Controller anzupassen. Wenn man, als Beispiel, die View Objekte in der Registry speichert, kann es gewünscht sein die initView() Methode mit Code zu Ändern der das folgende zusammensetzt:

  1. abstract class My_Base_Controller extends Zend_Controller_Action
  2. {
  3.     public function initView()
  4.     {
  5.         if (null === $this->view) {
  6.             if (Zend_Registry::isRegistered('view')) {
  7.                 $this->view = Zend_Registry::get('view');
  8.             } else {
  9.                 $this->view = new Zend_View();
  10.                 $this->view->setBasePath(dirname(__FILE__) . '/../views');
  11.             }
  12.         }
  13.  
  14.         return $this->view;
  15.     }
  16. }

Hoffentlich kann man anhand der Informationen in diesem Kapitel ersehen wie flexibel diese spezielle Komponente ist und wie Sie in eigene Anwendungen oder den Notwendigkeiten von Seiten damit erfüllt werden kann.

blog comments powered by Disqus