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

  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 TokenStorageInterface $tokenStorage;
  29.     private RequestStack $requestStack;
  30.     private string $environment;
  31.     private bool $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.      * @throws \RuntimeException When the TokenStorage is not available
  57.      */
  58.     public function getToken(): ?TokenInterface
  59.     {
  60.         if (!isset($this->tokenStorage)) {
  61.             throw new \RuntimeException('The "app.token" variable is not available.');
  62.         }
  64.         return $this->tokenStorage->getToken();
  65.     }
  67.     /**
  68.      * Returns the current user.
  69.      *
  70.      * @see TokenInterface::getUser()
  71.      */
  72.     public function getUser(): ?UserInterface
  73.     {
  74.         if (!isset($this->tokenStorage)) {
  75.             throw new \RuntimeException('The "app.user" variable is not available.');
  76.         }
  78.         return $this->tokenStorage->getToken()?->getUser();
  79.     }
  81.     /**
  82.      * Returns the current request.
  83.      */
  84.     public function getRequest(): ?Request
  85.     {
  86.         if (!isset($this->requestStack)) {
  87.             throw new \RuntimeException('The "app.request" variable is not available.');
  88.         }
  90.         return $this->requestStack->getCurrentRequest();
  91.     }
  93.     /**
  94.      * Returns the current session.
  95.      */
  96.     public function getSession(): ?Session
  97.     {
  98.         if (!isset($this->requestStack)) {
  99.             throw new \RuntimeException('The "app.session" variable is not available.');
  100.         }
  101.         $request = $this->getRequest();
  103.         return $request?->hasSession() ? $request->getSession() : null;
  104.     }
  106.     /**
  107.      * Returns the current app environment.
  108.      */
  109.     public function getEnvironment(): string
  110.     {
  111.         if (!isset($this->environment)) {
  112.             throw new \RuntimeException('The "app.environment" variable is not available.');
  113.         }
  115.         return $this->environment;
  116.     }
  118.     /**
  119.      * Returns the current app debug mode.
  120.      */
  121.     public function getDebug(): bool
  122.     {
  123.         if (!isset($this->debug)) {
  124.             throw new \RuntimeException('The "app.debug" variable is not available.');
  125.         }
  127.         return $this->debug;
  128.     }
  130.     /**
  131.      * Returns some or all the existing flash messages:
  132.      *  * getFlashes() returns all the flash messages
  133.      *  * getFlashes('notice') returns a simple array with flash messages of that type
  134.      *  * getFlashes(['notice', 'error']) returns a nested array of type => messages.
  135.      */
  136.     public function getFlashes(string|array $types = null): array
  137.     {
  138.         try {
  139.             if (null === $session = $this->getSession()) {
  140.                 return [];
  141.             }
  142.         } catch (\RuntimeException) {
  143.             return [];
  144.         }
  146.         if (null === $types || '' === $types || [] === $types) {
  147.             return $session->getFlashBag()->all();
  148.         }
  150.         if (\is_string($types)) {
  151.             return $session->getFlashBag()->get($types);
  152.         }
  154.         $result = [];
  155.         foreach ($types as $type) {
  156.             $result[$type] = $session->getFlashBag()->get($type);
  157.         }
  159.         return $result;
  160.     }
  162.     public function getCurrent_route(): ?string
  163.     {
  164.         if (!isset($this->requestStack)) {
  165.             throw new \RuntimeException('The "app.current_route" variable is not available.');
  166.         }
  168.         return $this->getRequest()?->attributes->get('_route');
  169.     }
  171.     /**
  172.      * @return array<string, mixed>
  173.      */
  174.     public function getCurrent_route_parameters(): array
  175.     {
  176.         if (!isset($this->requestStack)) {
  177.             throw new \RuntimeException('The "app.current_route_parameters" variable is not available.');
  178.         }
  180.         return $this->getRequest()?->attributes->get('_route_params') ?? [];
  181.     }
  182. }