2
0

Zend_Controller-Exceptions.xml 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- Reviewed: no -->
  3. <sect1 id="zend.controller.exceptions">
  4. <title>Excepciones MVC</title>
  5. <sect2 id="zend.controller.exceptions.introduction">
  6. <title>Introducción</title>
  7. <para>
  8. Los componentes MVC en Zend Framework utilizan un Front Controller,
  9. lo que significa que todas las solicitudes de un determinado
  10. sitio pasarán por un solo punto de entrada. Como resultado, todas
  11. las excepciones burbujearán eventualmente hacia arriba hasta el
  12. Front Controller, permitiendo al desarrollador manejarlos en un
  13. solo lugar.
  14. </para>
  15. <para>
  16. Sin embargo, los mensajes de excepción y la información de backtrace
  17. contienen a menudo información sensible del sistema, como
  18. declaraciones SQL, ubicaciones de archivos y otras cosas más.
  19. Para ayudar a proteger su sitio, por defecto
  20. <classname>Zend_Controller_Front</classname> captura todas las
  21. excepciones y las registra con el objeto respuesta; a su vez, y
  22. por defecto, el objeto respuesta no muestra mensajes de excepción.
  23. </para>
  24. </sect2>
  25. <sect2 id="zend.controller.exceptions.handling">
  26. <title>Manejando las Excepciones</title>
  27. <para>
  28. Ya hay varios mecanismos construidos en los componentes de MVC,
  29. que le permiten manejar excepciones.
  30. </para>
  31. <itemizedlist>
  32. <listitem>
  33. <para>
  34. Por defecto, el <link
  35. linkend="zend.controller.plugins.standard.errorhandler">error
  36. handler plugin</link> está registrado y activo.
  37. Este plugin fue diseñado para manejar:
  38. </para>
  39. <itemizedlist>
  40. <listitem><para>Errores debido a controladores o acciones perdidas</para></listitem>
  41. <listitem><para>Errores ocurriendo dentro de controladores de acción</para></listitem>
  42. </itemizedlist>
  43. <para>
  44. Operan como un plugin de <code>postDispatch()</code>,
  45. y comprueban para ver si un despachador, controlador de
  46. acción, o de otra excepción ha ocurrido.
  47. Si así fuera, lo remite a un controlador de manejo de
  48. errores.
  49. </para>
  50. <para>
  51. Este manejador abarcará la mayoría de las situaciones
  52. excepcionales, y maneja airosamente controladores y acciones
  53. perdidos.
  54. </para>
  55. </listitem>
  56. <listitem>
  57. <para><classname>Zend_Controller_Front::throwExceptions()</classname></para>
  58. <para>
  59. Pasando a este método un valor booleano verdadero,
  60. puede decirle al front controller que, en lugar
  61. de sumar excepciones en el objeto respuesta o utilizando
  62. el plugin de manejo de errores, prefiere manejarlos usted mismo.
  63. Como ejemplo:
  64. </para>
  65. <programlisting role="php"><![CDATA[
  66. $front->throwExceptions(true);
  67. try {
  68. $front->dispatch();
  69. } catch (Exception $e) {
  70. // usted mismo maneja las excepciones
  71. }
  72. ]]></programlisting>
  73. <para>
  74. Este método es probablemente la forma más fácil de añadir
  75. un manejo de excepciones personalizado que abarque toda la
  76. gama de posibles excepciones a su aplicación de
  77. front controller.
  78. </para>
  79. </listitem>
  80. <listitem>
  81. <para><classname>Zend_Controller_Response_Abstract::renderExceptions()</classname></para>
  82. <para>
  83. Al pasar a este método un valor booleano verdadero,
  84. le esta diciendo al objeto respuesta que debe emitir un
  85. mensaje de excepción y backtrace cuando se renderiza a sí
  86. mismo.
  87. En este escenario, se mostrará cualquier excepción planteada
  88. por su aplicación. Esto no es recomendable para entornos de
  89. producción, pero sí en desarrollo.
  90. </para>
  91. </listitem>
  92. <listitem>
  93. <para>
  94. <classname>Zend_Controller_Front::returnResponse()</classname> y
  95. <classname>Zend_Controller_Response_Abstract::isException()</classname>.
  96. </para>
  97. <para>
  98. Pasando un valor booleano verdadero a
  99. <classname>Zend_Controller_Front::returnResponse()</classname>,
  100. <classname>Zend_Controller_Front::dispatch()</classname>
  101. no renderizará la respuesta, sino que la devolverá.
  102. Una vez que tiene la respuesta, entonces puede probar ver
  103. si todas las excepciones fueron atrapadas usando su método
  104. <code>isException()</code>, y recuperando las excepciones
  105. a través del método <code>getException()</code>.
  106. Como ejemplo:
  107. </para>
  108. <programlisting role="php"><![CDATA[
  109. $front->returnResponse(true);
  110. $response = $front->dispatch();
  111. if ($response->isException()) {
  112. $exceptions = $response->getException();
  113. // maneje las excepciones ...
  114. } else {
  115. $response->sendHeaders();
  116. $response->outputBody();
  117. }
  118. ]]></programlisting>
  119. <para>
  120. La principal ventaja que este método ofrece por sobre
  121. <classname>Zend_Controller_Front::throwExceptions()</classname>
  122. es que le permite renderizar condicionalmente la respuesta
  123. después de manejar la excepción. Esta capturará cualquier
  124. excepción en la cadena de controladores, a diferencia del
  125. plugin de manejo de errores.
  126. </para>
  127. </listitem>
  128. </itemizedlist>
  129. </sect2>
  130. <sect2 id="zend.controller.exceptions.internal">
  131. <title>Excepciones MVC que Usted Pueda Encontrar</title>
  132. <para>
  133. Los diversos componentes de MVC -- solicitud, router, despachador,
  134. controlador de acción, y los objetos respuesta -- pueden arrojar
  135. excepciones en ocasiones.
  136. Algunas excepciones puede ser condicionalmente anuladas,
  137. y otras se usan para indicar al desarrollador que puede necesitar
  138. re-considerar la estructura de su aplicación.
  139. </para>
  140. <para>Como algunos ejemplos:</para>
  141. <itemizedlist>
  142. <listitem>
  143. <para>
  144. <classname>Zend_Controller_Dispatcher::dispatch()</classname>
  145. hará, por defecto, arrojar una excepción si se hace un
  146. requerimiento a un controlador no válido.
  147. Hay dos maneras recomendadas para lidiar con esto.
  148. </para>
  149. <itemizedlist>
  150. <listitem>
  151. <para>Establecer el parámetro
  152. <code>useDefaultControllerAlways</code>.
  153. </para>
  154. <para>
  155. En su front controller, o en su despachador,
  156. añada la siguiente directiva:
  157. </para>
  158. <programlisting role="php"><![CDATA[
  159. $front->setParam('useDefaultControllerAlways', true);
  160. // o
  161. $dispatcher->setParam('useDefaultControllerAlways', true);
  162. ]]></programlisting>
  163. <para>
  164. Cuando este flag está establecido, el despachador
  165. utilizará el controlador y la acción por defecto
  166. en lugar de lanzar una excepción.
  167. La desventaja de este método es que cualquier
  168. error ortográfico que un usuario haga cuando
  169. acceda a su sitio lo resolverá y mostrará su
  170. página de inicio, y que puede causar estragos
  171. con la optimización para los motores de búsqueda.
  172. </para>
  173. </listitem>
  174. <listitem>
  175. <para>
  176. La excepción arrojada por <code>dispatch()</code> es
  177. una <classname>Zend_Controller_Dispatcher_Exception</classname>
  178. conteniendo el texto 'Invalid controller specified'.
  179. Use uno de los métodos descriptos de <link
  180. linkend="zend.controller.exceptions.handling">la
  181. sección anterior</link> para atrapar la
  182. excepción, y luego redireccionar a una página
  183. genérica de error o a la página de inicio.
  184. </para>
  185. </listitem>
  186. </itemizedlist>
  187. </listitem>
  188. <listitem>
  189. <para>
  190. <classname>Zend_Controller_Action::__call()</classname>
  191. arrojará una
  192. <classname>Zend_Controller_Action_Exception</classname>
  193. si no puede despachar una acción inexistente a un método.
  194. Es probable que desee utilizar alguna acción por defecto
  195. en el controlador en casos como este.
  196. Formas de lograr esto incluyen:
  197. </para>
  198. <itemizedlist>
  199. <listitem>
  200. <para>
  201. Subclasear <classname>Zend_Controller_Action</classname> y
  202. anular el método <code>__call()</code>.
  203. Como ejemplo:
  204. </para>
  205. <programlisting role="php"><![CDATA[
  206. class My_Controller_Action extends Zend_Controller_Action
  207. {
  208. public function __call($method, $args)
  209. {
  210. if ('Action' == substr($method, -6)) {
  211. $controller = $this->getRequest()->getControllerName();
  212. $url = '/' . $controller . '/index';
  213. return $this->_redirect($url);
  214. }
  215. throw new Exception('Invalid method');
  216. }
  217. }
  218. ]]></programlisting>
  219. <para>
  220. El ejemplo anterior intercepta cualquier llamada a
  221. un método de acción indefinido y redirecciona a la
  222. acción predeterminada en el controlador.
  223. </para>
  224. </listitem>
  225. <listitem>
  226. <para>
  227. Subclasea a <classname>Zend_Controller_Dispatcher</classname>
  228. y anula el método <code>getAction()</code>
  229. para verificar si la acción existe.
  230. Como ejemplo:
  231. </para>
  232. <programlisting role="php"><![CDATA[
  233. class My_Controller_Dispatcher extends Zend_Controller_Dispatcher
  234. {
  235. public function getAction($request)
  236. {
  237. $action = $request->getActionName();
  238. if (empty($action)) {
  239. $action = $this->getDefaultAction();
  240. $request->setActionName($action);
  241. $action = $this->formatActionName($action);
  242. } else {
  243. $controller = $this->getController();
  244. $action = $this->formatActionName($action);
  245. if (!method_exists($controller, $action)) {
  246. $action = $this->getDefaultAction();
  247. $request->setActionName($action);
  248. $action = $this->formatActionName($action);
  249. }
  250. }
  251. return $action;
  252. }
  253. }
  254. ]]></programlisting>
  255. <para>
  256. El código anterior comprueba para ver que las
  257. acciones solicitadas existan en la clase del
  258. controlador; si no, se restablece la acción a la
  259. acción por defecto.
  260. </para>
  261. <para>
  262. Este método es agradable porque puede alterar
  263. transparentemente la acción antes del último
  264. despacho. Sin embargo, también significa que errores
  265. ortográficos en la URL todavía pueden despacharse
  266. correctamente, lo que no es muy bueno para la
  267. optimización en un motor de búsqueda.
  268. </para>
  269. </listitem>
  270. <listitem>
  271. <para>
  272. Use
  273. <classname>Zend_Controller_Action::preDispatch()</classname>
  274. o
  275. <classname>Zend_Controller_Plugin_Abstract::preDispatch()</classname>
  276. para identificar acciones inválidas.
  277. </para>
  278. <para>
  279. Subclaseando <classname>Zend_Controller_Action</classname>
  280. y modificando <code>preDispatch()</code>,
  281. puede modificar todos sus controladores que
  282. transmitan a otra acción o redireccionar antes de
  283. despachar la acción. El código para hacer esto se
  284. verá parecido al código de sustitución de arriba
  285. <code>__call()</code>.
  286. </para>
  287. <para>
  288. Alternativamente, puede verificar esta información
  289. en un plugin global. Esto tiene la ventaja de ser
  290. independiente del controlador de acción; si su
  291. aplicación consiste en una variedad de controladores
  292. de acción, y no todos ellos heredan de la misma clase,
  293. este método puede añadir coherencia a su manejo de
  294. clases diferentes.
  295. </para>
  296. <para>
  297. Como ejemplo:
  298. </para>
  299. <programlisting role="php"><![CDATA[
  300. class My_Controller_PreDispatchPlugin extends Zend_Controller_Plugin_Abstract
  301. {
  302. public function preDispatch(Zend_Controller_Request_Abstract $request)
  303. {
  304. $front = Zend_Controller_Front::getInstance();
  305. $dispatcher = $front->getDispatcher();
  306. $class = $dispatcher->getControllerClass($request);
  307. if (!$controller) {
  308. $class = $dispatcher->getDefaultControllerClass($request);
  309. }
  310. $r = new ReflectionClass($class);
  311. $action = $dispatcher->getActionMethod($request);
  312. if (!$r->hasMethod($action)) {
  313. $defaultAction = $dispatcher->getDefaultAction();
  314. $controllerName = $request->getControllerName();
  315. $response = $front->getResponse();
  316. $response->setRedirect('/' . $controllerName
  317. . '/' . $defaultAction);
  318. $response->sendHeaders();
  319. exit;
  320. }
  321. }
  322. }
  323. ]]></programlisting>
  324. <para>
  325. En este ejemplo, vamos a consultar para ver si la
  326. acción solicitada está disponible en el controlador.
  327. Si no, redireccionamos a la acción predeterminada
  328. en el controlador, y salimos inmediatamente de la
  329. ejecución del script.
  330. </para>
  331. </listitem>
  332. </itemizedlist>
  333. </listitem>
  334. </itemizedlist>
  335. </sect2>
  336. </sect1>
  337. <!--
  338. vim:se ts=4 sw=4 et:
  339. -->