Обработка ошибок ¶
В состав Yii входит встроенный обработчик ошибок, делающий работу с ошибками гораздо более
приятным занятием. А именно:
- Все не фатальные ошибки PHP (то есть warning, notice) конвертируются в исключения, которые можно перехватывать.
- Исключения и фатальные ошибки PHP отображаются в режиме отладки с детальным стеком вызовов и исходным кодом.
- Можно использовать для отображения ошибок действие контроллера.
- Поддерживаются различные форматы ответа.
По умолчанию обработчик ошибок включен. Вы можете выключить его объявив константу
YII_ENABLE_ERROR_HANDLER
со значением false
во входном скрипте вашего приложения.
Использование обработчика ошибок ¶
Обработчик ошибок регистрируется в качестве компонента приложения
с именем errorHandler
. Вы можете настраивать его следующим образом:
return [
'components' => [
'errorHandler' => [
'maxSourceLines' => 20,
],
],
];
С приведённой выше конфигурацией на странице ошибки будет отображаться до 20 строк исходного кода.
Как уже было упомянуто, обработчик ошибок конвертирует все не фатальные ошибки PHP в перехватываемые исключения.
Это означает что можно поступать с ошибками следующим образом:
use Yii;
use yii\base\ErrorException;
try {
10/0;
} catch (ErrorException $e) {
Yii::warning("Деление на ноль.");
}
// можно продолжать выполнение
Если вам необходимо показать пользователю страницу с ошибкой, говорящей ему о том, что его запрос не верен или не
должен был быть сделан, вы можете выкинуть исключение HTTP, такое как
yii\web\NotFoundHttpException. Обработчик ошибок корректно выставит статус код HTTP для ответа и использует
подходящий вид страницы ошибки.
use yii\web\NotFoundHttpException;
throw new NotFoundHttpException();
Настройка отображения ошибок ¶
Обработчик ошибок меняет отображение ошибок в зависимости от значения константы YII_DEBUG
.
При YII_DEBUG
равной true
(режим отладки), обработчик ошибок будет отображать для облегчения отладки детальный стек
вызовов и исходный код. При YII_DEBUG
равной false
отображается только сообщение об ошибке, тем самым не позволяя
получить информацию о внутренностях приложения.
Информация: Если исключение является наследником yii\base\UserException, стек вызовов не отображается вне
зависимости от значенияYII_DEBUG
так как такие исключения считаются ошибками пользователя и исправлять что-либо
разработчику не требуется.
По умолчанию обработчик ошибок показывает ошибки используя два представления:
@yii/views/errorHandler/error.php
: используется для отображения ошибок БЕЗ стека вызовов.
ПриYII_DEBUG
равнойfalse
используется только это преставление.@yii/views/errorHandler/exception.php
: используется для отображения ошибок СО стеком вызовов.
Вы можете настроить свойства errorView и exceptionView
для того, чтобы использовать свои представления.
Использование действий для отображения ошибок ¶
Лучшим способом изменения отображения ошибок является использование действий путём
конфигурирования свойства errorAction компонента errorHandler
:
// ...
'components' => [
// ...
'errorHandler' => [
'errorAction' => 'site/error',
],
]
Свойство errorAction принимает маршрут
действия. Конфигурация выше означает, что для отображения ошибки без стека вызовов будет использовано действие site/error
.
Само действие можно реализовать следующим образом:
namespace app\controllers;
use Yii;
use yii\web\Controller;
class SiteController extends Controller
{
public function actions()
{
return [
'error' => [
'class' => 'yii\web\ErrorAction',
],
];
}
}
Приведённый выше код задаёт действие error
используя класс yii\web\ErrorAction, который рендерит ошибку используя
отображение error
.
Вместо использования yii\web\ErrorAction вы можете создать действие error
как обычный метод:
public function actionError()
{
$exception = Yii::$app->errorHandler->exception;
if ($exception !== null) {
return $this->render('error', ['exception' => $exception]);
}
}
Вы должны создать файл представления views/site/error.php
. В этом файле, если используется yii\web\ErrorAction,
вам доступны следующие переменные:
name
: имя ошибки;message
: текст ошибки;exception
: объект исключения, из которого можно получить дополнительную информацию, такую как статус HTTP,
код ошибки, стек вызовов и т.д.
Информация: Если вы используете шаблоны приложения basic или advanced,
действие error и файл представления уже созданы за вас.
Изменение формата ответа ¶
Обработчик ошибок отображает ошибки в соответствии с выбранным форматом ответа.
Если формат ответа задан как html
, будут использованы представления для ошибок и
исключений, как описывалось ранее. Для остальных форматов ответа обработчик ошибок присваивает массив данных,
представляющий ошибку свойству yii\web\Response::$data. Оно далее конвертируется в необходимый формат. Например,
если используется формат ответа json
, вы получите подобный ответ:
HTTP/1.1 404 Not Found
Date: Sun, 02 Mar 2014 05:31:43 GMT
Server: Apache/2.2.26 (Unix) DAV/2 PHP/5.4.20 mod_ssl/2.2.26 OpenSSL/0.9.8y
Transfer-Encoding: chunked
Content-Type: application/json; charset=UTF-8
{
"name": "Not Found Exception",
"message": "The requested resource was not found.",
"code": 0,
"status": 404
}
Изменить формат можно в обработчике события beforeSend
компонента response
в конфигурации приложения:
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;
}
},
],
],
];
Приведённый код изменит формат ответа на подобный:
HTTP/1.1 200 OK
Date: Sun, 02 Mar 2014 05:31:43 GMT
Server: Apache/2.2.26 (Unix) DAV/2 PHP/5.4.20 mod_ssl/2.2.26 OpenSSL/0.9.8y
Transfer-Encoding: chunked
Content-Type: application/json; charset=UTF-8
{
"success": false,
"data": {
"name": "Not Found Exception",
"message": "The requested resource was not found.",
"code": 0,
"status": 404
}
}
Is it necessary to disable error output opposite the input fields? I want to display errors using getErrors()
only at the top of form.
benomatis
5,5467 gold badges36 silver badges59 bronze badges
asked Jun 5, 2015 at 20:04
1
In Yii 1.0 you can comment out this peice of code in your protected/config/main.php
'errorHandler'=>array(
// use 'site/error' action to display errors
'errorAction'=>'site/error',
),
In yii 2 you need to set YII_DEBUG is false
The error handler adjusts the error display according to the value of the constant YII_DEBUG. When YII_DEBUG is true (meaning in debug mode), the error handler will display exceptions with detailed call stack information and source code lines to help easier debugging. And when YII_DEBUG is false, only the error message will be displayed to prevent revealing sensitive information about the application.
Info: If an exception is a descendant of yii\base\UserException, no call stack will be displayed regardless the value of YII_DEBUG. This is because such exceptions are considered to be caused by user mistakes and the developers do not need to fix anything.
Take a look here for more details
http://www.yiiframework.com/doc-2.0/guide-runtime-handling-errors.html
answered Jun 5, 2015 at 20:10
Sari RahalSari Rahal
1,8952 gold badges32 silver badges53 bronze badges
1
Обработчик ошибок включен в Yii 2 по умолчанию. Отключить его можно добавив следующий код в стартовый скрипт приложения web/index.php:
// Отключение обработчика ошибок Yii2 define('YII_ENABLE_ERROR_HANDLER', false);
Конфигурация по умолчанию
В шаблонах приложений Yii 2 basic и advanced обработчик ошибок подключен как компонент приложения errorHandler. Рассмотрим примеры конфигурации:
- приложение basic: config/web.php;
- приложение advanced: индивидуальные настройки для каждого из приложений frontend/config/main.php и backend/config/main.php.
Минимальная конфигурация обработчика ошибок использует site/error для отображения ошибок и исключений.
return [ // ... 'components' => [ // ... 'errorHandler' => [ 'errorAction' => 'site/error', ], // ... ], // ... ];
В данном случае нет необходимости в явном создании действия actionError в контроллере SiteController. Если заглянуть в файл SiteController.php, можно увидеть, что там использовано встроенное действие yii\web\ErrorAction, которое отображает информацию через представление views/site/error.php.
// SiteController.php class SiteController extends Controller { // ... public function actions() { return [ 'error' => [ 'class' => 'yii\web\ErrorAction', ], // ... ]; } // ... }
Настройка представления и шаблона
Возьмем за основу вышеописанную стандартную конфигурацию.
Представление описывается свойством view класса yii\web\ErrorAction:
// SiteController.php class SiteController extends Controller { // ... public function actions() { return [ 'error' => [ 'class' => 'yii\web\ErrorAction', 'view' => '@app/views/site/custom-error-view.php' ], // ... ]; } // ... }
В тоже время, шаблон для вывода сообщений об ошибках, можно изменить двумя способами:
1. Явно указав нужный шаблон в файле представления:
// custom-error-view.php $this->context->layout = 'custom-error-layout';
2. Указать шаблон в методе beforeAction() класса SiteController:
// SiteController.php public function beforeAction($action) { if ($action->id == 'error') { $this->layout = 'custom-error-layout'; } return parent::beforeAction($action); }
Свой обработчик ошибок
При необходимости, возможно создание своего метода для обработки ошибок. Например, создадим действие site/fault в контроллере SiteController:
// SiteController.php public function actionFault() { $exception = Yii::$app->errorHandler->exception; if ($exception !== null) { $statusCode = $exception->statusCode; $name = $exception->getName(); $message = $exception->getMessage(); $this->layout = 'custom-error-layout'; return $this->render('custom-error-view', [ 'exception' => $exception, 'statusCode' => $statusCode, 'name' => $name, 'message' => $message ]); } }
И подключим его в конфигурационном файле:
return [ // ... 'components' => [ // ... 'errorHandler' => [ 'errorAction' => 'site/fault', ], // ... ], // ... ];
Готово. Теперь все ошибки будут обрабатываться новым методом actionFault() контроллера SiteController.
Можно удалить описание ненужного действия site/error:
// SiteController.php class SiteController extends Controller { // ... public function actions() { return [ // Comment out or remove following error configuration // 'error' => [ // 'class' => 'yii\web\ErrorAction', // 'view' => '@app/views/site/custom-error-view.php' // ], // ... ]; } // ... }
Конкретный пример
В действии запланирована такая выдача ошибки 403
если всё хорошо, то выполняется что должно выполняться } else { throw new HttpException(403,'Доступно для зарегистрировавшихся'); }
Хочу, чтобы вместо этого пользователя перекидывало на страницу с формой входа. Если использовать yii-user, там можно ещё передать флеш-сообщение с каким-то сопутствующим текстом и оно будет показано перед формой.
если всё хорошо, то выполняется что должно выполняться } else { Yii::$app->session->setFlash('info', 'Курс доступен только для зарегистрированных пользователей. Войдите в личный кабинет или пройдите регистрацию, если ещё не сделали этого.'); return $this->redirect('/user/login'); }
Обработчик ошибок
Обработчик ошибок включен в Yii2 по-умолчанию. его можно отключить во входном скрипте web/index.php
// Отключение обработчика ошибок Yii2 define('YII_ENABLE_ERROR_HANDLER', false);
Обработчик ошибок подключён как компонент приложения в конфиге
return [ // ... 'components' => [ // ... 'errorHandler' => [ 'errorAction' => 'site/error', ], // ... ], // ... ];
В SiteController.php использовано встроенное действие yii\web\ErrorAction, которое отображает ошибки через представление views/site/error.php
class SiteController extends Controller { // ... public function actions() { return [ 'error' => [ 'class' => 'yii\web\ErrorAction', ], // ... ]; } // ... }
Представление это можно заменить, указав свойство ‘view’
class SiteController extends Controller { // ... public function actions() { return [ 'error' => [ 'class' => 'yii\web\ErrorAction', 'view' => '@app/views/site/custom-error-view.php' ], // ... ]; } // ... }
Можно изменить шаблон для вывода сообщений об ошибках 2 способами:
1. Явно указать нужный шаблон в файле представления
$this->context->layout = 'custom-error-layout';
2. Указать шаблон в методе beforeAction() контроллера SiteController
public function beforeAction($action) { if ($action->id == 'error') { $this->layout = 'custom-error-layout'; } return parent::beforeAction($action); }
Создать свой обработчик ошибок
Создадим действие site/fault в контроллере SiteController
public function actionFault() { $exception = Yii::$app->errorHandler->exception; if ($exception !== null) { $statusCode = $exception->statusCode; $name = $exception->getName(); $message = $exception->getMessage(); $this->layout = 'custom-error-layout'; return $this->render('custom-error-view', [ 'exception' => $exception, 'statusCode' => $statusCode, 'name' => $name, 'message' => $message ]); } }
Тогда в конфиге надо заменить на
return [ // ... 'components' => [ // ... 'errorHandler' => [ 'errorAction' => 'site/fault', ], // ... ], // ... ];
Теперь все ошибки будут обрабатываться новым методом actionFault(). Можно удалить описание ненужного здесь встроенного действия.
class SiteController extends Controller { // ... public function actions() { return [ // Comment out or remove following error configuration // 'error' => [ // 'class' => 'yii\web\ErrorAction', // 'view' => '@app/views/site/custom-error-view.php' // ], // ... ]; } // ... }
По мотивам – http://nix-tips.ru/yii-2.html
I am moving into a production environment and the following is set:
error_reporting(E_ALL & ~E_NOTICE);
ini_set('display_errors', 0);
ini_set('log_errors', 1);
defined('YII_DEBUG') or define('YII_DEBUG', false);
defined('YII_ENV') or define('YII_ENV', 'prod');
defined('YII_ENABLE_ERROR_HANDLER') or define('YII_ENABLE_ERROR_HANDLER', false);
defined('YII_ENABLE_EXCEPTION_HANDLER') or define('YII_ENABLE_EXCEPTION_HANDLER', false);
However, I have noticed that Yii will still show that big beautiful stack trace filled with all sorts of goodies.
I know the best way to overcome this is to actually write sound code, however, that is not always possible when dealing with mischievous individuals.
Using:
Apache/2.4.27 (Amazon) PHP/7.0.25
Yii Framework/2.0.8
Testing:
<?php
ThisFunctionDoesNotExist();
?>
Although, everything seems to be correct, it doesnt work. I am having similar issues as this guy: http://www.yiiframework.com/forum/index.php/topic/22583-yii-debug-false-shows-php-notice-errors-and-stops/