Yii incluye un [[yii\web\ErrorHandler|error handler]] que permite una gestión de errores mucho más práctica que
anteriormente. En particular, el gestor de errores de Yii hace lo siguiente para mejorar la gestión de errores:
Todos los errores no fatales (ej. advertencias (warning), avisos (notices)) se convierten en excepciones capturables.
Las excepciones y los errores fatales de PHP se muestran con una pila de llamadas (call stack) de información
detallada y lineas de código fuente.
Soporta diferentes formatos de respuesta (response) de errores.
El [[yii\web\ErrorHandler|error handler]] esta habilitado de forma predeterminada. Se puede deshabilitar definiendo la
constante YII_ENABLE_ERROR_HANDLER con valor false en el script de entrada (entry script) de la aplicación.
El [[yii\web\ErrorHandler|error handler]] se registra como un componente de aplicación llamado errorHandler.
Se puede configurar en la configuración de la aplicación como en el siguiente ejemplo:
return [
'components'=> [
'errorHandler'=> [
'maxSourceLines'=>20,
],
],
];
Con la anterior configuración, el numero del lineas de código fuente que se mostrará en las páginas de excepciones será como máximo de 20.
Como se ha mencionado, el gestor de errores convierte todos los errores de PHP no fatales en excepciones capturables.
Esto significa que se puede usar el siguiente código para tratar los errores PHP:
useYii;
use yii\base\ErrorException;
try {
10/0;
} catch(ErrorException$e) {
Yii::warning("Division by zero.");
}
// la ejecución continua ...
Si se quiere mostrar una página de error que muestra al usuario que su petición no es válida o no es la esperada, se
puede simplemente lanzar una excepción de tipo [[yii\web\HttpException|HTTP exception]], como podría ser
[[yii\web\NotFoundHttpException]]. El gestor de errores establecerá correctamente el código de estado HTTP de la
respuesta y usará la vista de error apropiada para mostrar el mensaje.
El [[yii\web\ErrorHandler|error handler]] ajusta la visualización del error conforme al valor de la constante YII_DEBUG.
Cuando YII_DEBUG es true (es decir, en modo depuración (debug)), el gestor de errores mostrara las
excepciones con una pila detallada de información y con lineas de código fuente para ayudar a depurar. Y cuando la variable YII_DEBUG es false,
solo se mostrará el mensaje de error para prevenir la revelación de información sensible de la aplicación.
Info: Si una excepción es descendiente de [[yii\base\UserException]], no se mostrará la pila de llamadas
independientemente del valor de YII_DEBUG. Esto es debido a que se considera que estas excepciones se deben a
errores cometidos por los usuarios y los desarrolladores no necesitan corregirlas.
De forma predeterminada, el [[yii\web\ErrorHandler|error handler]] muestra los errores usando dos vistas:
@yii/views/errorHandler/error.php: se usa cuando deben mostrarse los errores SIN la información de la pila de
llamadas. Cuando YII_DEBUG es falos, este es el único error que se mostrara.
@yii/views/errorHandler/exception.php: se usa cuando los errores deben mostrarse CON la información de la pila de llamadas.
Se pueden configurar las propiedades [[yii\web\ErrorHandler::errorView|errorView]] y [[yii\web\ErrorHandler::exceptionView|exceptionView]]
el gestor de errores para usar nuestros propias vistas para personalizar la visualización de los errores.
Una mejor manera de personalizar la visualización de errores es usar un acción de error
dedicada. Para hacerlo, primero se debe configurar la propiedad [[yii\web\ErrorHandler::errorAction|errorAction]] del
componente errorHandler como en el siguiente ejemplo:
return [
'components'=> [
'errorHandler'=> [
'errorAction'=>'site/error',
],
]
];
La propiedad [[yii\web\ErrorHandler::errorAction|errorAction]] vincula una ruta a
una acción. La configuración anterior declara que cuando un error tiene que mostrarse sin la pila de información de
llamadas, se debe ejecutar la acción site/error.
Se puede crear una acción site/error como se hace a continuación,
namespace app\controllers;
useYii;
use yii\web\Controller;
classSiteControllerextendsController
{
publicfunctionactions()
{
return [
'error'=> [
'class'=>'yii\web\ErrorAction',
],
];
}
}
El código anterior define la acción error usando la clase [[yii\web\ErrorAction]] que renderiza un error usando la
vista llamada error.
Además, usando [[yii\web\ErrorAction]], también se puede definir la acción error usando un método de acción como en el siguiente ejemplo,
Ahora se debe crear un archivo de vista ubicado en views/sites/error.php. En este archivo de vista, se puede acceder
a las siguientes variables si se define el error como un [[yii\web\ErrorAction]]:
name: el nombre del error;
message: el mensaje del error;
exception: el objeto de excepción a través del cual se puede obtener más información útil, tal como el código de
estado HTTP, el código de error, la pila de llamadas del error, etc.
El gestor de errores muestra los errores de siguiente la configuración del formato de las
respuestas. Si el [[yii\web\Response::format response format]] es html, se usará la vista de
error o excepción para mostrar los errores tal y como se ha descrito en la anterior subsección. Para otros tipos de
formatos de respuesta, el gestor de errores asignara la representación del array de la excepción a la propiedad
[[yii\web\Response::data]] que posteriormente podrá convertirse al formato deseado. Por ejemplo, si el formato de
respuesta es json, obtendremos la siguiente respuesta:
"message": "The requested resource was not found.",
"code": 0,
"status": 404
}
Se puede personalizar el formato de respuestas de error respondiendo al evento beforeSend del componente response
en la configuración de la aplicación:
return [
// ...
'components'=> [
'response'=> [
'class'=>'yii\web\Response',
'on beforeSend'=>function($event) {
$response=$event->sender;
if ($response->data!==null) {
$response->data= [
'success'=>$response->isSuccessful,
'data'=>$response->data,
];
$response->statusCode=200;
}
},
],
],
];
El código anterior reformateará la respuesta de error como en el siguiente ejemplo:
