Zend_Controller-Migration.xml 32 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- EN-Revision: 15156 -->
  3. <!-- Reviewed: no -->
  4. <sect1 id="zend.controller.migration">
  5. <title>Migration von vorhergehenden Versionen</title>
  6. <para>
  7. Die API der MVC Komponenten hat sich mit der Zeit verändert. Wer Zend Framework bereits
  8. in einer früheren Version verwendet hat, folgt dem Leitfaden unten, damit dieSkripte die
  9. neue Archtitekur verwenden.
  10. </para>
  11. <sect2 id="zend.controller.migration.fromonesixtooneseven">
  12. <title>Migration von 1.6.x zu 1.7.0 oder neuer</title>
  13. <sect3 id="zend.controller.migration.fromonesixtooneseven.dispatcher">
  14. <title>Änderungen im Dispatcher Interface</title>
  15. <para>
  16. Benutzer haben uns darauf aufmerksam gemacht das
  17. <classname>Zend_Controller_Action_Helper_ViewRenderer</classname> Methoden auf der
  18. abstrakten Dispatcher Klasse verwendet hat die nicht im Dispatcher Interface waren.
  19. Die folgenden Methoden wurden hinzugefügt um sicherzustellen das eigene Dispatcher
  20. weiterhin mit den ausgelieferten Implementierungen funktionieren:
  21. </para>
  22. <itemizedlist>
  23. <listitem><para>
  24. <code>formatModuleName()</code>: sollte verwendet werden um einen rohen
  25. Controllernamen zu nehmen, wie den einen der in einem Anfrageobjekt gepackt ist,
  26. und Ihn in einen richtigen Klassennamen zu reformatieren den eine Klasse, die
  27. <classname>Zend_Controller_Action</classname> erweitert, verwenden würde
  28. </para></listitem>
  29. </itemizedlist>
  30. </sect3>
  31. </sect2>
  32. <sect2 id="zend.controller.migration.fromoneohtoonesix">
  33. <title>Migration von 1.5.x zu 1.6.0 oder neuer</title>
  34. <sect3 id="zend.controller.migration.fromoneohtoonesix.dispatcher">
  35. <title>Änderungen im Dispatcher Interface</title>
  36. <para>
  37. Benutzer haben uns darauf aufmerksam gemacht das sowohl
  38. <classname>Zend_Controller_Front</classname> als auch
  39. <classname>Zend_Controller_Router_Route_Module</classname> Methoden des Dispatchers
  40. verwenden die nicht im Dispatcher Interface waren. Wir haben jetzt die folgenden
  41. drei Methoden hinzugefügt um sicherzustellen das eigene Dispatcher weiterhin mit der
  42. ausgelieferten Implementation arbeiten:
  43. </para>
  44. <itemizedlist>
  45. <listitem><para>
  46. <code>getDefaultModule()</code>: Sollte den Namen des Standardmoduls
  47. zurückgeben.
  48. </para></listitem>
  49. <listitem><para>
  50. <code>getDefaultControllerName()</code>: Sollte den Namen des
  51. Standardcontrollers zurückgeben.
  52. </para></listitem>
  53. <listitem><para>
  54. <code>getDefaultAction()</code>: Sollte den Namen der Standardaktion
  55. zurückgeben.
  56. </para></listitem>
  57. </itemizedlist>
  58. </sect3>
  59. </sect2>
  60. <sect2 id="zend.controller.migration.fromoneohtoonefive">
  61. <title>Migration von 1.0.x zu 1.5.0 oder neuer</title>
  62. <para>
  63. Obwohl die meisten grundsätzlichen Funktionalitäten die gleichen bleiben und alle
  64. dokumentierten Funktionalitäten die gleichen bleiben gibt es doch ein spezielles
  65. <emphasis>undokumentiertes</emphasis> "Feature" das geändert wurde.
  66. </para>
  67. <para>
  68. Wenn URLs geschrieben werden besteht der dokumentierte Weg darin die Aktionsnamen
  69. camelCased mit einem Trennzeichen zu schreiben; diese sind normalerweise '.' oder '-',
  70. können aber im Dispatcher konfiguriert werden. Der Dispatcher ändert den Aktionsnamen
  71. intern auf Kleinschreibung und verwendet diese Trennzeichen um die Aktionsmethode
  72. wieder zu bauen indem er sie camelCase schreibt. Trotzdem, weil PHP Funktionen nicht
  73. unabhängig von der Schreibweise sind, <emphasis>könnte</emphasis> man URLs mit
  74. camelCase schreiben und der Dispatcher würde diese auf den gleichen Platz auflösen.
  75. Zum Beispiel, 'camel-cased' würde durch den Dispatcher zu 'camelCasedAction' werden;
  76. trotzdem, durch den Fall der unabhängigen Schreibweise in PHP, würden beide die selbe
  77. Methode ausführen.
  78. </para>
  79. <para>
  80. Das führt zu Problemen mit dem ViewRenderer wenn View Skripte aufgelöst werden. Der
  81. kanonische, dokumentierte Weg besteht darin das alle Trennzeichen zu Bindestrichen
  82. umgewandelt und die Wörter kleingeschrieben werden. Das erzeugt eine semantische
  83. Bindung zwischen Aktionen und View Skripten, und die Normalisierung stellt sicher
  84. das die Skripte gefunden werden. Trotzdem, wenn die Aktion 'camelCased' aufgerufen und
  85. aufgelöst wird, ist das Trennzeichen nicht mehr vorhanden, und der ViewRenderer
  86. versucht einen anderen Ort aufzulösen -- 'camelcased.phtml' statt 'camel-cased.phtml'.
  87. </para>
  88. <para>
  89. Einige Entwickler hängen an diesem "Feature", welches nie angedacht war. Verschiedene
  90. Änderungen im 1.5.0 Baum, führen dazu das der ViewRenderer diese Pfade nicht länger
  91. auflöst; die semantische Bindung wird nun erzwungen. Ale erstes, erzwingt der
  92. Dispatcher nun die Groß-/Kleinschreibung in Aktionsnamen. Das bedeutet das das
  93. hinleiten zu eigenen Aktionen über die URL durch Verwendung von camelCase nicht länger
  94. auf die gleiche Methode aufgelöst wird wie mit Trennzeichen (z.B. 'camel-casing').
  95. Das führt dazu das der ViewRenderer jetzt nur mehr zeichen-getrennte Aktionen
  96. honoriert wenn er View Skripte auflöst.
  97. </para>
  98. <para>´
  99. Wenn man findet das man auf dieses "Feature" nicht verzichten kann gibt es mehrere
  100. Optionen:
  101. </para>
  102. <itemizedlist>
  103. <listitem><para>
  104. Beste Option: Die View Skripte umbenennen. Vorteile: zukünftige Kompatibilität.
  105. Nachteile: Wenn man viele View Skripte hat die auf dem vorigen aufbauen führt
  106. das, unerwarteter Weise, zu vielen Umbenennungen die durchgeführt werden müssen.
  107. </para></listitem>
  108. <listitem>
  109. <para>
  110. Zweitbeste Option: Der ViewRenderer delegiert nun die Auflösung von View
  111. Skripten zu <classname>Zend_Filter_Inflector</classname>; man kann die Regeln
  112. des Inflectors ändern damit er nicht länger die Wörter der Aktion mit einem
  113. Bindestrich trennt:
  114. </para>
  115. <programlisting role="php"><![CDATA[
  116. $viewRenderer =
  117. Zend_Controller_Action_HelperBroker::getStaticHelper('viewRenderer');
  118. $inflector = $viewRenderer->getInflector();
  119. $inflector->setFilterRule(':action', array(
  120. new Zend_Filter_PregReplace(
  121. '#[^a-z0-9' . preg_quote(DIRECTORY_SEPARATOR, '#') . ']+#i',
  122. ''
  123. ),
  124. 'StringToLower'
  125. ));
  126. ]]></programlisting>
  127. <para>
  128. Der obige Code ändert den Inflector so, das er Wörter nicht länger mit einem
  129. Bindestrich trennt; Es kann auch gewünscht sein den 'StringToLower' Filter zu
  130. entfernen man die aktuellen View Skripte camelCased benannt haben
  131. <emphasis>will</emphasis>.
  132. </para>
  133. <para>
  134. Wenn die Umbenennung der View Skripte zu aufwendig oder Zeitintensiv ist, dann
  135. ist das die beste Option wenn man die Zeit hierfür findet.
  136. </para>
  137. </listitem>
  138. <listitem>
  139. <para>
  140. Die am wenigsten zu empfehlende Option: Man kann den Dispatcher dazu zwingen
  141. camelCase Aktionsnamen mit einem neuen Front Kontroller Flag
  142. 'useCaseSensitiveActions' zu bearbeiten:
  143. </para>
  144. <programlisting role="php"><![CDATA[
  145. $front->setParam('useCaseSensitiveActions', true);
  146. ]]></programlisting>
  147. <para>
  148. Das erlaubt es camelCase in der URL zu verwenden uns es trotzdem auf die
  149. gleiche Aktion aufzulösen wie wenn Trennzeichen verwendet worden wären. Das
  150. bedeutet das das Originale Problem trotzdem durchschlägt; es kann notwendig
  151. sein die zweite Option von oben zusätzlich zu verwenden um sicherzustellen
  152. das die Dinge in allen Variationen funktionieren.
  153. </para>
  154. <para>
  155. Man sollte auch beachten das die Verwendung dieses Flags eine Notiz auslöst,
  156. das dessen Verwendung nicht mehr durchgeführt werden sollte.
  157. </para>
  158. </listitem>
  159. </itemizedlist>
  160. </sect2>
  161. <sect2 id="zend.controller.migration.fromzeroninethree">
  162. <title>Migration von 0.9.3 nach 1.0.0RC1 oder neuer</title>
  163. <para>
  164. Die prinzipiellen Änderungen die durch 1.0.0RC1 angeboten werden sind die Einführung und
  165. standardmäßige Aktivierung des
  166. <link linkend="zend.controller.plugins.standard.errorhandler">ErrorHandler</link>
  167. Plugins und den
  168. <link linkend="zend.controller.actionhelpers.viewrenderer">ViewRenderer</link>
  169. Aktionhelfer. Bitte lies die Dokumentation jedes einzelnen gründlich um zu sehen wie sie
  170. arbeiten und welchen Effekt Sie auf die eigene Anwendung haben können.
  171. </para>
  172. <para>
  173. Der <code>ErrorHandler</code> Plugin läuft wärend der <code>postDispatch()</code>
  174. Prüfung auf Ausnahmen, und leitet zu einem spezifizierten Fehlerhandler Kontroller
  175. weiter. Solch ein Kontroller sollte in der eigenen Anwendung inkludiert werden. Er kann
  176. deaktiviert werden durch das setzen des Frontkontroller Parameters
  177. <code>noErrorHandler</code>:
  178. </para>
  179. <programlisting role="php"><![CDATA[
  180. $front->setParam('noErrorHandler', true);
  181. ]]></programlisting>
  182. <para>
  183. Der <code>ViewRenderer</code> Aktionhelfer automatisiert die Injizierung der View in den
  184. Aktionkontroller genauso wie das autorendern von Viewskripten basierend auf die aktuelle
  185. Aktion. Das primäre Problem dem man begegnen kann ist, wenn man Aktionen hat die keine
  186. View Skripte rendern und weder vorwärts- noch weiterleiten, da der
  187. <code>ViewRenderer</code> versucht ein View Skript zu Rendern basierend auf dem
  188. Aktionnamen.
  189. </para>
  190. <para>
  191. Es gibt verschiedene Strategien die man anwenden kann um den eigenen Code upzudaten. In
  192. kurzer Form, kann man global den <code>ViewRenderer</code> im eigenen Frontkontroller
  193. Bootstrap vor dem Abarbeiten ausschalten:
  194. </para>
  195. <programlisting role="php"><![CDATA[
  196. // Annahme das $front eine Instanz von Zend_Controller_Front ist
  197. $front->setParam('noViewRenderer', true);
  198. ]]></programlisting>
  199. <para>
  200. Trotzdem ist es keine gute Langzeitstrategie, da es auch bedeutet das man mehr Code
  201. schreiben muß.
  202. </para>
  203. <para>
  204. Wenn man bereit ist damit zu beginnen die <code>ViewRenderer</code> Funktionalität zu
  205. verwenden, gibt es verschiedene Dinge die man im eigenen Kontrollercode beachten muß.
  206. Zuerst muß auf die Aktionmethoden (die Methoden die mit 'Action' enden) geachtet werden,
  207. und ausgesucht werden was eine jede machen soll. Wenn nichts vom folgenden passiert, muß
  208. man Änderungen durchführen:
  209. </para>
  210. <itemizedlist>
  211. <listitem><para>Aufruf von <code>$this-&gt;render()</code></para></listitem>
  212. <listitem><para>Aufruf von <code>$this-&gt;_forward()</code></para></listitem>
  213. <listitem><para>Aufruf von <code>$this-&gt;_redirect()</code></para></listitem>
  214. <listitem><para>Aufruf des <code>Redirector</code> Aktionhelfers</para></listitem>
  215. </itemizedlist>
  216. <para>
  217. Die einfachste Änderung ist das ausschalten des Auto-Rendering für diese Methode:
  218. </para>
  219. <programlisting role="php"><![CDATA[
  220. $this->_helper->viewRenderer->setNoRender();
  221. ]]></programlisting>
  222. <para>
  223. Wenn man herausfindet das keine der eigenen Aktionmethoden rendern, weiterleiten oder
  224. umleiten, wird man voraussichtlich die oben angeführte Zeile in die eigene
  225. <code>preDispatch()</code> oder <code>init()</code> Methode einfügen wollen:
  226. </para>
  227. <programlisting role="php"><![CDATA[
  228. public function preDispatch()
  229. {
  230. // Ausschalten des autorendern vom View Skript
  231. $this->_helper->viewRenderer->setNoRender()
  232. // .. andere Dinge tun...
  233. }
  234. ]]></programlisting>
  235. <para>
  236. Wenn <code>render()</code> aufgerufen wird, und man
  237. <link linkend="zend.controller.modular">die konventionelle Modulare Verzeichnis
  238. Struktur</link> verwendet, wird man den Code ändern wollen um Autorendern zu
  239. Verwenden:
  240. </para>
  241. <itemizedlist>
  242. <listitem>
  243. <para>
  244. Wenn man mehrere View Skripte in einer einzelnen Aktion rendert muß nichts
  245. geändert werden.
  246. </para>
  247. </listitem>
  248. <listitem>
  249. <para>
  250. Wenn man einfach <code>render()</code> ohne Argumente aufruft, können diese
  251. Zeilen entfernt
  252. werden.
  253. </para>
  254. </listitem>
  255. <listitem>
  256. <para>
  257. Wenn man <code>render()</code> mit Argumenten aufruft, und danach nicht
  258. irgendeine Bearbeitung durchführt oder mehrere View sktipe rendert, können diese
  259. Aufrufe zu <code>$this-&gt;_helper-&gt;viewRenderer()</code> geändert werden.
  260. </para>
  261. </listitem>
  262. </itemizedlist>
  263. <para>
  264. Wenn die konventionelle modulare Verzeichnisstruktur nicht verwendet wird, gibt es eine
  265. Vielzahl von Methoden für das Setzen des View Basispfades und der Skript
  266. Pfadspezifikationen so das man den <code>ViewRenderer</code> verwenden kann. Bitte lies
  267. die <link linkend="zend.controller.actionhelpers.viewrenderer">ViewRenderer
  268. Dokumentation</link> für Informationen über diese Methoden.
  269. </para>
  270. <para>
  271. Wenn ein View Objekt von der Registry verwendet, oder das eigene View Objekt verändert,
  272. oder eine andere View Implementation verwendet wird wird man den
  273. <code>ViewRenderer</code> in diesem Objekt injiziieren wollen. Das kann ganz einfach
  274. jederzeit durchgeführt werden.
  275. </para>
  276. <itemizedlist>
  277. <listitem>
  278. <para>
  279. Vor dem verarbeiten einer Frontkontroller Instanz:
  280. </para>
  281. <programlisting role="php"><![CDATA[
  282. // Annahme das $view bereits definiert wurde
  283. $viewRenderer = new Zend_Controller_Action_Helper_ViewRenderer($view);
  284. Zend_Controller_Action_HelperBroker::addHelper($viewRenderer);
  285. ]]></programlisting>
  286. </listitem>
  287. <listitem>
  288. <para>
  289. Jederzeit wärend des Bootstrap Prozesses:
  290. </para>
  291. <programlisting role="php"><![CDATA[
  292. $viewRenderer =
  293. Zend_Controller_Action_HelperBroker::getStaticHelper('viewRenderer');
  294. $viewRenderer->setView($view);
  295. ]]></programlisting>
  296. </listitem>
  297. </itemizedlist>
  298. <para>
  299. Es gibt viele Wege den <code>ViewRenderer</code> zu modifizieren inklusive dem Setzen
  300. eines anderen View Skripts zum Rendern, dem Spezifizieren von Veränderungen für alle
  301. veränderbaren Elemente eines View Skript Pfades (inklusive der Endung), dem Auswählen
  302. eines Antwort-benannten Segments zur Anpassung und mehr. Wenn die konventionelle
  303. modulare Verzeichnisstruktur nicht verwendet wird, kann noch immer eine andere Pfad
  304. Spezifikation mit dem <code>ViewRenderer</code> zugeordnet werden.
  305. </para>
  306. <para>
  307. Wir empfehlen die Adaptierung des eigenen Codes um den <code>ErrorHandler</code> und
  308. <code>ViewRenderer</code> zu verwenden da diese neue Kernfunktionalitäten sind.
  309. </para>
  310. </sect2>
  311. <sect2 id="zend.controller.migration.fromzeroninetwo">
  312. <title>Migration von 0.9.2 nach 0.9.3 oder neuer</title>
  313. <para>
  314. 0.9.3 bietet <link linkend="zend.controller.actionhelpers">Aktionhelfer</link> neu an.
  315. Als Teil dieser Änderung wurden die folgenden Methoden entfernt da Sie nun im <link
  316. linkend="zend.controller.actionhelpers.redirector">Weiterleitungs
  317. Aktionhelfer</link> inkludiert sind:
  318. </para>
  319. <itemizedlist>
  320. <listitem>
  321. <para>
  322. <code>setRedirectCode()</code>; wurde umbenannt in
  323. <classname>Zend_Controller_Action_Helper_Redirector::setCode()</classname>.
  324. </para>
  325. </listitem>
  326. <listitem>
  327. <para>
  328. <code>setRedirectPrependBase()</code>; wurde umbenannt in
  329. <classname>Zend_Controller_Action_Helper_Redirector::setPrependBase()</classname>.
  330. </para>
  331. </listitem>
  332. <listitem>
  333. <para>
  334. <code>setRedirectExit()</code>; wurde umbenannt in
  335. <classname>Zend_Controller_Action_Helper_Redirector::setExit()</classname>.
  336. </para>
  337. </listitem>
  338. </itemizedlist>
  339. <para>
  340. Lese die <link linkend="zend.controller.actionhelpers">Aktionhelfer Dokumentation</link>
  341. für nähere Informationen über das empfangen und manipulieren von Helfer Objekten und die
  342. <link linkend="zend.controller.actionhelpers.redirector">Weiterleitungshelfer
  343. Dokumentation</link> für weitere Information über das setzen von
  344. Weiterleitungsoptionen (sowie alternative Methoden des weiterleitens).
  345. </para>
  346. </sect2>
  347. <sect2 id="zend.controller.migration.fromzerosix">
  348. <title>Migration von 0.6.0 nach 0.8.0 oder neuer</title>
  349. <para>
  350. Durch bisherige Änderungen bleibt die wesentliche Verwendung der MVC Komponenten gleich:
  351. </para>
  352. <programlisting role="php"><![CDATA[
  353. require_once 'Zend/Controller/Front.php';
  354. Zend_Controller_Front::run('/path/to/controllers');
  355. ]]></programlisting>
  356. <para>
  357. Dennoch wurde die Verzeichnisstruktur gründliche überarbeitet, verschiedene Komponenten
  358. wurden entfernt und mehrere andere umbenannt und hinzugefügt. Die Änderungen beinhalten:
  359. </para>
  360. <itemizedlist>
  361. <listitem>
  362. <para>
  363. <classname>Zend_Controller_Router</classname> wurde entfernt für den Rewrite
  364. Router entfernt.
  365. </para>
  366. </listitem>
  367. <listitem>
  368. <para>
  369. <classname>Zend_Controller_RewriteRouter</classname> wurde in
  370. <classname>Zend_Controller_Router_Rewrite</classname> umbenannt und zum Standard
  371. Router befördert, der mit dem Framework ausgeliefert wird;
  372. <classname>Zend_Controller_Front</classname> wird ihn als Standard verwenden,
  373. wenn kein anderer Router übergeben wird.
  374. </para>
  375. </listitem>
  376. <listitem>
  377. <para>
  378. Eine neue Route Klasse für die Verwendung mit dem Rewrite Router wurde
  379. eingeführt: <classname>Zend_Controller_Router_Route_Module</classname>; sie
  380. deckt die Standardrouten ab, die vom MVC verwendet werden und bietet die
  381. Unterstützung für <link linkend="zend.controller.modular">Controller
  382. Module</link>.
  383. </para>
  384. </listitem>
  385. <listitem>
  386. <para>
  387. <classname>Zend_Controller_Router_StaticRoute</classname> wurde umbenannt in
  388. <classname>Zend_Controller_Router_Route_Static</classname>.
  389. </para>
  390. </listitem>
  391. <listitem>
  392. <para>
  393. <classname>Zend_Controller_Dispatcher</classname> wurde umbenannt in
  394. <classname>Zend_Controller_Dispatcher_Standard</classname>.
  395. </para>
  396. </listitem>
  397. <listitem>
  398. <para>
  399. <classname>Zend_Controller_Action::_forward()</classname>'s Argumente wurden
  400. geändert. Die Signatur ist nun:
  401. </para>
  402. <programlisting role="php"><![CDATA[
  403. final protected function _forward($action,
  404. $controller = null,
  405. $module = null,
  406. array $params = null);
  407. ]]></programlisting>
  408. <para>
  409. <code>$action</code> wird immer benötigt; wenn kein Controller angegeben wird,
  410. wird eine Action im aktuellen Controller angenommen. <code>$module</code> wird
  411. immer ignoriert, es sei denn <code>$controller</code> wird angegeben.
  412. Schließlich werden alle übergebenen Parameter <code>$params</code> an das
  413. Request Objekt angehängt. Wenn man keinen Controller oder kein Modul angeben,
  414. aber dennoch Parameter übergeben möchte, gibt man einfach null für diese Werte
  415. an.
  416. </para>
  417. </listitem>
  418. </itemizedlist>
  419. </sect2>
  420. <sect2 id="zend.controller.migration.fromzerotwo">
  421. <title>Migration von 0.2.0 oder früher nach 0.6.0</title>
  422. <para>
  423. Die grundlegende Verwendung der MVC Komponenten hat sich nicht verändert; man kann immer
  424. noch das folgende machen:
  425. </para>
  426. <programlisting role="php"><![CDATA[
  427. require_once 'Zend/Controller/Front.php';
  428. Zend_Controller_Front::run('/path/to/controllers');
  429. ]]></programlisting>
  430. <programlisting role="php"><![CDATA[
  431. /* -- Erstelle einen Router -- */
  432. $router = new Zend_Controller_RewriteRouter();
  433. $router->addRoute('user',
  434. 'user/:username',
  435. array('controller' => 'user', 'action' => 'info')
  436. );
  437. /* -- Setze ihn im Controller -- */
  438. $ctrl = Zend_Controller_Front::getInstance();
  439. $ctrl->setRouter($router);
  440. /* -- Setze da Controller Verzeichnis und starte die Verarbeitung -- */
  441. $ctrl->setControllerDirectory('/path/to/controllers');
  442. $ctrl->dispatch();
  443. ]]></programlisting>
  444. <para>
  445. Wir empfehlen die Verwendung des Response Objektes, um Inhalte und Header zu sammeln.
  446. Dies erlaubt den flexibleren Wechsel von Ausgabeformaten (z.B. JSON oder XML statt
  447. XHTML) in deiner Applikation. Standardmäßig verarbeitet <code>dispatch()</code> die
  448. Antwort, sendet Header und gibt die Inhalte aus. Man kann den Front Controller auch
  449. auffordern, die Antwort durch <code>returnResponse()</code> zurückzugeben und die
  450. Antwort dann auf eigene Weise ausgeben. Eine zukünftige Version des Front Controllers
  451. könnte die Verwendung des Response Objektes durch Output Buffering erzwingen.
  452. </para>
  453. <para>
  454. Es gibt viele weitere zusätzliche Funktionalitäten, welche die vorherige API erweitern.
  455. Diese sind in der Dokumentation aufgeführt.
  456. </para>
  457. <para>
  458. Die meisten Änderungen, die man beachten muss, betreffen das Erweitern der diversen
  459. Komponenten. Die wichtigsten davon sind:
  460. </para>
  461. <itemizedlist>
  462. <listitem>
  463. <para>
  464. <classname>Zend_Controller_Front::dispatch()</classname> fängt standardmäßig die
  465. Ausnahmen im Response Objekt ab und gibt sie nicht aus, um sicherzugehen, dass
  466. keine sensitiven Systeminformationen ausgegeben werden. Man kann dies auf
  467. mehrere Arten überschreiben:
  468. </para>
  469. <itemizedlist>
  470. <listitem>
  471. <para>
  472. Setzen von <code>throwExceptions()</code> im Front Controller:
  473. </para>
  474. <programlisting role="php"><![CDATA[
  475. $front->throwExceptions(true);
  476. ]]></programlisting>
  477. </listitem>
  478. <listitem>
  479. <para>
  480. Setzen von <code>renderExceptions()</code> im Response objekt:
  481. </para>
  482. <programlisting role="php"><![CDATA[
  483. $response->renderExceptions(true);
  484. $front->setResponse($response);
  485. $front->dispatch();
  486. // oder:
  487. $front->returnResponse(true);
  488. $response = $front->dispatch();
  489. $response->renderExceptions(true);
  490. echo $response;
  491. ]]></programlisting>
  492. </listitem>
  493. </itemizedlist>
  494. </listitem>
  495. <listitem><para>
  496. <classname>Zend_Controller_Dispatcher_Interface::dispatch()</classname>
  497. akzeptiert und gibt nun ein <xref linkend="zend.controller.request" />
  498. Objekt anstelle eines Dispatcher Token zurück.
  499. </para></listitem>
  500. <listitem><para>
  501. <classname>Zend_Controller_Router_Interface::route()</classname>
  502. akzeptiert und gibt nun ein <xref linkend="zend.controller.request" />
  503. Objekt anstelle eines Dispatcher Token zurück.
  504. </para></listitem>
  505. <listitem>
  506. <para><classname>Zend_Controller_Action</classname> Änderungen beinhalten:</para>
  507. <itemizedlist>
  508. <listitem><para>
  509. Der Konstruktur akzeptiert nun genau drei Argumente,
  510. <classname>Zend_Controller_Request_Abstract $request</classname>,
  511. <classname>Zend_Controller_Response_Abstract $response</classname>, und
  512. <code>array $params (optional)</code>.
  513. <classname>Zend_Controller_Action::__construct()</classname> verwendet
  514. diese, um die Request, Response und invokeArgs Eigenschaften für das Objekt
  515. zu setzen, und beim Überschreiben des Konstrukturs sollte man dies ebenfalls
  516. tun. Besser ist es, die <code>init()</code> Methode zu verwenden, um jedwede
  517. Instanzkonfiguration durchzuführen, weil diese Methode als letzte Methode
  518. des Konstrukturs aufgerufen wird.
  519. </para></listitem>
  520. <listitem><para>
  521. <code>run()</code> ist nicht länger als final definiert, wird aber auch
  522. nicht länger vom Front Controller verwendet; sein einziger Zweck ist, dass
  523. die Klasse auch als Page Controller verwendet werden kann. Sie nimmt nun
  524. zwei optionale Argument an, ein
  525. <classname>Zend_Controller_Request_Abstract $request</classname>
  526. und ein <classname>Zend_Controller_Response_Abstract $response</classname>.
  527. </para></listitem>
  528. <listitem><para>
  529. <code>indexAction()</code> muss nicht mehr länger definiert werden, aber
  530. wird als Standardaktion empfohlen. Dies erlaubt dem RewriteRouter und den
  531. Action Controllern andere Standardaktionsmethoden zu definieren.
  532. </para></listitem>
  533. <listitem><para>
  534. <code>__call()</code> sollte überschrieben werden, um jede undefinierte
  535. Aktion automatisch verarbeiten zu können.
  536. </para></listitem>
  537. <listitem><para>
  538. <code>_redirect()</code> nimmt nun ein optionales zweites Argument entgegen,
  539. den HTTP Code, der mit dem Redirect zurückgegeben werden soll, und ein
  540. optionales drittes Argument <code>$prependBase</code>, das angibt, dass die
  541. im Request Objekt registrierte Basis URL der übergebenen URL voran gestellt
  542. werden soll.
  543. </para></listitem>
  544. <listitem>
  545. <para>
  546. Die <code>_action</code> Eigenschaft wird nicht mehr gesetzt. Diese
  547. Eigenschaft war ein
  548. <classname>Zend_Controller_Dispatcher_Token</classname>, der in der
  549. aktuellen Inkarnation nicht mehr länger existiert. Der einzige Zweck des
  550. Tokens war, Informationen über angeforderte Controller, Aktion und URL
  551. Parameter bereit zu stellen. Diese Infrmationen ist nun im Request
  552. Objekt verfügbar und kann wie folgt abgerufen werden:
  553. </para>
  554. <programlisting role="php"><![CDATA[
  555. // Hole den angeforderten Controllernamen
  556. // Der Zugriff erfolgte bisher über: $this->_action->getControllerName().
  557. // Das Beispiel unten verwendet getRequest(), obwohl man auch direkt auf die
  558. // $_request Eigenschaft zugreifen kann; die Verwendung von getRequest() wird
  559. // empfohlen, da eine Elternklasse den Zugriff auf das Request Objekt
  560. // überschreiben könnte
  561. $controller = $this->getRequest()->getControllerName();
  562. // Hole den angeforderten Aktionsnamen
  563. // Der Zugriff erfolgte bisher über: $this->_action->getActionName().
  564. $action = $this->getRequest()->getActionName();
  565. // Hole die Anfrageparameter
  566. // Dies hat sich nicht verändert; die _getParams() und _getParam()
  567. // Methoden leiten nun einfach auf das Request Objekt weiter.
  568. $params = $this->_getParams();
  569. // fordere den 'foo' Parameter an und verwende
  570. // 'default', wenn kein Standardwert gefunden werden kann
  571. $foo = $this->_getParam('foo', 'default');
  572. ]]></programlisting>
  573. </listitem>
  574. <listitem>
  575. <para>
  576. <code>noRouteAction()</code> wurde entfernt. Der geeignete Weg, um
  577. nicht vorhandene Aktionsmethoden abzufangen, wenn man sie an eine
  578. Standardaktion weiter leiten möchte, sollte die Verwendung von
  579. <code>__call()</code> sein:
  580. </para>
  581. <programlisting role="php"><![CDATA[
  582. public function __call($method, $args)
  583. {
  584. // Wenn eine nicht vorhandene 'Action' Methode angefordert wurde,
  585. // leite auf die Standard Aktionsmethode um:
  586. if ('Action' == substr($method, -6)) {
  587. return $this->defaultAction();
  588. }
  589. throw new Zend_Controller_Exception('Invalid method called');
  590. }
  591. ]]></programlisting>
  592. </listitem>
  593. </itemizedlist>
  594. </listitem>
  595. <listitem><para>
  596. <classname>Zend_Controller_RewriteRouter::setRewriteBase()</classname> wurde
  597. entfernt. Stattdessen soll
  598. <classname>Zend_Controller_Front::setBaseUrl()</classname> verwendet werden (oder
  599. <classname>Zend_Controller_Request_Http::setBaseUrl()</classname>, wenn die Request
  600. Klasse verwendet wird).
  601. </para></listitem>
  602. <listitem><para>
  603. <classname>Zend_Controller_Plugin_Interface</classname> wurde durch
  604. by <classname>Zend_Controller_Plugin_Abstract</classname> ersetzt. Alle Methoden
  605. nehmen nun ein <xref linkend="zend.controller.request" /> Objekt statt eines
  606. Dispatcher Tokens entgegen bzw. geben es zurück.
  607. </para></listitem>
  608. </itemizedlist>
  609. </sect2>
  610. </sect1>
  611. <!--
  612. vim:se ts=4 sw=4 et:
  613. -->