mirror of
https://github.com/silverstripe/silverstripe-framework
synced 2024-10-22 14:05:37 +02:00
3b9056fc01
I've decoupled `Cookie` from the actual act of setting and getting cookies. Currently there are a few limitations to how Cookie works that this change mitigates: 0. `Cookie` currently changes the super global `$_COOKIE` when setting to make the state of an application a bit more managable, but this is bad because we shouldn't be modifying super globals 0. One can't actually change the `$cookie_class` once the `Cookie::$inst` has been instantiated 0. One can't test cookies as there is no class that holds the state of the cookies (it's just held in the super global which is reset as part of `Director::test()` 0. One can't tell the origin of a cookie (eg: did the application set it and it needs to be sent, or did we receive it from the browser?) 0. `time()` was used, so testing was made difficult 0. There was no way to get all the cookies at once (without accessing the super global) Todos are on the phpdoc and I'd like to write some tests for the backend as well as update the docs (if there are any) around cookies. DOCS Adding `Cookie` docs Explains basic usage of `Cookie` as well as how the `Cookie_Backend` controls the setting and getting of cookies and manages state of sent vs received cookies Fixing `Cookie` usage `Cookie` is being used inconsistently with the API throughout framework. Either by not using `force_expiry` to expire cookies or setting them to null and then expiring them (which is redundant). NEW `Director::test()` takes `Cookie_Backend` rather than `array` for `$cookies` param
86 lines
2.3 KiB
PHP
86 lines
2.3 KiB
PHP
<?php
|
|
/**
|
|
* A set of static methods for manipulating cookies.
|
|
*
|
|
* @package framework
|
|
* @subpackage misc
|
|
*/
|
|
class Cookie {
|
|
|
|
/**
|
|
* @config
|
|
* @var boolean
|
|
*/
|
|
private static $report_errors = true;
|
|
|
|
/**
|
|
* Fetch the current instance of the cookie backend
|
|
*
|
|
* @return Cookie_Backend The cookie backend
|
|
*/
|
|
public static function get_inst() {
|
|
//if we don't have a CookieJar service yet, register it
|
|
if(!Injector::inst()->hasService('Cookie_Backend')) {
|
|
Injector::inst()->registerService(
|
|
Injector::inst()->create('CookieJar', $_COOKIE),
|
|
'Cookie_Backend'
|
|
);
|
|
}
|
|
return Injector::inst()->get('Cookie_Backend');
|
|
}
|
|
|
|
/**
|
|
* Set a cookie variable
|
|
*
|
|
* @param string $name The variable name
|
|
* @param mixed $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
|
|
*/
|
|
public static function set($name, $value, $expiry = 90, $path = null, $domain = null, $secure = false,
|
|
$httpOnly = true
|
|
) {
|
|
return self::get_inst()->set($name, $value, $expiry, $path, $domain, $secure, $httpOnly);
|
|
}
|
|
|
|
/**
|
|
* Get a cookie variable.
|
|
*
|
|
* @param string
|
|
* @return mixed
|
|
*/
|
|
public static function get($name) {
|
|
return self::get_inst()->get($name);
|
|
}
|
|
|
|
/**
|
|
* @param string
|
|
* @param string
|
|
* @param string
|
|
*/
|
|
public static function force_expiry($name, $path = null, $domain = null, $secure = false, $httpOnly = false) {
|
|
return self::get_inst()->forceExpiry($name, $path, $domain, $secure, $httpOnly);
|
|
}
|
|
|
|
/**
|
|
* @deprecated 3.2 Use the "Cookie.report_errors" config setting instead
|
|
* @param bool
|
|
*/
|
|
protected function set_report_errors($reportErrors) {
|
|
Deprecation::notice('3.2', 'Use the "Cookie.report_errors" config setting instead');
|
|
Config::inst()->update('Cookie', 'report_errors', $reportErrors);
|
|
}
|
|
|
|
/**
|
|
* @deprecated 3.2 Use the "Cookie.report_errors" config setting instead
|
|
* @return bool
|
|
*/
|
|
protected function report_errors() {
|
|
Deprecation::notice('3.2', 'Use the "Cookie.report_errors" config setting instead');
|
|
return Config::inst()->get('Cookie', 'report_errors');
|
|
}
|
|
}
|