[HttpFoundation] Refactor away options property.

It does not make sense to try and store session ini directives since they can be changes outside
of the class as they are part of the global state.

Coding stan
This commit is contained in:
Drak 2012-03-08 15:11:10 +05:45
parent 21221f7cf6
commit 39526df67c
2 changed files with 39 additions and 30 deletions

View File

@ -76,7 +76,7 @@ class MockArraySessionStorage extends SessionStorage
*/ */
public function regenerate($destroy = false) public function regenerate($destroy = false)
{ {
if ($this->options['auto_start'] && !$this->started) { if (!$this->started) {
$this->start(); $this->start();
} }
@ -124,6 +124,22 @@ class MockArraySessionStorage extends SessionStorage
$this->loadSession($this->sessionData); $this->loadSession($this->sessionData);
} }
/**
* {@inheritdoc}
*/
public function getBag($name)
{
if (!isset($this->bags[$name])) {
throw new \InvalidArgumentException(sprintf('The SessionBagInterface %s is not registered.', $name));
}
if (!$this->started) {
$this->start();
}
return $this->bags[$name];
}
/** /**
* Generates a session ID. * Generates a session ID.
* *

View File

@ -30,11 +30,6 @@ class SessionStorage implements SessionStorageInterface
*/ */
protected $bags; protected $bags;
/**
* @var array
*/
protected $options = array();
/** /**
* @var boolean * @var boolean
*/ */
@ -93,6 +88,11 @@ class SessionStorage implements SessionStorageInterface
*/ */
public function __construct(array $options = array(), $handler = null) public function __construct(array $options = array(), $handler = null)
{ {
// sensible defaults
ini_set('session.auto_start', 0); // by default we prefer to explicitly start the session using the class.
ini_set('session.cache_limiter', ''); // disable by default because it's managed by HeaderBag (if used)
ini_set('session.use_cookies', 1);
$this->setOptions($options); $this->setOptions($options);
$this->setSaveHandler($handler); $this->setSaveHandler($handler);
} }
@ -116,7 +116,15 @@ class SessionStorage implements SessionStorageInterface
return true; return true;
} }
if ($this->options['use_cookies'] && headers_sent()) { // catch condition where session was started automatically by PHP
if (!$this->started && !$this->closed && $this->saveHandler->isActive()
&& $this->saveHandler->isSessionHandlerInterface()) {
$this->loadSession();
return true;
}
if (ini_get('session.use_cookies') && headers_sent()) {
throw new \RuntimeException('Failed to start the session because headers have already been sent.'); throw new \RuntimeException('Failed to start the session because headers have already been sent.');
} }
@ -131,9 +139,6 @@ class SessionStorage implements SessionStorageInterface
$this->saveHandler->setActive(false); $this->saveHandler->setActive(false);
} }
$this->started = true;
$this->closed = false;
return true; return true;
} }
@ -205,8 +210,10 @@ class SessionStorage implements SessionStorageInterface
throw new \InvalidArgumentException(sprintf('The SessionBagInterface %s is not registered.', $name)); throw new \InvalidArgumentException(sprintf('The SessionBagInterface %s is not registered.', $name));
} }
if ($this->options['auto_start'] && !$this->started) { if (ini_get('session.auto_start') && !$this->started) {
$this->start(); $this->start();
} else if ($this->saveHandler->isActive() && !$this->started) {
$this->loadSession();
} }
return $this->bags[$name]; return $this->bags[$name];
@ -218,30 +225,13 @@ class SessionStorage implements SessionStorageInterface
* For convenience we omit 'session.' from the beginning of the keys. * For convenience we omit 'session.' from the beginning of the keys.
* Explicitly ignores other ini keys. * Explicitly ignores other ini keys.
* *
* session_get_cookie_params() overrides values. * @param array $options Session ini directives array(key => value).
*
* @param array $options
* *
* @see http://php.net/session.configuration * @see http://php.net/session.configuration
*/ */
public function setOptions(array $options) public function setOptions(array $options)
{ {
$this->options = $options; foreach ($options as $key => $value) {
// set defaults for certain values
$defaults = array(
'cache_limiter' => '', // disable by default because it's managed by HeaderBag (if used)
'auto_start' => false,
'use_cookies' => true,
);
foreach ($defaults as $key => $value) {
if (!isset($this->options[$key])) {
$this->options[$key] = $value;
}
}
foreach ($this->options as $key => $value) {
if (in_array($key, array( if (in_array($key, array(
'auto_start', 'cache_limiter', 'cookie_domain', 'cookie_httponly', 'auto_start', 'cache_limiter', 'cookie_domain', 'cookie_httponly',
'cookie_lifetime', 'cookie_path', 'cookie_secure', 'cookie_lifetime', 'cookie_path', 'cookie_secure',
@ -322,5 +312,8 @@ class SessionStorage implements SessionStorageInterface
$session[$key] = isset($session[$key]) ? $session[$key] : array(); $session[$key] = isset($session[$key]) ? $session[$key] : array();
$bag->initialize($session[$key]); $bag->initialize($session[$key]);
} }
$this->started = true;
$this->closed = false;
} }
} }