Action Helfer

Einführung

Aktion Helfer erlauben Entwicklern Runtime und/oder On-Demand Funktionalität in jeden Aktion Controller zu inizieren der Zend_Controller_Action erweitert. Aktion Controller versuchen den Notwendigkeit zu minimieren, den abstrakten Aktion Controller zu erweitern um damit normale Aktion Controller Funktionen inizieren.

Es gibt eine Menge an Wegen um Aktion Helfer zu verwenden. Aktion Helfer verwenden ein Broker System, ähnlich den Typen von Brokern in Zend_View_Helper, und denen von Zend_Controller_Plugin. Aktion Helfer Zend_View_Helper) können bei Bedarf geladen und aufgerufen werden, oder Sie können wärend der Anfragezeit (Bootstrap) instanziert werden oder wären der Erstellungszeit des Aktion Controllers ( init()). Um Sie näher zu verstehen, betrachten wir Ihre Verwendung in der folgenden Sektion.

Helfer Initialisierung

Ein Helfer kann auf vielen verschiedenen Wegen initialisiert werden, basierend auf den eigenen Bedürfnissen und den Funktionalitäten dieses Helfers.

Ein Helfer Broker wir das der $_helper Teilnehmer von Zend_Controller_Action gespeichert; der Broker kann verwendet werden um Helfer zu empfangen oder aufzurufen. Einige Methoden das zu tun sind:

  • Explizit getHelper() verwenden. Ihm einfach einen Namen übergeben und ein Helfer Objekt wird zurückgegeben:

    1. $flashMessenger = $this->_helper->getHelper('FlashMessenger');
    2. $flashMessenger->addMessage('Wir haben in der letzten Anfrage etwas getan');
  • Verwenden der __get() Funktionalität des Helfer Brokers und Empfangen des Helfers wie wenn er eine Teilnehmer Eigenschaft des Brokers wäre:

    1. $flashMessenger = $this->_helper->FlashMessenger;
    2. $flashMessenger->addMessage('Wir haben in der letzten Anfrage etwas getan');
  • Letztendlich implmentieren die meisten Aktion Helfer die direct() Methode welche eine spezielle, Standardmethode im Helfer aufruft. In Beispiel des FlashMessenger's, wird addMessage() aufgerufen:

    1. $this->_helper->FlashMessenger('Wir haben in der letzten Anfrage etwas getan');

Note: Alle oben angeführten Beispiel sind funktionell gleichwertig.

Man kann Helfer auch explizit instanzieren. Das kann gewollt sein wenn der Helfer ausserhalb eines Aktion Controllers verwendet werden soll, oder wenn ein Helfer an einen Helfer Broker übergeben wird um Ihn durch irgendeine Aktion zu verwenden. Instanziert wird er wie jede andere PHP Klasse.

Der Helfer Broker

Zend_Controller_Action_HelperBroker behandelt die Details der Registrierung von Helfer Objekten und Helfer Pfaden, sowie dem Empfangen von Helfern bei Befarf.

Um einen Helfer im Browser zu registrieren, kann addHelper() verwendet werden:

  1. Zend_Controller_Action_HelperBroker::addHelper($helper);

Natürlich ist das Instanzieren und übergeben von Helfern an den Broker etwas Zeit- und Ressourcen intensiv, weswegen twei Methoden existieren um die Dinge etwas zu automatisieren: addPrefix() und addPath().

  • addPrefix() nimmt einen Klassenpräfix und verwendet Ihn um einen Pfad zu ermitteln wo Helferklassen definiert wurden. Er nimmt an das der Präfix den Konventionen der Benamung von Klassen im Zend Framework folgt.

    1. // Helfer mit vorangestelltem My_Action_Helpers in My/Action/Helpers/ hinzufügen
    2. Zend_Controller_Action_HelperBroker::addPrefix('My_Action_Helpers');
  • addPath() nimmt ein Verzeichnis als erstes Argument und einen Klassenprefix als zweites Argument (Standardwert ist 'Zend_Controller_Action_Helper'). Das erlaubt es die eigenen Klassenpräfixes mit speziellen Verzeichnissen zu verbinden.

    1. // Helfer mit vorangestelltem Helper in Plugins/Helpers/ hinzufügen
    2. Zend_Controller_Action_HelperBroker::addPath('./Plugins/Helpers',
    3.                                              'Helper');

Da diese Methoden statisch sind, können Sie zu jeder Zeit in der Controllerkette aufgerufen werden um Helfer dynamisch hinzuzufügen wenn es notwendig wird.

Intern verwendet der Helfer Broker eine Instanz des PluginLoader's um die Pfade zu verwalten. Man erhlt den PluginLoader indem die statische Methode getPluginLoader() verwendet, oder alternativ, eine eigene PluginLoader Instanz einfügt durch Verwenden von setPluginLoader().

Um zu ermitteln ob ein Helfer im Helfer Broker existiert, kann hasHelper($name) verwendet werden, wobei $name der Kurzname des Helfers ist (ohne das Präfix):

  1. // Prüft ob der 'redirector' Helfer im Broker registriert ist:
  2. if (Zend_Controller_Action_HelperBroker::hasHelper('redirector')) {
  3.     echo 'Der Redirector Helfer ist registriert';
  4. }

Es gibt auch zwei statische Methoden für das bekommen von Helfern vom Helferbroker: getExistingHelper() und getStaticHelper(). getExistingHelper() empfängt einen Helfer nur dann wenn er davor durch den Helferbroker ausgerufen wirde oder explizit in Ihm registriert wurde; wenn nicht wird eine Ausnahme geworfen. getStaticHelper() macht das selbe wie getExistingHelper(), wird aber versuchen den Helfer zu initiieren wenn dieser davor noch nicht im Helferstack registriert wurde. getStaticHelper() ist eine gute Wahl für das empfangen von Helfern welche man konfigurieren will.

Beide Methoden nehmen ein einzelnes Argument, $name, welches der Kurzname des Helfers (ohne den Präfix) ist.

  1. // Prüfe ob der 'redirector' Helfer im Broker registriert ist und holt Ihn:
  2. if (Zend_Controller_Action_HelperBroker::hasHelper('redirector')) {
  3.     $redirector =
  4.         Zend_Controller_Action_HelperBroker::getExistingHelper('redirector');
  5. }
  6.  
  7. // Oder, Ihn einfach empfangen, ohne darüber nachzudenken ob er bereits
  8. // registriert wurde oder nicht:
  9. $redirector =
  10.     Zend_Controller_Action_HelperBroker::getStaticHelper('redirector');
  11. }

Schlußendlich, um einen registrierten Helfer vom Broker zu entfernen, kann removeHelper($name) verwendet werden, wobei $name der Kurzname des Helfers ist (ohne den Prefix):

  1. // Wenn vorhanden, entferne den 'redirector' Helfer vom Broker:
  2. if (Zend_Controller_Action_HelperBroker::hasHelper('redirector')) {
  3.     Zend_Controller_Action_HelperBroker::removeHelper('redirector')
  4. }

Eingebaute Aktions Helfer

Zend Framework enthält standardmäßig verschiedene Action Helfer: AutoComplete für automatisierte Antworten für AJAX Autovervollständigung; ContextSwitch und AjaxContext für alternative Antwort Formate eigener Aktionen; einen FlashMessenger für die Behandlung von Kurznachrichten; Json für das verschlüsseln und senden von JSON Antworten; einen Redirector, um verschiedene Implementationen, für das Umleiten zu internen und externen Seiten, für die Anwendung bereitzustellen und einen ViewRenderer um den Prozess des Setzens eines View Objekts im Controller und dem Rendern von Views zu automatisieren.

ActionStack

Der ActionStack Helfer erlaubt das Verschieben von Anfragen zum ActionStack Front Controller Plugin, welches effektiv hilft um eine Queue von Aktionen zu erstellen die wärend der Anfrage ausgeführt wird. Der Helfer erlaubt das hinzufügen von Aktionen entweder durch Spezifikation von neuen Anfrage Objekten oder Aktion - Controller - Modul Sets.

Note: Der Aufruf des ActionStack Helpers inizialisiert das ActionStack Plugin
Der Aufruf des ActionStack Helpers registriert das ActionStack Plugin implizit -- was bedeutet dass das ActionStack Plugin nicht explizit registriert werden muß um dessen Funktionalität zu verwenden.

Example #1 Eine Aufgabe hinzufügen indem Aktion, Controller und Modulnamen verwendet werden

Oft ist es am einfachsten, einfach die Aktion, den Controller und das Modul (und optionale Anfrage Parameter) zu spezifizieren, wie wenn Zend_Controller_Action::_forward() aufgerufen werden würde:

  1. class FooController extends Zend_Controller_Action
  2. {
  3.     public function barAction()
  4.     {
  5.         // Dem Stack zwei Aktionen hinzufügen
  6.         // Und /foo/baz/bar/baz aufrufen
  7.         // (FooController::bazAction() mit der Anfrage var bar == baz)
  8.         $this->_helper->actionStack('baz',
  9.                                     'foo',
  10.                                     'default',
  11.                                     array('bar' => 'baz'));
  12.  
  13.         // Aufruf für /bar/bat hinzufügen
  14.         // (BarController::batAction())
  15.         $this->_helper->actionStack('bat', 'bar');
  16.     }
  17. }

Example #2 Eine Aufgabe hinzufügen durch Verwendung eines Anfrage Objektes

Machmal macht die OOP Natur eines Anfrage Objektes mehr Sinn; solch ein Objekt kann dem ActionStack Helfer genauso übergeben werden.

  1. class FooController extends Zend_Controller_Action
  2. {
  3.     public function barAction()
  4.     {
  5.         // Dem Stack zwei Aktionen hinzufügen
  6.         // Aufruf zu /foo/baz/bar/baz hinzufügen
  7.         // (FooController::bazAction() mit der Anfrage var bar == baz)
  8.         $request = clone $this->getRequest();
  9.         // Controller oder Modul nicht setzen, verwende aktuelle Werte
  10.         $request->setActionName('baz')
  11.                 ->setParams(array('bar' => 'baz'));
  12.         $this->_helper->actionStack($request);
  13.  
  14.         // Aufruf zu /bar/bat hinzufügen
  15.         // (BarController::batAction())
  16.         $request = clone $this->getRequest();
  17.         // Modul nicht setzen, verwende aktuelle Werte
  18.         $request->setActionName('bat')
  19.                 ->setControllerName('bar');
  20.         $this->_helper->actionStack($request);
  21.     }
  22. }

AutoComplete

