boaPHP开发手册v5.5

cookie类
版本 1.0+
命名空间 boa
文件 boa/cookie.php
说明 cookie类(会话客户端),继承base类,配置:'COOKIE' => [],
配置
配置项 默认值 类型 说明
prefix bs_ string cookie前缀
lifetime 0 int cookie有效期(秒),0=关闭浏览器就失效
path / string cookie有效路径
domain string cookie有效域名
secure false bool cookie是否仅通过HTTPS传输
httponly true bool cookie是否无法通过JavaScript等脚本访问
目录
方法 说明
cfg() 获取或设置配置信息
get() 获取cookie
set() 设置cookie
del() 删除cookie
clear() 清理cookie
方法

cfg()

说明
获取或设置配置信息
参数 必须 默认值 类型 说明
$k null string
$v null string
返回值
同 base 类
示例
$cookie = boa::cookie();
$cookie->cfg('domain', '.boasoft.top'); // 设置域

get()

说明
获取cookie
参数 必须 默认值 类型 说明
$key Y string cookie名称
返回值
返回有效期内cookie值(string)
示例
$name = $cookie->get('name');

set()

说明
设置cookie
参数 必须 默认值 类型 说明
$key Y string cookie名称
$val Y string cookie值
$ttl null int cookie有效期(秒),默认为lifetime配置
$enc false bool 是否加密
返回值
成功返回true(bool),失败返回false(bool)
示例
$cookie->set('name', $name, 86400); // 1天有效期

del()

说明
删除cookie
参数 必须 默认值 类型 说明
$key Y string cookie名称
返回值
成功返回true(bool),失败返回false(bool)
示例
$cookie->del('name');

clear()

说明
清理cookie
示例
$cookie->clear(); // 删除同域下所有cookie