Der Front ControllerÜbersichtZend_Controller_Front implementiert ein » Front Controller-Entwurfsmuster, das in » Model-View-Controller (MVC)-Anwendungen verwendet wird. Seine Aufgabe ist, die Abfrage-Umgebung zu initialisieren, die eingehende Abfrage zu routen und dann die Anfrage an alle angefragten Aktionen weiterzuleiten (das alles zusammen wird auch dispatchen genannt); er fasst alle Antworten zusammen und gibt sie zurück, wenn der Prozess beendet ist. Zend_Controller_Front implementiert auch das » Singleton-Entwurfsmuster , das heißt nur eine einzige Instanz dieser Klasse darf zu jedem Zeitpunkt existieren. Das ermöglicht es auch, dass der Front-Controller als Registry fungiert, in der alle anderen Objekte des Prozesses Daten persistent speichern können. Zend_Controller_Front registriert einen Plugin-Broker in der Registry, die er selber ist, was es erlaubt, verschiedene Events, die er auslöst, von den Plugins überwachen zu lassen. In den meisten Fällen gibt das dem Entwickler die Möglichkeit, einen maßgeschneiderten Dispatch-Prozess zu entwerfen, ohne den Front-Controller erweitern zu müssen um Funktionalität hinzuzufügen. Als ein absolutes Minimum, um zu funktionieren, braucht der Front-Controller den Pfad zu einem oder mehreren Verzeichnissen, die Action-Controller enthalten. Verschiedene Methoden können auch noch aufgerufen werden, um die Front-Controller-Umgebung und die seiner Hilfsklassen anzupassen.
Grundlegende MethodenDer Front-Controller hat etliche Zugriffsmethoden, die benutzt werden können, um seine Umgebung zu konfigurieren. Jedoch gibt es drei grundlegende Methoden, die entscheidend für die Funktionalität des Front-Controllers sind: getInstance()getInstance() wird benutzt, um eine Front-Controller Instanz zu erhalten. Da der Front-Controller das Singleton-Entwurfsmuster implementiert, ist das auch die einzige Möglichkeit, ein Front-Controller-Objekt zu erhalten.
setControllerDirectory() und addControllerDirectory()setControllerDirectory() wird benutzt, um dem Dispatcher zu sagen, wo er nach Action-Controller-Klassendateien suchen soll. Sie akzeptiert sowohl einen einzelnen Pfad als auch ein Array aus Modul und Pfadpaaren. Ein Paar Beispiele:
Die aktuellen Einstellungen für den/die Controller-Ordner können mit getControllerDirectory() abgerufen werden; das gibt ein Array mit Modul- und Verzeichnispaaren zurück. addModuleDirectory() und getModuleDirectory()Ein Aspekt des Front-Controllers ist, dass man für die Erstellung von alleinstehenden Komponenten eine modulare Verzeichnisstruktur definieren kann; diese werden "Module" (modules) genannt. Jedes Modul sollte in seinem eigenen Verzeichnis sein und die Verzeichnisstruktur des Standardmoduls spiegeln -- z.B., sollte es mindestens ein /controllers/ Unterverzeichnis haben und typischerweise ein /views/ Unterverzeichnis und andere Anwendungsverzeichnisse. addModuleDirectory() erlaubt es, den Namen des Verzeichnisses zu übergeben, der ein oder mehrere Modulverzeichnisse enthält. Er scannt dieses dann und fügt es den Controllerverzeichnissen des Front-Controllers hinzu. Später, wenn man den Pfad zu einem speziellen Modul oder dem aktuellen Modul eruieren will, kann getModuleDirectory() aufgerufen werden und optional ein Modulname übergeben werden, für welches das spezielle Modulverzeichnis geholt werden soll. dispatch()dispatch(Zend_Controller_Request_Abstract $request = null, Zend_Controller_Response_Abstract $response = null) erledigt die Schwerstarbeit des Front-Controllers. Sie nimmt als Parameter optional ein Anfrage-Object und/oder ein Antwort-Objekt entgegen, was es dem Entwickler erlaubt, wahlweise eigene Objekte für diese beiden Aufgaben zu bestimmen. Wenn kein Anfrage- oder Antwort-Objekt angegeben werden, wird dispatch() nach vorher registrierten Objekten suchen und diese benutzen oder Standardversionen für seinen Prozess instanzieren (in beiden Fällen wird der HTTP-Dialekt als Standard benutzt). Auf ähnliche Art sucht dispatch() nach registrierten Router- und Dispatcher-Objekten und instanziert die Standardversionen wenn keine gefunden werden. Der Dispatch-Prozess hat drei verschiedene Schritte:
Das Routing geschieht genau einmal, indem die Werte aus dem Anfrageobjekt benutzt, die zum Zeitpunkt des Aufrufes von dispatch() vorhanden waren. Das Dispatchen geschieht in einer Schleife; eine Anfrage kann entweder melden, dass es mehrere Aktionen gibt, die ausgeführt werden sollen, oder der Controller oder ein Plugin können das Anfrageobjekt zurücksetzen, um zu erzwingen, dass noch zusätzliche Aktionen ausgeführt werden sollen. Wenn alles erledigt ist, gibt der Front-Controller eine Antwort zurück. run()Zend_Controller_Front::run($path) ist eine statische Methode, die einfach einen Pfad zu einem Verzeichnis, das Action-Controller enthält, als Parameter akzeptiert. Sie holt sich eine Front-Controller-Instanz (mit getInstance()), registriert den angegebenen Pfad mit setControllerDirectory(), und dispatcht schlussendlich. Im Grunde ist run() eine Komfort-Methode, die für Seitenkonstellationen benutzt werden kann, die keine Anpassung der Front-Controller-Umgebung benötigen.
Methoden für UmgebungszugriffZusätzlich zu den oben aufgelisteten Methoden gibt es eine Menge Zugriffsmethoden, die benutzt werden können, um die Front-Controller-Umgebung zu beeinflussen -- und damit die Umgebung der Klassen, an die der Front-Controller seine Arbeit weiterleitet.
Front-Controller-ParameterIn der Einführung haben wir erwähnt, dass der Front-Controller auch als eine Registry für die verschiedenen Controller-Komponenten fungiert. Das macht er über eine Gruppe von "param"-Methoden, de es erlauben, beliebige Daten -- Objekte und Variablen -- im Front-Controller zu registrieren, die dann zu jeder Zeit im Dispatch-Prozess abgerufen werden können. Diese Werte werden weitergegeben an den Router, den Dispatcher und an die Aktions-Controller. Diese Methodengruppe besteht aus:
Es gibt mehrere vordefinierte Parameter, die ebenfalls gesetzt werden können und die speziellen Einfluss auf den Dispatch-Prozess haben:
Erweitern des Front-ControllersUm den Front-Controller zu erweitern, muss als Minimalanforderung auf jeden Fall die Methode getInstance() überschrieben werden:
Das Überschreiben der getInstance()-Methode sorgt dafür, dass folgende Aufrufe von Zend_Controller_Front::getInstance() eine Instanz der neuen Subklasse zurückgeben anstatt einer Zend_Controller_Front-Instanz -- das ist speziell für einige der alternativen Router und View-Helfer nützlich. Typischerweise muss der Front-Controller nicht erweitert werden, es sei denn, es ist gewünscht, neue Funktionalität (wie zum Beispiel einen Plugin-Autoloader oder einen Weg, Action-Helper-Pfade anzugeben) hinzuzufügen. Einige Gelegenheiten, bei denen das Standardverhalten geändert werden könnte, wären zum Beispiel die Art, wie Controller geladen oder deren Pfade gespeichert werden, oder welcher Standard-Router und/oder Dispatcher benutzt werden.
|
|