mirror of
https://github.com/silverstripe/silverstripe-framework
synced 2024-10-04 23:28:41 +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
105 lines
2.3 KiB
PHP
105 lines
2.3 KiB
PHP
<?php
|
|
|
|
class CookieTest extends SapphireTest {
|
|
|
|
private $cookieInst;
|
|
|
|
public function setUpOnce() {
|
|
parent::setUpOnce();
|
|
Injector::nest();
|
|
}
|
|
|
|
public function tearDownOnce() {
|
|
parent::tearDownOnce();
|
|
//restore the cookie_backend
|
|
Injector::unnest();
|
|
}
|
|
|
|
public function setUp() {
|
|
parent::setUp();
|
|
Injector::inst()->registerService(new CookieJar($_COOKIE), 'Cookie_Backend');
|
|
}
|
|
|
|
public function tearDown() {
|
|
parent::tearDown();
|
|
Injector::inst()->unregisterNamedObject('Cookie_Backend');
|
|
}
|
|
|
|
/**
|
|
* Check a new cookie inst will be loaded with the superglobal by default
|
|
*/
|
|
public function testCheckNewInstTakesSuperglobal() {
|
|
//store the superglobal state
|
|
$existingCookies = $_COOKIE;
|
|
|
|
//set a mock state for the superglobal
|
|
$_COOKIE = array(
|
|
'cookie1' => 1,
|
|
'cookie2' => 'cookies',
|
|
'cookie3' => 'test',
|
|
);
|
|
|
|
Injector::inst()->unregisterNamedObject('Cookie_Backend');
|
|
|
|
$this->assertEquals($_COOKIE['cookie1'], Cookie::get('cookie1'));
|
|
$this->assertEquals($_COOKIE['cookie2'], Cookie::get('cookie2'));
|
|
$this->assertEquals($_COOKIE['cookie3'], Cookie::get('cookie3'));
|
|
|
|
//for good measure check the CookieJar hasn't stored anything extra
|
|
$this->assertEquals($_COOKIE, Cookie::get_inst()->getAll(false));
|
|
|
|
//restore the superglobal state
|
|
$_COOKIE = $existingCookies;
|
|
}
|
|
|
|
/**
|
|
* Check we don't mess with super globals when manipulating cookies
|
|
*
|
|
* State should be managed sperately to the super global
|
|
*/
|
|
public function testCheckSuperglobalsArentTouched() {
|
|
|
|
//store the current state
|
|
$before = $_COOKIE;
|
|
|
|
//change some cookies
|
|
Cookie::set('cookie', 'not me');
|
|
Cookie::force_expiry('cookie2');
|
|
|
|
//assert it hasn't changed
|
|
$this->assertEquals($before, $_COOKIE);
|
|
|
|
}
|
|
|
|
/**
|
|
* Check we can actually change a backend
|
|
*/
|
|
public function testChangeBackend() {
|
|
|
|
Cookie::set('test', 'testvalue');
|
|
|
|
$this->assertEquals('testvalue', Cookie::get('test'));
|
|
|
|
Injector::inst()->registerService(new CookieJar(array()), 'Cookie_Backend');
|
|
|
|
$this->assertEmpty(Cookie::get('test'));
|
|
|
|
}
|
|
|
|
/**
|
|
* Check we can actually get the backend inst out
|
|
*/
|
|
public function testGetInst() {
|
|
|
|
$inst = new CookieJar(array('test' => 'testvalue'));
|
|
|
|
Injector::inst()->registerService($inst, 'Cookie_Backend');
|
|
|
|
$this->assertEquals($inst, Cookie::get_inst());
|
|
|
|
$this->assertEquals('testvalue', Cookie::get('test'));
|
|
|
|
}
|
|
|
|
}
|