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
• $sameSite (string) – The value for the SameSite cookie parameter. If null, the default from config/App.php is used

傳回型態:

void

這個輔助函數功能給你更友善的語法來設定瀏覽器 cookie。 請參閱 回應庫 對應它的使用說明, 由於此函數是 Response::setCookie() 的一種。

get_cookie($index[, $xssClean = false])

參數:

• $index (string) – Cookie 名稱
• $xss_clean (bool) – 是否對回傳值使用 XSS 過濾

傳回:

cookie 值或如果沒找到的 NULL

傳回型態:

混合的

此輔助函數功能提供更友善的語法以取得 cookie。 由於此功能的動作與 IncomingRequest::getCookie() 相似， 請參照 傳入請求庫 以找到更詳細的使用說明。除非它同時也會預置你可能預先設定在你的 app/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);

has_cookie(string $name[, ?string $value = null[, string $prefix = '']])

參數:

• $name (string) – Cookie name
• $value (string|null) – Cookie value
• $prefix (string) – Cookie prefix

傳回型態:

bool

Checks if a cookie exists by name. This is an alias of Response::hasCookie().