Zend_Controller-ActionController.xml 28 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- EN-Revision: 18556 -->
  3. <!-- Reviewed: no -->
  4. <sect1 id="zend.controller.action">
  5. <title>Action Controller</title>
  6. <sect2 id="zend.controller.action.introduction">
  7. <title>Einführung</title>
  8. <para>
  9. <classname>Zend_Controller_Action</classname> ist eine abstrakte Klasse die verwendet
  10. werden kann um Aktion Controller zu implementieren die mit dem Front Controller
  11. verwendet werden können um eine WebSeite zu erstellen die auf dem Model-View-Controller
  12. (<acronym>MVC</acronym>) Pattern basiert.
  13. </para>
  14. <para>
  15. Um <classname>Zend_Controller_Action</classname> zu verwenden, muß von dieser in der
  16. eigenen aktuellen Aktions Controller Klasse ererbt werden (oder von dieser erben um eine
  17. eigene Basisklasse für Aktion Controller zu erstellen). Die grundsätzlichste Operation
  18. ist es von Ihr zu erben und Aktions Methoden zu erstellen die den verschiedenen Aktionen
  19. entsprechen die der Controller der eigenen Seite handhaben soll. Das Handhaben von
  20. Routen und Dispatchen des <classname>Zend_Controller</classname>'s wird automatisch
  21. jegliche Methode die in der eigenen Klasse auf 'Action' endet, als potentielle
  22. Controller Aktion herausfinden.
  23. </para>
  24. <para>
  25. Soll unsere Klasse, zum Beispiel, wie folgt definiert sein:
  26. </para>
  27. <programlisting language="php"><![CDATA[
  28. class FooController extends Zend_Controller_Action
  29. {
  30. public function barAction()
  31. {
  32. // mach irgendwas
  33. }
  34. public function bazAction()
  35. {
  36. // mach irgendwas
  37. }
  38. }
  39. ]]></programlisting>
  40. <para>
  41. Die obige <emphasis>FooController</emphasis> Klasse (Controller
  42. <emphasis>foo</emphasis>)´definiert zwei Aktionen, <emphasis>bar</emphasis> und
  43. <emphasis>baz</emphasis>.
  44. </para>
  45. <para>
  46. Da gibt es viel mehr das damit getan werden kann als das, wie eigene Initialisierungs
  47. Aktionen, Standardaktionen die aufgerufen werden wenn keine Aktion (oder eine ungültige
  48. Aktion) spezifiziert wird, pre- und post Dispatch Hooks, und eine Vielzahl von Helfer
  49. Methoden. Dieses Kapitel arbeitet als eine Übersicht der Aktion Controller
  50. Funktionalitäten.
  51. </para>
  52. <note>
  53. <title>Standardverhalten</title>
  54. <para>
  55. Standardmäßig aktiviert der <link linkend="zend.controller.front">Front
  56. Controller</link> den Aktion Helfer des <link
  57. linkend="zend.controller.actionhelpers.viewrenderer">ViewRenderer</link>'s.
  58. Dieser Helfer übernimmt das Einfügen des View Objekts in den Controller, sowie das
  59. automatische Darstellen der View. Er kann innerhalb des Aktion Controllers mit einer
  60. der folgenden Methoden ausgeschaltet werden:
  61. </para>
  62. <programlisting language="php"><![CDATA[
  63. class FooController extends Zend_Controller_Action
  64. {
  65. public function init()
  66. {
  67. // Lokal nur bei diesem Controller; beeinflußt alle Aktionen die mit
  68. // init geladen wurden:
  69. $this->_helper->viewRenderer->setNoRender(true);
  70. // Global:
  71. $this->_helper->removeHelper('viewRenderer');
  72. // Auch global, muß aber in Verbindung mit der Lokalen Version sein um
  73. // für diesen Controller zu gelten:
  74. Zend_Controller_Front::getInstance()
  75. ->setParam('noViewRenderer', true);
  76. }
  77. }
  78. ]]></programlisting>
  79. <para>
  80. <methodname>initView()</methodname>, <methodname>getViewScript()</methodname>,
  81. <methodname>render()</methodname>, und <methodname>renderScript()</methodname>
  82. handeln alle in Vertretung zum <emphasis>ViewRenderer</emphasis> solange der Helfer
  83. nicht im Helfer Broker ist oder das <emphasis>noViewRenderer</emphasis> Flag nicht
  84. gesetzt wurde.
  85. </para>
  86. <para>
  87. Das rendern kann für individuelle Views auch ganz einfach ausgeschaltet werden durch
  88. Setzen des <emphasis>noRender</emphasis> Flags des
  89. <emphasis>ViewRenderer</emphasis>'s:
  90. </para>
  91. <programlisting language="php"><![CDATA[
  92. class FooController extends Zend_Controller_Action
  93. {
  94. public function barAction()
  95. {
  96. // Nur für diese Aktion das automatische Rendern ausschalten:
  97. $this->_helper->viewRenderer->setNoRender();
  98. }
  99. }
  100. ]]></programlisting>
  101. <para>
  102. Der primäre Grund um den <emphasis>ViewRenderer</emphasis> auszuschalten ist, wenn
  103. einfach kein View Objekt benötigt wird, oder wenn nicht über ein View Skript
  104. gerendert werden soll (zum Beispiel wenn ein Aktion Controller verwendet wird um
  105. Web Service Protokolle wie <acronym>SOAP</acronym>, <acronym>XML-RPC</acronym> oder
  106. <acronym>REST</acronym> anzubieten. In den meisten Fällen wird man den
  107. <emphasis>ViewRenderer</emphasis> nie global ausschalten müssen, nur selektiv
  108. innerhalb einzelner Controller oder Aktionen.
  109. </para>
  110. </note>
  111. </sect2>
  112. <sect2 id="zend.controller.action.initialization">
  113. <title>Objekt Initialisierung</title>
  114. <para>
  115. Wärend man immer den Konstruktor des Aktion Controller's überschreiben kann ist das
  116. nicht notwendig. <methodname>Zend_Controller_Action::__construct()</methodname> führt
  117. einige wichtige Aufgabe aus, wie das registrieren der Anfrage und Antwort Objekte, sowie
  118. alle eigene einleitenden Argumente die von Front Controller übergeben wurden. Wenn der
  119. Konstruktor überschrieben werden muß, muß sichergestellt sein das
  120. <methodname>parent::__construct($request, $response, $invokeArgs)</methodname>
  121. aufgerufen wird.
  122. </para>
  123. <para>
  124. Der bessere Weg als die Instanzierung zu ändern ist die Verwendung der
  125. <methodname>init()</methodname> Methode, welche nach der letzten Aufgabe von
  126. <methodname>__construct()</methodname> aufgerufen wird. Zum Beispiel wenn man sich zu
  127. einer Datenbank bei der Instanzierung verbinden will:
  128. </para>
  129. <programlisting language="php"><![CDATA[
  130. class FooController extends Zend_Controller_Action
  131. {
  132. public function init()
  133. {
  134. $this->db = Zend_Db::factory('Pdo_Mysql', array(
  135. 'host' => 'myhost',
  136. 'username' => 'user',
  137. 'password' => 'XXXXXXX',
  138. 'dbname' => 'website'
  139. ));
  140. }
  141. }
  142. ]]></programlisting>
  143. </sect2>
  144. <sect2 id="zend.controller.action.prepostdispatch">
  145. <title>Pre- und Post-Dispatch Hooks</title>
  146. <para>
  147. <classname>Zend_Controller_Action</classname> spezifiziert zwei Methoden die aufgerufen
  148. werden können um eine angefragte Aktion fertigzustellen,
  149. <methodname>preDispatch()</methodname> und <methodname>postDispatch()</methodname>.
  150. Diese können auf viele Wege nützlich sein: zum Beispiel um Authentifizierungen und
  151. <acronym>ACL</acronym>'s prüfen bevor eine Aktion ausgeführt wird (durch Aufruf von
  152. <methodname>_forward()</methodname> in <methodname>preDispatch()</methodname> wird die
  153. Aktion übersprungen), oder erzeugte Inhalte in einem seitenweiten Template zu plazieren
  154. (<methodname>postDispatch()</methodname>).
  155. </para>
  156. <note>
  157. <title>Verwendung von of init() vs. preDispatch()</title>
  158. <para>
  159. In der <link linkend="zend.controller.action.initialization">vorigen Sektion</link>
  160. haben wir die <methodname>init()</methodname> Methode eingeführt, und in dieser
  161. Sektion die <methodname>preDispatch()</methodname> Methode. Was ist der Unterschied
  162. zwischen Ihnen, und welche Aktionen kann man in jeder von Ihnen durchführen?
  163. </para>
  164. <para>
  165. Die <methodname>init()</methodname> Methode ist primär dafür gedacht den Constructor
  166. zu erweitern. Typischerweise sollte der Constructor einfach den Status des Objekts
  167. setzen und keine weitere Logik ausführen. Das kann die Initialisierung von
  168. Ressourcen enthalten die im Kontroller verwendet werden (wie Modelle, Konfigurations
  169. Objekte, usw.), oder die Zuordnung von Werten die vom Front Controller, der
  170. Bootstrap oder einer Registry empfangenen wurden.
  171. </para>
  172. <para>
  173. Die <methodname>preDispatch()</methodname> Methode kann auch verwendet werden um den
  174. Status des Objekts oder der Umgebung (z.B. View, Action Helfer, usw.) zu setzen,
  175. aber sein primärer Zweck besteht darin Annahme darüber zu treffen, ob eine
  176. angefragte Aktion ausgeführt werden sollte oder nicht. Wenn nicht, dann sollte
  177. <methodname>_forward()</methodname> auf eine andere Aktion ausgeführt, oder eine
  178. Exception geworfen werden.
  179. </para>
  180. <para>
  181. Beachte: <methodname>_forward()</methodname> arbeitet aktuell nicht korrekt wenn es
  182. von <methodname>init()</methodname> ausgeführt wird, das die Formalisierung der
  183. Annahmen beider Methoden ist.
  184. </para>
  185. </note>
  186. </sect2>
  187. <sect2 id="zend.controller.action.accessors">
  188. <title>Zugriffe</title>
  189. <para>
  190. Eine Anzahl von Objekten und Variablen werden im Objekt registriert, und jede hat
  191. Zugriffsmethoden.
  192. </para>
  193. <itemizedlist>
  194. <listitem><para>
  195. <emphasis>Anfrage Objekt</emphasis>: <methodname>getRequest()</methodname> kann
  196. verwendet werden um das Anfrage Objekt zu erhalten das verwendet wurde um die
  197. Aktion aufzurufen.
  198. </para></listitem>
  199. <listitem>
  200. <para>
  201. <emphasis>Antwort Objekt</emphasis>: <methodname>getResponse()</methodname>
  202. kann verwendet werden um das Antwort Objekt zu erhalten das die letztendliche
  203. Antwort erzeugt. Einige typische Aufrufe können wie folgt aussehen:
  204. </para>
  205. <programlisting language="php"><![CDATA[
  206. $this->getResponse()->setHeader('Content-Type', 'text/xml');
  207. $this->getResponse()->appendBody($content);
  208. ]]></programlisting>
  209. </listitem>
  210. <listitem>
  211. <para>
  212. <emphasis>Aufgerufene Argumente</emphasis>: Der Front Controller kann Parameter
  213. in den Router, Dispatcher und Aktion Controller einfügen. Um diese zu erhalten
  214. kann <methodname>getInvokeArg($key)</methodname> verwendet werden; alternativ
  215. kann man die komplette Liste mit <methodname>getInvokeArgs()</methodname>
  216. erhalten.
  217. </para>
  218. </listitem>
  219. <listitem>
  220. <para>
  221. <emphasis>Anfrage Parameter</emphasis>: Das Anfrage Objekt liefert die Anfrage
  222. Parameter, wie alle <constant>_GET</constant> oder <constant>_POST</constant>
  223. Parameter, oder Benutzer Parameter die in der Information des
  224. <acronym>URL</acronym> Pfades spezifiziert sind. Um diese zu erhalten kann
  225. <methodname>_getParam($key)</methodname> oder
  226. <methodname>_getAllParams()</methodname> verwendet werden. Es können auch
  227. Anfrage Parameter gesetzt werden indem <methodname>_setParam()</methodname>
  228. verwendet wird; das ist nützlich wenn an zusätzliche Aktionen weitergeleitet
  229. werden soll.
  230. </para>
  231. <para>
  232. Um zu Testen ob ein Parameter existiert (nützlich für logische Auswahlen), kann
  233. <methodname>_hasParam($key)</methodname> verwendet werden.
  234. </para>
  235. <note>
  236. <para>
  237. <methodname>_getParam()</methodname> kann ein optionales zweites Argument
  238. nehmen das einen Standardwert enthält der verwendet wird wenn der Parameter
  239. nicht gesetzt oder leer ist. Wenn er verwendet wird ist es nicht mehr
  240. notwendig <methodname>_hasParam()</methodname> vor dem Empfangen eines
  241. Wertes aufzurufen:
  242. </para>
  243. <programlisting language="php"><![CDATA[
  244. // Verwende des Standardwert 1 wenn id nicht gesetzt wurde
  245. $id = $this->_getParam('id', 1);
  246. // Statt:
  247. if ($this->_hasParam('id') {
  248. $id = $this->_getParam('id');
  249. } else {
  250. $id = 1;
  251. }
  252. ]]></programlisting>
  253. </note>
  254. </listitem>
  255. </itemizedlist>
  256. </sect2>
  257. <sect2 id="zend.controller.action.viewintegration">
  258. <title>View Integration</title>
  259. <note id="zend.controller.action.viewintegration.viewrenderer">
  260. <title>Standard View Integration über den ViewRenderer</title>
  261. <para>
  262. Der Inhalt dieses Kapitel ist nur gültig wenn man den <link
  263. linkend="zend.controller.actionhelpers.viewrenderer">ViewRenderer</link>
  264. explizit deaktiviert hat. Andernfalls kann man dieses kapitel ohne Bedenken
  265. überspringen.
  266. </para>
  267. </note>
  268. <para>
  269. <classname>Zend_Controller_Action</classname> bietet einen rudimentären und flexiblen
  270. Mechanismus für View Integration. Zwei Methoden machen das möglich,
  271. <methodname>initView()</methodname> und <methodname>render()</methodname>; die erste
  272. Methode lädt die öffentliche Eigenschaft <varname>$view</varname> träge, und die zweite
  273. rendert eine View basierend auf der aktuell angefragen Aktion, wobei die Verzeichnis
  274. Hirarchie verwendet wird um den Pfad des Skripts zu ermitteln.
  275. </para>
  276. <sect3 id="zend.controller.action.viewintegration.initview">
  277. <title>View Initialisierung</title>
  278. <para>
  279. <methodname>initView()</methodname> initialisiert das View Objekt.
  280. <methodname>render()</methodname> ruft <methodname>initView()</methodname> auf um
  281. das View Objekt zu erhalten, aber es kann jederzeit initialisiert werden;
  282. standardmäßig wird die <varname>$view</varname> Eigenschaft mit einem
  283. <classname>Zend_View</classname> Objekt bekanntgegeben, aber jede Klasse die
  284. <classname>Zend_View_Interface</classname> implementiert kann verwendet werden.
  285. Wenn <varname>$view</varname> bereits initialisiert wurde, wird diese Eigenschaft
  286. einfach zurückgegeben.
  287. </para>
  288. <para>
  289. Die Standardimplementation macht die folgenden Annahmen über die
  290. Verzeichnisstruktur:
  291. </para>
  292. <programlisting language="php"><![CDATA[
  293. applicationOrModule/
  294. controllers/
  295. IndexController.php
  296. views/
  297. scripts/
  298. index/
  299. index.phtml
  300. helpers/
  301. filters/
  302. ]]></programlisting>
  303. <para>
  304. In anderen Worten, wird angenommen das View Skripte im
  305. <filename>/views/scripts/</filename> Unterverzeichnis sind, und das
  306. <filename>/views/</filename> Unterverzeichnis weitere Funktionalitäten enthält
  307. (helpers, filters). Wenn der Name und der Pfad des View Skripts ermittelt wird,
  308. wird das <filename>/views/scripts/</filename> Verzeichnis als Basispfad verwendet,
  309. mit einem Verzeichnis das nach dem individuellen Controller benannt ist und eine
  310. Hierarchie von View Skripten bietet.
  311. </para>
  312. </sect3>
  313. <sect3 id="zend.controller.action.viewintegration.render">
  314. <title>Rendern von Views</title>
  315. <para>
  316. <methodname>render()</methodname> hat die folgende Signatur:
  317. </para>
  318. <programlisting language="php"><![CDATA[
  319. string render(string $action = null,
  320. string $name = null,
  321. bool $noController = false);
  322. ]]></programlisting>
  323. <para>
  324. <methodname>render()</methodname> rendert ein View Skript. Wenn keine Argumente
  325. übergeben werden, wird angenommen dass das angefragte Skript
  326. <filename>[controller]/[action].phtml</filename> ist (wobei
  327. <filename>.phtml</filename> der Wert der <varname>$viewSuffix</varname> Eigenschaft
  328. ist). Wenn ein Wert für <varname>$action</varname> angegeben wird, wird das
  329. Template im <filename>/[controller]/</filename> Unterverzeichnis gerendert. Um die
  330. Verwendung des <filename>/[controller]/</filename> Unterverzeichnisses zu
  331. überschreiben kann ein <constant>TRUE</constant> Wert für
  332. <varname>$noController</varname> übergeben werden. Zuletzt werden
  333. templates in das Antwort Objekt gerendert; wenn zu einem spezifischen
  334. <link linkend="zend.controller.response.namedsegments">benannten Segment</link> im
  335. Antwort Objekt dargestellt werden soll, kann ein Wert an <varname>$name</varname>
  336. übergeben werden.
  337. </para>
  338. <note><para>
  339. Da Controller- und Aktionsnamen Wort Begrenzer Zeichen enthalten können wie
  340. z.B. '_', '.' und '-', normalisiert <methodname>render()</methodname> diese
  341. zu '-' wenn der Skript Name eruiert wird. Intern werden die Wort- und
  342. Pfadbegrenzer vom Dispatcher verwendet um die Normalisierung durchzuführen.
  343. Deshalb wird eine Anfrage auf <filename>/foo.bar/baz-bat</filename> das Skript
  344. auf <filename>foo-bar/baz-bat.phtml</filename> rendern. Wenn eine
  345. Aktionsmethode camelCase Zeichen enthält, muß beachtet werden das diese in '-'
  346. seperierten Wörter umgewandelt werden wenn der Dateiname des View Skripts
  347. eruiert wird.
  348. </para></note>
  349. <para>
  350. Einige Beispiele:
  351. </para>
  352. <programlisting language="php"><![CDATA[
  353. class MyController extends Zend_Controller_Action
  354. {
  355. public function fooAction()
  356. {
  357. // Rendert my/foo.phtml
  358. $this->render();
  359. // Rendert my/bar.phtml
  360. $this->render('bar');
  361. // Rendert baz.phtml
  362. $this->render('baz', null, true);
  363. // Rendert my/login.phtml in das 'form' Segment des Antwort Objektes
  364. $this->render('login', 'form');
  365. // Rendert site.phtml in das 'page' Segmetn des Antwort Objektes;
  366. // verwendet nicht das 'my/' Unterverzeichnis
  367. $this->render('site', 'page', true);
  368. }
  369. public function bazBatAction()
  370. {
  371. // Rendert my/baz-bat.phtml
  372. $this->render();
  373. }
  374. }
  375. ]]></programlisting>
  376. </sect3>
  377. </sect2>
  378. <sect2 id="zend.controller.action.utilmethods">
  379. <title>Nützliche Methoden</title>
  380. <para>
  381. Neben den Zugriffs- und View Integrationsmethoden, hat
  382. <classname>Zend_Controller_Action</classname> verschiedene nützliche Methoden für die
  383. Durchführung üblicher Aufgaben von innerhalb der Aktionsmethoden (oder vom
  384. Pre- und Post-Dispatch).
  385. </para>
  386. <itemizedlist>
  387. <listitem>
  388. <para>
  389. <methodname>_forward($action, $controller = null, $module = null, array $params
  390. = null)</methodname>: führt eine weitere Aktion aus. Wenn in
  391. <methodname>preDispatch()</methodname> aufgerufen, wird die aktuelle
  392. aufgerufene Aktion übersprungen zugunsten der neuen. Andererseits, wenn die
  393. aktuelle Aktion durchgeführt wurde, wird die Aktion die in
  394. <methodname>_forward()</methodname> angefragt wird, ausgeführt.
  395. </para>
  396. </listitem>
  397. <listitem>
  398. <para>
  399. <methodname>_redirect($url, array $options = array())</methodname>: leitet zu
  400. einem anderen Ort um. Diese Methode nimmt eine <acronym>URL</acronym> und ein
  401. optionales Set von Optionen. Standardmäßig führt Sie eine
  402. <acronym>HTTP</acronym> 302 Umleitung durch.
  403. </para>
  404. <para>
  405. Diese Optionen können ein oder mehrere der folgenden enthalten:
  406. </para>
  407. <itemizedlist>
  408. <listitem>
  409. <para>
  410. <emphasis>exit:</emphasis> ob oder ob nicht sofort ausgestiegen werden
  411. soll. Wenn angefragt, wird jede offene Session sauber beendet und die
  412. Umleitung durchgeführt.
  413. </para>
  414. <para>
  415. Diese Option kann global im Controller gesetzt werden indem der
  416. <methodname>setRedirectExit()</methodname> Zugriff verwendet wird.
  417. </para>
  418. </listitem>
  419. <listitem>
  420. <para>
  421. <emphasis>prependBase:</emphasis> ob oder ob nicht, die im Anfrage
  422. Objekt registrierte Basis <acronym>URL</acronym>, dem angebotenen
  423. <acronym>URL</acronym> angehängt wird.
  424. </para>
  425. <para>
  426. Diese Option kann gobal im Controller gesetzt werden indem der
  427. <methodname>setRedirectPrependBase()</methodname> Zugriff verwendet
  428. wird.
  429. </para>
  430. </listitem>
  431. <listitem>
  432. <para>
  433. <emphasis>code:</emphasis> welche <acronym>HTTP</acronym> Code für die
  434. Umleitung verwendet wird. Standardmäßig wird ein
  435. <acronym>HTTP</acronym> 302 erstellt; jeder Code zwischen 301 und 306
  436. kann verwendet werden.
  437. </para>
  438. <para>
  439. Diese Option kann global im Controller gesetzt werden indem der
  440. <methodname>setRedirectCode()</methodname> Zugriff verwendet wird.
  441. </para>
  442. </listitem>
  443. </itemizedlist>
  444. </listitem>
  445. </itemizedlist>
  446. </sect2>
  447. <sect2 id="zend.controller.action.subclassing">
  448. <title>Erweitern des Aktion Controllers</title>
  449. <para>
  450. Vom Design her muß <classname>Zend_Controller_Action</classname> erweitert werden um
  451. einen Aktion Controller zu erstellen. Als Minimum, muß eine Aktions Methode definiert
  452. werden die der Controller aufrufen kann.
  453. </para>
  454. <para>
  455. Neben dem erstellen von nützlichen Funktionalitäten für Web Anwendungen, wird auch die
  456. Notwendigkeit bestehen das vom gleichen Setup oder von den nützlichen Funktionen vieles
  457. in verschiedenen Controllern wiederholt wird; wenn dem so ist, löst die Erstellung einer
  458. gemeinsamen Basis Controller Klasse die <classname>Zend_Controller_Action</classname>
  459. erweitert zu einer Lösung dieser Redundanz.
  460. </para>
  461. <example id="zend.controller.action.subclassing.example-call">
  462. <title>Behandeln nicht-vorhandener Aktionen</title>
  463. <para>
  464. Wenn eine Anfrage an einen Controller durchgeführt wird die eine undefinierte
  465. Aktions Methode enthält, kommt
  466. <methodname>Zend_Controller_Action::__call()</methodname> zum Einsatz.
  467. <methodname>__call()</methodname> ist natürlich <acronym>PHP</acronym>'s magische
  468. Methode für das Überladen von Methoden.
  469. </para>
  470. <para>
  471. Standardmäßig wirft diese Methode eine
  472. <classname>Zend_Controller_Action_Exception</classname> die anzeigt das die
  473. angefragte Aktion nicht im Controller gefunden werden konnte. Wenn die angefragte
  474. Methode mit 'Action' endet, wird angenommen das eine Aktion angefragt wurde die
  475. nicht existiert; solch ein Fehler resultiert in einer Ausnahme mit dem Code 404.
  476. Alle anderen Methoden resultieren in einer Ausnahme mit dem Code 500. Das erlaubt
  477. die einfache Differenzierung zwischen Seiten die nicht gefunden wurden und
  478. Anwendungsfehlern in der Fehlerbehandlung.
  479. </para>
  480. <para>
  481. Diese Funktionalität sollte überschrieben werden wenn eine andere Operation
  482. ausgeführt werden soll. Wenn zum Beispiel eine Fehlermeldung angezeigt werden soll
  483. kann etwas die das folgende geschrieben werden:
  484. </para>
  485. <programlisting language="php"><![CDATA[
  486. class MyController extends Zend_Controller_Action
  487. {
  488. public function __call($method, $args)
  489. {
  490. if ('Action' == substr($method, -6)) {
  491. // Wenn die Aktionsmethode nicht gefunden wurde,
  492. // das error Template darstellen
  493. return $this->render('error');
  494. }
  495. // Alle anderen Methoden werfen eine Ausnahme
  496. throw new Exception('Invalid method "'
  497. . $method
  498. . '" called',
  499. 500);
  500. }
  501. }
  502. ]]></programlisting>
  503. <para>
  504. Eine andere Möglichkeit ist, dass man zu einer standardmäßigen Controller Seiten
  505. weiterleiten will:
  506. </para>
  507. <programlisting language="php"><![CDATA[
  508. class MyController extends Zend_Controller_Action
  509. {
  510. public function indexAction()
  511. {
  512. $this->render();
  513. }
  514. public function __call($method, $args)
  515. {
  516. if ('Action' == substr($method, -6)) {
  517. // Wenn die Aktionsmethode nicht gefunden wurde,
  518. // leite zur Index Aktion weiter
  519. return $this->_forward('index');
  520. }
  521. // Alle anderen Methoden werden eine Ausnahme
  522. throw new Exception('Invalid method "'
  523. . $method
  524. . '" called',
  525. 500);
  526. }
  527. }
  528. ]]></programlisting>
  529. </example>
  530. <para>
  531. Neben dem überschreiben von <methodname>__call()</methodname>, kann jede der
  532. Initialisierungs-, Utility-, Zugriffs-, View- und Dispatch-Hook Methoden die vorher in
  533. diesem Kapitel beschrieben wurden, überschrieben werden um eigene Controller
  534. anzupassen. Wenn man, als Beispiel, die View Objekte in der Registry speichert, kann es
  535. gewünscht sein die <methodname>initView()</methodname> Methode mit Code zu Ändern der
  536. das folgende zusammensetzt:
  537. </para>
  538. <programlisting language="php"><![CDATA[
  539. abstract class My_Base_Controller extends Zend_Controller_Action
  540. {
  541. public function initView()
  542. {
  543. if (null === $this->view) {
  544. if (Zend_Registry::isRegistered('view')) {
  545. $this->view = Zend_Registry::get('view');
  546. } else {
  547. $this->view = new Zend_View();
  548. $this->view->setBasePath(dirname(__FILE__) . '/../views');
  549. }
  550. }
  551. return $this->view;
  552. }
  553. }
  554. ]]></programlisting>
  555. <para>
  556. Hoffentlich kann man anhand der Informationen in diesem Kapitel ersehen wie flexibel
  557. diese spezielle Komponente ist und wie Sie in eigene Anwendungen oder den
  558. Notwendigkeiten von Seiten damit erfüllt werden kann.
  559. </para>
  560. </sect2>
  561. </sect1>
  562. <!--
  563. vim:se ts=4 sw=4 et:
  564. -->