mirror of
https://github.com/silverstripe/silverstripe-framework
synced 2024-10-22 14:05:37 +02:00
ebb2458f22
Previous to this the Cookie class has been very inflexible (cookies are all set using the static Cookie::set() and so the functionality is not extendable). Cookie class has been adjusted so extension is now a possibility for those wishing to alter its functionality. Improves compliance to the law of demeter.
93 lines
2.5 KiB
PHP
93 lines
2.5 KiB
PHP
<?php
|
|
/**
|
|
* A set of static methods for manipulating cookies.
|
|
*
|
|
* @package framework
|
|
* @subpackage misc
|
|
*/
|
|
class Cookie {
|
|
|
|
/**
|
|
* @var boolean
|
|
*/
|
|
static $report_errors = true;
|
|
|
|
/**
|
|
* Cookie class and instance for extendability purposes
|
|
*/
|
|
static $cookie_class = 'Cookie';
|
|
|
|
static $inst = null;
|
|
|
|
public static function get_inst() {
|
|
if(is_null(self::$inst)) {
|
|
self::$inst = new self::$cookie_class();
|
|
}
|
|
return self::$inst;
|
|
}
|
|
|
|
/**
|
|
* Set a cookie variable
|
|
*
|
|
* @param string $name The variable name
|
|
* @param string $value The variable value.
|
|
* @param int $expiry The expiry time, in days. Defaults to 90.
|
|
* @param string $path See http://php.net/set_session
|
|
* @param string $domain See http://php.net/set_session
|
|
* @param boolean $secure See http://php.net/set_session
|
|
* @param boolean $httpOnly See http://php.net/set_session
|
|
*/
|
|
static function set($name, $value, $expiry = 90, $path = null, $domain = null, $secure = false, $httpOnly = false) {
|
|
return self::get_inst()->inst_set($name, $value, $expiry, $path, $domain, $secure, $httpOnly);
|
|
}
|
|
|
|
/**
|
|
* Get a cookie variable
|
|
*/
|
|
static function get($name) {
|
|
return self::get_inst()->inst_get($name);
|
|
}
|
|
|
|
static function forceExpiry($name, $path = null, $domain = null) {
|
|
return self::get_inst()->inst_forceExpiry($name, $path, $domain);
|
|
}
|
|
|
|
static function set_report_errors($reportErrors) {
|
|
return self::get_inst()->inst_set_report_errors($reportErrors);
|
|
}
|
|
|
|
static function report_errors() {
|
|
return self::get_inst()->inst_report_errors();
|
|
}
|
|
|
|
public function inst_set($name, $value, $expiry = 90, $path = null, $domain = null, $secure = false, $httpOnly = false) {
|
|
if(!headers_sent($file, $line)) {
|
|
$expiry = $expiry > 0 ? time()+(86400*$expiry) : $expiry;
|
|
$path = ($path) ? $path : Director::baseURL();
|
|
setcookie($name, $value, $expiry, $path, $domain, $secure, $httpOnly);
|
|
} else {
|
|
if(self::$report_errors) {
|
|
user_error("Cookie '$name' can't be set. The site started outputting was content at line $line in $file", E_USER_WARNING);
|
|
}
|
|
}
|
|
}
|
|
|
|
public function inst_get($name) {
|
|
return isset($_COOKIE[$name]) ? $_COOKIE[$name] : null;
|
|
}
|
|
|
|
public function inst_forceExpiry($name, $path = null, $domain = null) {
|
|
if(!headers_sent($file, $line)) {
|
|
self::set($name, null, -20, $path, $domain);
|
|
}
|
|
}
|
|
|
|
public function inst_set_report_errors($reportErrors) {
|
|
self::$report_errors = $reportErrors;
|
|
}
|
|
|
|
public function report_errors() {
|
|
return self::$report_errors;
|
|
}
|
|
}
|