N°6934 - Symfony 6.4 - upgrade Symfony bundles to 6.4 (#580)

* Update Symfony lib to version ~6.4.0
* Update code missing return type
* Add an iTop general configuration entry to store application secret (Symfony mandatory parameter)
* Use dependency injection in ExceptionListener & UserProvider classes

lib/symfony/twig-bridge/AppVariable.php

@@ -13,10 +13,11 @@ namespace Symfony\Bridge\Twig;
 
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\RequestStack;
-use Symfony\Component\HttpFoundation\Session\Session;
+use Symfony\Component\HttpFoundation\Session\SessionInterface;
 use Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface;
 use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
 use Symfony\Component\Security\Core\User\UserInterface;
+use Symfony\Component\Translation\LocaleSwitcher;
 
 /**
  * Exposes some Symfony parameters and services as an "app" global variable.
@@ -25,78 +26,89 @@ use Symfony\Component\Security\Core\User\UserInterface;
  */
 class AppVariable
 {
-    private $tokenStorage;
-    private $requestStack;
-    private $environment;
-    private $debug;
+    private TokenStorageInterface $tokenStorage;
+    private RequestStack $requestStack;
+    private string $environment;
+    private bool $debug;
+    private LocaleSwitcher $localeSwitcher;
+    private array $enabledLocales;
 
+    /**
+     * @return void
+     */
     public function setTokenStorage(TokenStorageInterface $tokenStorage)
     {
         $this->tokenStorage = $tokenStorage;
     }
 
+    /**
+     * @return void
+     */
     public function setRequestStack(RequestStack $requestStack)
     {
         $this->requestStack = $requestStack;
     }
 
+    /**
+     * @return void
+     */
     public function setEnvironment(string $environment)
     {
         $this->environment = $environment;
     }
 
+    /**
+     * @return void
+     */
     public function setDebug(bool $debug)
     {
         $this->debug = $debug;
     }
 
+    public function setLocaleSwitcher(LocaleSwitcher $localeSwitcher): void
+    {
+        $this->localeSwitcher = $localeSwitcher;
+    }
+
+    public function setEnabledLocales(array $enabledLocales): void
+    {
+        $this->enabledLocales = $enabledLocales;
+    }
+
     /**
      * Returns the current token.
      *
-     * @return TokenInterface|null
-     *
      * @throws \RuntimeException When the TokenStorage is not available
      */
-    public function getToken()
+    public function getToken(): ?TokenInterface
     {
-        if (null === $tokenStorage = $this->tokenStorage) {
+        if (!isset($this->tokenStorage)) {
             throw new \RuntimeException('The "app.token" variable is not available.');
         }
 
-        return $tokenStorage->getToken();
+        return $this->tokenStorage->getToken();
     }
 
     /**
      * Returns the current user.
      *
-     * @return UserInterface|null
-     *
      * @see TokenInterface::getUser()
      */
-    public function getUser()
+    public function getUser(): ?UserInterface
     {
-        if (null === $tokenStorage = $this->tokenStorage) {
+        if (!isset($this->tokenStorage)) {
             throw new \RuntimeException('The "app.user" variable is not available.');
         }
 
-        if (!$token = $tokenStorage->getToken()) {
-            return null;
-        }
-
-        $user = $token->getUser();
-
-        // @deprecated since Symfony 5.4, $user will always be a UserInterface instance
-        return \is_object($user) ? $user : null;
+        return $this->tokenStorage->getToken()?->getUser();
     }
 
     /**
      * Returns the current request.
-     *
-     * @return Request|null
      */
-    public function getRequest()
+    public function getRequest(): ?Request
     {
-        if (null === $this->requestStack) {
+        if (!isset($this->requestStack)) {
             throw new \RuntimeException('The "app.request" variable is not available.');
         }
 
@@ -105,27 +117,23 @@ class AppVariable
 
     /**
      * Returns the current session.
-     *
-     * @return Session|null
      */
-    public function getSession()
+    public function getSession(): ?SessionInterface
     {
-        if (null === $this->requestStack) {
+        if (!isset($this->requestStack)) {
             throw new \RuntimeException('The "app.session" variable is not available.');
         }
         $request = $this->getRequest();
 
-        return $request && $request->hasSession() ? $request->getSession() : null;
+        return $request?->hasSession() ? $request->getSession() : null;
     }
 
     /**
      * Returns the current app environment.
-     *
-     * @return string
      */
-    public function getEnvironment()
+    public function getEnvironment(): string
     {
-        if (null === $this->environment) {
+        if (!isset($this->environment)) {
             throw new \RuntimeException('The "app.environment" variable is not available.');
         }
 
@@ -134,33 +142,53 @@ class AppVariable
 
     /**
      * Returns the current app debug mode.
-     *
-     * @return bool
      */
-    public function getDebug()
+    public function getDebug(): bool
     {
-        if (null === $this->debug) {
+        if (!isset($this->debug)) {
             throw new \RuntimeException('The "app.debug" variable is not available.');
         }
 
         return $this->debug;
     }
 
+    public function getLocale(): string
+    {
+        if (!isset($this->localeSwitcher)) {
+            throw new \RuntimeException('The "app.locale" variable is not available.');
+        }
+
+        return $this->localeSwitcher->getLocale();
+    }
+
+    public function getEnabled_locales(): array
+    {
+        if (!isset($this->enabledLocales)) {
+            throw new \RuntimeException('The "app.enabled_locales" variable is not available.');
+        }
+
+        return $this->enabledLocales;
+    }
+
     /**
      * Returns some or all the existing flash messages:
      *  * getFlashes() returns all the flash messages
      *  * getFlashes('notice') returns a simple array with flash messages of that type
      *  * getFlashes(['notice', 'error']) returns a nested array of type => messages.
-     *
-     * @return array
      */
-    public function getFlashes($types = null)
+    public function getFlashes(string|array $types = null): array
     {
         try {
             if (null === $session = $this->getSession()) {
                 return [];
             }
-        } catch (\RuntimeException $e) {
+        } catch (\RuntimeException) {
+            return [];
+        }
+
+        // In 7.0 (when symfony/http-foundation: 6.4 is required) this can be updated to
+        // check if the session is an instance of FlashBagAwareSessionInterface
+        if (!method_exists($session, 'getFlashBag')) {
             return [];
         }
 
@@ -179,4 +207,25 @@ class AppVariable
 
         return $result;
     }
+
+    public function getCurrent_route(): ?string
+    {
+        if (!isset($this->requestStack)) {
+            throw new \RuntimeException('The "app.current_route" variable is not available.');
+        }
+
+        return $this->getRequest()?->attributes->get('_route');
+    }
+
+    /**
+     * @return array<string, mixed>
+     */
+    public function getCurrent_route_parameters(): array
+    {
+        if (!isset($this->requestStack)) {
+            throw new \RuntimeException('The "app.current_route_parameters" variable is not available.');
+        }
+
+        return $this->getRequest()?->attributes->get('_route_params') ?? [];
+    }
 }