Yii - Registrazione

Yii fornisce un framework altamente personalizzabile ed estensibile. Con l'aiuto di questo framework, puoi facilmente registrare vari tipi di messaggi.

Per registrare un messaggio, è necessario chiamare uno dei seguenti metodi:

  • Yii::error() - Registra un messaggio di errore irreversibile.

  • Yii::warning() - Registra un messaggio di avviso.

  • Yii::info() - Registra un messaggio con alcune informazioni utili.

  • Yii::trace() - Registra un messaggio per tracciare come viene eseguita una parte di codice.

I metodi sopra riportati registrano i messaggi di registro in varie categorie. Condividono la seguente firma della funzione:

function ($message, $category = 'application')

dove -

  • $message - Il messaggio di registro da registrare

  • $category - La categoria del messaggio di registro

Un modo semplice e conveniente per denominare lo schema è usare la costante magica PHP __METHOD__. Ad esempio:

Yii::info('this is a log message', __METHOD__);

Una destinazione del log è un'istanza della classe yii \ log \ Target. Filtra tutti i messaggi di registro per categorie e li esporta in file, database e / o e-mail.

Step 1 - Puoi anche registrare più target di log, come.

return [
   // the "log" component is loaded during bootstrapping time
   'bootstrap' => ['log'],
   'components' => [
      'log' => [
         'targets' => [
            [
               'class' => 'yii\log\DbTarget',
               'levels' => ['error', 'warning', 'trace', 'info'],
            ],
            [
               'class' => 'yii\log\EmailTarget',
               'levels' => ['error', 'warning'],
               'categories' => ['yii\db\*'],
               'message' => [
                  'from' => ['[email protected]'],
                  'to' => ['[email protected]', '[email protected]'],
                  'subject' => 'Application errors at mydomain.com',
               ],
            ],
         ],
      ],
   ],
];

Nel codice precedente, sono registrati due obiettivi. Il primo target seleziona tutti gli errori, avvisi, tracce e messaggi informativi e li salva in un database. Il secondo obiettivo invia tutti i messaggi di errore e di avviso all'email dell'amministratore.

Yii fornisce le seguenti destinazioni di registro integrate:

  • yii\log\DbTarget - Memorizza i messaggi di registro in un database.

  • yii\log\FileTarget - Salva i messaggi di registro nei file.

  • yii\log\EmailTarget - Invia messaggi di registro a indirizzi e-mail predefiniti.

  • yii\log\SyslogTarget - Salva i messaggi di log in syslog chiamando la funzione PHP syslog ().

Per impostazione predefinita, i messaggi di registro sono formattati come segue:

Timestamp [IP address][User ID][Session ID][Severity Level][Category] Message Text

Step 2 - Per personalizzare questo formato, è necessario configurare il file yii\log\Target::$prefixproprietà. Per esempio.

[
   'class' => 'yii\log\FileTarget',
   'prefix' => function ($message) {
      $user = Yii::$app->has('user', true) ? Yii::$app->get('user') : 'undefined user'; $userID = $user ? $user->getId(false) : 'anonym';
      return "[$userID]";
   }
]

Lo snippet di codice precedente configura una destinazione di log in modo che tutti i messaggi di log siano preceduti dall'ID utente corrente.

Per impostazione predefinita, i messaggi di registro includono i valori di queste variabili PHP globali: $ _GET, $_POST, $_SESSIONE, $_COOKIE, $_FILES e $ _SERVER. Per modificare questo comportamento, è necessario configurare ilyii\log\Target::$logVars proprietà con i nomi delle variabili che desideri includere.

Tutti i messaggi di registro vengono mantenuti in una matrice dall'oggetto logger. L'oggetto logger scaricava i messaggi registrati nelle destinazioni di log ogni volta che l'array accumula un certo numero di messaggi (il valore predefinito è 1000).

Step 3 - Per personalizzare questo numero, è necessario chiamare il flushInterval property.

return [
   'bootstrap' => ['log'],
   'components' => [
      'log' => [
         'flushInterval' => 50, // default is 1000
         'targets' => [...],
      ],
   ],
];

Anche quando l'oggetto logger scarica i messaggi di log nelle destinazioni di log, questi non vengono esportati immediatamente. L'esportazione avviene quando una destinazione del log accumula un certo numero di messaggi (il valore predefinito è 1000).

Step 4 - Per personalizzare questo numero, è necessario configurare il file exportInterval proprietà.

[
   'class' => 'yii\log\FileTarget',
   'exportInterval' => 50, // default is 1000
]

Step 5 - Ora, modifica il file config/web.php archiviare in questo modo.

<?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',
         ],
         'mailer' => [
            'class' => 'yii\swiftmailer\Mailer',
            // send all mails to a file by default. You have to set
            // 'useFileTransport' to false and configure a transport
            // for the mailer to send real emails.
            'useFileTransport' => true,
         ],
         'log' => [
            'flushInterval' => 1,
            'traceLevel' => YII_DEBUG ? 3 : 0,
            'targets' => [
               [
                  'class' => 'yii\log\FileTarget',
                  'exportInterval' => 1,
                  'logVars' => []
               ],
            ],
         ],
         '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;
?>

Nel codice sopra, definiamo il componente dell'applicazione di log, impostiamo l'estensione flushInterval e exportIntevalproprietà su 1 in modo che tutti i messaggi di registro vengano visualizzati immediatamente nei file di registro. Omettiamo anche la proprietà levels della destinazione del log. Significa che i messaggi di registro di tutte le categorie (errore, avviso, informazioni, traccia) appariranno nei file di registro.

Step 6 - Quindi, crea una funzione chiamata actionLog () nel SiteController.

public function actionLog() {
   Yii::trace('trace log message');
   Yii::info('info log message');
   Yii::warning('warning log message');
   Yii::error('error log message');
}

Nel codice precedente, scriviamo solo quattro messaggi di registro di diverse categorie nei file di registro.

Step 7 - Digita l'URL http://localhost:8080/index.php?r=site/lognella barra degli indirizzi del browser web. I messaggi di log dovrebbero apparire nella directory app / runtime / logs nel file app.log.