Cookie helper.
Class declared in SYSPATH/classes/Cookie.php on line 3.
string $domainlink to thisRestrict the domain that the cookie is available to
NULL
integer $expirationlink to thisNumber of seconds before the cookie expires
integer 0
boolean $httponlylink to thisOnly transmit cookies over HTTP, disabling Javascript access
bool FALSE
string $pathlink to thisRestrict the path that the cookie is available to
string(1) "/"string $saltlink to thisMagic salt to add to the cookie
string(4) "null"boolean $securelink to thisOnly transmit cookies over secure connections
bool FALSE
Deletes a cookie by making the value null and expiring it.
Cookie::delete('theme');
string
$name
required - Cookie name boolean
publicstaticfunctiondelete($name){// Remove the cookieunset($_COOKIE[$name]);// Nullify the cookie and make it expirereturnstatic::_setcookie($name, null, -86400, Cookie::$path, Cookie::$domain, Cookie::$secure, Cookie::$httponly);}
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');
string
$key
required - Cookie name mixed
$default
= NULL - Default value to return string
publicstaticfunctionget($key,$default= null){if(!isset($_COOKIE[$key])) {// The cookie does not existreturn$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 valuelist ($hash,$value) =explode('~',$cookie, 2);if(Security::slow_equals(Cookie::salt($key,$value),$hash)) {// Cookie signature is validreturn$value;}// The cookie signature is invalid, delete itstatic::delete($key);}return$default;}
Generates a salt string for a cookie based on the name and value.
$salt= Cookie::salt('theme','red');
string
$name
required - Name of cookie string
$value
required - Value of cookie
string
publicstaticfunctionsalt($name,$value){// Require a valid saltif(!Cookie::$salt) {thrownewKohana_Exception('A valid cookie salt is required. Please set Cookie::$salt in your bootstrap.php. For more information check the documentation');}// Determine the user agent$agent= isset($_SERVER['HTTP_USER_AGENT']) ?strtolower($_SERVER['HTTP_USER_AGENT']) :'unknown';returnhash_hmac('sha1',$agent.$name.$value. Cookie::$salt, Cookie::$salt);}
Sets a signed cookie. Note that all cookie values must be strings and no automatic serialization will be performed!
By default, Cookie::$expiration is 0 - if you skip/pass null for the optional lifetime argument your cookies will expire immediately unless you have separately configured Cookie::$expiration.
// Set the "theme" cookieCookie::set('theme','red');
string
$name
required - Name of cookie string
$value
required - Value of cookie integer
$lifetime
= NULL - Lifetime in seconds boolean
publicstaticfunctionset($name,$value,$lifetime= null){if($lifetime=== null) {// Use the default expiration$lifetime= Cookie::$expiration;}if($lifetime!== 0) {// The expiration is expected to be a UNIX timestamp$lifetime+=static::_time();}// Add the salt to the cookie value$value= Cookie::salt($name,$value) .'~'.$value;returnstatic::_setcookie($name,$value,$lifetime, Cookie::$path, Cookie::$domain, Cookie::$secure, Cookie::$httponly);}
Proxy for the native setcookie function - to allow mocking in unit tests so that they do not fail when headers have been sent.
string
$name
required - $name string
$value
required - $value integer
$expire
required - $expire string
$path
required - $path string
$domain
required - $domain boolean
$secure
required - $secure boolean
$httponly
required -
bool
protectedstaticfunction_setcookie($name,$value,$expire,$path,$domain,$secure,$httponly){returnsetcookie($name,$value,$expire,$path,$domain,$secure,$httponly);}
Proxy for the native time function - to allow mocking of time-related logic in unit tests
int
protectedstaticfunction_time(){returntime();}