Cookie · tp5文档

# Cookie ThinkPHP使用`think\Cookie`类提供Cookie支持。 ## 初始化大多数情况下，我们不需要进行`Cookie`的初始化，系统会在调用`Cooie`类方法的时候自动根据`cache`配置参数初始化，如果需要可以手动使用`init`方法进行初始化设置，例如： ``` <pre class="calibre18"> ``` // cookie初始化 Cookie::init(['prefix'=>'think_', 'expire'=>3600, 'path'=>'/']); // 单独指定当前前缀 Cookie::prefix('think_'); ``` ``` 支持的参数及默认值如下： ``` <pre class="calibre18"> ``` // cookie 名称前缀'prefix' => '', // cookie 保存时间'expire' => 0, // cookie 保存路径'path' => '/', // cookie 有效域名'domain' => '', // cookie 启用安全传输'secure' => false, // httponly设置'httponly' => '', // 是否使用 setcookie'setcookie' => true, ``` ``` ## 读取Cookie 建议的读取`Cookie`数据的方法是通过`Request`请求对象的`cookie`方法（原因和Session读取一样），例如： ``` <pre class="calibre18"> ``` namespace app\index\controller; use think\Request; class User{ public function index(Request $request){ echo $request->cookie('user_name'); // 读取二维数组echo $request->cookie('user.name'); } } ``` ``` > 通过Request对象读取Cookie数据支持默认值及过滤方法，因此也更加安全，并且支持多维数组的读取。当然也支持使用`Cookie`类直接读取数据： ``` <pre class="calibre18"> ``` namespace app\index\controller; use think\Cookie; class User{ public function index(){ echo Cookie::get('user_name'); } } ``` ``` > Cookie::get方法不支持读取二维数组数据。 ## 模板输出同样，可以使用下面的方法在模板文件中输出Cookie值。 ``` <pre class="calibre18"> ``` {$Request.cookie.user_name} ``` ``` ## `Cookie`操作下面是一些关于Cookie的基础操作方法。 ### 设置 ``` <pre class="calibre18"> ``` // 设置Cookie 有效期为 3600秒 Cookie::set('name','value',3600); // 设置cookie 前缀为think_ Cookie::set('name','value',['prefix'=>'think_', 'expire'=>3600]); // 支持数组 Cookie::set('name',[1,2,3]); ``` ``` ### 判断 ``` <pre class="calibre18"> ``` Cookie::has('name'); // 判断指定前缀的cookie值是否存在Cookie::has('name','think_'); ``` ``` ### 获取 ``` <pre class="calibre18"> ``` Cookie::get('name'); // 获取指定前缀的cookie值Cookie::get('name','think_'); ``` ``` ### 删除 //删除cookie ``` <pre class="calibre18"> ``` Cookie::delete('name'); // 删除指定前缀的cookieCookie::delete('name','think_'); ``` ``` ### 清空 ``` <pre class="calibre18"> ``` // 清空指定前缀的cookieCookie::clear('think_'); ``` ``` > 注意，目前不支持清空所有的`Cookie`数据，如果必须这样做，请直接操作`$_COOKIE`变量。 ## 助手函数系统提供了`cookie`助手函数用于基本的`Cookie`操作，可以完成前面的所有功能，例如： ``` <pre class="calibre42"> ``` // 初始化 cookie(['prefix' => 'think_', 'expire' => 3600]); // 设置 cookie('name', 'value', 3600); // 判断 cookie('?name'); // 获取echo cookie('name'); // 删除 cookie('name', null); // 清除 cookie(null, 'think_'); ``` ```