Yii-using-cookies

提供:Dev Guides
移動先:案内検索

Yii-クッキーの使用

Cookieを使用すると、リクエスト間でデータを保持できます。 PHPでは、 $ _ COOKIE 変数を介してアクセスできます。 YiiはCookieを yii \ web \ Cookie クラスのオブジェクトとして表します。 この章では、Cookieを読み取るためのいくつかの方法について説明します。

ステップ1 *- *SiteControlleractionReadCookies メソッドを作成します。

public function actionReadCookies() {
  //get cookies from the "request" component
   $cookies = Yii::$app->request->cookies;
  //get the "language" cookie value
  //if the cookie does not exist, return "ru" as the default value
   $language = $cookies->getValue('language', 'ru');
  //an alternative way of getting the "language" cookie value
   if (($cookie = $cookies->get('language')) !== null) {
      $language = $cookie->value;
   }
  //you may also use $cookies like an array
   if (isset($cookies['language'])) {
      $language = $cookies['language']->value;
   }
  //check if there is a "language" cookie
   if ($cookies->has('language')) echo "Current language: $language";
}

ステップ2 *-Cookieの送信動作を確認するには、 *SiteControlleractionSendCookies というメソッドを作成します。

public function actionSendCookies() {
  //get cookies from the "response" component
   $cookies = Yii::$app->response->cookies;
  //add a new cookie to the response to be sent
   $cookies->add(new \yii\web\Cookie([
      'name' => 'language',
      'value' => 'ru-RU',
   ]));
   $cookies->add(new \yii\web\Cookie([
      'name' => 'username',
      'value' => 'John',
   ]));
   $cookies->add(new \yii\web\Cookie([
      'name' => 'country',
      'value' => 'USA',
   ]));
}

ステップ3 *- *http://localhost:8080/index.php?r = site/send-cookies にアクセスすると、Cookieがブラウザー内に保存されていることがわかります。

Cookieを保存

Yiiでは、デフォルトでCookie検証が有効になっています。 Cookieがクライアント側で変更されるのを防ぎます。 config/web.phpファイルのハッシュ文字列は、各Cookieに署名します。

<?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' => [
            'traceLevel' => YII_DEBUG ? 3 : 0,
            'targets' => [
               [
                  'class' => 'yii\log\FileTarget',
                     'levels' => ['error', 'warning'],
                ],
            ],
         ],
         'urlManager' => [
           //'showScriptName' => false,
           //'enablePrettyUrl' => true,
           //'enableStrictParsing' => true,
           //'suffix' => '/'
         ],
         '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;
?>
*yii \ web \ Request
$ enableCookieValidation* プロパティを false に設定すると、Cookie検証を無効にできます。