123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269 |
- <?php
- /*
- * This file is part of the Symfony package.
- *
- * (c) Fabien Potencier <fabien@symfony.com>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
- namespace Symfony\Component\HttpFoundation\Session\Storage;
- use Symfony\Component\HttpFoundation\Session\SessionBagInterface;
- /**
- * MockArraySessionStorage mocks the session for unit tests.
- *
- * No PHP session is actually started since a session can be initialized
- * and shutdown only once per PHP execution cycle.
- *
- * When doing functional testing, you should use MockFileSessionStorage instead.
- *
- * @author Fabien Potencier <fabien@symfony.com>
- * @author Bulat Shakirzyanov <mallluhuct@gmail.com>
- * @author Drak <drak@zikula.org>
- */
- class MockArraySessionStorage implements SessionStorageInterface
- {
- /**
- * @var string
- */
- protected $id = '';
- /**
- * @var string
- */
- protected $name;
- /**
- * @var bool
- */
- protected $started = false;
- /**
- * @var bool
- */
- protected $closed = false;
- /**
- * @var array
- */
- protected $data = array();
- /**
- * @var MetadataBag
- */
- protected $metadataBag;
- /**
- * @var array
- */
- protected $bags;
- /**
- * Constructor.
- *
- * @param string $name Session name
- * @param MetadataBag $metaBag MetadataBag instance.
- */
- public function __construct($name = 'MOCKSESSID', MetadataBag $metaBag = null)
- {
- $this->name = $name;
- $this->setMetadataBag($metaBag);
- }
- /**
- * Sets the session data.
- *
- * @param array $array
- */
- public function setSessionData(array $array)
- {
- $this->data = $array;
- }
- /**
- * {@inheritdoc}
- */
- public function start()
- {
- if ($this->started) {
- return true;
- }
- if (empty($this->id)) {
- $this->id = $this->generateId();
- }
- $this->loadSession();
- return true;
- }
- /**
- * {@inheritdoc}
- */
- public function regenerate($destroy = false, $lifetime = null)
- {
- if (!$this->started) {
- $this->start();
- }
- $this->metadataBag->stampNew($lifetime);
- $this->id = $this->generateId();
- return true;
- }
- /**
- * {@inheritdoc}
- */
- public function getId()
- {
- return $this->id;
- }
- /**
- * {@inheritdoc}
- */
- public function setId($id)
- {
- if ($this->started) {
- throw new \LogicException('Cannot set session ID after the session has started.');
- }
- $this->id = $id;
- }
- /**
- * {@inheritdoc}
- */
- public function getName()
- {
- return $this->name;
- }
- /**
- * {@inheritdoc}
- */
- public function setName($name)
- {
- $this->name = $name;
- }
- /**
- * {@inheritdoc}
- */
- public function save()
- {
- if (!$this->started || $this->closed) {
- throw new \RuntimeException('Trying to save a session that was not started yet or was already closed');
- }
- // nothing to do since we don't persist the session data
- $this->closed = false;
- $this->started = false;
- }
- /**
- * {@inheritdoc}
- */
- public function clear()
- {
- // clear out the bags
- foreach ($this->bags as $bag) {
- $bag->clear();
- }
- // clear out the session
- $this->data = array();
- // reconnect the bags to the session
- $this->loadSession();
- }
- /**
- * {@inheritdoc}
- */
- public function registerBag(SessionBagInterface $bag)
- {
- $this->bags[$bag->getName()] = $bag;
- }
- /**
- * {@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];
- }
- /**
- * {@inheritdoc}
- */
- public function isStarted()
- {
- return $this->started;
- }
- /**
- * Sets the MetadataBag.
- *
- * @param MetadataBag $bag
- */
- public function setMetadataBag(MetadataBag $bag = null)
- {
- if (null === $bag) {
- $bag = new MetadataBag();
- }
- $this->metadataBag = $bag;
- }
- /**
- * Gets the MetadataBag.
- *
- * @return MetadataBag
- */
- public function getMetadataBag()
- {
- return $this->metadataBag;
- }
- /**
- * Generates a session ID.
- *
- * This doesn't need to be particularly cryptographically secure since this is just
- * a mock.
- *
- * @return string
- */
- protected function generateId()
- {
- return hash('sha256', uniqid('ss_mock_', true));
- }
- protected function loadSession()
- {
- $bags = array_merge($this->bags, array($this->metadataBag));
- foreach ($bags as $bag) {
- $key = $bag->getStorageKey();
- $this->data[$key] = isset($this->data[$key]) ? $this->data[$key] : array();
- $bag->initialize($this->data[$key]);
- }
- $this->started = true;
- $this->closed = false;
- }
- }
|