Modules
Cookie
extends Kohana_Cookie
Cookie helper.
Class declared in SYSPATH/classes/cookie.php on line 3.
Constants
- None
Properties
public static
string$domainRestrict the domain that the cookie is available to
NULL
public static
integer$expirationNumber of seconds before the cookie expires
integer 0
public static
boolean$httponlyOnly transmit cookies over HTTP, disabling Javascript access
bool FALSE
public static
string$pathRestrict the path that the cookie is available to
string(1) "/"public static
string$saltMagic salt to add to the cookie
string(5) "kooky"public static
boolean$secureOnly transmit cookies over secure connections
bool FALSE
Methods
public static delete( string $name ) (defined in Kohana_Cookie)
Deletes a cookie by making the value NULL and expiring it.
Cookie::delete('theme');
Parameters
-
string$name required - Cookie name
Tags
Return Values
boolean
Source Code
public static function delete($name)
{
// Remove the cookie
unset($_COOKIE[$name]);
// Nullify the cookie and make it expire
return Cookie::set($name, NULL, -86400);
}public static get( string $key [, mixed $default = NULL ] ) (defined in Kohana_Cookie)
Gets the value of a signed cookie. Cookies without signatures will not be returned. If the cookie signature is present, but invalid, the cookie will be deleted.
// Get the "theme" cookie, or use "blue" if the cookie does not exist
$theme = Cookie::get('theme', 'blue');
Parameters
-
string$key required - Cookie name -
mixed$default = NULL - Default value to return
Return Values
string
Source Code
public static function get($key, $default = NULL)
{
if ( ! isset($_COOKIE[$key]))
{
// The cookie does not exist
return $default;
}
// Get the cookie value
$cookie = $_COOKIE[$key];
// Find the position of the split between salt and contents
$split = strlen(Cookie::salt($key, NULL));
if (isset($cookie[$split]) AND $cookie[$split] === '~')
{
// Separate the salt and the value
list ($hash, $value) = explode('~', $cookie, 2);
if (Cookie::salt($key, $value) === $hash)
{
// Cookie signature is valid
return $value;
}
// The cookie signature is invalid, delete it
Cookie::delete($key);
}
return $default;
}public static salt( string $name , string $value ) (defined in Kohana_Cookie)
Generates a salt string for a cookie based on the name and value.
$salt = Cookie::salt('theme', 'red');
Parameters
-
string$name required - Name of cookie -
string$value required - Value of cookie
Return Values
string
Source Code
public static function salt($name, $value)
{
// Determine the user agent
$agent = isset($_SERVER['HTTP_USER_AGENT']) ? strtolower($_SERVER['HTTP_USER_AGENT']) : 'unknown';
return sha1($agent.$name.$value.Cookie::$salt);
}public static set( string $name , string $value [, integer $expiration = NULL ] ) (defined in Kohana_Cookie)
Sets a signed cookie. Note that all cookie values must be strings and no automatic serialization will be performed!
// Set the "theme" cookie
Cookie::set('theme', 'red');
Parameters
-
string$name required - Name of cookie -
string$value required - Value of cookie -
integer$expiration = NULL - Lifetime in seconds
Tags
Return Values
boolean
Source Code
public static function set($name, $value, $expiration = NULL)
{
if ($expiration === NULL)
{
// Use the default expiration
$expiration = Cookie::$expiration;
}
if ($expiration !== 0)
{
// The expiration is expected to be a UNIX timestamp
$expiration += time();
}
// Add the salt to the cookie value
$value = Cookie::salt($name, $value).'~'.$value;
return setcookie($name, $value, $expiration, Cookie::$path, Cookie::$domain, Cookie::$secure, Cookie::$httponly);
}