1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351
|
<?xml version="1.0" encoding="UTF-8"?>
<!-- EN-Revision: 24249 -->
<!-- Reviewed: no -->
<sect1 id="zend.controller.quickstart">
<title>Zend_Controller Schnellstart</title>
<sect2 id="zend.controller.quickstart.introduction">
<title>Einführung</title>
<para>
<classname>Zend_Controller</classname> ist das Herz des <acronym>MVC</acronym> Systems
des Zend Frameworks. <acronym>MVC</acronym> bedeutet <ulink
url="http://de.wikipedia.org/wiki/Model_View_Controller">Model-View-Controller</ulink>
und ist ein Entwurfsmuster, das darauf abzielt, Anwendungslogik von Anzeigelogik zu
trennen. <classname>Zend_Controller_Front</classname> implementiert ein <ulink
url="http://www.martinfowler.com/eaaCatalog/frontController.html">Front-Controller</ulink>-Entwurfsmuster,
das vorschreibt, dass alle Anfragen vom Front-Controller abgefangen und abhängig von der
angeforderten <acronym>URL</acronym> an individuelle Action-Controller weitergeleitet
werden.
</para>
<para>
Das <classname>Zend_Controller</classname> 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.
</para>
</sect2>
<sect2 id="zend.controller.quickstart.go">
<title>Schnelleinstieg</title>
<para>
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.
</para>
<sect3 id="zend.controller.quickstart.go.directory">
<title>Ordnerstruktur anlegen</title>
<para>
Der erste Schritt ist, die Ordnerstruktur für das Framework anzulegen.
Typischerweise ist das die folgende:
</para>
<programlisting language="php"><![CDATA[
application/
controllers/
IndexController.php
models/
views/
scripts/
index/
index.phtml
helpers/
filters/
html/
.htaccess
index.php
]]></programlisting>
</sect3>
<sect3 id="zend.controller.quickstart.go.docroot">
<title>Wurzelverzeichnis setzen</title>
<para>
Der Webserver ist so zu konfigurieren, dass das Wurzelverzeichnis (Document Root)
des Webservers im <filename>html/</filename>-Verzeichnis der obigen Ordnerstruktur
liegt.
</para>
</sect3>
<sect3 id="zend.controller.quickstart.go.rewrite">
<title>Rewrite-Regeln erstellen</title>
<para>
In die Datei <filename>html/.htaccess</filename> aus der Struktur von oben gehört
der folgende Code:
</para>
<programlisting language="php"><![CDATA[
RewriteEngine On
RewriteCond %{REQUEST_FILENAME} -s [OR]
RewriteCond %{REQUEST_FILENAME} -l [OR]
RewriteCond %{REQUEST_FILENAME} -d
RewriteRule ^.*$ - [NC,L]
RewriteRule ^.*$ index.php [NC,L]
]]></programlisting>
<note>
<title>Über mod_rewrite lernen</title>
<para>
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 <ulink
url="http://httpd.apache.org/docs/2.0/mod/mod_rewrite.html">lerne mehr über
mod_rewrite</ulink>.
</para>
</note>
<para>
Wenn man <acronym>IIS</acronym> 7.0 verwendet, sollte man die folgende Rewrite
Konfiguration verwenden:
</para>
<programlisting language="xml"><![CDATA[
<?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>
]]></programlisting>
<para>
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.
</para>
<note>
<para>
Die Rewrite-Regel oben ist für den Apache-Webserver; Beispiele für andere
Webserver finden sich in der <link
linkend="zend.controller.router.introduction">Router-Dokumentation</link>.
</para>
</note>
</sect3>
<sect3 id="zend.controller.quickstart.go.bootstrap">
<title>Boostrap-Datei erstellen</title>
<para>
Die Bootstrap-Datei ist die Datei, durch die alle Anfragen geleitet werden
-- <filename>html/index.php</filename> in unserem Fall. In die Datei
<filename>html/index.php</filename> gehört der folgende Code:
</para>
<programlisting language="php"><![CDATA[
Zend_Controller_Front::run('/path/to/app/controllers');
]]></programlisting>
<para>
Das instanziert und führt den Front-Controller aus,
der Anfragen an den Action-Controller weitergibt.
</para>
</sect3>
<sect3 id="zend.controller.quickstart.go.controller">
<title>Den Action-Controller für die Startseite erstellen</title>
<para>
Bevor wir von Action-Controllern reden, sollte erst verstanden werden, wie Anfragen
im Zend Framework behandelt werden. Standardmäßig zeigt das erste Segment eines
<acronym>URL</acronym> auf einen Controller und das zweite Segment auf eine Aktion,
welche dieser Controller ausführen soll. Als Beispiel sei der <acronym>URL</acronym>
<filename>http://framework.zend.com/roadmap/components</filename> gegeben. Der Pfad
ist <filename>/roadmap/components</filename>, was die Anfrage zum Controller
<emphasis>roadmap</emphasis> und dort in die Aktion <emphasis>components</emphasis>
leitet. Wenn keine Aktion angegeben wird, wird <emphasis>index</emphasis> als
Standard-Aktion angenommen, und wenn kein Controller angegeben wird, wird auch
<emphasis>index</emphasis> als Standard-Controller angenommen. (Das folgt der
Apache-Konvention, die einen <emphasis>DirectoryIndex</emphasis> automatisch
findet).
</para>
<para>
Der Dispatcher von <classname>Zend_Controller</classname> 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
<emphasis>Controller</emphasis> angehängt. Das bedeutet für unser Beispiel, dass
die Anfrage nach dem Controller <emphasis>roadmap</emphasis> an die Klasse
<classname>RoadmapController</classname> weitergeleitet wird.
</para>
<para>
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 <emphasis>Action</emphasis> wird angehängt. In
unserem Beispiel wird also die Aktion <emphasis>components</emphasis> zu
<methodname>componentsAction()</methodname>, insgesamt wird also die Methode
<methodname>RoadmapController::componentsAction()</methodname> aufgerufen.
</para>
<para>
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 <emphasis>index</emphasis>. Also gehört in
die Datei <filename>application/controllers/IndexController.php</filename>
folgendes:
</para>
<programlisting language="php"><![CDATA[
/** Zend_Controller_Action */
class IndexController extends Zend_Controller_Action
{
public function indexAction()
{
}
}
]]></programlisting>
<para>
Normalerweise ist ein Action-Helper namens <link
linkend="zend.controller.actionhelpers.viewrenderer">ViewRenderer</link>
eingeschaltet. Das bedeutet, dass sofort, wenn eine leere Aktionsmethode und ein
passendes View-Script existieren, Inhalte gerendert werden. Standardmäßig wird die
Klasse <classname>Zend_View</classname> als View-Schicht im Zend-Framework
<acronym>MVC</acronym> verwendet. Der <emphasis>ViewRenderer</emphasis> zaubert ein
wenig, und benutzt Controller- (hier: <emphasis>index</emphasis>) und Aktionsname
(hier: <emphasis>index</emphasis>), um herauszufinden, welches Template er rendern
soll. Ohne dass man dies ändert, haben Templates die Dateiendung
<filename>.phtml</filename>, das heißt also für unser Beispiel, dass das Template
<filename>index/index.phtml</filename> gerendert wird. Zusätzlich nimmt der
<emphasis>ViewRenderer</emphasis> automatisch an, dass das Verzeichnis
<filename>views/</filename> auf der selben Ebene wie das Controller Verzeichnis das
View-Basisverzeichnis ist, und dass die eigentlichen View-Scripts in dessen
Unterverzeichnis <filename>views/scripts/</filename> liegen. Insgesamt hat also das
Template, das gerendert wird, den Pfad
<filename>application/views/scripts/index/index.phtml</filename>.
</para>
</sect3>
<sect3 id="zend.controller.quickstart.go.view">
<title>Das View-Script erstellen</title>
<para>
Wie <link linkend="zend.controller.quickstart.go.controller">oben
beschrieben</link>, werden View-Scripts im Verzeichnis
<filename>application/views/scripts/</filename> abgelegt; das View-Script für den
Starseiten-Controller und dessen Standard-Aktion hat den Pfad
<filename>application/views/scripts/index/index.phtml</filename>. Da hinein kommt
das folgende <acronym>HTML</acronym>:
</para>
<programlisting language="php"><![CDATA[
<!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>
]]></programlisting>
</sect3>
<sect3 id="zend.controller.quickstart.go.errorhandler">
<title>Fehler-Controller erstellen</title>
<para>
Standardmäßig ist <link
linkend="zend.controller.plugins.standard.errorhandler">das
Error-Handler-Plugin</link> registriert. Dieses Plugin erwartet, dass ein Controller
existiert, der Fehler behandelt. Ohne weitere Einstellungen erwartet es einen
<emphasis>ErrorController</emphasis> im Default-Modul mit einer Methode namens
<methodname>errorAction()</methodname>:
</para>
<programlisting language="php"><![CDATA[
/** Zend_Controller_Action */
class ErrorController extends Zend_Controller_Action
{
public function errorAction()
{
}
}
]]></programlisting>
<para>
In der bereits angesprochenen Ordnerstruktur gehört dieser Code in die Datei
<filename>application/controllers/ErrorController.php</filename>. Außerdem muss
auch ein View-Script
<filename>application/views/scripts/error/error.phtml</filename> erstellt
werden; Beispielhaft könnte sein Inhalt so aussehen:
</para>
<programlisting language="php"><![CDATA[
<!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>
]]></programlisting>
</sect3>
<sect3 id="zend.controller.quickstart.go.finish">
<title>Die Seite ansehen!</title>
<para>
Jetzt, wo der erste Controller und das erste View-Script geschrieben sind, kann der
Browser aufgerufen und die Seite angesehen werden. Wäre
<filename>example.com</filename> die Domain der Zend Framework-Installation, dann
würde jeder der folgenden <acronym>URL</acronym>s auf die Seite zeigen, die wir
gerade erstellt haben:
</para>
<itemizedlist>
<listitem><para><filename>http://example.com/</filename></para></listitem>
<listitem><para><filename>http://example.com/index</filename></para></listitem>
<listitem>
<para><filename>http://example.com/index/index</filename></para>
</listitem>
</itemizedlist>
<para>
Herzlichen Glückwunsch, Sie sind jetzt bereit, weitere Controller und
Aktionsmethoden zu erstellen und Ihrer Seite damit Leben einzuhauchen.
</para>
</sect3>
</sect2>
</sect1>
|