Zend_Controller-QuickStart.xml 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- EN-Revision: 15182 -->
  3. <!-- Reviewed: no -->
  4. <sect1 id="zend.controller.quickstart">
  5. <title>Zend_Controller Schnellstart</title>
  6. <sect2 id="zend.controller.quickstart.introduction">
  7. <title>Einführung</title>
  8. <para>
  9. <classname>Zend_Controller</classname> ist das Herz des MVC-Systems des Zend Framework.
  10. MVC bedeutet <ulink url="http://de.wikipedia.org/wiki/Model_View_Controller">Model-View-Controller</ulink>
  11. und ist ein Entwurfsmuster, das darauf abzielt, Anwendungslogik von Anzeigelogik zu trennen.
  12. <classname>Zend_Controller_Front</classname> implementiert ein <ulink
  13. url="http://www.martinfowler.com/eaaCatalog/frontController.html">Front-Controller</ulink>-Entwurfsmuster,
  14. das vorschreibt, dass alle Anfragen vom Front-Controller abgefangen und abhängig von der angeforderten URL
  15. an individuelle Action-Controller weitergeleitet werden.
  16. </para>
  17. <para>
  18. Das <classname>Zend_Controller</classname> System wurde im Sinne der Erweiterungsmöglichkeiten
  19. entwickelt, entweder durch Erstellen von Subklassen, welche die bestehenden Klassen
  20. erweitern, oder durch Erstellen neuer Klassen, welche die verschiedenen Interfaces
  21. und abstrakten Klassen implementieren, welche das Fundament der Controller
  22. Klassenfamilie bilden, oder durch das Schreiben von Plugins und Action Helper, um die
  23. Funktionalität des Systems zu erweitern oder zu verändern.
  24. </para>
  25. </sect2>
  26. <sect2 id="zend.controller.quickstart.go">
  27. <title>Schnelleinstieg</title>
  28. <para>
  29. Wer mehr und tiefergehende Informationen benötigt, sollte die folgenden Abschnitte lesen.
  30. Dieser Abschnitt zeigt, wie man auf dem schnellsten Weg ein System lauffähig bekommt.
  31. </para>
  32. <sect3 id="zend.controller.quickstart.go.directory">
  33. <title>Ordnerstruktur anlegen</title>
  34. <para>
  35. Der erste Schritt ist, die Ordnerstruktur für das Framework anzulegen. Typischerweise ist das
  36. die folgende:
  37. </para>
  38. <programlisting role="php"><![CDATA[
  39. application/
  40. controllers/
  41. IndexController.php
  42. models/
  43. views/
  44. scripts/
  45. index/
  46. index.phtml
  47. helpers/
  48. filters/
  49. html/
  50. .htaccess
  51. index.php
  52. ]]></programlisting>
  53. </sect3>
  54. <sect3 id="zend.controller.quickstart.go.docroot">
  55. <title>Wurzelverzeichnis setzen</title>
  56. <para>
  57. Der Webserver ist so zu konfigurieren, dass das Wurzelverzeichnis (Document Root) des Webservers
  58. im <code>html</code>-Verzeichnis der obigen Ordnerstruktur liegt.
  59. </para>
  60. </sect3>
  61. <sect3 id="zend.controller.quickstart.go.rewrite">
  62. <title>Rewrite-Regeln erstellen</title>
  63. <para>
  64. In die Datei <code>html/.htaccess</code> aus der Struktur von oben gehört der folgende Code:
  65. </para>
  66. <programlisting role="php"><![CDATA[
  67. RewriteEngine On
  68. RewriteCond %{REQUEST_FILENAME} -s [OR]
  69. RewriteCond %{REQUEST_FILENAME} -l [OR]
  70. RewriteCond %{REQUEST_FILENAME} -d
  71. RewriteRule ^.*$ - [NC,L]
  72. RewriteRule ^.*$ index.php [NC,L]
  73. ]]></programlisting>
  74. <note>
  75. <title>Über mod_rewrite lernen</title>
  76. <para>
  77. Die obigen Rewrite Regeln erlauben es auf jede Datei im Document Root des
  78. eigenen virtuellen Host's zuzugreifen. Wenn es Dateien gibt die man auf diesem
  79. Weg nicht bereitstellen will, muss man in seinen Regeln restriktiver sein. Gehe
  80. zur Apache WebSite und <ulink
  81. url="http://httpd.apache.org/docs/2.0/mod/mod_rewrite.html">lerne mehr über
  82. mod_rewrite</ulink>.
  83. </para>
  84. </note>
  85. <para>
  86. Wenn man IIS 7.0 verwendet, sollte man die folgende Rewrite Konfiguration verwenden:
  87. </para>
  88. <programlisting role="xml"><![CDATA[
  89. <?xml version="1.0" encoding="UTF-8"?>
  90. <configuration>
  91. <system.webServer>
  92. <rewrite>
  93. <rules>
  94. <rule name="Imported Rule 1" stopProcessing="true">
  95. <match url="^.*$" />
  96. <conditions logicalGrouping="MatchAny">
  97. <add input="{REQUEST_FILENAME}"
  98. matchType="IsFile" pattern=""
  99. ignoreCase="false" />
  100. <add input="{REQUEST_FILENAME}"
  101. matchType="IsDirectory"
  102. pattern="" ignoreCase="false" />
  103. </conditions>
  104. <action type="None" />
  105. </rule>
  106. <rule name="Imported Rule 2" stopProcessing="true">
  107. <match url="^.*$" />
  108. <action type="Rewrite" url="index.php" />
  109. </rule>
  110. </rules>
  111. </rewrite>
  112. </system.webServer>
  113. </configuration>
  114. ]]></programlisting>
  115. <para>
  116. Die obige Regel routet Anfragen entsprechend auf existierende Ressourcen
  117. (existierende Symlinks, nicht-leere Dateien, oder nicht-leere Verzeichnisse),
  118. und alle anderen Anfragen an den Front Controller.
  119. </para>
  120. <note>
  121. <para>
  122. Die Rewrite-Regel oben ist für den Apache-Webserver; Beispiele für andere Webserver finden sich
  123. in der <link linkend="zend.controller.router.introduction">Router-Dokumentation</link>.
  124. </para>
  125. </note>
  126. </sect3>
  127. <sect3 id="zend.controller.quickstart.go.bootstrap">
  128. <title>Boostrap-Datei erstellen</title>
  129. <para>
  130. Die Bootstrap-Datei ist die Datei, durch die alle Anfragen geleitet werden
  131. -- <code>html/index.php</code> in unserem Fall. In die Datei
  132. <code>html/index.php</code> gehört der folgende Code:
  133. </para>
  134. <programlisting role="php"><![CDATA[
  135. Zend_Controller_Front::run('/path/to/app/controllers');
  136. ]]></programlisting>
  137. <para>
  138. Das instanziert und führt den Front-Controller aus,
  139. der Anfragen an den Action-Controller weitergibt.
  140. </para>
  141. </sect3>
  142. <sect3 id="zend.controller.quickstart.go.controller">
  143. <title>Den Action-Controller für die Startseite erstellen</title>
  144. <para>
  145. Bevor wir von Action-Controllern reden, sollte erst verstanden werden, wie Anfragen im Zend Framework
  146. behandelt werden. Standardmäßig zeigt das erste Segment eines URL auf einen Controller und
  147. das zweite Segment auf eine Aktion, die dieser Controller ausführen soll.
  148. Als Beispiel sei der URL <code>http://framework.zend.com/roadmap/components</code> gegeben.
  149. Der Pfad ist <code>/roadmap/components</code>, was die Anfrage zum Controller <code>roadmap</code>
  150. und dort in die Aktion <code>components</code> leitet. Wenn keine Aktion angegeben wird, wird
  151. <code>index</code> als Standard-Aktion angenommen, und wenn kein Controller angegeben wird,
  152. wird auch <code>index</code> als Standard-Controller angenommen. (Das folgt der Apache-Konvention,
  153. die einen <code>DirectoryIndex</code> automatisch findet).
  154. </para>
  155. <para>
  156. Der Dispatcher von <classname>Zend_Controller</classname> nimmt dann den Wert, der als Controller angegeben
  157. ist, und schließt daraus auf eine passende Klasse. In der normalen Einstellung des Dispatchers
  158. wird der erste Buchstabe jedes Wortes im Controller-Namen groß geschrieben (Title-case), und dann
  159. das Wort <code>Controller</code> angehängt. Das bedeutet für unser Beispiel, dass die Anfrage nach
  160. dem Controller <code>roadmap</code> an die Klasse <code>RoadmapController</code> weitergeleitet wird.
  161. </para>
  162. <para>
  163. Auf ähnliche Art wird die Methode für die Aktion bestimmt, die der Controller ausführen soll.
  164. In der Grundeinstellung wird die angefragte Aktion komplett kleingeschrieben und das Wort
  165. <code>Action</code> wird angehängt. In unserem Beispiel wird also die Aktion <code>components</code>
  166. zu <code>componentsAction</code>, insgesamt wird also die Methode
  167. <code>RoadmapController::componentsAction()</code> aufgerufen.
  168. </para>
  169. <para>
  170. Also, weiter gehts. Jetzt wird ein Startseiten-Controller und eine dazugehörige
  171. Standard-Aktionsmethode erstellt. Wie vorhin bereits erwähnt, heißen Standard-Controller und -Aktion
  172. beide <code>index</code>. Also gehört in die Datei
  173. <code>application/controllers/IndexController.php</code> folgendes:
  174. </para>
  175. <programlisting role="php"><![CDATA[
  176. /** Zend_Controller_Action */
  177. class IndexController extends Zend_Controller_Action
  178. {
  179. public function indexAction()
  180. {
  181. }
  182. }
  183. ]]></programlisting>
  184. <para>
  185. Normalerweise ist ein Action-Helper namens <link
  186. linkend="zend.controller.actionhelpers.viewrenderer">ViewRenderer</link>
  187. eingeschaltet. Das bedeutet, dass sofort, wenn eine leere Aktionsmethode und ein passendes View-Script
  188. existieren, Inhalte gerendert werden. Standardmäßig wird die Klasse
  189. <classname>Zend_View</classname> als View-Schicht im Zend-Framework MVC verwendet. Der <code>ViewRenderer</code>
  190. zaubert ein wenig, und benutzt Controller- (hier: <code>index</code>) und Aktionsname
  191. (hier: <code>index</code>), um herauszufinden, welches Template er rendern soll.
  192. Ohne dass man dies ändert, haben Templates die Dateiendung <code>.phtml</code>, das heißt also für
  193. unser Beispiel, dasss das Template <code>index/index.phtml</code> gerendert wird.
  194. Zusätzlich nimmt der <code>ViewRenderer</code> automatisch an, dass das Verzeichnis
  195. <code>views</code> auf der selben Ebene wie das Controller Verzeichnis
  196. das View-Basisverzeichnis ist, und dass die eigentlichen View-Scripts in dessen Unterverzeichnis
  197. <code>views/scripts/</code> liegen. Insgesamt hat also das Template, das gerendert wird,
  198. den Pfad <code>application/views/scripts/index/index.phtml</code>.
  199. </para>
  200. </sect3>
  201. <sect3 id="zend.controller.quickstart.go.view">
  202. <title>Das View-Script erstellen</title>
  203. <para>
  204. Wie <link linkend="zend.controller.quickstart.go.controller">oben beschrieben</link>,
  205. werden View-Scripts im Verzeichnis <code>application/views/scripts/</code> abgelegt;
  206. das View-Script für den Starseiten-Controller und dessen Standard-Aktion hat den Pfad
  207. <code>application/views/scripts/index/index.phtml</code>. Da hinein kommt das folgende HTML:
  208. </para>
  209. <programlisting role="php"><![CDATA[
  210. <!DOCTYPE html
  211. PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
  212. "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
  213. <html>
  214. <head>
  215. <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  216. <title>Meine erste Zend Framework-Seite</title>
  217. </head>
  218. <body>
  219. <h1>Hallo Welt!</h1>
  220. </body>
  221. </html>
  222. ]]></programlisting>
  223. </sect3>
  224. <sect3 id="zend.controller.quickstart.go.errorhandler">
  225. <title>Fehler-Controller erstellen</title>
  226. <para>
  227. Standardmäßig ist <link
  228. linkend="zend.controller.plugins.standard.errorhandler">das
  229. Error-Handler-Plugin</link> registriert. Dieses Plugin erwartet, dass ein Controller existiert,
  230. der Fehler behandelt. Ohne weitere Einstellungen erwartet es einen <code>ErrorController</code>
  231. im Default-Modul mit einer Methode namens <code>errorAction</code>:
  232. </para>
  233. <programlisting role="php"><![CDATA[
  234. /** Zend_Controller_Action */
  235. class ErrorController extends Zend_Controller_Action
  236. {
  237. public function errorAction()
  238. {
  239. }
  240. }
  241. ]]></programlisting>
  242. <para>
  243. In der bereits angesprochenen Ordnerstruktur gehört dieser Code in die Datei
  244. <code>application/controllers/ErrorController.php</code>.
  245. Außerdem muss auch ein View-Script
  246. <code>application/views/scripts/error/error.phtml</code> erstellt werden; Beispielhaft
  247. könnte sein Inhalt so aussehen:
  248. </para>
  249. <programlisting role="php"><![CDATA[
  250. <!DOCTYPE html
  251. PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
  252. "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
  253. <html>
  254. <head>
  255. <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  256. <title>Fehler</title>
  257. </head>
  258. <body>
  259. <h1>Ein Fehler ist aufgetreten</h1>
  260. <p>Ein Fehler ist aufgetreten;
  261. bitte versuchen Sie es später noch einmal.</p>
  262. </body>
  263. </html>
  264. ]]></programlisting>
  265. </sect3>
  266. <sect3 id="zend.controller.quickstart.go.finish">
  267. <title>Die Seite ansehen!</title>
  268. <para>
  269. Jetzt, wo der erste Controller und das erste View-Script geschrieben sind, kann der Browser
  270. aufgerufen und die Seite angesehen werden. Wäre
  271. <code>example.com</code> die Domain der Zend Framework-Installation, dann würde jeder der folgenden
  272. URLs auf die Seite zeigen, die wir gerade erstellt haben:
  273. </para>
  274. <itemizedlist>
  275. <listitem><para><code>http://example.com/</code></para></listitem>
  276. <listitem><para><code>http://example.com/index</code></para></listitem>
  277. <listitem><para><code>http://example.com/index/index</code></para></listitem>
  278. </itemizedlist>
  279. <para>
  280. Herzlichen Glückwunsch, Sie sind jetzt bereit, weitere Controller und Aktionsmethoden
  281. zu erstellen und Ihrer Seite damit Leben einzuhauchen.
  282. </para>
  283. </sect3>
  284. </sect2>
  285. </sect1>
  286. <!--
  287. vim:se ts=4 sw=4 et:
  288. -->