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

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.  * @implements \ArrayAccess<mixed, mixed>
  22.  */
  23. class LazySessionAccess implements \ArrayAccess, \Countable
  24. {
  25.     private SessionInterface $session;
  26.     private bool $hasPreviousSession;
  28.     public function __construct(SessionInterface $session, bool $hasPreviousSession = true)
  29.     {
  30.         $this->session = $session;
  31.         $this->hasPreviousSession = $hasPreviousSession;
  32.     }
  34.     /**
  35.      * @param mixed $offset
  36.      */
  37.     public function offsetExists($offset): bool
  38.     {
  39.         if (!$this->hasPreviousSession && !$this->session->isStarted()) {
  40.             return false;
  41.         }
  43.         $this->startSession();
  45.         return \array_key_exists($offset, $_SESSION);
  46.     }
  48.     /**
  49.      * @param mixed $offset
  50.      *
  51.      * @return mixed
  52.      */
  53.     #[\ReturnTypeWillChange]
  54.     public function &offsetGet($offset)
  55.     {
  56.         $this->startSession();
  58.         return $_SESSION[$offset];
  59.     }
  61.     /**
  62.      * @param mixed $offset
  63.      * @param mixed $value
  64.      */
  65.     public function offsetSet($offset, $value): void
  66.     {
  67.         $this->startSession();
  69.         $_SESSION[$offset] = $value;
  70.     }
  72.     /**
  73.      * @param mixed $offset
  74.      */
  75.     public function offsetUnset($offset): void
  76.     {
  77.         $this->startSession();
  79.         unset($_SESSION[$offset]);
  80.     }
  82.     public function count(): int
  83.     {
  84.         if (!$this->hasPreviousSession && !$this->session->isStarted()) {
  85.             return 0;
  86.         }
  88.         $this->startSession();
  90.         return \count($_SESSION);
  91.     }
  93.     private function startSession(): void
  94.     {
  95.         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.');
  97.         $this->session->start();
  99.         /** @phpstan-ignore-next-line */
  100.         if ($_SESSION instanceof self) {
  101.             throw new \RuntimeException('Unable to start the native session, $_SESSION was not replaced.');
  102.         }
  104.         // Accessing the session object may replace the global $_SESSION variable,
  105.         // so we store the bags in a local variable first before setting them on $_SESSION
  106.         $beBag = $this->session->getBag('contao_backend');
  107.         $feBag = $this->session->getBag('contao_frontend');
  109.         $_SESSION['BE_DATA'] = $beBag;
  110.         $_SESSION['FE_DATA'] = $feBag;
  111.     }
  112. }