Viele AJAX Javascript Bibliotheken bieten Funktionalitäten an für eine automatische Vervollständigung wobei eine Auswahlliste von potentiell passenden Ergebnissen angezeigt wird während der Benutzer tippt. Der AutoComplete Helfer zielt darauf ab einfach akzeptierbare Ergebnisse zu solchen Methoden zurückzugeben.

Da nicht alle JS Bibliotheken automatische Vervollständigung auf die gleiche Art implementieren bietet der AutoComplete Helfer einige grundsätzliche abstrakte Funktionalitäten zu vielen Bibliotheken und konkrete Implementierungen für individuelle Bibliotheken. Zurückgegebene Typen sind generell entweder JSON Arrays von Strings, JSON Arrays von Arrays (mit jedem Mitgliedsarray das ein assoziatives Array von Metadaten ist, das verwendet wird um die Auswahlliste zu erstellen), oder HTML.

Die grundsätzliche Verwendung ist für jede Implementierung die selbe:

  1. class FooController extends Zend_Controller_Action
  2. {
  3.     public function barAction()
  4.     {
  5.         // etwas Logik durchführen...
  6.  
  7.         // Verschlüsseln und Antwort senden;
  8.         $this->_helper->autoCompleteDojo($data);
  9.  
  10.         // oder explizit:
  11.         $response = $this->_helper->autoCompleteDojo
  12.                                   ->sendAutoCompletion($data);
  13.  
  14.         // oder einfach die Antwort der automatischen
  15.         // Vervollständigung vorbereiten;
  16.         $response = $this->_helper->autoCompleteDojo
  17.                                   ->prepareAutoCompletion($data);
  18.     }
  19. }

Standardmäßig mach die automatische Vervollständigung folgendes:

  • Layouts und ViewRenderer ausschalten.

  • Die richtigen Antwort Header zu setzen.

  • Antwort Body mit verschlüsselten oder formatierten automatisch vervollständigten Daten setzen.

  • Antwort senden.

Mögliche Methoden des Helfers beinhalten:

  • disableLayouts() kann verwendet werden um Layouts und den ViewRenderer auszuschalten. Typischerweise wird das innerhalb von prepareAutoCompletion() aufgerufen.

  • encodeJson($data, $keepLayouts = false) verschlüsselt Daten zu JSON, und aktiviert oder deaktiviert Layouts optional. Typischerweise wird das innerhalb von prepareAutoCompletion() aufgerufen.

  • prepareAutoCompletion($data, $keepLayouts = false) wird verwendet um Daten im Antwortformat vorzubereiten wenn das für die konkrete Implementation notwendig ist, wobei Layouts optional aktiviert oder deaktiviert werden können. Der Rückgabewert variiert basierend auf der Implementierung.

  • sendAutoCompletion($data, $keepLayouts = false) wird verwendet um Daten im Antwortformat zu senden was für die konkrete Implementierung notendig ist. Sie ruft prepareAutoCompletion() und sendet dann die Antwort.

  • direct($data, $sendNow = true, $keepLayouts = false) wird verwendet wenn der Helfer als Methode des Helfer Brokers aufgerufen wird. Das $sendNow Flag wird verwendet um festzustellen ob sendAutoCompletion() oder prepareAutoCompletion() aufgerufen werden muß.

Aktuell unterstützt AutoComplete die folgenden Dojo und Scriptaculous AJAX Bibliotheken.

AutoCompletion mit Dojo

Dojo hat per se keinen AutoCompletion Wizard, hat aber zwei Wizards die AutoCompletion ausführen können: ComboBox und FilteringSelect. In beiden Fällen benötigen Sie einen Datenspeicher der QueryReadStore implementiert; für mehr Informationen über dieses Thema siehe die » dojo.data Dokumentation.

Im Zend Framework kann ein einfaches indiziertes Array an den AutoCompletionDojo Helfer übergeben werden, und er wird eine JSON Antwort zurückgeben die passend für die Verwendung in so einem Speicher ist:

  1. // In der Controller Aktion:
  2. $this->_helper->autoCompleteDojo($data);

Example #3 AutoCompletion mit Dojo und der Verwendung von Zend MVC

AutoCompletion mit Dojo, über Zend MVC, benötigt verschiedene Dinge: Erstellung eines Form Objekts für die Kombobox bei der man AutoCompletion will, eine Controller Action für das anbieten der AutoCompletion Ergebnisse, Erstellung eines eigenen QueryReadSote um die AutoCompletion Aktion damit zu verbinden, und Erstellung des Javascripts das zur Initialisierung der AutoCompletion auf der Serverseite zu verwenden ist.

Schauen wir uns zuerst das benötigte Javascript an. Dojo bietet ein komplettes Framework für die Erstellung von OOP Javascript, so wie Zend Framework für PHP. Teile davon sind die Möglichkeit Pseudo-Namespaces zu erstellen indem die Verzeichnis Hirarchie verwendet wird. Wir erstellen ein 'custom' Verzeichnis auf dem gleichen Level wie das Dojo Verzeichnis das Teil der Distribution von Dojo ist. In diesem Verzeichnis, erstellen wir eine Javascript Datei, TestNameReadStore.js, mit den folgenden Inhalten:

  1. dojo.provide("custom.TestNameReadStore");
  2. dojo.declare("custom.TestNameReadStore", dojox.data.QueryReadStore, {
  3.     fetch:function (request) {
  4.         request.serverQuery = { test:request.query.name };
  5.         return this.inherited("fetch", arguments);
  6.     }
  7. });

Diese Klasse ist einfach eine Erweiterung von Dojo's eigenem QueryReadStore, welche selbst eine Abstrakte Klasse ist. Wir definieren einfach eine Methode mit der angefragt werden soll, und verknüpfen Sie mit dem 'test' Element.

Als nächstes, erstellen wir das Form Element für das wir AutoCompletion wollen:

  1. class TestController extends Zend_Controller_Action
  2. {
  3.     protected $_form;
  4.  
  5.     public function getForm()
  6.     {
  7.         if (null === $this->_form) {
  8.             $this->_form = new Zend_Form();
  9.             $this->_form->setMethod('get')
  10.                 ->setAction(
  11.                     $this->getRequest()->getBaseUrl() . '/test/process'
  12.                 )
  13.                 ->addElements(array(
  14.                     'test' => array('type' => 'text', 'options' => array(
  15.                         'filters'        => array('StringTrim'),
  16.                         'dojoType'       => array('dijit.form.ComboBox'),
  17.                         'store'          => 'testStore',
  18.                         'autoComplete'   => 'false',
  19.                         'hasDownArrow'   => 'true',
  20.                         'label' => 'Your input:',
  21.                     )),
  22.                     'go' => array('type' => 'submit',
  23.                                   'options' => array('label' => 'Go!'))
  24.                 ));
  25.         }
  26.         return $this->_form;
  27.     }
  28. }

Hier erstellen wir einfach eine Form mit den 'test' und 'go' Methoden. Die 'test' Methode fügt verschiedene spezielle, Dojo-spezifische Attribute hinzu: dojoType, store, autoComplete, und hasDownArrow. Der dojoType wird verwendet um anzuzeigen das wir eine ComboBox erstellen, und wir Sie zum Datenspeicher von 'testStore' verbinden wollen (Schlüssel 'store') -- mehr dazu später. Die Spezifizierung von 'autoComplete' mit FALSE sagt Dojo das der erste passende Eintrag nicht automatisch ausgewählt wird, aber stattdessen eine Liste von Entsprechnungen angezeigt wird. Letztendlich, erstellt 'hasDownArrow' einen Abwärtspfeil ähnlich einer Selectbox sodas Wir die Entsprechnungen zeigen und verstecken können.

Fügen wir eine Methode hinzu um die Form anzuzeigen, sowie einen Endpunkt für die Bearbeitung der AutoCompletion:

  1. class TestController extends Zend_Controller_Action
  2. {
  3.     // ...
  4.  
  5.     /**
  6.      * Startseite
  7.      */
  8.     public function indexAction()
  9.     {
  10.         $this->view->form = $this->getForm();
  11.     }
  12.  
  13.     public function autocompleteAction()
  14.     {
  15.         if ('ajax' != $this->_getParam('format', false)) {
  16.             return $this->_helper->redirector('index');
  17.         }
  18.         if ($this->getRequest()->isPost()) {
  19.             return $this->_helper->redirector('index');
  20.         }
  21.  
  22.         $match = trim($this->getRequest()->getQuery('test', ''));
  23.  
  24.         $matches = array();
  25.         foreach ($this->getData() as $datum) {
  26.             if (0 === strpos($datum, $match)) {
  27.                 $matches[] = $datum;
  28.             }
  29.         }
  30.         $this->_helper->autoCompleteDojo($matches);
  31.     }
  32. }

in unserer autocompleteAction() machen wir eine Anzahl von Dingen. Zuerst schauen wir darauf eine Post Anfrage durchzuführen, und das dort ein 'format' Parameter auf den Wert 'ajax' gesetzt ist; das hilft einfach störende Anfragen zur Aktion zu reduzieren. Als nächstes prüfen wir auf den 'test' Parameter, und vergleichen Ihn mit unseren Daten. (wir haben absichtlich die Implementation von getData() hier ausgelassen -- es können einfach jede Art von Datenquelle sein.) Letztendlich senden wir unsere Entsprechungen zum AutoCompletion Helfer.

Jetzt da wir alle Teile des Backends haben, sehen wir uns an was wir benötigen um es in unserem View Skript für die Startseite auszugeben. Zuerst müssen wir unseren Datenspeicher einstellen, dann unsere Form darstellen, und letztendlich sicherstellen das die richtigen Dojo Bibliotheken -- inklusive unserer eigenen Datenspeicher -- geladen werden. Schauen wir uns das View Skript an, das die Schritte kommentiert:

  1. <?php // Den Datenspeicher einstellen: ?>
  2. <div dojoType="custom.TestNameReadStore" jsId="testStore"
  3.     url="<?php echo $this->baseUrl() ?>/unit-test/autocomplete/format/ajax"
  4.     requestMethod="get"></div>
  5.  
  6. <?php // Die Form darstellen: ?>
  7. <?php echo $this->form ?>
  8.  
  9. <?php // Das Dojo-betreffende CSS einstellen das im
  10.       // HTML Head geladen werden soll: ?>
  11. <?php $this->headStyle()->captureStart() ?>
  12. @import "<?php echo $this->baseUrl()
  13. ?>/javascript/dijit/themes/tundra/tundra.css";
  14. @import "<?php echo $this->baseUrl() ?>/javascript/dojo/resources/dojo.css";
  15. <?php $this->headStyle()->captureEnd() ?>
  16.  
  17. <?php // Javascript einstellen das im HTML Head geladen werden soll,
  18.       // inklusive aller benötigten Dojo Bibliotheken: ?>
  19. <?php $this->headScript()
  20.         ->setAllowArbitraryAttributes(true)
  21.         ->appendFile($this->baseUrl() . '/javascript/dojo/dojo.js',
  22.             'text/javascript',
  23.             array('djConfig' => 'parseOnLoad: true'))
  24.         ->captureStart() ?>
  25. djConfig.usePlainJson=true;
  26. dojo.registerModulePath("custom","../custom");
  27. dojo.require("dojo.parser");
  28. dojo.require("dojox.data.QueryReadStore");
  29. dojo.require("dijit.form.ComboBox");
  30. dojo.require("custom.TestNameReadStore");
  31. <?php $this->headScript()->captureEnd() ?>

