CodeIgniter4 Cookie 辅助函数
Cookie 辅助函数文件包含一些协助 Cookie 运行的函数。
加载 Cookie 辅助函数
Cookie 辅助函数文件使用下面的代码加载:
helper('cookie');
函数参考
该辅助函数有下列可用函数:
set_cookie
($name[, $value = ''[, $expire = ''[, $domain = ''[, $path = '/'[, $prefix = ''[, $secure = false[, $httpOnly = false]]]]]]])
参数: | $name (mixed) – Cookie 名称 或 对这函数所有通用参数的关联数组 |
---|---|
$value (string) – Cookie 值 | |
$expire (int) – 直到截止时的秒数 | |
$domain (string) – Cookie 域名 (通常是: .yourdomain.com) | |
$path (string) – Cookie 路径 | |
$prefix (string) – Cookie 名称前缀 | |
$secure (bool) – 是否仅仅通过 HTTPS 发送 Cookie | |
$httpOnly (bool) – 是否从 JavaScript 中隐藏 Cookie | |
返回类型: | void |
辅助函数给你更友好的语法去 设置 浏览器的 Cookies. 辅助函数使用的说明参考 响应库 , 同时对 Response::setCookie()
来说 Cookie 辅助函数是别称.
get_cookie
($index[, $xssClean = false])
参数: | $index (string) – Cookie 名称 |
---|---|
$xss_clean (bool) – 返回值是否应用在 XSS 过滤中 | |
返回: | 返回 Cookie 值而如果没有则为空 |
返回类型: | mixed |
辅助函数给你更友好的语法去 获取 浏览器的 Cookies. 辅助函数详细的使用说明参考 传入请求库 同时辅助函数的作用非常近似于 IncomingRequest::getCookie()
, 你也许已经设置在你的 application/Config/App.php 文件里除了它也预置了 $cookiePrefix
.
delete_cookie
($name[, $domain = ''[, $path = '/'[, $prefix = '']]])
参数: | $name (string) – Cookie 名称 |
---|---|
$domain (string) – Cookie 域名 (通常是: .yourdomain.com) | |
$path (string) – Cookie 路径 | |
$prefix (string) – Cookie 名称前缀 | |
返回类型: | void |
该函数让你删除一个 Cookie. 除非你已经设置了一个定制路径或者其他值,仅仅 Cookie 的名字是必须的。
delete_cookie('name');
这个函数除了没有值和截止参数,它对 set_cookie()
来说在其他方面是恒等的。 你能在第一参数里确定数组值或者你要设置 非连续 参数。
delete_cookie($name, $domain, $path, $prefix);