Zend_Controller-Exceptions.xml 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- EN-Revision: 15156 -->
  3. <!-- Reviewed: no -->
  4. <sect1 id="zend.controller.exceptions">
  5. <title>MVC Ausnahmen</title>
  6. <sect2 id="zend.controller.exceptions.introduction">
  7. <title>Einführung</title>
  8. <para>
  9. Die MVC Komponenten im Zend Framework verwenden einen Front Controller, was bedeutet das alle
  10. Anfragen zu einer bestimmten Site über einen einzelnen Eintrittspunkt laufen. Als Ergebnis treten
  11. alle Ausnahmen eventuell am Front Controllerauf, was es Entwicklern erlaubt diese an einem
  12. einzelnen Ort zu behandeln.
  13. </para>
  14. <para>
  15. Trotzdem enthalten Ausnahmemeldungen und Backtrace Informationen oft sensitive Systeminformationen,
  16. wie SQL Anweisungen, Dateiorte, und andere. Um zu helfen die eigene Site zu schützen, werden
  17. standardmäßig alle Ausnahmen von <classname>Zend_Controller_Front</classname> gefangen und im Antwortobjekt
  18. registriert; zusätzlich zeigt das Antwortobjekt die Ausnahmemeldungen standardmäßig nicht an.
  19. </para>
  20. </sect2>
  21. <sect2 id="zend.controller.exceptions.handling">
  22. <title>Behandeln von Ausnahmen</title>
  23. <para>
  24. Verschiedene Mechanismen sind bereits in die MVC Komponenten eingebaut um die Behandlung von
  25. Ausnahmen zu erlauben.
  26. </para>
  27. <itemizedlist>
  28. <listitem>
  29. <para>
  30. Standardmäßig ist das
  31. <link linkend="zend.controller.plugins.standard.errorhandler">Error Handler Plugin</link>
  32. registriert und aktiv. Dieses Plugin wurde erstellt um folgendes zu behandeln:
  33. </para>
  34. <itemizedlist>
  35. <listitem>
  36. <para>
  37. Fehler durch fehlende Controller oder Aktionen
  38. </para>
  39. </listitem>
  40. <listitem>
  41. <para>
  42. Fehler die in Actioncontrollern auftreten
  43. </para>
  44. </listitem>
  45. </itemizedlist>
  46. <para>
  47. Es arbeitet als <code>postDispatch()</code> Plugin und prüft ob eine Dispatcher,
  48. Actioncontroller oder andere Ausnahme aufgetreten ist. Wenn das so ist, leitet es an den
  49. Error Handler Controller weiter.
  50. </para>
  51. <para>
  52. Dieser Handler deckt die meisten Ausnahmesituationen ab, und behandelt fehlende
  53. Controller und Aktionen taktvoll.
  54. </para>
  55. </listitem>
  56. <listitem>
  57. <para><classname>Zend_Controller_Front::throwExceptions()</classname></para>
  58. <para>
  59. Durch die Übergabe eines boolschen True Wertes an diese Methode, kann dem Front Controller
  60. mitgeteilt werden das, statt der Ansammlung der Ausnahmen im Antwortobjekt oder der Verwendung
  61. des Error Handler Plugin's, man diese Ausnahmen selbst behandeln will. Als Beispiel:
  62. </para>
  63. <programlisting role="php"><![CDATA[
  64. $front->throwExceptions(true);
  65. try {
  66. $front->dispatch();
  67. } catch (Exception $e) {
  68. // Ausnahmen selbst behandeln
  69. }
  70. ]]></programlisting>
  71. <para>
  72. Diese Methode ist möglicherweise der einfachste Weg um eigene Ausnahmebehandlungen
  73. hinzuzufügen die den vollen Umfang der möglichen Ausnahmen der Front Controller Anwendung
  74. behandeln.
  75. </para>
  76. </listitem>
  77. <listitem>
  78. <para><classname>Zend_Controller_Response_Abstract::renderExceptions()</classname></para>
  79. <para>
  80. Durch die Übergabe eines boolschen True Wertes an diese Methode kann dem Antwortobjekt
  81. mitgeteilt werden das es Ausnahmenachrichten und Backtrace darstellen soll, wenn es
  82. selbst dargestellt wird. In diesem Szenario wird jede Ausnahme die an der Anwendung
  83. auftritt angezeigt. Das wird nur in nicht-produktiven Umgebungen vorgeschlagen.
  84. </para>
  85. </listitem>
  86. <listitem>
  87. <para>
  88. <classname>Zend_Controller_Front::returnResponse()</classname> und
  89. <classname>Zend_Controller_Response_Abstract::isException()</classname>.
  90. </para>
  91. <para>
  92. Durch die Übergabe eines boolschen True zu
  93. <classname>Zend_Controller_Front::returnResponse()</classname>, wird
  94. <classname>Zend_Controller_Front::dispatch()</classname> die Antwort nicht darstellen, aber diese
  95. stattdessen zurückgeben. Sobald man die antwort hat, kann diese getestet werden um zu
  96. sehen ob irgendwelche Ausnahmen gefangen wurden indem die <code>isException()</code>
  97. Methode verwendet, und die Ausnahme über die <code>getException()</code> Methode
  98. empfangen wird. Als Beispiel:
  99. </para>
  100. <programlisting role="php"><![CDATA[
  101. $front->returnResponse(true);
  102. $response = $front->dispatch();
  103. if ($response->isException()) {
  104. $exceptions = $response->getException();
  105. // Ausnahme behandeln ...
  106. } else {
  107. $response->sendHeaders();
  108. $response->outputBody();
  109. }
  110. ]]></programlisting>
  111. <para>
  112. Der primäre Vorteil die diese Methode über
  113. <classname>Zend_Controller_Front::throwExceptions()</classname> bietet ist, das Sie es erlaubt
  114. die Antwort wahlweise darzustellen nachdem die Ausnahme behandelt wurde. Das fängt jede
  115. Ausnahme in der Kontrollerkette, im Gegensatz zum Error Handler Plugin.
  116. </para>
  117. </listitem>
  118. </itemizedlist>
  119. </sect2>
  120. <sect2 id="zend.controller.exceptions.internal">
  121. <title>MVC Ausnahme die auftreten können</title>
  122. <para>
  123. Die verschiedenen MVC Komponenten -- Anfragen, Router, Dispatcher, Actioncontroller, und
  124. Antwortobjekte -- können alle gelegentlich Ausnahmen werfen. Einige Ausnahmen können
  125. wahlweise überschrieben werden und andere werden Verwendet um dem Entwickler anzuzeigen das
  126. die eigene Struktur der Anwendung überdacht werden sollte.
  127. </para>
  128. <para>Einige Beispiele:</para>
  129. <itemizedlist>
  130. <listitem>
  131. <para>
  132. <classname>Zend_Controller_Dispatcher::dispatch()</classname> wird standardmäßig eine Ausnahme werfen
  133. wenn ein ungültiger Controller angefragt wird. Es gibt zwei empfohlene Wege um damit
  134. umzugehen.
  135. </para>
  136. <itemizedlist>
  137. <listitem>
  138. <para>Den <code>useDefaultControllerAlways</code> Parameter setzen.</para>
  139. <para>
  140. Im eigenen Frontcontroller, oder dem eigenen Dispatcher, die folgende
  141. Anweisung hinzufügen:
  142. </para>
  143. <programlisting role="php"><![CDATA[
  144. $front->setParam('useDefaultControllerAlways', true);
  145. // oder
  146. $dispatcher->setParam('useDefaultControllerAlways', true);
  147. ]]></programlisting>
  148. <para>
  149. Wenn dieses Flag gesetzt ist, wird der Dispatcher den Standardcontroller und die
  150. Standardaktion verwenden statt eine Ausnahme zu werfen. Der Nachteil dieser Methode
  151. ist das jegliche Schreibfehler die ein Benutzer macht wenn er auf die Site
  152. zugreift, trotzdem aufgelöst werden und die Homepage angezeigt wird, was bei der
  153. Optimierung von Suchmaschienen verherenden Schaden anrichten kann.
  154. </para>
  155. </listitem>
  156. <listitem>
  157. <para>
  158. Die Ausnahme die von <code>dispatch()</code> geworfen wird, ist eine
  159. <classname>Zend_Controller_Dispatcher_Exception</classname> die den Text
  160. 'Invalid controller specified' enthält. Eine der Methoden die in
  161. <link linkend="zend.controller.exceptions.handling">der vorhergehenden Sektion</link>
  162. beschrieben wurden können verwendet werden um die Ausnahme zu fangen und dann zu
  163. einer generellen Fehlerseite oder der Homepage umzuleiten.
  164. </para>
  165. </listitem>
  166. </itemizedlist>
  167. </listitem>
  168. <listitem>
  169. <para>
  170. <classname>Zend_Controller_Action::__call()</classname> wird eine
  171. <classname>Zend_Controller_Action_Exception</classname> geworfen wenn eine nicht existierende Aktion
  172. einer Methode nicht dargestellt werden kann. Normalerweise wird es gewünscht sein in Fällen
  173. wie diesen eine Standardaktion im Controller zu verwenden. Wege um das zu tun beinhalten:
  174. </para>
  175. <itemizedlist>
  176. <listitem>
  177. <para>
  178. Eine Subklasse von <classname>Zend_Controller_Action</classname> erstellen und die
  179. <code>__call()</code> Methode überschreiben. Als Beispiel:
  180. </para>
  181. <programlisting role="php"><![CDATA[
  182. class My_Controller_Action extends Zend_Controller_Action
  183. {
  184. public function __call($method, $args)
  185. {
  186. if ('Action' == substr($method, -6)) {
  187. $controller = $this->getRequest()->getControllerName();
  188. $url = '/' . $controller . '/index';
  189. return $this->_redirect($url);
  190. }
  191. throw new Exception('Ungültige Methode');
  192. }
  193. }
  194. ]]></programlisting>
  195. <para>
  196. Das obige Beispiel fängt jede nicht definierte Aktionsmethode ab die aufgerufen wird
  197. und leitet Sie zur Standardaktion im Controller um.
  198. </para>
  199. </listitem>
  200. <listitem>
  201. <para>
  202. Eine Subklasse von <classname>Zend_Controller_Dispatcher</classname> erstellen und die
  203. <code>getAction()</code> Methode überschreiben um zu prüfen ob die Aktion
  204. existiert. Als Beispiel:
  205. </para>
  206. <programlisting role="php"><![CDATA[
  207. class My_Controller_Dispatcher extends Zend_Controller_Dispatcher
  208. {
  209. public function getAction($request)
  210. {
  211. $action = $request->getActionName();
  212. if (empty($action)) {
  213. $action = $this->getDefaultAction();
  214. $request->setActionName($action);
  215. $action = $this->formatActionName($action);
  216. } else {
  217. $controller = $this->getController();
  218. $action = $this->formatActionName($action);
  219. if (!method_exists($controller, $action)) {
  220. $action = $this->getDefaultAction();
  221. $request->setActionName($action);
  222. $action = $this->formatActionName($action);
  223. }
  224. }
  225. return $action;
  226. }
  227. }
  228. ]]></programlisting>
  229. <para>
  230. Der obige Code prüft ob die angefragte Aktion in der Controllerklasse existiert ;
  231. wenn nicht wird die Aktion auf die Standardaktion resetiert.
  232. </para>
  233. <para>
  234. Diese Methode ist nützlich, weil Sie die Aktion transparent ändert bevor diese
  235. letztendlich dargestellt wird. Trotzdem bedeutet es auch, das Schreibfehler in der
  236. URL trotzdem richtig dargestellt werden, was für die Optimierung von Suchmaschinen
  237. nicht gut ist.
  238. </para>
  239. </listitem>
  240. <listitem>
  241. <para>
  242. Verwenden von <classname>Zend_Controller_Action::preDispatch()</classname> oder
  243. <classname>Zend_Controller_Plugin_Abstract::preDispatch()</classname> um eine ungültige
  244. Aktion zu identifizieren.
  245. </para>
  246. <para>
  247. Durch das Erstellen einer Subklasse von <classname>Zend_Controller_Action</classname> und
  248. dem modifizieren von <code>preDispatch()</code>, können alle eigenen Kontroller
  249. geändert werden damit Sie an andere Aktionen weiterleiten oder umleiten bevor
  250. die Aktion letztendlich dargestellt wird. Der Code hierfür schaut ähnlich wie der
  251. Code für das Überschreiben von <code>__call()</code> aus, der oben schon angezeigt
  252. wurde.
  253. </para>
  254. <para>
  255. Alternativ kann diese Information in einem globalen Plugin geprüft werden. Das
  256. hat den Vorteil das es unabhängig von Actioncontroller ist; wenn die eigene
  257. Anwendung aus einer Reihe von Actioncontrollern besteht, und nicht alle von der
  258. gleichen Klasse abgeleitet sind, kann diese Methode Kontinuität in der
  259. Handhabung der verschiedenen Klassen bringen.
  260. </para>
  261. <para>
  262. Als Beispiel:
  263. </para>
  264. <programlisting role="php"><![CDATA[
  265. class My_Controller_PreDispatchPlugin extends Zend_Controller_Plugin_Abstract
  266. {
  267. public function preDispatch(Zend_Controller_Request_Abstract $request)
  268. {
  269. $front = Zend_Controller_Front::getInstance();
  270. $dispatcher = $front->getDispatcher();
  271. $class = $dispatcher->getControllerClass($request);
  272. if (!$controller) {
  273. $class = $dispatcher->getDefaultControllerClass($request);
  274. }
  275. $r = new ReflectionClass($class);
  276. $action = $dispatcher->getActionMethod($request);
  277. if (!$r->hasMethod($action)) {
  278. $defaultAction = $dispatcher->getDefaultAction();
  279. $controllerName = $request->getControllerName();
  280. $response = $front->getResponse();
  281. $response->setRedirect('/' . $controllerName
  282. . '/' . $defaultAction);
  283. $response->sendHeaders();
  284. exit;
  285. }
  286. }
  287. }
  288. ]]></programlisting>
  289. <para>
  290. In diesem Beispiel wird geprüft ob die angefragte Aktion im Controller vorhanden ist.
  291. Wenn dem nicht so ist, wird auf die Standardaktion im Controller umgeleitet und
  292. die Ausführung des Sktipts sofort beendet.
  293. </para>
  294. </listitem>
  295. </itemizedlist>
  296. </listitem>
  297. </itemizedlist>
  298. </sect2>
  299. </sect1>
  300. <!--
  301. vim:se ts=4 sw=4 et:
  302. -->