vendor/symfony/symfony/src/Symfony/Bundle/FrameworkBundle/Templating/Helper/SessionHelper.php line 14

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <fabien@symfony.com>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace Symfony\Bundle\FrameworkBundle\Templating\Helper;
  14. @trigger_error('The '.SessionHelper::class.' class is deprecated since version 4.3 and will be removed in 5.0; use Twig instead.', \E_USER_DEPRECATED);
  16. use Symfony\Component\HttpFoundation\RequestStack;
  17. use Symfony\Component\HttpFoundation\Session\SessionInterface;
  18. use Symfony\Component\Templating\Helper\Helper;
  20. /**
  21.  * SessionHelper provides read-only access to the session attributes.
  22.  *
  23.  * @author Fabien Potencier <fabien@symfony.com>
  24.  *
  25.  * @deprecated since version 4.3, to be removed in 5.0; use Twig instead.
  26.  */
  27. class SessionHelper extends Helper
  28. {
  29.     protected $session;
  30.     protected $requestStack;
  32.     public function __construct(RequestStack $requestStack)
  33.     {
  34.         $this->requestStack = $requestStack;
  35.     }
  37.     /**
  38.      * Returns an attribute.
  39.      *
  40.      * @param string $name    The attribute name
  41.      * @param mixed  $default The default value
  42.      *
  43.      * @return mixed
  44.      */
  45.     public function get($name, $default = null)
  46.     {
  47.         return $this->getSession()->get($name, $default);
  48.     }
  50.     public function getFlash($name, array $default = [])
  51.     {
  52.         return $this->getSession()->getFlashBag()->get($name, $default);
  53.     }
  55.     public function getFlashes()
  56.     {
  57.         return $this->getSession()->getFlashBag()->all();
  58.     }
  60.     public function hasFlash($name)
  61.     {
  62.         return $this->getSession()->getFlashBag()->has($name);
  63.     }
  65.     private function getSession(): SessionInterface
  66.     {
  67.         if (null === $this->session) {
  68.             if (!$this->requestStack->getMasterRequest()) {
  69.                 throw new \LogicException('A Request must be available.');
  70.             }
  72.             $this->session = $this->requestStack->getMasterRequest()->getSession();
  73.         }
  75.         return $this->session;
  76.     }
  78.     /**
  79.      * {@inheritdoc}
  80.      */
  81.     public function getName()
  82.     {
  83.         return 'session';
  84.     }
  85. }