Programmer's Reference Guide

Kapitel 12. Zend_Controller

Inhaltsverzeichnis

12.1. Zend_Controller Schnellstart
12.1.1. Einführung
12.1.2. Schnelleinstieg
12.1.2.1. Ordnerstruktur anlegen
12.1.2.2. Wurzelverzeichnis setzen
12.1.2.3. Rewrite-Regeln erstellen
12.1.2.4. Boostrap-Datei erstellen
12.1.2.5. Den Action-Controller für die Startseite erstellen
12.1.2.6. Das View-Script erstellen
12.1.2.7. Fehler-Controller erstellen
12.1.2.8. Die Seite ansehen!
12.2. Zend_Controller Grundlagen
12.3. Der Front Controller
12.3.1. Übersicht
12.3.2. Grundlegende Methoden
12.3.2.1. getInstance()
12.3.2.2. setControllerDirectory() und addControllerDirectory()
12.3.2.3. addModuleDirectory() und getModuleDirectory()
12.3.2.4. dispatch()
12.3.2.5. run()
12.3.3. Methoden für Umgebungszugriff
12.3.4. Front Controller-Parameter
12.3.5. Erweitern des Front-Controllers
12.4. Das Request Objekt
12.4.1. Einführung
12.4.2. HTTP Anfragen
12.4.2.1. Auf Request Daten zugreifen
12.4.2.2. Basis Url und Unterverzeichnisse
12.4.2.3. Erkennen der Anfrage Methode
12.4.2.4. Erkennen von AJAX Anfragen
12.4.3. Vererben des Anfrage Objektes
12.5. Der Standard Router
12.5.1. Einführung
12.5.2. Einen Router verwenden
12.5.3. Grundsätzliche Rewrite Router Operationen
12.5.4. Standard Routen
12.5.5. Basis URL und Unterverzeichnisse
12.5.6. Globale Parameter
12.5.7. Router Typen
12.5.7.1. Zend_Controller_Router_Route
12.5.7.1.1. Variable Standards
12.5.7.1.2. Variable Anforderungen
12.5.7.1.3. Übersetzte Segmente
12.5.7.2. Zend_Controller_Router_Route_Static
12.5.7.3. Zend_Controller_Router_Route_Regex
12.5.7.4. Zend_Controller_Router_Route_Hostname
12.5.7.5. Zend_Controller_Router_Route_Chain
12.5.7.5.1. Verkettete Routen über Zend_Config
12.5.8. Zend_Config mit dem RewriteRouter verwenden
12.5.9. Erben vom Router
12.6. Der Dispatcher
12.6.1. Überblick
12.6.2. Erben vom Dispatcher
12.7. Action Controller
12.7.1. Einführung
12.7.2. Objekt Initialisierung
12.7.3. Pre- und Post-Dispatch Hooks
12.7.4. Zugriffe
12.7.5. View Integration
12.7.5.1. View Initialisierung
12.7.5.2. Rendern von Views
12.7.6. Nützliche Methoden
12.7.7. Erweitern des Aktion Kontrollers
12.8. Action Helfer
12.8.1. Einführung
12.8.2. Helfer Initialisierung
12.8.3. Der Helfer Broker
12.8.4. Eingebaute Aktions Helfer
12.8.4.1. ActionStack
12.8.4.2. AutoComplete
12.8.4.2.1. AutoCompletion mit Dojo
12.8.4.2.2. AutoCompletion mit Scriptaculous
12.8.4.3. ContextSwitch und AjaxContext
12.8.4.3.1. Vorhandene Standard Kontexte
12.8.4.3.2. Eigene Kontexte erstellen
12.8.4.3.3. Kontexte per Aktion setzen
12.8.4.3.4. Kontext Switching initialisieren
12.8.4.3.5. Zusätzliche Funktionalitäten
12.8.4.3.6. AjaxContext Funktionalität
12.8.4.4. FlashMessenger
12.8.4.4.1. Einführung
12.8.4.4.2. Beispiel einer standardmäßigen Verwendung
12.8.4.5. JSON
12.8.4.6. Redirector
12.8.4.6.1. Einführung
12.8.4.6.2. Beispiel für die grundsätzliche Verwendung
12.8.4.7. ViewRenderer
12.8.4.7.1. Einführung
12.8.4.7.2. API
12.8.4.7.3. Grundsätzliches Beispiel der Verwendung
12.8.4.7.4. Erweiterte Beispiel der Verwendung
12.8.5. Schreiben eigener Helfer
12.9. Das Response Objekt
12.9.1. Verwendung
12.9.2. Header manipulieren
12.9.3. Benannte Segmente
12.9.4. Auf Ausnahmen im Antwort Objekt testen
12.9.5. Erben vom Antwort Objekt
12.10. Plugins
12.10.1. Einführung
12.10.2. Plugins schreiben
12.10.3. Plugins verwenden
12.10.4. Empfangen und Manipulieren von Plugins
12.10.5. Plugins die in der Standard Distribution enthalten sind
12.10.5.1. ActionStack
12.10.5.2. Zend_Controller_Plugin_ErrorHandler
12.10.5.2.1. Den Fehler Handler als 404 Handler verwenden
12.10.5.2.2. Zuvor gerenderte Ausgaben erhalten
12.10.5.2.3. Beispiele für die Verwendung des Plugins
12.10.5.2.4. Beispiel für den Fehler Kontroller
12.11. Eine konventionelle modulare Verzeichnis Struktur verwenden
12.11.1. Einführung
12.11.2. Verzeichnisse für Modul Kontroller spezifizieren
12.11.3. Zu Modulen routen
12.11.4. Modul oder globaler Standard Kontroller
12.12. MVC Ausnahmen
12.12.1. Einführung
12.12.2. Behandeln von Ausnahmen
12.12.3. MVC Ausnahme die auftreten können
12.13. Migration von vorhergehenden Versionen
12.13.1. Migratiion von 1.7.x zu 1.8.0 oder neuer
12.13.1.1. Änderungen der Standard Route
12.13.2. Migration von 1.6.x zu 1.7.0 oder neuer
12.13.2.1. Änderungen im Dispatcher Interface
12.13.3. Migration von 1.5.x zu 1.6.0 oder neuer
12.13.3.1. Änderungen im Dispatcher Interface
12.13.4. Migration von 1.0.x zu 1.5.0 oder neuer
12.13.5. Migration von 0.9.3 nach 1.0.0RC1 oder neuer
12.13.6. Migration von 0.9.2 nach 0.9.3 oder neuer
12.13.7. Migration von 0.6.0 nach 0.8.0 oder neuer
12.13.8. Migration von 0.2.0 oder früher nach 0.6.0

