Skip to main content
Drupal API
User account menu
  • Log in

Breadcrumb

  1. Drupal Core 11.1.x
  2. MockArraySessionStorage.php

class MockArraySessionStorage

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>

Hierarchy

  • class \Symfony\Component\HttpFoundation\Session\Storage\MockArraySessionStorage implements \Symfony\Component\HttpFoundation\Session\Storage\SessionStorageInterface

Expanded class hierarchy of MockArraySessionStorage

2 files declare their use of MockArraySessionStorage
DrupalKernel.php in core/lib/Drupal/Core/DrupalKernel.php
FunctionalTestSetupTrait.php in core/lib/Drupal/Core/Test/FunctionalTestSetupTrait.php

File

vendor/symfony/http-foundation/Session/Storage/MockArraySessionStorage.php, line 28

Namespace

Symfony\Component\HttpFoundation\Session\Storage
View source
class MockArraySessionStorage implements SessionStorageInterface {
    protected string $id = '';
    protected bool $started = false;
    protected bool $closed = false;
    protected array $data = [];
    protected MetadataBag $metadataBag;
    
    /**
     * @var SessionBagInterface[]
     */
    protected array $bags = [];
    public function __construct(string $name = 'MOCKSESSID', ?MetadataBag $metaBag = null) {
        $this->setMetadataBag($metaBag);
    }
    public function setSessionData(array $array) : void {
        $this->data = $array;
    }
    public function start() : bool {
        if ($this->started) {
            return true;
        }
        if (!$this->id) {
            $this->id = $this->generateId();
        }
        $this->loadSession();
        return true;
    }
    public function regenerate(bool $destroy = false, ?int $lifetime = null) : bool {
        if (!$this->started) {
            $this->start();
        }
        $this->metadataBag
            ->stampNew($lifetime);
        $this->id = $this->generateId();
        return true;
    }
    public function getId() : string {
        return $this->id;
    }
    public function setId(string $id) : void {
        if ($this->started) {
            throw new \LogicException('Cannot set session ID after the session has started.');
        }
        $this->id = $id;
    }
    public function getName() : string {
        return $this->name;
    }
    public function setName(string $name) : void {
        $this->name = $name;
    }
    public function save() : void {
        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;
    }
    public function clear() : void {
        // clear out the bags
        foreach ($this->bags as $bag) {
            $bag->clear();
        }
        // clear out the session
        $this->data = [];
        // reconnect the bags to the session
        $this->loadSession();
    }
    public function registerBag(SessionBagInterface $bag) : void {
        $this->bags[$bag->getName()] = $bag;
    }
    public function getBag(string $name) : SessionBagInterface {
        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];
    }
    public function isStarted() : bool {
        return $this->started;
    }
    public function setMetadataBag(?MetadataBag $bag) : void {
        $this->metadataBag = $bag ?? new MetadataBag();
    }
    
    /**
     * Gets the MetadataBag.
     */
    public function getMetadataBag() : MetadataBag {
        return $this->metadataBag;
    }
    
    /**
     * Generates a session ID.
     *
     * This doesn't need to be particularly cryptographically secure since this is just
     * a mock.
     */
    protected function generateId() : string {
        return bin2hex(random_bytes(16));
    }
    protected function loadSession() : void {
        $bags = array_merge($this->bags, [
            $this->metadataBag,
        ]);
        foreach ($bags as $bag) {
            $key = $bag->getStorageKey();
            $this->data[$key] ??= [];
            $bag->initialize($this->data[$key]);
        }
        $this->started = true;
        $this->closed = false;
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
MockArraySessionStorage::$bags protected property
MockArraySessionStorage::$closed protected property
MockArraySessionStorage::$data protected property
MockArraySessionStorage::$id protected property
MockArraySessionStorage::$metadataBag protected property
MockArraySessionStorage::$started protected property
MockArraySessionStorage::clear public function Clear all session data in memory. Overrides SessionStorageInterface::clear
MockArraySessionStorage::generateId protected function Generates a session ID.
MockArraySessionStorage::getBag public function Gets a SessionBagInterface by name. Overrides SessionStorageInterface::getBag
MockArraySessionStorage::getId public function Returns the session ID. Overrides SessionStorageInterface::getId
MockArraySessionStorage::getMetadataBag public function Gets the MetadataBag. Overrides SessionStorageInterface::getMetadataBag
MockArraySessionStorage::getName public function Returns the session name. Overrides SessionStorageInterface::getName
MockArraySessionStorage::isStarted public function Checks if the session is started. Overrides SessionStorageInterface::isStarted
MockArraySessionStorage::loadSession protected function
MockArraySessionStorage::regenerate public function Regenerates id that represents this storage. Overrides SessionStorageInterface::regenerate 1
MockArraySessionStorage::registerBag public function Registers a SessionBagInterface for use. Overrides SessionStorageInterface::registerBag
MockArraySessionStorage::save public function Force the session to be saved and closed. Overrides SessionStorageInterface::save 1
MockArraySessionStorage::setId public function Sets the session ID. Overrides SessionStorageInterface::setId
MockArraySessionStorage::setMetadataBag public function
MockArraySessionStorage::setName public function Sets the session name. Overrides SessionStorageInterface::setName
MockArraySessionStorage::setSessionData public function
MockArraySessionStorage::start public function Starts the session. Overrides SessionStorageInterface::start 1
MockArraySessionStorage::__construct public function 1

API Navigation

  • Drupal Core 11.1.x
  • Topics
  • Classes
  • Functions
  • Constants
  • Globals
  • Files
  • Namespaces
  • Deprecated
  • Services
RSS feed
Powered by Drupal