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

  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\FlashBagAwareSessionInterface;
  17. use Symfony\Component\HttpFoundation\Session\SessionInterface;
  18. use Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface;
  19. use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
  20. use Symfony\Component\Security\Core\User\UserInterface;
  21. use Symfony\Component\Translation\LocaleSwitcher;
  23. /**
  24.  * Exposes some Symfony parameters and services as an "app" global variable.
  25.  *
  26.  * @author Fabien Potencier <fabien@symfony.com>
  27.  */
  28. class AppVariable
  29. {
  30.     private TokenStorageInterface $tokenStorage;
  31.     private RequestStack $requestStack;
  32.     private string $environment;
  33.     private bool $debug;
  34.     private LocaleSwitcher $localeSwitcher;
  35.     private array $enabledLocales;
  37.     public function setTokenStorage(TokenStorageInterface $tokenStorage): void
  38.     {
  39.         $this->tokenStorage = $tokenStorage;
  40.     }
  42.     public function setRequestStack(RequestStack $requestStack): void
  43.     {
  44.         $this->requestStack = $requestStack;
  45.     }
  47.     public function setEnvironment(string $environment): void
  48.     {
  49.         $this->environment = $environment;
  50.     }
  52.     public function setDebug(bool $debug): void
  53.     {
  54.         $this->debug = $debug;
  55.     }
  57.     public function setLocaleSwitcher(LocaleSwitcher $localeSwitcher): void
  58.     {
  59.         $this->localeSwitcher = $localeSwitcher;
  60.     }
  62.     public function setEnabledLocales(array $enabledLocales): void
  63.     {
  64.         $this->enabledLocales = $enabledLocales;
  65.     }
  67.     /**
  68.      * Returns the current token.
  69.      *
  70.      * @throws \RuntimeException When the TokenStorage is not available
  71.      */
  72.     public function getToken(): ?TokenInterface
  73.     {
  74.         if (!isset($this->tokenStorage)) {
  75.             throw new \RuntimeException('The "app.token" variable is not available.');
  76.         }
  78.         return $this->tokenStorage->getToken();
  79.     }
  81.     /**
  82.      * Returns the current user.
  83.      *
  84.      * @see TokenInterface::getUser()
  85.      */
  86.     public function getUser(): ?UserInterface
  87.     {
  88.         if (!isset($this->tokenStorage)) {
  89.             throw new \RuntimeException('The "app.user" variable is not available.');
  90.         }
  92.         return $this->tokenStorage->getToken()?->getUser();
  93.     }
  95.     /**
  96.      * Returns the current request.
  97.      */
  98.     public function getRequest(): ?Request
  99.     {
  100.         if (!isset($this->requestStack)) {
  101.             throw new \RuntimeException('The "app.request" variable is not available.');
  102.         }
  104.         return $this->requestStack->getCurrentRequest();
  105.     }
  107.     /**
  108.      * Returns the current session.
  109.      */
  110.     public function getSession(): ?SessionInterface
  111.     {
  112.         if (!isset($this->requestStack)) {
  113.             throw new \RuntimeException('The "app.session" variable is not available.');
  114.         }
  115.         $request = $this->getRequest();
  117.         return $request?->hasSession() ? $request->getSession() : null;
  118.     }
  120.     /**
  121.      * Returns the current app environment.
  122.      */
  123.     public function getEnvironment(): string
  124.     {
  125.         if (!isset($this->environment)) {
  126.             throw new \RuntimeException('The "app.environment" variable is not available.');
  127.         }
  129.         return $this->environment;
  130.     }
  132.     /**
  133.      * Returns the current app debug mode.
  134.      */
  135.     public function getDebug(): bool
  136.     {
  137.         if (!isset($this->debug)) {
  138.             throw new \RuntimeException('The "app.debug" variable is not available.');
  139.         }
  141.         return $this->debug;
  142.     }
  144.     public function getLocale(): string
  145.     {
  146.         if (!isset($this->localeSwitcher)) {
  147.             throw new \RuntimeException('The "app.locale" variable is not available.');
  148.         }
  150.         return $this->localeSwitcher->getLocale();
  151.     }
  153.     public function getEnabled_locales(): array
  154.     {
  155.         if (!isset($this->enabledLocales)) {
  156.             throw new \RuntimeException('The "app.enabled_locales" variable is not available.');
  157.         }
  159.         return $this->enabledLocales;
  160.     }
  162.     /**
  163.      * Returns some or all the existing flash messages:
  164.      *  * getFlashes() returns all the flash messages
  165.      *  * getFlashes('notice') returns a simple array with flash messages of that type
  166.      *  * getFlashes(['notice', 'error']) returns a nested array of type => messages.
  167.      */
  168.     public function getFlashes(string|array|null $types = null): array
  169.     {
  170.         try {
  171.             $session = $this->getSession();
  172.         } catch (\RuntimeException) {
  173.             return [];
  174.         }
  176.         if (!$session instanceof FlashBagAwareSessionInterface) {
  177.             return [];
  178.         }
  180.         if (null === $types || '' === $types || [] === $types) {
  181.             return $session->getFlashBag()->all();
  182.         }
  184.         if (\is_string($types)) {
  185.             return $session->getFlashBag()->get($types);
  186.         }
  188.         $result = [];
  189.         foreach ($types as $type) {
  190.             $result[$type] = $session->getFlashBag()->get($type);
  191.         }
  193.         return $result;
  194.     }
  196.     public function getCurrent_route(): ?string
  197.     {
  198.         if (!isset($this->requestStack)) {
  199.             throw new \RuntimeException('The "app.current_route" variable is not available.');
  200.         }
  202.         return $this->getRequest()?->attributes->get('_route');
  203.     }
  205.     /**
  206.      * @return array<string, mixed>
  207.      */
  208.     public function getCurrent_route_parameters(): array
  209.     {
  210.         if (!isset($this->requestStack)) {
  211.             throw new \RuntimeException('The "app.current_route_parameters" variable is not available.');
  212.         }
  214.         return $this->getRequest()?->attributes->get('_route_params') ?? [];
  215.     }
  216. }