CakePHP Cookie 管理


使用 CakePHP 处理 Cookie 既简单又安全,CakePHP 有一个 CookieComponent 类用于管理 Cookie,该类提供了几种使用 Cookie 的方法:

要使用 cookie,在控制器中引入这两个类:

use Cake\Http\Cookie\Cookie;
use Cake\Http\Cookie\CookieCollection;

必须首先创建 cookie 对象才能注册 cookie:

$cookie = new Cookie(name,value,expiration time,path,domain);

name和value是必填的,其他是可选的参数。

写入 Cookie 


以下是写入 Cookie 的语法:

$cookie = new Cookie(name,value,expiration time,path,domain);

创建的 cookie 必须添加到 cookieCollection 中,如下所示:

$cookie = new Cookie('name','XYZ');
$cookies = new CookieCollection([$cookie]);

如果已经创建了 cookie 集合对象,则可以添加其余的 cookie,如下所示:

$cookies = $cookies->add($cookie);

读取 Cookie 


要读取 cookie,需要使用 cookiecollection 中的 get() 方法。

语法

读取cookie的语法如下:

Cake\Http\Cookie\CookieCollection::get($name)

这将返回 cookiecollection 接口,要获取 cookie 的值,需要调用方法 getValue()。

Cake\Http\Cookie\CookieCollection Interface::getValue()

检查 Cookie 


CookieCollection的has()方法会告诉你 cookie 是否存在:

Cake\Http\Cookie\CookieCollection::has($name)
echo $isPresent = $this->cookies->has('name');

删除 Cookie


CookieCollection的remove()方法用于删除cookie,以下是 remove() 方法的语法:

Cake\Http\Cookie\CookieCollection::remove($name)

remove() 方法接受一个参数,即要删除的 cookie 变量的名称。

示例 1

$test = $this->cookies->remove('name');

示例 2

修改config/routes.php文件,如下所示:

<?php
use Cake\Http\Middleware\CsrfProtectionMiddleware;
use Cake\Routing\Route\DashedRoute;
use Cake\Routing\RouteBuilder;
$routes->setRouteClass(DashedRoute::class);
$routes->scope('/', function (RouteBuilder $builder) {
    $builder->registerMiddleware('csrf', new CsrfProtectionMiddleware([
        'httpOnly' => true,
    ]));
    $builder->applyMiddleware('csrf');
    // $builder->connect('/pages',['controller'=>'Pages','action'=>'display', 'home']);
    $builder->connect('cookie/testcookies',['controller'=>'Cookies','action'=>'testCookies']);
    $builder->fallbacks();
});

新建src/Controller/Cookies/CookiesController.php文件,并将以下代码复制到该文件中:

<?php
    namespace App\Controller;
    use App\Controller\AppController;
    use Cake\Http\Cookie\Cookie;
    use Cake\Http\Cookie\CookieCollection;
    class CookiesController extends AppController{
        public $cookies;
        public function testCookies() {
            $cookie = new Cookie('name','XYZ');
            $this->cookies = new CookieCollection([$cookie]);
            $cookie_val = $this->cookies->get('name');
            $this->set('cookie_val',$cookie_val->getValue());
            $isPresent = $this->cookies->has('name');
            $this->set('isPresent',$isPresent);
            $this->set('count', $this->cookies->count());
            $test = $this->cookies->remove('name');
            $this->set('count_afterdelete', $test->count());
        }
    }
?>

新建src/Template/Cookie/test_cookies.php文件,并将以下代码复制到该文件中:

The value of the cookie is: <?php echo $cookie_val; ?>

<br/>
<?php
    if($isPresent):
?>
The cookie is present.
<?php
    else:
?>
The cookie isn't present.
<?php
    endif;
?>
<br/>
<?php
    echo "The count of cookie before delete is :" .$count;
?>
<br/>
<?php
    echo "The count of cookie after delete is :" .$count_afterdelete;
?>

访问http://localhost/cakephp4/cookie/testcookies执行上述示例,输出如下所示:

Cookie