Cookie Helper

The Cookie Helper file contains functions that assist in working withcookies.

Loading this Helper

This helper is loaded using the following code:

  1. helper('cookie');

Available Functions

The following functions are available:

  • setcookie($name[, $value = ''[, $expire = ''[, $domain = ''[, $path = '/'[, $prefix = ''[, $secure = false[, $httpOnly = false_]]]]]]])

Parameters:

  • $name (mixed) – Cookie name or associative array of all of the parameters available to this function
  • $value (string) – Cookie value
  • $expire (int) – Number of seconds until expiration
  • $domain (string) – Cookie domain (usually: .yourdomain.com)
  • $path (string) – Cookie path
  • $prefix (string) – Cookie name prefix
  • $secure (bool) – Whether to only send the cookie through HTTPS
  • $httpOnly (bool) – Whether to hide the cookie from JavaScriptReturn type:void

This helper function gives you friendlier syntax to set browsercookies. Refer to the Response Library fora description of its use, as this function is an alias forResponse::setCookie().

  • getcookie($index[, $xssClean = false_])

Parameters:

  • $index (string) – Cookie name
  • $xss_clean (bool) – Whether to apply XSS filtering to the returned valueReturns:The cookie value or NULL if not foundReturn type:mixed

This helper function gives you friendlier syntax to get browsercookies. Refer to the IncomingRequest Library fordetailed description of its use, as this function acts verysimilarly to IncomingRequest::getCookie(), except it will also prependthe $cookiePrefix that you might’ve set in yourapp/Config/App.php file.

  • deletecookie($name[, $domain = ''[, $path = '/'[, $prefix = ''_]]])

Parameters:

  • $name (string) – Cookie name
  • $domain (string) – Cookie domain (usually: .yourdomain.com)
  • $path (string) – Cookie path
  • $prefix (string) – Cookie name prefixReturn type:void

Lets you delete a cookie. Unless you’ve set a custom path or othervalues, only the name of the cookie is needed.

  1. delete_cookie('name');

This function is otherwise identical to set_cookie(), except that itdoes not have the value and expiration parameters. You can submit anarray of values in the first parameter or you can set discreteparameters.

  1. delete_cookie($name, $domain, $path, $prefix);