vendor/symfony/twig-bridge/AppVariable.php line 172

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\Bridge\Twig;
  14. use Symfony\Component\HttpFoundation\Request;
  15. use Symfony\Component\HttpFoundation\RequestStack;
  16. use Symfony\Component\HttpFoundation\Session\Session;
  17. use Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface;
  18. use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
  19. use Symfony\Component\Security\Core\User\UserInterface;
  21. /**
  22.  * Exposes some Symfony parameters and services as an "app" global variable.
  23.  *
  24.  * @author Fabien Potencier <fabien@symfony.com>
  25.  */
  26. class AppVariable
  27. {
  28.     private $tokenStorage;
  29.     private $requestStack;
  30.     private $environment;
  31.     private $debug;
  33.     public function setTokenStorage(TokenStorageInterface $tokenStorage)
  34.     {
  35.         $this->tokenStorage = $tokenStorage;
  36.     }
  38.     public function setRequestStack(RequestStack $requestStack)
  39.     {
  40.         $this->requestStack = $requestStack;
  41.     }
  43.     public function setEnvironment(string $environment)
  44.     {
  45.         $this->environment = $environment;
  46.     }
  48.     public function setDebug(bool $debug)
  49.     {
  50.         $this->debug = $debug;
  51.     }
  53.     /**
  54.      * Returns the current token.
  55.      *
  56.      * @return TokenInterface|null
  57.      *
  58.      * @throws \RuntimeException When the TokenStorage is not available
  59.      */
  60.     public function getToken()
  61.     {
  62.         if (null === $tokenStorage = $this->tokenStorage) {
  63.             throw new \RuntimeException('The "app.token" variable is not available.');
  64.         }
  66.         return $tokenStorage->getToken();
  67.     }
  69.     /**
  70.      * Returns the current user.
  71.      *
  72.      * @return UserInterface|null
  73.      *
  74.      * @see TokenInterface::getUser()
  75.      */
  76.     public function getUser()
  77.     {
  78.         if (null === $tokenStorage = $this->tokenStorage) {
  79.             throw new \RuntimeException('The "app.user" variable is not available.');
  80.         }
  82.         if (!$token = $tokenStorage->getToken()) {
  83.             return null;
  84.         }
  86.         $user = $token->getUser();
  88.         // @deprecated since Symfony 5.4, $user will always be a UserInterface instance
  89.         return \is_object($user) ? $user : null;
  90.     }
  92.     /**
  93.      * Returns the current request.
  94.      *
  95.      * @return Request|null
  96.      */
  97.     public function getRequest()
  98.     {
  99.         if (null === $this->requestStack) {
  100.             throw new \RuntimeException('The "app.request" variable is not available.');
  101.         }
  103.         return $this->requestStack->getCurrentRequest();
  104.     }
  106.     /**
  107.      * Returns the current session.
  108.      *
  109.      * @return Session|null
  110.      */
  111.     public function getSession()
  112.     {
  113.         if (null === $this->requestStack) {
  114.             throw new \RuntimeException('The "app.session" variable is not available.');
  115.         }
  116.         $request = $this->getRequest();
  118.         return $request && $request->hasSession() ? $request->getSession() : null;
  119.     }
  121.     /**
  122.      * Returns the current app environment.
  123.      *
  124.      * @return string
  125.      */
  126.     public function getEnvironment()
  127.     {
  128.         if (null === $this->environment) {
  129.             throw new \RuntimeException('The "app.environment" variable is not available.');
  130.         }
  132.         return $this->environment;
  133.     }
  135.     /**
  136.      * Returns the current app debug mode.
  137.      *
  138.      * @return bool
  139.      */
  140.     public function getDebug()
  141.     {
  142.         if (null === $this->debug) {
  143.             throw new \RuntimeException('The "app.debug" variable is not available.');
  144.         }
  146.         return $this->debug;
  147.     }
  149.     /**
  150.      * Returns some or all the existing flash messages:
  151.      *  * getFlashes() returns all the flash messages
  152.      *  * getFlashes('notice') returns a simple array with flash messages of that type
  153.      *  * getFlashes(['notice', 'error']) returns a nested array of type => messages.
  154.      *
  155.      * @return array
  156.      */
  157.     public function getFlashes($types = null)
  158.     {
  159.         try {
  160.             if (null === $session = $this->getSession()) {
  161.                 return [];
  162.             }
  163.         } catch (\RuntimeException $e) {
  164.             return [];
  165.         }
  167.         if (null === $types || '' === $types || [] === $types) {
  168.             return $session->getFlashBag()->all();
  169.         }
  171.         if (\is_string($types)) {
  172.             return $session->getFlashBag()->get($types);
  173.         }
  175.         $result = [];
  176.         foreach ($types as $type) {
  177.             $result[$type] = $session->getFlashBag()->get($type);
  178.         }
  180.         return $result;
  181.     }
  182. }