Zend_Controller Schnellstart

Einführung

Zend_Controller ist das Herz des MVC Systems des Zend Frameworks. 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.

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.

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

Wurzelverzeichnis setzen

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

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]

Note: Ü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:

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.

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

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.

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.

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:




  
  Meine erste Zend Framework-Seite


    Hallo Welt!

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:

Fehler

Ein Fehler ist aufgetreten

Ein Fehler ist aufgetreten; bitte versuchen Sie es später noch einmal.

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.

Zend Framework 1.9.9 Manual