12.1. Zend_Controller Schnellstart

12.1.1. Einführung

Zend_Controller ist das Herz des MVC-Systems des Zend Framework. MVC bedeutet Model-View-Controller und ist ein Entwurfsmuster, das darauf abzielt, Anwendungslogik von Anzeigelogik zu trennen. Zend_Controller_Front implementiert ein Front-Controller-Entwurfsmuster, das vorschreibt, dass alle Anfragen vom Front-Controller abgefangen und abhängig von der angeforderten URL an individuelle Action-Controller weitergeleitet werden.

Das Zend_Controller System wurde im Sinne der Erweiterungsmöglichkeiten entwickelt, entweder durch Erstellen von Subklassen, welche die bestehenden Klassen erweitern, oder durch Erstellen neuer Klassen, welche die verschiedenen Interfaces und abstrakten Klassen implementieren, welche das Fundament der Controller Klassenfamilie bilden, oder durch das Schreiben von Plugins und Action Helper, um die Funktionalität des Systems zu erweitern oder zu verändern.

12.1.2. Schnelleinstieg

Wer mehr und tiefergehende Informationen benötigt, sollte die folgenden Abschnitte lesen. Dieser Abschnitt zeigt, wie man auf dem schnellsten Weg ein System lauffähig bekommt.

12.1.2.1. Ordnerstruktur anlegen

Der erste Schritt ist, die Ordnerstruktur für das Framework anzulegen. Typischerweise ist das die folgende:


application/
    controllers/
        IndexController.php
    models/
    views/
        scripts/
            index/
                index.phtml
        helpers/
        filters/
html/
    .htaccess
    index.php

12.1.2.2. Wurzelverzeichnis setzen

Der Webserver ist so zu konfigurieren, dass das Wurzelverzeichnis (Document Root) des Webservers im html-Verzeichnis der obigen Ordnerstruktur liegt.

12.1.2.3. Rewrite-Regeln erstellen

In die Datei html/.htaccess aus der Struktur von oben gehört der folgende Code:


RewriteEngine On
RewriteCond %{REQUEST_FILENAME} -s [OR]
RewriteCond %{REQUEST_FILENAME} -l [OR]
RewriteCond %{REQUEST_FILENAME} -d
RewriteRule ^.*$ - [NC,L]
RewriteRule ^.*$ index.php [NC,L]
[Anmerkung] Über mod_rewrite lernen

Die obigen Rewrite Regeln erlauben es auf jede Datei im Document Root des eigenen virtuellen Host's zuzugreifen. Wenn es Dateien gibt die man auf diesem Weg nicht bereitstellen will, muss man in seinen Regeln restriktiver sein. Gehe zur Apache WebSite und lerne mehr über mod_rewrite.

Wenn man IIS 7.0 verwendet, sollte man die folgende Rewrite Konfiguration verwenden:


<?xml version="1.0" encoding="UTF-8"?>
<configuration>
     <system.webServer>
         <rewrite>
             <rules>
                 <rule name="Imported Rule 1" stopProcessing="true">
                     <match url="^.*$" />
                     <conditions logicalGrouping="MatchAny">
                         <add input="{REQUEST_FILENAME}"
                             matchType="IsFile" pattern=""
                             ignoreCase="false" />
                         <add input="{REQUEST_FILENAME}"
                             matchType="IsDirectory"
                             pattern="" ignoreCase="false" />
                     </conditions>
                     <action type="None" />
                 </rule>
                 <rule name="Imported Rule 2" stopProcessing="true">
                     <match url="^.*$" />
                     <action type="Rewrite" url="index.php" />
                 </rule>
             </rules>
         </rewrite>
     </system.webServer>
</configuration>

Die obige Regel routet Anfragen entsprechend auf existierende Ressourcen (existierende Symlinks, nicht-leere Dateien, oder nicht-leere Verzeichnisse), und alle anderen Anfragen an den Front Controller.

[Anmerkung] Anmerkung

Die Rewrite-Regel oben ist für den Apache-Webserver; Beispiele für andere Webserver finden sich in der Router-Dokumentation.

12.1.2.4. Boostrap-Datei erstellen

Die Bootstrap-Datei ist die Datei, durch die alle Anfragen geleitet werden -- html/index.php in unserem Fall. In die Datei html/index.php gehört der folgende Code:


Zend_Controller_Front::run('/path/to/app/controllers');

Das instanziert und führt den Front-Controller aus, der Anfragen an den Action-Controller weitergibt.

12.1.2.5. Den Action-Controller für die Startseite erstellen

Bevor wir von Action-Controllern reden, sollte erst verstanden werden, wie Anfragen im Zend Framework behandelt werden. Standardmäßig zeigt das erste Segment eines URL auf einen Controller und das zweite Segment auf eine Aktion, die dieser Controller ausführen soll. Als Beispiel sei der URL http://framework.zend.com/roadmap/components gegeben. Der Pfad ist /roadmap/components, was die Anfrage zum Controller roadmap und dort in die Aktion components leitet. Wenn keine Aktion angegeben wird, wird index als Standard-Aktion angenommen, und wenn kein Controller angegeben wird, wird auch index als Standard-Controller angenommen. (Das folgt der Apache-Konvention, die einen DirectoryIndex automatisch findet).

Der Dispatcher von Zend_Controller nimmt dann den Wert, der als Controller angegeben ist, und schließt daraus auf eine passende Klasse. In der normalen Einstellung des Dispatchers wird der erste Buchstabe jedes Wortes im Controller-Namen groß geschrieben (Title-case), und dann das Wort Controller angehängt. Das bedeutet für unser Beispiel, dass die Anfrage nach dem Controller roadmap an die Klasse RoadmapController weitergeleitet wird.