Beachte die Aufrufe zu den View Helfern wie headStyle und headScript; das sind Platzhalter, welche dann in der HTML Head Sektion des Layout View Skripts dargestellt werden können.

Wir haben jetzt alle Teil um mit Dojo AutoCompletion zu arbeiten.

AutoCompletion mit Scriptaculous

» Scriptaculous erwartet eine HTML Antwort in einem speziellen Format.

Der Helfer der mit dieser Bibliothek zu verwenden ist 'AutoCompleteScriptaculous'. Es muß einfach ein Array von Daten angegeben werden, und der Helfer wird eine HTML Antwort erstellen die mit Ajax.Autocompleter kompatibel ist.

ContextSwitch und AjaxContext

Der ContextSwitch Action Helfer ist vorgesehen für die Erleicherung bei der Rückgabe von unserschiedlichen Antwortformaten oder Anfragen. Der AjaxContext Helfer ist eine spezialisierte Version von ContextSwitch welche die Rückgabe von Antworten zu XmlHttpRequests erleichtert.

Um einen von Ihnen zu aktivieren, muß der Controller darauf hingewiesen werden welche Aktion zu welchem Kontext antworten kann. Wenn eine hereinkommende Anfrage einen gültigen Kontext für eine gegebene Aktion indiziert, dann wird der Helfer:

  • das Layout ausschalten wenn es eingeschaltet ist.

  • einen alternativen View suffix setzen, was effektiv ein separates View Skript für den Kontext benötigt.

  • die richtigen Antwort Header für den gewünschten Kontext senden.

  • optional den spezifizierten Callback aufrufen um den Kontext zu definieren und/oder anschließende Berechnungen durchführen.

Als Beispiel wird der folgende Controller angenommen:

  1. class NewsController extends Zend_Controller_Action
  2. {
  3.     /**
  4.      * Landeseite; leitet zu listAction() weiter
  5.      */
  6.     public function indexAction()
  7.     {
  8.         $this->_forward('list');
  9.     }
  10.  
  11.     /**
  12.      * News Items auflisten
  13.      */
  14.     public function listAction()
  15.     {
  16.     }
  17.  
  18.     /**
  19.      * Ein News Item anzeigen
  20.      */
  21.     public function viewAction()
  22.     {
  23.     }
  24. }

Angenommen wir wollen das listAction() auch im XML Format vorhanden ist. Statt der Erstellung einer anderen Aktion, kann angezeigt werden das eine XML Antwort zurückgegeben wird:

  1. class NewsController extends Zend_Controller_Action
  2. {
  3.     public function init()
  4.     {
  5.         $contextSwitch = $this->_helper->getHelper('contextSwitch');
  6.         $contextSwitch->addActionContext('list', 'xml')
  7.                       ->initContext();
  8.     }
  9.  
  10.     // ...
  11. }

Was macht das:

  • Setzt den 'Content-Type' Antwort Header auf 'text/xml'.

  • Ändert den View Suffix auf 'xml.phtml' (oder, wenn ein alternativer View Suffix verwendet wird, 'xml.[dein Suffix]').

Jetzt muß ein neues View Skript erstellt werden, 'news/list.xml.phtml', welches das XML erzeugt und darstellt.

Um zu ermitteln ob eine Anfrage eine Kontextänderung initiiert, prüft der Helfer auf ein token im Anfrage Objekt. Standardäßig schaut er auf den 'format' Parameter, durch den das konfiguriert werden kann. Das bedeutet das, in den meisten Fällen, um eine Kontextänderung zu triggern, ein 'format' Parameter in der Anfrage hinzugefügt werden kann:

  • über URL Parameter: /news/list/format/xml (beachte, das Standard Routing Schema erlaubt übliche Schlüssel/Werte Paare nach der Aktion)

  • über GET Parameter: z.B., /news/list?format=xml

ContextSwitch erlaubt es beliebige Kontexte zu spezifizieren, inklusive welche Kontextänderung stattfinden wird (wenn überhaupt), jegliche Antwort Header die gesendet werden sollen, und beliebige Callbacks für Initialisierung und folgende Bearbeitung.

Vorhandene Standard Kontexte

Standardmäßig sind zwei Kontexte im ContextSwitch Helfer vorhanden: json und XML.

  • JSON. Der JSON Kontext setzt den 'Content-Type' Antwort Header auf 'application/json' und den View Skript Suffix auf 'json.phtml'.

    Trotzdem wird standardmäßig kein View Skript benötigt. Es serialisiert einfach alle View Variablen und sendet die JSON Antwort sofort aus.

    Dieses Verhalten kann deaktiviert werden indem die automatische JSON Serialisierung abgeschaltet wird:

    1. $this->_helper->contextSwitch()->setAutoJsonSerialization(false);
  • XML. Der XML Kontext setzt den 'Content-Type' Antwort Header auf 'text/xml' und den View Skript Suffix auf 'xml.phtml'. Es muß ein neues View Skript für den Kontext erstellt werden.

Eigene Kontexte erstellen

Manchmal sind die Standardkontexte nicht genug. Zum Beispiel wenn man YAML zurückgeben will, oder PHP serialisieren, ein RSS oder ATOM Feed, usw. ContextSwitch erlaubt es das zu tun.

Der einfachste Weg einen neuen Kontext hinzuzufügen ist über die addContext() Methode. Diese Methoe nimmt zwei Argumente, den Namen des Kontextes, und eine Array Spezifikation. Die Spezifikation sollte ein oder mehrere der folgenden Dinge enthalten:

  • suffix: Der Suffix der dem Standard View Suffix angefügt werden soll der im ViewRenderer registriert ist.

  • headers: Ein Array von Header zu Wert Paaren das als Teil der Antwort gesendet werden soll.

  • callbacks: Ein Array das ein oder mehrere der Schlüssel 'init' oder 'post' enthält, die auf gültige PHP Callbacks zeigen und die für die Initialisierung des Contextes und die Nachbearbeitung verwendet werden können.

    Initialisierungs Callbacks treten auf wenn der Kontext durch ContextSwitch erkannt wird. Sie können verwendet werden um spezielle Logik auszuführen die stattfinden soll. Als Beispiel verwendet der JSON Kontext einen Callback um den ViewRenderer auszuschalten wenn die automatische JSON Serialisierung eingeschaltet ist.

    Nachbearbeitung tritt wärend der postDispatch() Routine der Aktion auf, und kann verwendet werden um spezielle Logik auszuführen. Als Beispiel verwendet der JSON Kontext einen Callback um festzustellen ob die automatische JSON Serialisierung eingeschaltet ist; wenn dem so ist, serialisiert es die View Variablen zu JSON und sendet die Antwort, aber wenn dem nicht so ist, schaltet es den ViewRenderer wieder ein.

Es gibt eine Vielzahl an Methoden für die Interaktion mit Kontexten:

  • addContext($context, array $spec): Fügt einen neuen Kontext hinzu. Wirft eine Ausnahme wenn der Kontext bereits existiert.

  • setContext($context, array $spec): Fügt einen neuen Kontext hinzu oder überschreibt einen bestehenden Kontext. Verwendet die gleiche Spezifikation wie addContext().

  • addContexts(array $contexts): Fügt viele Kontexte auf einmal hinzu. Das $contexts Array sollte ein Array von Kontext zu Spezifikation Paaren sein. Wenn einer der Kontexte bereits existiert, wird eine Ausnahme geworfen.

  • setContexts(array $contexts): Fügt neue Kontexte hinzu und überschreibt bestehende. Verwendet die gleiche Spezifikation wie addContexts().

  • hasContext($context): Gibt TRUE zurück wenn der Kontext existiert, andernfalls FALSE.

  • getContext($context): Empfängt einen einzelnen Kontext durch den Namen. Gibt ein Array zurück das der Spezifikation folgt die in addContext() verwendet wird.

  • getContexts(): Empfängt alle Kontexte. Gibt ein Array von Kontext zu Spezifikation Paaren zurück.

  • removeContext($context): Entfernt einen einzelnen Kontext durch seinen Namen. Gibt im Erfolgsfall TRUE zurück, und FALSE wenn der Kontext nicht gefunden wurde.

  • clearContexts(): Entfernt alle Kontexte.

Kontexte per Aktion setzen

Es gibt zwei Mechanismen für das Setzen vorhandener Kontexte. Es kann entweder manuell ein Array im Controller erstellt werden, oder es können verschiedene Methoden in ContextSwitch verwendet werden um Sie zu bauen.

Die prinzipielle Methode für das Hinzufügen von Aktion zu Kontext Relationen ist addActionContext(). Sie erwartet zwei Argumente, die Aktion zu welcher der Kontext hinzugefügt werden soll, und entweder den Namen des Kontextes oder ein Array von Kontexten. Als Beispiel nehmen wir die folgende Controller Klasse an:

  1. class FooController extends Zend_Controller_Action
  2. {
  3.     public function listAction()
  4.     {
  5.     }
  6.  
  7.     public function viewAction()
  8.     {
  9.     }
  10.  
  11.     public function commentsAction()
  12.     {
  13.     }
  14.  
  15.     public function updateAction()
  16.     {
  17.     }
  18. }

Angenommen wir sollen einen XML Kontext zu der 'list' Aktion hinzufügen, und XML und JSON Kontexte zu der 'comments' Aktion. Wir können das in der init() Methode machen:

  1. class FooController extends Zend_Controller_Action
  2. {
  3.     public function init()
  4.     {
  5.         $this->_helper->contextSwitch()
  6.              ->addActionContext('list', 'xml')
  7.              ->addActionContext('comments', array('xml', 'json'))
  8.              ->initContext();
  9.     }
  10. }

Alternativ kann einfach die Array-Eigenschaft $contexts definiert werden:

  1. class FooController extends Zend_Controller_Action
  2. {
  3.     public $contexts = array(
  4.         'list'     => array('xml'),
  5.         'comments' => array('xml', 'json')
  6.     );
  7.  
  8.     public function init()
  9.     {
  10.         $this->_helper->contextSwitch()->initContext();
  11.     }
  12. }

Das obige ist weniger Overhead, aber enthält auch potentielle Fehler.

Die folgenden Methoden können verwendet werden um die Kontext-Mappings zu erstellen:

  • addActionContext($action, $context): markiert einen oder mehrere Kontexte als in einer Aktion vorhanden. Wenn bereits Mapping existieren wird einfach bei diesen Mappings angehängt. $context kann ein einzelner Kontext sein, oder ein Array von Kontexten.

    Ein Wert von TRUE für den Kontext markiert alle vorhandenen Kontexte als vorhanden für die Aktion.

    Ein leerer Wert für $context deaktiviert alle Kontexte für die gegebene Aktion.

  • setActionContext($action, $context): markiert einen oder mehrere Kontexte als in einer Aktion vorhanden. Wenn bereits Mappings existieren werden Sie mit den spezifizierten ersetzt. $context kann ein einzelner Kontext sein, oder ein Array von Kontexten.

  • addActionContexts(array $contexts): fügt mehrere Aktion zu Kontext Paare auf einmal hinzu. $contexts sollte ein assoziatives Array von Aktion zu Kontext Paaren sein. Es entspricht addActionContext(), was bedeutet das wenn eine Paarung bereits existiert, diese hinzugefügt wird.

  • setActionContexts(array $contexts): fungiert wie addActionContexts(), überschreibt aber bestehende Aktion zu Kontext Paare.

  • hasActionContext($action, $context): ermittelt ob eine spezielle Aktion einen gegebenen Kontext hat.

  • getActionContexts($action = null): gibt entweder alle Kontexte für eine gegebene Aktion zurück, oder alle Aktion zu Kontext Paare.

  • removeActionContext($action, $context): entfernt ein oder mehrere Kontexte von einer gegebenen Aktion. $context kann ein einzelner Kontext sein, oder ein Array von Kontexten.

  • clearActionContexts($action = null): entfernt alle Kontexte von einer gegebenen Aktion, oder von allen Aktionen mit Kontexten.

Kontext Switching initialisieren

Um Kontext Switching zu initialisieren, muß initContext() im Action Controller aufgerufen werden:

  1. class NewsController extends Zend_Controller_Action
  2. {
  3.     public function init()
  4.     {
  5.         $this->_helper->contextSwitch()->initContext();
  6.     }
  7. }

In einigen Fällen, will man einen Kontext erzwingen der verwendet werden soll; zum Beispiel wenn man nur den XML Kontext erlauben will wenn Kontext Switching aktiviert ist. Das kann durch die Übergaben des Kontextes zu initContext() getan werden:

  1. $contextSwitch->initContext('xml');

Zusätzliche Funktionalitäten

Eine Vielzahl an Methoden kann verwendet werden um das Verhalten des ContextSwitch Helfers zu verändern. Diese sind:

  • setAutoJsonSerialization($flag): Standardmäßig serialisieren JSON Kontexte alle View Variablen in die JSON Notierung und geben diese als Antwort zurück. Wenn man seine eigene Antwort erstellen will, sollte das ausgeschaltet werden; das muß vor dem Aufruf von initContext() geschehen.

    1. $contextSwitch->setAutoJsonSerialization(false);
    2. $contextSwitch->initContext();

    Der Wert des Flags erhält man mit getAutoJsonSerialization().

  • setSuffix($context, $suffix, $prependViewRendererSuffix): Mit dieser Methode kann ein anderer Suffix spezifiziert werden der für einen gegebenen Kontext verwendet werden soll. Das dritte Argument wird verwendet um anzuzeigen ob der aktuelle Suffix des ViewRenderers dem neuen Suffix vorangestellt werden soll oder nicht; dieses Flag ist standardmäßig aktiviert.

    Die Übergabe eines leeren Werte an den Suffix führt dazu das nur der Suffix des ViewRenderers verwendet wird.

  • addHeader($context, $header, $content): Fügt einen Antwort Header für einen gegebenen Kontext hinzu. $header ist der Headername, und $content ist der Wert der an diesen Header übergeben werden soll.

    Jeder Kontxt kann mehrere Header haben; addHeader() fügt zusätzliche Header in den Header Stack des Kontextes ein.

    Wenn der spezifizierte $header bereits für diesen Kontext existiert, wird eine Ausnahme geworfen.

  • setHeader($context, $header, $content): setHeader() funktioniert wie addHeader(), ausser das sie erlaubt das existierende Kontext Header überschrieben werden.

  • addHeaders($context, array $headers): Fügt einen gegebenen Kontext mehrere Header auf einmal hinzu. Entspricht addHeader(), was bedeutet das eine Ausnahme geworfen wird wenn der Header bereits existiert. $headers ist ein Array von Header zu Kontext Paaren.

  • setHeaders($context, array $headers.): Wie addHeaders(), nur das es setHeader() entspricht und damit das Überschreiben existierender Header erlaubt.

  • getHeader($context, $header): Enpfängt den Wert eines Headers für einen gegebenen Kontext. Gibt NULL zurück wenn dieser nicht gefunden wird.

  • removeHeader($context, $header): Entfernt einen einzelnen Header für einen gegebenen Kontext.

  • clearHeaders($context, $header): Entfernt alle Header für einen gegebenen Kontext.

  • setCallback($context, $trigger, $callback): Setzt einen Callback bei einem gegebenen Trigger für einen gegebenen Kontext. Trigger können entweder 'init' oder 'post' sein (was zeigt das der Callback entweder bei der Initialisierung oder der Nachbearbeitung aufgerufen wird). $callback sollte ein gültiger PHP Callback sein.

  • setCallbacks($context, array $callbacks): Setzt mehrere Callbacks für einen gegebenen Kontext. $callbacks sollte ein Trigger zu Callback Paar sein. Aktuell sind die meisten Callbacks die registriert werden können zwei, einer für Initialisierung und einer für die Nachbearbeitung.

  • getCallback($context, $trigger): Empfängt einen Callback für einen gegebenen Trigger in einem gegebenen Kontext.

  • getCallbacks($context): Empfängt alle Callbacks für einen gegebenen Kontext. Gibt ein Array von Trigger zu Callback Paaren zurück.

  • removeCallback($context, $trigger): Entfernt einen Callback für einen gegebenen Trigger und Kontext.

  • clearCallbacks($context): Entfernt alle Callbacks für einen gegebenen Kontext.

  • setContextParam($name): Setzt den Anfrageparameter der geprüft werden muß um zu entscheiden ob eine Kontextumschaltung angefragt wurde oder nicht. Der Wert ist standardmäßig 'format', aber dieser Zugriffspunkt kann verwendet werden um einen alternativen wert zu setzen.

    getContextParam() kann verwendet werden um den aktuellen Wert zu erhalten.

  • setAutoDisableLayout($flag): Standardmäßig sind Layouts ausgeschaltet wenn eine Kontextumschaltung erfolgt; das ist weil Layouts typischerweise dafür verwendet werden um normale Antworten darzustellen, und Sie in alternativen Kontexten keine Bedeutung haben. Wenn man trotzdem Layouts verwenden will (möglicherweise hat man ein Layout für einen neuen Kontext), kann dieses Verhalten mit der Übergabe eines FALSE Wertes an setAutoDisableLayout() geändert werden. Das sollte aber before dem Aufruf von initContext() geschehen.

    Um den Wert dieses Flags zu erhalten, kann der Zugriffspunkt getAutoDisableLayout() verwendet werden.

  • getCurrentContext() kann verwendet werden um festzustellen welcher Kontext erkannt wurde, wenn überhaupt. Er gibt NULL zurück wenn keine Kontextumschaltung stattgefunden hat, oder wenn er aufgerufen wurde bevor initContext() stattgefunden hat.

AjaxContext Funktionalität

Der AjaxContext Helfer erweitert ContextSwitch, sodas alle für ContextSwitch gelisteten Funktionalitäten in Ihm vorhanden sind. Es gibt trotzdem ein paar wichtige Änderungen.

Zuerst, verwendet es eine andere Action Controller Eigenschaft $ajaxable um Kontexte festzustellen. Damit kann man verschiedene Kontexte verwenden für AJAX gegenüber normalen HTTP Anfragen. Die verschiedenen * ActionContext()* Methoden von AjaxContext schreiben in diese Eigenschaft.

Zweitens, wird nur dann getriggert wenn ein XmlHttpRequest stattgefunden hat, was durch die isXmlHttpRequest() Methode den Anfrageobjektes festgestellt wird. Deshalb wird, wenn der Kontextparameter ('format') in der Anfrage übergeben wird, aber die anfrage nicht als XmlHttpRequest gemacht wurde, keine Kontextumschaltung getriggert.

Drittens, fügt der AjaxContext einen zusätzlichen, HTML, Kontext hinzu. In diesem Kontext setzt er den Suffix auf 'ajax.phtml' um diesen Kontext von einer normalen Anfrage zu unterscheiden. Es werden keine zusätzlichen Header zurückgegeben.

Example #4 Aktionen erlauben auf Ajax Anfragen zu antworten

In dem folgenden Beispiel erlauben wir Anfragen auf die Aktionen 'view', 'form' und 'process' auf AJAX Anfragen zu antworten. In den ersten zwei Fällen, 'view' und 'form' wird ein HTML Teilstück zurückgegeben mit dem die Seite aktualisiert werden soll; im letzteren wird JSON zurückgegeben.

  1. class CommentController extends Zend_Controller_Action
  2. {
  3.     public function init()
  4.     {
  5.         $ajaxContext = $this->_helper->getHelper('AjaxContext');
  6.         $ajaxContext->addActionContext('view', 'html')
  7.                     ->addActionContext('form', 'html')
  8.                     ->addActionContext('process', 'json')
  9.                     ->initContext();
  10.     }
  11.  
  12.     public function viewAction()
  13.     {
  14.         // Ein einzelnes Kommentar holen um es anzuzeigen.
  15.         // Wenn AjaxContext erkannt wurde, verwendet es das
  16.         // comment/view.ajax.phtml View Skript.
  17.     }
  18.  
  19.     public function formAction()
  20.     {
  21.         // Stellt die "add new comment" Form dar.
  22.         // Wenn AjaxContext erkannt wurde, verwendes es das
  23.         // comment/form.ajax.phtml View Skript.
  24.     }
  25.  
  26.     public function processAction()
  27.     {
  28.         // Bearbeitet einen neuen Kommentar
  29.         // Gibt das Ergebnis als JSON zurück; fügt die Ergebnisse einfach als
  30.         // View Variablen hinzu, und JSON wird zurückgegeben.
  31.     }
  32. }

