Yii - Gestione degli errori

Yii include un gestore degli errori integrato. Il gestore degli errori Yii esegue le seguenti operazioni:

• Converte tutti gli errori PHP non fatali in eccezioni catturabili.
• Visualizza tutti gli errori e le eccezioni con uno stack di chiamate dettagliato.
• Supporta diversi formati di errore.
• Supporta l'utilizzo di un'azione del controller per visualizzare gli errori.

Per disabilitare il gestore degli errori, è necessario definire la costante YII_ENABLE_ERROR_HANDLER come falsa nello script di immissione. Il gestore degli errori viene registrato come componente dell'applicazione.

Step 1 - Puoi configurarlo nel modo seguente.

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

La configurazione precedente imposta il numero di righe di codice sorgente da visualizzare a 10. Il gestore degli errori converte tutti gli errori PHP non fatali in eccezioni catturabili.

Step 2 - Aggiungi una nuova funzione chiamata actionShowError() al SiteController.

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

Step 3 - Vai all'URL http://localhost:8080/index.php?r=site/show-error. Vedrai un messaggio di avviso.

Se vuoi mostrare all'utente che la sua richiesta non è valida, puoi lanciare il file yii\web\NotFoundHttpException.

Step 4 - Modifica il file actionShowError() funzione.

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

Step 5 - Digita l'indirizzo http://localhost:8080/index.php?r=site/show-errornella barra degli indirizzi. Vedrai il seguente errore HTTP.

Quando la costante YII_DEBUG è vera, il gestore degli errori visualizzerà gli errori con uno stack di chiamate dettagliato. Quando la costante è falsa, verrà visualizzato solo il messaggio di errore. Per impostazione predefinita, il gestore degli errori mostra gli errori utilizzando queste visualizzazioni:

• @yii/views/errorHandler/exception.php - il file di visualizzazione viene utilizzato quando gli errori devono essere visualizzati con le informazioni sullo stack di chiamate.

• @yii/views/errorHandler/error.php - il file di visualizzazione viene utilizzato quando gli errori devono essere visualizzati senza le informazioni sullo stack di chiamate.

È possibile utilizzare azioni di errore dedicate per personalizzare la visualizzazione degli errori.

Step 6 - Modifica il file errorHandler componente dell'applicazione in config/web.php file.

<?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;
?>

La configurazione precedente definisce che quando un errore deve essere visualizzato senza lo stack di chiamate, il file site/error l'azione verrà eseguita.

Step 7 - Modifica il file actions() metodo del SiteController.

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

Il codice sopra definisce che quando un file error si verifica, verrà eseguito il rendering della vista degli errori.

Step 8 - Crea un file chiamato error.php nella directory 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 - Vai all'indirizzo http://localhost:8080/index.php?r=site/show-error, vedrai la visualizzazione degli errori personalizzata.