Cookies

17 Mar 2025 | 阅读 2 分钟

Cookie 是服务器嵌入用户系统中的一个小文件，用于识别用户。

在 Yii 中，每个 cookie 都是 yii\web\Cookie 的一个对象。

yii\web\Request (请求中提交的 cookie 集合) 和 yii\web\Response (需要发送给用户的 cookie 集合) 通过名为 cookies 的属性来维护 cookie 的集合。

控制器处理应用程序中的 cookie 请求和响应。因此，应该在控制器中读取和发送 cookie。

设置 Cookies

使用以下代码将 Cookie 发送给最终用户。

// get the cookie collection (yii\web\CookieCollection) 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' => 'name',
    'value' => 'sssit',
]));

获取 Cookies

要获取 Cookie，请使用以下代码。

// get the cookie collection (yii\web\CookieCollection) from the "request" component
$cookies = Yii::$app->request->cookies;

// get the cookie value. If the cookie does not exist, return "default" as the default value.
$name = $cookies->getValue('name', 'default');

// an alternative way of getting the "name" cookie value
if (($cookie = $cookies->get('name')) !== null) {
    $name = $cookie->value;
}

// you may also use $cookies like an array
if (isset($cookies['name'])) {
    $name = $cookies['name']->value;
}

// check if there is a "name" cookie
if ($cookies->has('name')) ...
if (isset($cookies['name'])) ...

移除 Cookies

要移除 Cookie，请使用 Yii 的 remove() 函数。

$cookies = Yii::$app->response->cookies;
// remove a cookie
$cookies->remove('name');
// equivalent to the following
unset($cookies['name']);

示例

让我们看一个设置和显示 cookie 值的示例。

步骤 1 在 SiteController.php 文件中添加两个 action：actionSetCookie 和 actionShowCookie。

class SiteController extends Controller 
{ 
    /** 
     * @inheritdoc 
     */ 
    public function behaviors() 
    { 
        return [ 
            'access' => [ 
                'class' => AccessControl::className(), 
                'only' => ['logout', 'signup'], 
                'rules' => [ 
                    [ 
                        'actions' => ['signup'], 
                        'allow' => true, 
                        'roles' => ['?'], 
                    ], 
                    [ 
                        'actions' => ['logout', 'set-cookie', 'show-cookie'], 
                        'allow' => true, 
                        'roles' => ['@'], 
                    ], 
                ], 
            ], 
            'verbs' => [ 
                'class' => VerbFilter::className(), 
                'actions' => [ 
                    'logout' => ['post'], 
                ], 
            ], 
        ]; 
    } 

    /** 
     * @inheritdoc 
     */ 
    public function actions() 
   { 
        return [ 
            'error' => [ 
                'class' => 'yii\web\ErrorAction', 
            ], 
            'captcha' => [ 
                'class' => 'yii\captcha\CaptchaAction', 
                'fixedVerifyCode' => YII_ENV_TEST ? 'testme' : null, 
            ], 
        ]; 
    } 

    public function actionSetCookie() 
    { 
        $cookies = Yii::$app->response->cookies; 
        $cookies->add(new \yii\web\Cookie 
            ([ 
            'name' => 'test', 
            'value' => 'SSSIT Pvt. Ltd.' 
            ])); 
    } 

    public function actionShowCookie() 
    { 
        if(Yii::$app->getRequest()->getCookies()->has('test')) 
        { 
            print_r(Yii::$app->getRequest()->getCookies()->getValue('test')); 
        } 
    } 

步骤 2 在浏览器上运行它以首先使用以下 URL 设置 cookie：

https:///cook/frontend/web/index.php?r=site/set-cookie