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

  1. <?php
  2. /*
  3.  * This file is part of the Symfony package.
  4.  *
  5.  * (c) Fabien Potencier <fabien@symfony.com>
  6.  *
  7.  * For the full copyright and license information, please view the LICENSE
  8.  * file that was distributed with this source code.
  9.  */
  10. namespace Symfony\Bridge\Twig;
  11. use Symfony\Component\HttpFoundation\Request;
  12. use Symfony\Component\HttpFoundation\RequestStack;
  13. use Symfony\Component\HttpFoundation\Session\Session;
  14. use Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface;
  15. use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
  16. use Symfony\Component\Security\Core\User\UserInterface;
  17. /**
  18.  * Exposes some Symfony parameters and services as an "app" global variable.
  19.  *
  20.  * @author Fabien Potencier <fabien@symfony.com>
  21.  */
  22. class AppVariable
  23. {
  24.     private TokenStorageInterface $tokenStorage;
  25.     private RequestStack $requestStack;
  26.     private string $environment;
  27.     private bool $debug;
  28.     public function setTokenStorage(TokenStorageInterface $tokenStorage)
  29.     {
  30.         $this->tokenStorage $tokenStorage;
  31.     }
  32.     public function setRequestStack(RequestStack $requestStack)
  33.     {
  34.         $this->requestStack $requestStack;
  35.     }
  36.     public function setEnvironment(string $environment)
  37.     {
  38.         $this->environment $environment;
  39.     }
  40.     public function setDebug(bool $debug)
  41.     {
  42.         $this->debug $debug;
  43.     }
  44.     /**
  45.      * Returns the current token.
  46.      *
  47.      * @throws \RuntimeException When the TokenStorage is not available
  48.      */
  49.     public function getToken(): ?TokenInterface
  50.     {
  51.         if (!isset($this->tokenStorage)) {
  52.             throw new \RuntimeException('The "app.token" variable is not available.');
  53.         }
  54.         return $this->tokenStorage->getToken();
  55.     }
  56.     /**
  57.      * Returns the current user.
  58.      *
  59.      * @see TokenInterface::getUser()
  60.      */
  61.     public function getUser(): ?UserInterface
  62.     {
  63.         if (!isset($this->tokenStorage)) {
  64.             throw new \RuntimeException('The "app.user" variable is not available.');
  65.         }
  66.         return $this->tokenStorage->getToken()?->getUser();
  67.     }
  68.     /**
  69.      * Returns the current request.
  70.      */
  71.     public function getRequest(): ?Request
  72.     {
  73.         if (!isset($this->requestStack)) {
  74.             throw new \RuntimeException('The "app.request" variable is not available.');
  75.         }
  76.         return $this->requestStack->getCurrentRequest();
  77.     }
  78.     /**
  79.      * Returns the current session.
  80.      */
  81.     public function getSession(): ?Session
  82.     {
  83.         if (!isset($this->requestStack)) {
  84.             throw new \RuntimeException('The "app.session" variable is not available.');
  85.         }
  86.         $request $this->getRequest();
  87.         return $request?->hasSession() ? $request->getSession() : null;
  88.     }
  89.     /**
  90.      * Returns the current app environment.
  91.      */
  92.     public function getEnvironment(): string
  93.     {
  94.         if (!isset($this->environment)) {
  95.             throw new \RuntimeException('The "app.environment" variable is not available.');
  96.         }
  97.         return $this->environment;
  98.     }
  99.     /**
  100.      * Returns the current app debug mode.
  101.      */
  102.     public function getDebug(): bool
  103.     {
  104.         if (!isset($this->debug)) {
  105.             throw new \RuntimeException('The "app.debug" variable is not available.');
  106.         }
  107.         return $this->debug;
  108.     }
  109.     /**
  110.      * Returns some or all the existing flash messages:
  111.      *  * getFlashes() returns all the flash messages
  112.      *  * getFlashes('notice') returns a simple array with flash messages of that type
  113.      *  * getFlashes(['notice', 'error']) returns a nested array of type => messages.
  114.      */
  115.     public function getFlashes(string|array $types null): array
  116.     {
  117.         try {
  118.             if (null === $session $this->getSession()) {
  119.                 return [];
  120.             }
  121.         } catch (\RuntimeException) {
  122.             return [];
  123.         }
  124.         if (null === $types || '' === $types || [] === $types) {
  125.             return $session->getFlashBag()->all();
  126.         }
  127.         if (\is_string($types)) {
  128.             return $session->getFlashBag()->get($types);
  129.         }
  130.         $result = [];
  131.         foreach ($types as $type) {
  132.             $result[$type] = $session->getFlashBag()->get($type);
  133.         }
  134.         return $result;
  135.     }
  136.     public function getCurrent_route(): ?string
  137.     {
  138.         if (!isset($this->requestStack)) {
  139.             throw new \RuntimeException('The "app.current_route" variable is not available.');
  140.         }
  141.         return $this->getRequest()?->attributes->get('_route');
  142.     }
  143.     /**
  144.      * @return array<string, mixed>
  145.      */
  146.     public function getCurrent_route_parameters(): array
  147.     {
  148.         if (!isset($this->requestStack)) {
  149.             throw new \RuntimeException('The "app.current_route_parameters" variable is not available.');
  150.         }
  151.         return $this->getRequest()?->attributes->get('_route_params') ?? [];
  152.     }
  153. }