vendor/contao/core-bundle/src/Session/LazySessionAccess.php line 55

Open in your IDE?
  1. <?php
  3. declare(strict_types=1);
  5. /*
  6.  * This file is part of Contao.
  7.  *
  8.  * (c) Leo Feyer
  9.  *
  10.  * @license LGPL-3.0-or-later
  11.  */
  13. namespace Contao\CoreBundle\Session;
  15. use Symfony\Component\HttpFoundation\Session\SessionInterface;
  17. /**
  18.  * Automatically starts the session if someone accesses $_SESSION.
  19.  *
  20.  * @internal
  21.  */
  22. class LazySessionAccess implements \ArrayAccess, \Countable
  23. {
  24.     /**
  25.      * @var SessionInterface
  26.      */
  27.     private $session;
  29.     /**
  30.      * @var bool
  31.      */
  32.     private $hasPreviousSession;
  34.     public function __construct(SessionInterface $session, bool $hasPreviousSession = true)
  35.     {
  36.         $this->session = $session;
  37.         $this->hasPreviousSession = $hasPreviousSession;
  38.     }
  40.     #[\ReturnTypeWillChange]
  41.     public function offsetExists($offset): bool
  42.     {
  43.         if (!$this->hasPreviousSession && !$this->session->isStarted()) {
  44.             return false;
  45.         }
  47.         $this->startSession();
  49.         return \array_key_exists($offset, $_SESSION);
  50.     }
  52.     #[\ReturnTypeWillChange]
  53.     public function &offsetGet($offset)
  54.     {
  55.         $this->startSession();
  57.         return $_SESSION[$offset];
  58.     }
  60.     #[\ReturnTypeWillChange]
  61.     public function offsetSet($offset, $value): void
  62.     {
  63.         $this->startSession();
  65.         $_SESSION[$offset] = $value;
  66.     }
  68.     #[\ReturnTypeWillChange]
  69.     public function offsetUnset($offset): void
  70.     {
  71.         $this->startSession();
  73.         unset($_SESSION[$offset]);
  74.     }
  76.     #[\ReturnTypeWillChange]
  77.     public function count(): int
  78.     {
  79.         if (!$this->hasPreviousSession && !$this->session->isStarted()) {
  80.             return 0;
  81.         }
  83.         $this->startSession();
  85.         return \count($_SESSION);
  86.     }
  88.     /**
  89.      * @throws \RuntimeException
  90.      */
  91.     private function startSession(): void
  92.     {
  93.         trigger_deprecation('contao/core-bundle', '4.5', 'Using "$_SESSION" has been deprecated and will no longer work in Contao 5.0. Use the Symfony session instead.');
  95.         $this->session->start();
  97.         /** @phpstan-ignore-next-line */
  98.         if ($_SESSION instanceof self) {
  99.             throw new \RuntimeException('Unable to start the native session, $_SESSION was not replaced.');
  100.         }
  102.         // Accessing the session object may replace the global $_SESSION variable,
  103.         // so we store the bags in a local variable first before setting them on $_SESSION
  104.         $beBag = $this->session->getBag('contao_backend');
  105.         $feBag = $this->session->getBag('contao_frontend');
  107.         $_SESSION['BE_DATA'] = $beBag;
  108.         $_SESSION['FE_DATA'] = $feBag;
  109.     }
  110. }