Yii2 возникла внутренняя ошибка сервера

Обработка ошибок ¶

Если при обработке запроса к RESTful API в запросе пользователя обнаруживается ошибка или происходит
что-то непредвиденное на сервере, вы можете просто выбрасывать исключение, чтобы уведомить пользователя о нештатной ситуации.
Если вы можете установить конкретную причину ошибки (например, запрошенный ресурс не существует), вам следует подумать
о том, чтобы выбрасывать исключение с соответствующим кодом состояния HTTP (например, yiiwebNotFoundHttpException,
соответствующее коду состояния 404). Yii отправит ответ с соответствующим
HTTP-кодом и текстом. Он также включит в тело ответа сериализованное представление
исключения. Например:

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
}

Сводный список кодов состояния HTTP, используемых REST-фреймворком Yii:

• 200: OK. Все сработало именно так, как и ожидалось.
• 201: Ресурс был успешно создан в ответ на POST-запрос. Заголовок Location
  содержит URL, указывающий на только что созданный ресурс.
• 204: Запрос обработан успешно, и в ответе нет содержимого (для запроса DELETE, например).
• 304: Ресурс не изменялся. Можно использовать закэшированную версию.
• 400: Неверный запрос. Может быть связано с разнообразными проблемами на стороне пользователя, такими как неверные JSON-данные
  в теле запроса, неправильные параметры действия, и т.д.
• 401: Аутентификация завершилась неудачно.
• 403: Аутентифицированному пользователю не разрешен доступ к указанной точке входа API.
• 404: Запрошенный ресурс не существует.
• 405: Метод не поддерживается. Сверьтесь со списком поддерживаемых HTTP-методов в заголовке Allow.
• 415: Не поддерживаемый тип данных. Запрашивается неправильный тип данных или номер версии.
• 422: Проверка данных завершилась неудачно (в ответе на POST-запрос, например). Подробные сообщения об ошибках смотрите в теле ответа.
• 429: Слишком много запросов. Запрос отклонен из-за превышения ограничения частоты запросов.
• 500: Внутренняя ошибка сервера. Возможная причина — ошибки в самой программе.

Свой формат ответа с ошибкой ¶

Вам может понадобиться изменить формат ответа с ошибкой. Например, вместо использования разных статусов ответа HTTP
для разных ошибок, вы можете всегда отдавать статус 200, а реальный код статуса отдавать как часть JSON ответа:

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
    }
}

Для этого можно использовать событие beforeSend компонента response прямо в конфигурации приложения:

return [
    // ...
    'components' => [
        'response' => [
            'class' => 'yiiwebResponse',
            'on beforeSend' => function ($event) {
                $response = $event->sender;
                if ($response->data !== null && !empty(Yii::$app->request->get('suppress_response_code'))) {
                    $response->data = [
                        'success' => $response->isSuccessful,
                        'data' => $response->data,
                    ];
                    $response->statusCode = 200;
                }
            },
        ],
    ],
];

Приведённый выше код изменит формат ответа (как для удачного запроса, так и для ошибок) если передан GET-параметр
suppress_response_code.

После структурирования Yii2 и нстройки файлов index, появляется ошибка «An internal server error occurred». но если index настроить не правильно, поменять местами frontend и backend, всё работает.
Пример admin/index:
<?php
defined(‘YII_DEBUG’) or define(‘YII_DEBUG’, false);
defined(‘YII_ENV’) or define(‘YII_ENV’, ‘prod’);

require __DIR__ . ‘/../../yii/vendor/autoload.php’;
require __DIR__ . ‘/../../yii/vendor/yiisoft/yii2/Yii.php’;
require __DIR__ . ‘/../../yii/common/config/bootstrap.php’;
require __DIR__ . ‘/../../yii/frontend/config/bootstrap.php’;

$config = yiihelpersArrayHelper::merge(
require __DIR__ . ‘/../../yii/common/config/main.php’,
require __DIR__ . ‘/../../yii/common/config/main-local.php’,
require __DIR__ . ‘/../../yii/frontend/config/main.php’,
require __DIR__ . ‘/../../yii/frontend/config/main-local.php’
);

(new yiiwebApplication($config))->run();

В каждом ответе Http-протокола существует некий 3-х значный код. Он позволяет клиенту правильно трактовать полученный результат. Думаю всем веб-мастерам хорошо известен код «404 — Not found». Кодов на самом деле огромное множество, все они описаны в спецификации Http протокола. Но знать все не обязательно. Главное при создании Exception (исключения) выбрать правильную группу кодов ответа. Групп всего 5:

• 1xx Информационные сообщения
• 2xx Успешное выполнение запроса
• 3xx Перенаправления (редирект)
• 4xx Ошибки клиента
• 5xx Ошибка на сервере

К ошибкам клиента относятся обращения к несуществующей странице, к запрещенной странице, неправильные параметры запроса, вызов не существующего метода, слишком большое количество запросов.
К серверным ошибкам относятся внутренние ошибки сервера, недоступность сервиса или отсутствие поддержки данной версии протокола.
Из всего вышесказанного становится понятно, что разработчику для корректной обработки ошибок нужны коды из 4 группы.

HttpException в Yii2

Зачем вообще нужны Exception? Для того, чтобы в случаи неожиданной ошибки, приложение могло сообщить о том, что его работа прекращена по такой-то причине. Exception можно отлавливать и обрабатывать, например с помощью конструкции try catch.
В Yii2 есть класс yiiwebHttpException с помощью которого можно создать любое исключение.

 throw new HttpException(404 ,'User not found');

Так же существуют классы со звучными именами для наиболее часто используемых типов ошибок, благодаря которым вам не нужно запоминать код ответа.

• BadRequestHttpException — 400 ошибка
• UnauthorizedHttpException — 401 ошибка
• ForbiddenHttpException — 403 ошибка
• NotFoundHttpException — 404 ошибка
• MethodNotAllowedHttpException — 405 ошибка
• NotAcceptableHttpException — 406 ошибка
• ConflictHttpException — 409 ошибка
• GoneHttpException — 410 ошибка
• UnsupportedMediaTypeHttpException — 415 ошибка
• TooManyRequestsHttpException — 429 ошибка
• ServerErrorHttpException — 500 ошибка

Все они отнаследованы от yiiwebHttpException и не нуждаются указании кода ответа.

 throw new NotFoundHttpException('User not found');

Установить статус ответа можно и с помощью метода setStatusCode() класса yiiwebResponse

Yii::$app->response->setStatusCode(422);

Это удобно тогда, когда есть необходимость передать что-либо в теле ответа.