Auf der Seite des Clients, wird die AJAX Bibliothek einfach die Endpunkte '/comment/view', '/comment/form', und '/comment/process' anfragen, und den 'format' Parameter übergeben: '/comment/view/format/html', '/comment/form/format/html', '/comment/process/format/json'. (Oder der Parameter kann über den Abfrage String übergeben werden: z.B. , "?format=json".)

Angenommen die Bibliothek übergibt den 'X-Requested-With: XmlHttpRequest' Header, dann werden diese Aktionen das richtige Antwortformat zurückgeben.

FlashMessenger

Einführung

Der FlashMessenger Helfer erlaubt es Nachrichten zu übergeben die ein Benutzer bei der nächsten Anfrage sehen können soll. Um das durchführen zu können, verwendet FlashMessenger den Zend_Session_Namespace um Nachrichten für die Zukunft oder den nächsten Empfang einer Anfrage zu speichern. Es ist generell eine gute Idee, das wenn man plant Zend_Session oder Zend_Session_Namespace zu verwenden, diese mit Zend_Session::start() in der Bootstrap Datei zu initialisieren. (Siehe die Zend_Session Dokumentation für weitere Details über die Verwendung)

Beispiel einer standardmäßigen Verwendung

Das Anwendungsbeispiel von unten zeigt die Verwendung einer Flash Nachricht und Ihre Grundlagen. Wenn die Aktion /some/my aufgerufen wird, fügt Sie die Flash Nachricht "Eintrag gespeichert!" hinzu. Eine weitere Anfrage zu der Aktion /some/my-next-request empfängt Sie (und löscht Sie auch).

  1. class SomeController extends Zend_Controller_Action
  2. {
  3.     /**
  4.      * FlashMessenger
  5.      *
  6.      * @var Zend_Controller_Action_Helper_FlashMessenger
  7.      */
  8.     protected $_flashMessenger = null;
  9.  
  10.     public function init()
  11.     {
  12.         $this->_flashMessenger =
  13.             $this->_helper->getHelper('FlashMessenger');
  14.         $this->initView();
  15.     }
  16.  
  17.     public function myAction()
  18.     {
  19.         /**
  20.          * default method of getting
  21.          * Zend_Controller_Action_Helper_FlashMessenger
  22.          * instance on-demand
  23.          */
  24.         $this->_flashMessenger->addMessage('Eintrag gespeichert!');
  25.     }
  26.  
  27.     public function myNextRequestAction()
  28.     {
  29.         $this->view->messages = $this->_flashMessenger->getMessages();
  30.         $this->render();
  31.     }
  32. }

JSON

JSON Antworten sind die Antworten der Wahl wenn mit AJAX Anfragen gearbeitet wird die Dataset Antworten erwarten; JSON kann sofort auf Seite des Clienten geparst werden, was zu schneller Ausführung führt.

Der JSON Action Helfer macht verschiedene Dinge:

  • Layouts auschalten wenn sie aktuell aktiviert sind.

  • Optional ein Array von Optionen als zweites Argument an Zend_Json::encode() übergeben. Dieses Array von Optionen erlaubt es Layouts und Kodierungen einzuschalten indem Zend_Json_Expr verwendet wird.

    1. $this->_helper->json($data, array('enableJsonExprFinder' => true));
  • Den ViewRenderer ausschalten wenn er aktiviert ist.

  • Den 'Content-Type' Antwort Header auf 'application/json' setzen.

  • Standardmäßig, die Antwort sofort zurückgeben, ohne darauf zu warten das die Aktion die Ausführung beendet.

Die Verwendung ist einfach: Entweder als Methode des Helfer Brokers aufrufen, oder eine der Methoden encodeJson() oder sendJson() aufrufen:

  1. class FooController extends Zend_Controller_Action
  2. {
  3.     public function barAction()
  4.     {
  5.         // einige Berechnungen durchführen...
  6.         // Die JSON Antwort senden:
  7.         $this->_helper->json($data);
  8.  
  9.         // oder...
  10.         $this->_helper->json->sendJson($data);
  11.  
  12.         // oder das JSON empfangen:
  13.         $json = $this->_helper->json->encodeJson($data);
  14.     }
  15. }

Note: Layouts behalten
Wenn man ein separates Layout für JSON Antworten hat -- möglicherweise um die JSON Antworten in einer Art Kontext zu wrappen -- akzeptiert jede Methode im JSON Helfer ein zweites, optionales Argument: Ein Flag um Layouts zu aktivieren oder deaktivieren. Die Übergabe eines boolschen TRUE Wertes hält Layouts aktiviert:

  1. $this->_helper->json($data, true);
