Zend_Controller_Action ist eine abstrakte Klasse die verwendet werden kann um Aktion Kontroller zu implementieren die mit dem Front Kontroller 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 Kontroller Klasse ererbt werden (oder von dieser erben um eine eigene Basisklasse für Aktion Kontroller zu erstellen). Die grundsätzlichste Operation ist es von Ihr zu erben und Aktions Methoden zu erstellen die den verschiedenen Aktionen entsprechen die der Kontroller 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 Kontroller Aktion herausfinden.

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

class FooController extends Zend_Controller_Action
{
    public function barAction()
    {
        // mach irgendwas
    }

    public function bazAction()
    {
        // mach irgendwas
    }
}

        

Die obige FooController Klasse (Kontroller 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 Kontroller Funktionalitäten.

Hinweis: Standardverhalten
Standardmäßig aktiviert der Front Kontroller den Aktion Helfer des ViewRenderer's. Dieser Helfer übernimmt das Einfügen des View Objekts in den Kontroller, sowie das automatische Rendern der View. Er kan innerhalb des Aktion Kontrollers mit einer der folgenden Methoden ausgeschaltet werden:

class FooController extends Zend_Controller_Action
{
    public function init()
    {
        // Lokal nur bei diesem Kontroller; beeinflußt alle Aktionen die mit init geladen wurden:
        $this->_helper->viewRenderer->setNoRender(true);

        // Global:
        $this->_helper->removeHelper('viewRenderer');

        // Auch global, muß aber in Verbindung mit der Lokalen Version sein um für diesen Kontroller zu gelten:
        Zend_Controller_Front::getInstance()
            ->setParam('noViewRenderer', true);
    }
}

            

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:

class FooController extends Zend_Controller_Action
{
    public function barAction()
    {
        // Nur für diese Aktion das automatische Rendern ausschalten:
        $this->_helper->viewRenderer->setNoRender();
    }
}

            

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 Kontroller 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 Kontroller oder Aktionen.

Wärend man immer den Konstruktor des Aktion Kontroller'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 Kontroller ü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:

class FooController extends Zend_Controller_Action
{
    public function init()
    {
        $this->db = Zend_Db::factory('Pdo_Mysql', array(
            'host'     => 'myhost',
            'username' => 'user',
            'password' => 'XXXXXXX',
            'dbname'   => 'website'
        ));
    }
}

        

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 ACLs 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()).

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:

  $this->getResponse()->setHeader('Content-Type', 'text/xml');
  $this->getResponse()->appendBody($content);
  
                  

• Aufgerufene Argumente: Der Front Kontroller kann Parameter in den Router, Dispatcher und Aktion Kontroller 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.

  Hinweis: _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:
  

  // Verwende des Standardwert 1 wenn id nicht gesetzt wurde
  $id = $this->_getParam('id', 1);
  
  // Statt:
  if ($this->_hasParam('id') {
      $id = $this->_getParam('id');
  } else {
      $id = 1;
  }
  
                      

Hinweis: 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 öffnetliche 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.

applicationOrModule/
    controllers/
        IndexController.php
    views/
        scripts/
            index/
                index.phtml
        helpers/
        filters/

            

string render(string $action = null,
              string $name = null,
              bool $noController = false);

            

class MyController extends Zend_Controller_Action
{
    public function fooAction()
    {
        // Rendert my/foo.phtml
        $this->render();

        // Rendert my/bar.phtml
        $this->render('bar');

        // Rendert baz.phtml
        $this->render('baz', null, true);

        // Rendert my/login.phtml in das 'form' Segment des Antwort Objektes
        $this->render('login', 'form');

        // Rendert site.phtml in das 'page' Segmetn des Antwort Objektes;
        // verwendet nicht das 'my/' Unterverzeichnis
        $this->render('site', 'page', true);
    }

    public function bazBatAction()
    {
        // Rendert my/baz-bat.phtml
        $this->render();
    }
}

            

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-/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 Kontroller 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 Kontroller 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 Kontroller gesetzt werden indem der setRedirectCode() Zugriff verwendet wird.

Vom Design her muß Zend_Controller_Action erweitert werden um einen Aktion Kontroller zu erstellen. Als Minimum, muß eine Aktions Methode definiert werden die der Kontroller 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 Kontrollern wiederholt wird; wenn dem so ist, löst die Erstellung einer gemeinsamen Basis Kontroller Klasse die Zend_Controller_Action erweitert zu einer Lösung dieser Redundanz.

class MyController extends Zend_Controller_Action
{
    public function __call($method, $args)
    {
        if ('Action' == substr($method, -6)) {
            // Wenn die Aktionsmethode nicht gefunden wurde, rendere das error Template
            return $this->render('error');
        }

        // Alle anderen Methoden werfen eine Ausnahme
        throw new Exception('Invalid method "'
                            . $method
                            . '" called',
                            500);
    }
}

            

class MyController extends Zend_Controller_Action
{
    public function indexAction()
    {
        $this->render();
    }

    public function __call($method, $args)
    {
        if ('Action' == substr($method, -6)) {
            // Wenn die Aktionsmethode nicht gefunden wurde, leite zur Index Aktion weiter
            return $this->_forward('index');
        }

        // Alle anderen Methoden werden eine Ausnahme
        throw new Exception('Invalid method "'
                            . $method
                            . '" called',
                            500);
    }
}

            

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

abstract class My_Base_Controller extends Zend_Controller_Action
{
    public function initView()
    {
        if (null === $this->view) {
            if (Zend_Registry::isRegistered('view')) {
                $this->view = Zend_Registry::get('view');
            } else {
                $this->view = new Zend_View();
                $this->view->setBasePath(dirname(__FILE__) . '/../views');
            }
        }

        return $this->view;
    }
}

        

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.