Auf ähnliche Art wird die Methode für die Aktion bestimmt, die der Controller ausführen soll. In der Grundeinstellung wird die angefragte Aktion komplett kleingeschrieben und das Wort Action wird angehängt. In unserem Beispiel wird also die Aktion components zu componentsAction, insgesamt wird also die Methode RoadmapController::componentsAction() aufgerufen.

Also, weiter gehts. Jetzt wird ein Startseiten-Controller und eine dazugehörige Standard-Aktionsmethode erstellt. Wie vorhin bereits erwähnt, heißen Standard-Controller und -Aktion beide index. Also gehört in die Datei application/controllers/IndexController.php folgendes:


/** Zend_Controller_Action */
class IndexController extends Zend_Controller_Action
{
    public function indexAction()
    {
    }
}

Normalerweise ist ein Action-Helper namens ViewRenderer eingeschaltet. Das bedeutet, dass sofort, wenn eine leere Aktionsmethode und ein passendes View-Script existieren, Inhalte gerendert werden. Standardmäßig wird die Klasse Zend_View als View-Schicht im Zend-Framework MVC verwendet. Der ViewRenderer zaubert ein wenig, und benutzt Controller- (hier: index) und Aktionsname (hier: index), um herauszufinden, welches Template er rendern soll. Ohne dass man dies ändert, haben Templates die Dateiendung .phtml, das heißt also für unser Beispiel, dass das Template index/index.phtml gerendert wird. Zusätzlich nimmt der ViewRenderer automatisch an, dass das Verzeichnis views auf der selben Ebene wie das Controller Verzeichnis das View-Basisverzeichnis ist, und dass die eigentlichen View-Scripts in dessen Unterverzeichnis views/scripts/ liegen. Insgesamt hat also das Template, das gerendert wird, den Pfad application/views/scripts/index/index.phtml.

12.1.2.6. Das View-Script erstellen

Wie oben beschrieben, werden View-Scripts im Verzeichnis application/views/scripts/ abgelegt; das View-Script für den Starseiten-Controller und dessen Standard-Aktion hat den Pfad application/views/scripts/index/index.phtml. Da hinein kommt das folgende HTML:


<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<head>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  <title>Meine erste Zend Framework-Seite</title>
</head>
<body>
    <h1>Hallo Welt!</h1>
</body>
</html>

12.1.2.7. Fehler-Controller erstellen

Standardmäßig ist das Error-Handler-Plugin registriert. Dieses Plugin erwartet, dass ein Controller existiert, der Fehler behandelt. Ohne weitere Einstellungen erwartet es einen ErrorController im Default-Modul mit einer Methode namens errorAction:


/** Zend_Controller_Action */
class ErrorController extends Zend_Controller_Action
{
    public function errorAction()
    {
    }
}

In der bereits angesprochenen Ordnerstruktur gehört dieser Code in die Datei application/controllers/ErrorController.php. Außerdem muss auch ein View-Script application/views/scripts/error/error.phtml erstellt werden; Beispielhaft könnte sein Inhalt so aussehen:


<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<head>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  <title>Fehler</title>
</head>
<body>
    <h1>Ein Fehler ist aufgetreten</h1>
    <p>Ein Fehler ist aufgetreten;
       bitte versuchen Sie es später noch einmal.</p>
</body>
</html>

12.1.2.8. Die Seite ansehen!

Jetzt, wo der erste Controller und das erste View-Script geschrieben sind, kann der Browser aufgerufen und die Seite angesehen werden. Wäre example.com die Domain der Zend Framework-Installation, dann würde jeder der folgenden URLs auf die Seite zeigen, die wir gerade erstellt haben:

  • http://example.com/

  • http://example.com/index

  • http://example.com/index/index

Herzlichen Glückwunsch, Sie sind jetzt bereit, weitere Controller und Aktionsmethoden zu erstellen und Ihrer Seite damit Leben einzuhauchen.


Search the Manual

Translation Status Reports

View the current status report of Zend Framework manual translations.