Optional kann ein Array als zweiter Parameter übergeben werden. Dieses Array kann eine Vielzahl von Optionen enthalten, inklusive der keepLayouts Option:
  1. $this->_helper->json($data, array('keepLayouts' => true);

Note: Kodierung einschalten durch Verwendung von Zend_Json_Expr
Zend_Json::encode() erlaubt die Kodierung von nativen JSON Ausdrücken indem Zend_Json_Expr Objekte verwendet werden. Diese Option ist standardmäßig ausgeschaltet. Um diese Option einzuschalten muß ein boolscher TRUE Wert an die enableJsonExprFinder Option übergeben werden:

  1. $this->_helper->json($data, array('enableJsonExprFinder' => true);
Wenn man das durchführen will, muss man ein Array als zweite Option übergeben. Das erlaubt es auch andere Optionen, wie zum Beispiel die keepLayouts Option, zu kombinieren. Alle diese Optionen werden dann an Zend_Json::encode() übergeben.
  1. $this->_helper->json($data, array(
  2.     'enableJsonExprFinder' => true,
  3.     'keepLayouts'          => true,
  4. ));

Redirector

Einführung

Der Redirector Helfer erlaubt die Verwendung eines Redirector Objektes um die Notwendigkeiten der Anwendung für das Umleiten zu einer neuen URL zu erfüllen. Er bietet vielfache Vorteile gegenüber der _redirect() Methode. Er ist zum Beispiel fähig seitenweises Verhalten im Redirector Objekt vorzudefinieren oder bietet ein eingebautes gotoSimple($action, $controller, $module, $params) Interface ähnlich dem von Zend_Controller_Action::_forward().

Der Redirector hat eine Anzahl von Methoden die verwendet werden können um das Verhalten beim Umleiten zu beeinflussen:

  • setCode() kann verwendet werden um den HTTP Antwort Code zu setzen der während des Umleitens verwendet werden soll.

  • setExit() kann verwendet werden um ein exit() nach einer Umleitung zu erzwingen. Standardmäßig ist dieser TRUE.

  • setGotoSimple() kann verwendet werden um eine Standard URL zu setzen die verwendet wird wenn keine an gotoSimple() übergeben wird. Verwendet die API von Zend_Controller_Action::_forward(): setGotoSimple($action, $controller = null, $module = null, array $params = array())

  • setGotoRoute() kann verwendet werden um eine URL basierend auf einer registrierten Route zu setzen. Übergeben in einem Array von Schlüssel und Werte Paaren und einem Routernamen, wird die URL anhand des Routertyps und der Definition zusammengebaut.

  • setGotoUrl() kann verwendet werden um eine Standard URL zu setzen die verwendet wird wenn keine an gotoUrl() übergeben wird. Akzeptiert einen einzelnen URL String.

  • setPrependBase() kann verwendet werden um die Basis URL des Anfrage Objektes einer mit setGotoUrl(), gotoUrl() oder gotoUrlAndExit() definierten URL, voranzustellen.

  • setUseAbsoluteUri() kann verwendet werden um den Redirector dazu zu zwingen absolute URIs zu verwenden wenn umgeleitet wird. Wenn diese Option gesetzt ist, verwendet Sie den Wert von $_SERVER['HTTP_HOST'], $_SERVER['SERVER_PORT'], und $_SERVER['HTTPS'] um eine komplete URI zur, durch eine der Umleitungsmethoden, spezifizierten URL zu erstellen. Diese Option ist standardmäßig ausgeschaltet, kann aber in späteren Releases standardmäßig eingeschaltet sein.

Zusätzlich gibt es eine Reihe von Methoden im Redirector für die Bearbeitung der aktuellen Umleitungen:

  • gotoSimple() verwendet setGotoSimple() ( _forward()-ähnliche API) um eine URL zu erstellen und eine Umleitung durchzuführen.

  • gotoRoute() verwendet setGotoRoute() (route-assembly) um eine URL zu erstellen und eine Umleitung durchzuführen.

  • gotoUrl() verwendet setGotoUrl() (URL string) um eine URL zu erstellen und eine Umleitung durchzuführen.

Letztendlich kann die aktuelle Umleitungs URL jederzeit festgestellt werden durch Verwendung von getRedirectUrl().

Beispiel für die grundsätzliche Verwendung

Example #5 Optionen setzen

Dieses Beispiel überschreibt diverse Optionen, inklusive dem Setzen des HTTP Statuscodes und dessen Verwendung in der Umleitung ('303'), nicht abbrechen der Umleitung und definieren einer Standard URL die beim Umleiten verwendet wird.

  1. class SomeController extends Zend_Controller_Action
  2. {
  3.     /**
  4.      * Redirector - definiert zur Komplettierung des Codes
  5.      *
  6.      * @var Zend_Controller_Action_Helper_Redirector
  7.      */
  8.     protected $_redirector = null;
  9.  
  10.     public function init()
  11.     {
  12.         $this->_redirector = $this->_helper->getHelper('Redirector');
  13.  
  14.         // Setzt die Standardoptionen für die Umleitung
  15.         // Da das Objekt in der Helferanwendung registriert ist,
  16.         // wird diese für alle Aktionen ab diesem Zeitpunkt relevant
  17.         $this->_redirector->setCode(303)
  18.                           ->setExit(false)
  19.                           ->setGotoSimple("this-action",
  20.                                           "some-controller");
  21.     }
  22.  
  23.     public function myAction()
  24.     {
  25.         /* Mach was */
  26.  
  27.         // Umleiten zu einer vorher definierten URL, und einen Ausstieg
  28.         // erzwingen der stattfindet sobald das getan wurde:
  29.         $this->_redirector->redirectAndExit();
  30.         return; // wird nie erreicht
  31.     }
  32. }

Example #6 Standardwerte verwenden

Diese Beispiel nimmt an das die Standardwerte verwendet werden, was bedeutet das jede Umleitung in einem sofortigen exit() resultiert.

  1. // ALTERNATIVES BEISPIEL
  2. class AlternativeController extends Zend_Controller_Action
  3. {
  4.     /**
  5.      * Redirector - definiert zur Komplettierung des Codes
  6.      *
  7.      * @var Zend_Controller_Action_Helper_Redirector
  8.      */
  9.     protected $_redirector = null;
  10.  
  11.     public function init()
  12.     {
  13.         $this->_redirector = $this->_helper->getHelper('Redirector');
  14.     }
  15.  
  16.     public function myAction()
  17.     {
  18.         /* Mach was */
  19.  
  20.         $this->_redirector
  21.             ->gotoUrl('/my-controller/my-action/param1/test/param2/test2');
  22.         return; // wird nie erreicht da standardmäßig gegangen und beendet wird
  23.     }
  24. }

Example #7 Verwenden von goto()'s _forward() API

gotoSimple()'s API entspricht der von Zend_Controller_Action::_forward(). Der primäre Unterschied ist das Sie eine URL von den übergebenen Parametern erstellt und das Standardformat :module/:controller/:action/* des Standardrouters verwendet. Dann leitet es um statt die Aktion zu verketten.

  1. class ForwardController extends Zend_Controller_Action
  2. {
  3.     /**
  4.      * Redirector - definiert zur Komplettierung des Codes
  5.      *
  6.      * @var Zend_Controller_Action_Helper_Redirector
  7.      */
  8.     protected $_redirector = null;
  9.  
  10.     public function init()
  11.     {
  12.         $this->_redirector = $this->_helper->getHelper('Redirector');
  13.     }
  14.  
  15.     public function myAction()
  16.     {
  17.         /* Mach was */
  18.  
  19.         // Umleiten zu 'my-action' von 'my-controller' im aktuellen Modul,
  20.         // und verwenden der Parameter param1 => test und param2 => test2
  21.         $this->_redirector->gotoSimple('my-action',
  22.                                        'my-controller',
  23.                                        null,
  24.                                        array('param1' => 'test',
  25.                                              'param2' => 'test2'
  26.                                              )
  27.                                        );
  28.     }
  29. }

Example #8 Verwenden von Routen die mit gotoRoute() zusammengebaut wurden

Das folgende Beispiel verwendet die assemble() Methode des Router's um eine URL zu erstellen die auf einem assoziativen Array von Parametern basiert das übergeben wurde. Es nimmt an das die folgende Route registriert wurde:

  1. $route = new Zend_Controller_Router_Route(
  2.     'blog/:year/:month/:day/:id',
  3.     array('controller' => 'archive',
  4.           'module' => 'blog',
  5.           'action' => 'view')
  6. );
  7. $router->addRoute('blogArchive', $route);

Angenommen ein Array hat year auf 206 gesetzt, month auf 4, day auf 24, und id auf 42, dann würde dieses eine URL wie die folgende erstellen: /blog/2006/4/24/42.

  1. class BlogAdminController extends Zend_Controller_Action
  2. {
  3.     /**
  4.      * Redirector - definiert zur Komplettierung des Codes
  5.      *
  6.      * @var Zend_Controller_Action_Helper_Redirector
  7.      */
  8.     protected $_redirector = null;
  9.  
  10.     public function init()
  11.     {
  12.         $this->_redirector = $this->_helper->getHelper('Redirector');
  13.     }
  14.  
  15.     public function returnAction()
  16.     {
  17.         /* Mach was */
  18.  
  19.         // Umleiten zum Blog Archiv. Erstellt die folgende URL:
  20.         // /blog/2006/4/24/42
  21.         $this->_redirector->gotoRoute(
  22.             array('year' => 2006,
  23.                   'month' => 4,
  24.                   'day' => 24,
  25.                   'id' => 42),
  26.             'blogArchive'
  27.         );
  28.     }
  29. }

ViewRenderer

Einführung

Der ViewRenderer Helfer wurde designt um die folgenden Ziele erfüllen:

  • Entfernen der Notwendigkeit View Objekte innerhalb der Controller zu instanzieren; View Objekte werden automatisch mit dem Controller registriert.

  • Automatisch View Skript, Helfer und Filter Pfade setzen basierend auf dem aktuellen Modul, und den aktuellen Modulnamen automatisch als Klassenprefix für Helfer und Filterklassen assoziieren.

  • Ein global vorhandenes View Objekt für alle bearbeitenden Controller und Aktionen erstellen.

  • Dem Entwickler erlauben das Standard View Rendering Optionen für alle Controller gesetzt werden.

  • Die Fähigkeit hinzufügen das ein View Skript ohne Intervention automatisch gerendert wird.

  • Dem Entwickler erlauben seine eigenen Spezifikationen, für den View Basisnamen und für View Skriptpfade, zu erstellen.

Note: Wenn man ein _forward(), redirect() oder render() manuell durchführt, wird kein automatisches rendern erfolgen, da man beim Ausführen von jeder dieser Aktionen dem ViewRenderer mitteilt das man seine eigene Ausgabe durchführen will.

Note: Der ViewRenderer ist standardmäßig aktiviert. Man kann Ihn über den Parameter noViewRenderer des Frontcontrollers deaktivieren ($front->setParam('noViewRenderer', true);) oder den Helfer vom Helfer Broker Stack entfernen ( Zend_Controller_Action_HelperBroker::removeHelper('viewRenderer')).
Wenn man Einstellungen vom ViewRenderer vor der Ausführung des Front Controllers ändern will, kann das auf zwei Wegen getan werden:

  • Instanzieren und Registrieren eines eigenen ViewRenderer Objekts und dieses an den Helfer Broker übergeben:

    1. $viewRenderer = new Zend_Controller_Action_Helper_ViewRenderer();
    2. $viewRenderer->setView($view)
    3.              ->setViewSuffix('php');
    4. Zend_Controller_Action_HelperBroker::addHelper($viewRenderer);
  • Initialisieren und/oder empfangen eines ViewRenderer Objekts auf Wunsch über den Helfer Broker:

    1. $viewRenderer =
    2.     Zend_Controller_Action_HelperBroker::getStaticHelper('viewRenderer');
    3. $viewRenderer->setView($view)
    4.              ->setViewSuffix('php');

API

In seiner einfachsten Verwendung, kann der ViewRenderer ganz einfach instanziert und an den Aktion Helfer Broker übergeben werden. Der einfachste Weg Ihn auf einmal zu Instanzieren und Registrieren ist es, die Methode getStaticHelper() des Helfer Brokers zu verwenden:

  1. Zend_Controller_Action_HelperBroker::getStaticHelper('viewRenderer');

Das erste Mal wenn ein Aktion Controller instanziert wird, triggert er den ViewRenderer ein View Objekt zu instanzieren. Jedes Mal wenn ein Controller Instanziert wird, wird die init() Methode des ViewRenderer's aufgerufen, was dazu führt das er die view Eigenschaft des Aktion Controllers setzt, und addScriptPath(), mit einem Pfad relativ zum aktuellen Modul, aufruft; das wird mit einem Klassenprefix aufgerufen der nach dem aktuellen Modul benannt ist, was effektiv für alle Helfer und Filterklassen die im Modul definiert werden den Namensraum setzt.

Jedes Mal wenn postDispatch() aufgerufen wird, ruft dieses render() für die aktuelle Aktion auf.

Als Beispiel kann die folgende Klasse angenommen werden:

  1. // Eine Controller Klasse, foo Modul:
  2. class Foo_BarController extends Zend_Controller_Action
  3. {
  4.     // Rendert standardmäßig bar/index.phtml; keine Aktion benötigt
  5.     public function indexAction()
  6.     {
  7.     }
  8.  
  9.     // Rendert bar/populate.phtml mit der Variable 'foo' gesetzt auf 'bar'.
  10.     // Da View Objekte beim preDispatch() definiert werden, sind diese
  11.     // bereits vorhanden.
  12.     public function populateAction()
  13.     {
  14.         $this->view->foo = 'bar';
  15.     }
  16. }
  17.  
  18. ...
  19.  
  20. // In einem der View Sktipte:
  21. $this->foo(); // Foo_View_Helper_Foo::foo() aufrufen

Der ViewRenderer definiert auch eine Anzahl von Zugriffspunkten um das Setzen und Empfangen von View Optionen zu erlauben:

  • setView($view) erlaubt das Setzen des View Objektes für den ViewRenderer. Er wird als öffentliche Klasseneigenschaft $view gesetzt.

  • setNeverRender($flag = true) kann verwendet werden um das automatische rendern global ein- oder auszuschalten, z.B. für alle Controller. Wenn er auf TRUE gesetzt wird, ruft postDispatch() nicht automatisch render() im aktuellen Controller auf. getNeverRender() empfängt den aktuellen Wert.

  • setNoRender($flag = true) kann verwendet werden um das automatische rendern ein- oder auszuschalten. Wenn er auf TRUE gesetzt wird, wird postDispatch() render() im aktuellen Controller nicht automatisch aufrufen. Diese Einstellung wird jedesmal zurückgesetzt wenn preDispatch() aufgerufen wird (z.B. muß dieses Flag für jeden Controller gesetzt werden für den das automatische rendern nicht automatisch stattfinden soll). getNoRender() empfängt den aktuellen Wert.

  • setNoController($flag = true) kann verwendet werden um render() zu sagen das für Aktion Skripts nicht in einem Unterverzeichnis gesucht werden soll das nach dem Controller benannt ist (was das Standardverhalten ist). getNoController() empfängt den aktuellen Wert.

  • setNeverController($flag = true) ist analog zu setNoController(), arbeitet aber auf einem globalen Level -- z.B. wird es nicht für jede ausgeführte Aktion zurückgesetzt. getNeverController() empfängt den aktuellen Wert.

  • setScriptAction($name) kann verwendet werden um das Aktion Skript zu spezifizieren das gerendert werden soll. $name sollte der Name des Skripts sein, ohne den Datei Suffix (und ohne das Controller Unterverzeichnis, ausser wenn noController eingeschaltet wurde). Wenn nicht spezifiziert, wird nach einem View Skript gesucht das nach der Aktion in Anfrage Objekt benannt ist. getScriptAction() empfängt den aktuellen Wert.

  • setResponseSegment($name) kann verwendet werden um zu spezifizieren in welches Segment das nach einem Antwort Objekt benannt ist, gerendert werden soll. Wenn nicht spezifiziert, wird in das Standard Segment gerendert. getResponseSegment() empfängt den aktuellen Wert.

  • initView($path, $prefix, $options) kann aufgerufen werden um den Basis View Pfad, den Klassenprefix für Helfer, Filter Skripts und ViewRenderer Optionen zu spezifizieren. Es kann eines der folgenden Flags übergeben werden: neverRender, noRender, noController, scriptAction, und responseSegment.

  • setRender($action = null, $name = null, $noController = false) erlaubt es scriptAction, responseSegment, oder noController in einem Schritt zu übergeben. direct() ist ein Alias für diese Methode, und erlaubt es diese Methode einfach vom eigenen Controller aus aufzurufen:

    1. // Rendert 'foo' statt dem aktuellen Aktion Skript
    2. $this->_helper->viewRenderer('foo');
    3.  
    4. // Rendert form.phtml zum 'html' Antwort Segment, ohne einen Controller aus dem
    5. // Unterverzeichnis des View Skripts zu verwenden:
    6. $this->_helper->viewRenderer('form', 'html', true);

    Note: setRender() und direct() stellen das View Sktript nicht dar, sondern setzen Hinweise die postDispatch() und render() dann verwenden wenn die View dargestellt wird.

Der Constructor erlaubt es optional das View Objekt und ViewRenderer Optionen zu übergeben; er akzeptiert die gleichen Flags wie initView():

  1. $view    = new Zend_View(array('encoding' => 'UTF-8'));
  2. $options = array('noController' => true, 'neverRender' => true);
  3. $viewRenderer =
  4.     new Zend_Controller_Action_Helper_ViewRenderer($view, $options);

Es gibt einige zusätzliche Methoden für das individualisieren von Pfadspezifikationen die für das Herausfinden des Basis View Pfades verwendet werden der dem View Objekt hinzugefügt wird, und den View Skript Pfad der verwendet wird wenn das View Skript zu dem gerendert werden soll automatisch herausgefunden wird. Diese Methoden nehmen alle ein oder mehrere der folgenden Platzhalter:

  • :moduleDir zeigt auf das aktuelle Modul Basisverzeichnis (von der Konvention her das Elternverzeicnis des Controller Verzeichnisses des Moduls).

  • :module zeigt auf den aktuellen Modulnamen.

  • :controller zeigt auf den aktuellen Controllernamen.

  • :action zeigt auf den aktuellen Aktionsnamen.

  • :suffix zeigt auf das aktuelle Suffix des View Skripts (welcher über setViewSuffix() gesetzt werden kann).

Die Methoden für das kontrollieren der Pfad Spezifikationen sind:

  • setViewBasePathSpec($spec) erlaubt die Änderung der Pfad Spezifikation die verwendet wird um den Basispfad herauszufinden zu dem das View Objekt hinzugefügt werden soll. Die Standardspezifikation ist :moduleDir/views. Die aktuelle Spezifikation kann jederzeit durch Verwenden von getViewBasePathSpec() erhalten werden.

  • setViewScriptPathSpec($spec) erlaubt die Änderung der Pfad Spezifikation die verwendet wird um den Pfad zu einem individuellen View Skript herauszufinden (ohne den Basis View Skript Pfad). Die Standard Spezifikation ist :controller/:action.:suffix. Die aktuelle Spezifikation kann jederzeit durch Verwenden von getViewScriptPathSpec() erhalten werden.

  • setViewScriptPathNoControllerSpec($spec) erlaubt die Änderung der Pfad Spezifkiation die verwendet wird um den Pfad zu einem individuellen View Skript herauszufinden wenn noController aktiv ist (ohne den Basis View Skript Pfad). Die Standard Spezifikation ist :action.:suffix. Die aktuelle Spezikifation kann jederzeit durch Verwenden von getViewScriptPathNoControllerSpec() erhalten werden.

Für eine feinkörnige Kontrolle über Pfadspezifikationen kann Zend_Filter_Inflector verwendet werden. Im Hintergrund verwendet der ViewRenderer einen Inflector um bereits Abstimmungen am Pfad durchzuführen. Um auf dem Inflector einzuwirken, damit entweder ein eigener für die Verwendung gesetzt wird, oder um den Standard Inflector zu verändern, können die folgenden Methoden verwendet werden:

  • getInflector() empfängt den Inflector. Wenn bis dahin keiner im ViewRenderer existiert, wird dieser, anhand der Verwendung der Standard Regeln, erstellt.

    Standardmäßig verwendet dieser statische Referenzregeln für das Suffix und Modulverzeichnis, sowie ein statisches Ziel; das erlaubt verschiedenen ViewRenderer Eigenschaften den Inflector dynamisch zu ändern.

  • setInflector($inflector, $reference) erlaubt das Setzen eines eigenen Inflectors für die Verwendung mit dem ViewRenderer. Wenn $reference TRUE ist, setzt dieser das Suffix und Modulverzeichnis als statische Referenz zu ViewRenderer Eigenschaften, genauso wie das Ziel.

Note: Standard Konventionen für das Eruieren
Der ViewRenderer führt einige Pfad Normalisierungen durch um das Eruieren von View Skripten einfacher zu machen. Die Standardregeln sind wie folgt:

  • :module: MixedCase und camelCaseWörter werden durch Bindestriche getrennt, und der komplette String wird auf Kleinschreibung geändert. z.B.: "FooBarBaz" wird "foo-bar-baz".

    Intern verwendet der Inflector die Filter Zend_Filter_Word_CamelCaseToDash und Zend_Filter_StringToLower.

  • :controller: MixedCase und camelCaseWörter werden durch Bindestriche getrennt; Unterstriche werden in Verzeichnistrennzeichen konvertiert, und der komplette String wird auf Kleinschreibung geändert. Beispiele: "FooBar" wird "foo-bar"; "FooBar_Admin" wird "foo-bar/admin".

    Intern verwendet der Inflector die Filter Zend_Filter_Word_CamelCaseToDash, Zend_Filter_Word_UnderscoreToSeparator und Zend_Filter_StringToLower.

  • :action: MixedCase und camelCaseWörter werden durch Bindestriche getrennt; nicht-anphanummerische Zeichen werden zu Bindestrichen übersetzt, und der komplette String wird auf Kleinschreibung geändert. Beispiele: "fooBar" wird "foo-bar"; "foo-barBaz" wird "foo-bar-baz".

    Intern verwendet der Inflector die Filter Zend_Filter_Word_CamelCaseToDash, Zend_Filter_PregReplace und Zend_Filter_StringToLower.

Die letzten Teile in der ViewRenderer API sind die Methoden für das aktuelle herausfinden von View Skript Pfaden und Rendern von Views. Diese enthalten:

  • renderScript($script, $name) erlaubt es ein Skript mit einem selbst spezifizierten Pfad zu rendern, optional zu einem benannten Pfad Segment. Wenn diese Methode verwendet wird, ermittelt der ViewRenderer nicht automatisch den Skriptnamen sondern übergibt das $script Argument direkt der render() Methode des View Objekts.

    Note: Sobald die View zum Antwort Objekt gerendert wurde, setzt diese noRender um irrtümliches mehrfaches rendern zum selben View Skript zu verhindern.

    Note: Standardmäßig handelt Zend_Controller_Action::renderScript() in Vertretung zur renderScript() Methode des ViewRenderer's.

  • getViewScript($action, $vars) erstellt den Pfad zu einem View Skript das auf einer Aktion basiert die übergeben wird, und/oder allen Variablen die in $vars übergeben werden. Schlüssel für dieses Array können jede der Pfad Spezifikations Schhüssel enthalten ('moduleDir', 'module', 'controller', 'action', und 'suffix'). Jede übergebene Variable wird verwendet; andernfalls werden Werte die auf der aktuellen Anfrage basieren angewendet.

    getViewScript() verwendet entweder viewScriptPathSpec oder viewScriptPathNoControllerSpec basierend auf den Einstellungen des noController Flags.

    Wortbegrenzer die in Modul-, Controller- oder Aktionsnamen vorkommen werden mit Bindestrichen ('-') ersetzt. Deshalb resultiert, wenn der Controllername 'foo.bar' und die Aktion 'baz:bat' ist, die Verwendung der standard Pfad Spezifikation einen View Skript Pfad von 'foo-bar/baz-bat.phtml'.

    Note: Standardmäßig handelt Zend_Controller_Action::getViewScript() in Vertretung zur getViewScript() Methode des ViewRenderer's.

  • render($action, $name, $noController) prüft zuerst ob entweder $name oder $noController übergeben wurde, und wenn dem so ist, wird das betreffende Flag (respektive responseSegment und noController) im ViewRenderer gesetzt. Dann übergibt er das $action Argument, wenn vorhanden, an getViewScript(). Am Ende wird der berechnete View Skript Pfad an renderScript() übergeben.

    Note: Achtung vor den Nebeneffekten bei der Verwendung von render(): Die Werte die für den Anwort Segment Namen und für das noController Flag übergeben werden sind im Objekt dauerhaft. Zusätzlich wird noRender gesetzt nachdem das rendern fertig ist.

    Note: Standardmäßig handelt Zend_Controller_Action::render() in Vertretung zur render() Methode des ViewRenderer's.

  • renderBySpec($action, $vars, $name) erlaubt es Pfad Spezifikations Variablen zu übergeben um den View Skript Pfad zu ermitteln der erstellt werden soll. Es übergibt $action und $vars an getScriptPath() und übergibt anschließend den resultierenden Skript Pfad und $name an renderScript().

Grundsätzliches Beispiel der Verwendung

Example #9 Grundsätzliche Verwendung

Am einfachsten, wird einfach der ViewRenderer Helfer mit dem Helfer Broker in der eigenen Bootstrap Datei, initialisiert und registriert, und anschließend die Variablen in den Aktion Methoden gesetzt.

  1. // In der Bootstrap Datei:
  2. Zend_Controller_Action_HelperBroker::getStaticHelper('viewRenderer');
  3.  
  4. ...
  5.  
  6. // 'foo' Modul, 'bar' Controller:
  7. class Foo_BarController extends Zend_Controller_Action
  8. {
  9.     // Rendert standardmäßig bar/index.phtml; keine Aktion benötigt
  10.     public function indexAction()
  11.     {
  12.     }
  13.  
  14.     // Rendert bar/populate.phtml wobei die Variable 'foo' auf 'bar'
  15.     // gesetzt wird. Da das View Objekt beim preDispatch() definiert,
  16.     // ist es bereits vorhanden.
  17.     public function populateAction()
  18.     {
  19.         $this->view->foo = 'bar';
  20.     }
  21.  
  22.     // Rendert nichts da zu einer anderen Aktion weitergeleitet wird;
  23.     // die neue Aktion wird jegliches rendern durchführen
  24.     public function bazAction()
  25.     {
  26.         $this->_forward('index');
  27.     }
  28.  
  29.     // Rendert nichts da zu einer anderen Lokation weitergeleitet wird
  30.     public function batAction()
  31.     {
  32.         $this->_redirect('/index');
  33.     }
  34. }

Note: Benamungs Konventionen: Wort Begrenzer in Controller- und Aktionnamen
Wenn der Controller- oder Aktionsname aus mehreren Wörtern aufgebaut ist, müssen diese, da der Dispatcher das benötigt, seperiert sein durch die URL nach spezifischem Pfad und Wort Begrenzer Zeichen. Der ViewRenderer ersetzt jeden Pfad Begrenzer den er im Controllernamen findet mit einem aktuellen Pfad Begrenzer ('/'), und jeden Wort Begrenzer der gefunden wird mit einem Bindestrich ('-') wenn Pfade erstellt werden. Deshalb würde ein Aufruf der Aktion /foo.bar/baz.bat zu FooBarController::bazBatAction() in FooBarControll.php weiterleiten was wiederum foo-bar/baz-bat.phtml darstellen würde; ein Aufruf der Aktion /bar_baz/baz-bat für dazu das Bar_BazController::bazBatAction() in Bar/BazController.php dispatched wird (betrachte die Separation des Pfades) und bar/baz/baz-bat.phtml gerendert wird.
Es ist zu beachten das im zweiten Beispiel, das Modul noch immer das Standardmodul ist, aber das der Controller, wegen der Existenz eines Pfad Separators, den Namen Bar_BazController in Bar/BazController.php empfängt. Der ViewRenderer emuliert die Controller Verzeichnis Hierarchie.

Example #10 Automatisches rendern ausschalten

Für einige Aktionen oder Controller, kann es gewünscht sein das automatische Rendern auszuschalten -- zum Beispiel, wenn eine andere Art von Ausgabe (XML, JSON, etc) ausgegeben werden soll, oder wenn man einfach nichts ausgeben will. Es gibt zwei Optionen: Alle Fälle von automatischem Rendern ausschalten ( setNeverRender()), oder dieses einfach für die aktuelle Aktion ausschalten ( setNoRender()).

  1. // Baz Controller Klasse, bar Modul:
  2. class Bar_BazController extends Zend_Controller_Action
  3. {
  4.     public function fooAction()
  5.     {
  6.         // Diese Sektion nicht automatisch Rendern
  7.         $this->_helper->viewRenderer->setNoRender();
  8.     }
  9. }
  10.  
  11. // Bat Controller Klasse, Bar Modul:
  12. class Bar_BatController extends Zend_Controller_Action
  13. {
  14.     public function preDispatch()
  15.     {
  16.         // Die Aktionen dieses Controller nie automatisch Rendern
  17.         $this->_helper->viewRenderer->setNoRender();
  18.     }
  19. }

Note: In den meisten Fällen, macht es keinen Sinn das automatische Rendern global auszuschalten (ala setNeverRender()), da das einzige das man dann vom ViewRenderer erhält das automatische Setup des View Objekts ist.

Example #11 Ein anderes View Skript auswählen

Einige Situationen erfordern das ein anderes Skript, als das nach der Aktion benannte, ausgeführt wird. Zum Beispiel, wenn man einen Controller hat der Aktionen sowohl hinzufügen als auch bearbeiten kann, und beide mit der selben 'form' View angezeigt werden, aber mit unterschiedlichen Werten gesetzt werden. Der Skript Name kann ganz einfach geändert werden. Entweder mit setScriptAction(), setRender() oder durch Aufruf des Helfers als Methode, was wiederum setRender() ausruft.

  1. // Bar Controller Klasse, foo Modul:
  2. class Foo_BarController extends Zend_Controller_Action
  3. {
  4.     public function addAction()
  5.     {
  6.         // Rendert 'bar/form.phtml' statt 'bar/add.phtml'
  7.         $this->_helper->viewRenderer('form');
  8.     }
  9.  
  10.     public function editAction()
  11.     {
  12.         // Rendert 'bar/form.phtml' statt 'bar/edit.phtml'
  13.         $this->_helper->viewRenderer->setScriptAction('form');
  14.     }
  15.  
  16.     public function processAction()
  17.     {
  18.         // einige Prüfungen durchführen...
  19.         if (!$valid) {
  20.             // Rendert 'bar/form.phtml' statt 'bar/process.phtml'
  21.             $this->_helper->viewRenderer->setRender('form');
  22.             return;
  23.         }
  24.  
  25.         // andernfalls die Bearbeitung weiter durchführen...
  26.     }
  27.  
  28. }

Example #12 Die resigstrierte View ändern

Was wenn ein View Objekt modifiziert werden soll -- zum Beispiel, die Helfer Pfade ändern, oder die Kodierung? Das kann durch Modifikation des View Objekts, das im Controller gesetzt ist, gemacht werden, oder durch herausnehmen des View Objekts aus dem ViewRenderer; beide referenzieren auf das gleiche Objekt.

  1. // Bar Controller Klasse, foo Modul:
  2. class Foo_BarController extends Zend_Controller_Action
  3. {
  4.     public function preDispatch()
  5.     {
  6.         // Die Kodierung der View ändern
  7.         $this->view->setEncoding('UTF-8');
  8.     }
  9.  
  10.     public function bazAction()
  11.     {
  12.         // Das View Objekt erhalten, und den Kommentar Callback
  13.         // auf 'htmlspecialchars' setzen
  14.         $view = $this->_helper->viewRenderer->view;
  15.         $view->setEscape('htmlspecialchars');
  16.     }
  17. }

Erweiterte Beispiel der Verwendung

Example #13 Die Pfad Spezifikationen ändern

In einigen Fällen, kann man entscheiden das die standardmäßige Pfad Spezifikation nicht den Notwendigkeiten der Seite entspricht. Zum Beispiel, wenn man einen einzelnen Template Baum haben will zu dem man dann Zugriff für Entwickler geben kann (das ist sehr typisch wenn man zum Beispiel » Smarty verwendet). In solchen Fällen, kann es gewünscht sein die Spezifkiation des View Basispfades hardkodiert zu erstellen und eine alternative Spezifikation für die Pfade der Aktions View Skripte selbst zu erstellen.

Für die Zwecke dieses Beispiels, nehmen wir an das der Basispfad zur View '/opt/vendor/templates' sein soll, und das die View Skripte durch ':moduleDir/:controller/:action.:suffix' referenziert werden sollen; wenn das noController Flag gesetzt wurde, soll aus dem Top Level statt aus einem Unterverzeichnis gerendert werden (':action.:suffix'). Zuletzt soll 'tpl' als View Skript Suffix für Dateinamen verwendet werden.

  1. /**
  2. * In der Bootstrap Datei:
  3. */
  4.  
  5. // Unterschiedliche View Implmentation
  6. $view = new ZF_Smarty();
  7.  
  8. $viewRenderer = new Zend_Controller_Action_Helper_ViewRenderer($view);
  9. $viewRenderer->setViewBasePathSpec('/opt/vendor/templates')
  10.              ->setViewScriptPathSpec(':module/:controller/:action.:suffix')
  11.              ->setViewScriptPathNoControllerSpec(':action.:suffix')
  12.              ->setViewSuffix('tpl');
  13. Zend_Controller_Action_HelperBroker::addHelper($viewRenderer);

Example #14 Mehrfache View Skripte von der gleichen Aktion rendern

Manchmal, ist es notwendig mehrfache View Skripte von einer einzelnen Aktion zu rendern. Das ist sehr geradlinig -- einfach mehrere Aufrufe zu render() machen:

  1. class SearchController extends Zend_Controller_Action
  2. {
  3.     public function resultsAction()
  4.     {
  5.         // Annahme das $this->model das aktuelle Modell ist
  6.         $this->view->results =
  7.             $this->model->find($this->_getParam('query', '');
  8.  
  9.         // render() handelt standardmäßig in Vertretung zum ViewRenderer
  10.         // Rendert zuerst die Such Form und anschließend die Ergebnisse
  11.         $this->render('form');
  12.         $this->render('results');
  13.     }
  14.  
  15.     public function formAction()
  16.     {
  17.         // tue nichts; der ViewRenderer bearbeitet das View Skript automatisch
  18.     }
  19. }

Schreiben eigener Helfer

Aktions Helfer erweitern Zend_Controller_Action_Helper_Abstract, eine abstrakte Klasse die das Basisinterface bietet und vom Helfer Broker funktionell benötigt wird. Diese inkludiert die folgenden Methoden:

  • setActionController() wird verwendet um den aktuellen Aktion Controller zu setzen.

  • init(), wird vom Helfer Broker wärend der Instanzierung ausgeführt und kann verwendet werden um den Status zurückzusetzen wenn mehrere Controller den gleichen Helfer in einer verketteten Aktion verwenden.

  • preDispatch(), wird vor der ausführenden Aktion gestartet.

  • postDispatch() wird ausgeführt nachdem eine Aktion fertig ist -- selbst wenn ein preDispatch() Plugin die Aktion abgebrochen hat. Normalerweise nützlich für das Saubermachen.

  • getRequest() empfängt das aktuelle Anfrage Objekt.

  • getResponse() empfängt das aktuelle Antwort Objekt.

  • getName() empfängt den Helfernamen. Sie empfängt die Portion des Klassennamens der dem letzten Unterstrich-Zeichen folgt, oder andererseits den kompletten Klassennamen. Als Beispiel, wenn die Klasse Zend_Controller_Action_Helper_Redirector heißt, wird Redirector zurückgegeben; eine Klasse die FooMessage heißt wird einfach sich selbst zurückgeben.

Optional kann eine direct() Methode in der eigenen Helfer Klasse inkludiert werden. Wenn Sie definiert ist, erlaubt Sie den Helfer als eine Methode des Helfer Brokers zu verwenden, um eine einfache rein-raus Verwendung des Helfers zu ermöglichen. Als Beispiel definiert der Umleiter direct() als einen Alias von goto() und erlaubt damit die Verwendung des Helfers wie folgt:

  1. // Umleiten zu /blog/view/item/id/42
  2. $this->_helper->redirector('item', 'view', 'blog', array('id' => 42));

Intern schaut die __call() Methode des Helfer Brokers nach einem Helfer der redirector heißt, prüft anschließend ob der Helfer eine definierte direct() Methode besitzt und ruft diese mit den angegebenen Argumenten auf.

Wenn eine eigene Helfer Klasse erstellt wurde, kann man zu Ihr wie im obigen Kapitel beschrieben, Zugang erhalten.

blog comments powered by Disqus