Yii - Tratamento de Erros

O Yii inclui um gerenciador de erros embutido. O manipulador de erros Yii faz o seguinte -

• Converte todos os erros não fatais de PHP em exceções capturáveis.
• Exibe todos os erros e exceções com uma pilha de chamadas detalhada.
• Suporta diferentes formatos de erro.
• Oferece suporte ao uso de uma ação do controlador para exibir erros.

Para desativar o manipulador de erros, você deve definir a constante YII_ENABLE_ERROR_HANDLER como falsa no script de entrada. O manipulador de erros é registrado como um componente do aplicativo.

Step 1 - Você pode configurá-lo da seguinte maneira.

return [
   'components' => [
      'errorHandler' => [
         'maxSourceLines' => 10,
      ],
   ],
];

A configuração acima define o número de linhas de código-fonte a serem exibidas em 10. O manipulador de erros converte todos os erros não fatais do PHP em exceções capturáveis.

Step 2 - Adicione uma nova função chamada actionShowError() para o SiteController.

public function actionShowError() {
   try {
      5/0;
   } catch (ErrorException $e) {
      Yii::warning("Ooops...division by zero.");
   }
   // execution continues...
}

Step 3 - Vá para o URL http://localhost:8080/index.php?r=site/show-error. Você verá uma mensagem de aviso.

Se você quiser mostrar ao usuário que sua solicitação é inválida, você pode lançar o yii\web\NotFoundHttpException.

Step 4 - Modifique o actionShowError() função.

public function actionShowError() {
   throw new NotFoundHttpException("Something unexpected happened");
}

Step 5 - Digite o endereço http://localhost:8080/index.php?r=site/show-errorna barra de endereço. Você verá o seguinte erro de HTTP.

Quando a constante YII_DEBUG for verdadeira, o manipulador de erros exibirá erros com uma pilha de chamadas detalhada. Quando a constante é falsa, apenas a mensagem de erro será exibida. Por padrão, o manipulador de erros mostra erros usando essas visualizações -

• @yii/views/errorHandler/exception.php - o arquivo de visualização é usado quando os erros devem ser exibidos com informações da pilha de chamadas.

• @yii/views/errorHandler/error.php - o arquivo de visualização é usado quando os erros devem ser exibidos sem informações da pilha de chamadas.

Você pode usar ações de erro dedicadas para personalizar a exibição de erros.

Step 6 - Modifique o errorHandler componente de aplicativo no config/web.php Arquivo.

<?php
   $params = require(__DIR__ . '/params.php');
   $config = [
      'id' => 'basic',
      'basePath' => dirname(__DIR__),
      'bootstrap' => ['log'],
      'components' => [
         'request' => [
            // !!! insert a secret key in the following (if it is empty) - this
               //is required by cookie validation
            'cookieValidationKey' => 'ymoaYrebZHa8gURuolioHGlK8fLXCKjO',
         ],
         'cache' => [
            'class' => 'yii\caching\FileCache',
         ],
         'user' => [
            'identityClass' => 'app\models\User',
            'enableAutoLogin' => true,
         ],
         'errorHandler' => [ 'errorAction' => 'site/error', ],
         //other components...
            'db' => require(__DIR__ . '/db.php'),
      ],
      'modules' => [
         'hello' => [
            'class' => 'app\modules\hello\Hello',
         ],
      ],
      'params' => $params,
   ];
   if (YII_ENV_DEV) {
      // configuration adjustments for 'dev' environment
      $config['bootstrap'][] = 'debug'; $config['modules']['debug'] = [
         'class' => 'yii\debug\Module',
      ];
      $config['bootstrap'][] = 'gii'; $config['modules']['gii'] = [
         'class' => 'yii\gii\Module',
      ];
   }
   return $config;
?>

A configuração acima define que, quando um erro precisa ser exibido sem a pilha de chamadas, o site/error ação será executada.

Step 7 - Modifique o actions() método do SiteController.

public function actions() {
   return [
      'error' => [
         'class' => 'yii\web\ErrorAction',
      ],
   ];
}

O código acima define que quando um error ocorrer, a visualização de erro será renderizada.

Step 8 - Crie um arquivo chamado error.php sob o diretório views / site.

<?php
   /* @var $this yii\web\View */
   /* @var $name string */ /* @var $message string */
   /* @var $exception Exception */ use yii\helpers\Html; $this->title = $name; ?> <div class = "site-error"> <h2>customized error</h2> <h1><?= Html::encode($this->title) ?></h1>
   
   <div class = "alert alert-danger">
      <?= nl2br(Html::encode($message)) ?>
   </div>
   
   <p>
      The above error occurred while the Web server was processing your request.
   </p>
   
   <p>
      Please contact us if you think this is a server error. Thank you.
   </p>
</div>

Step 9 - Vá para o endereço http://localhost:8080/index.php?r=site/show-error, você verá a visualização de erro personalizada.