feature symfony#50321 [TwigBridge] Add AppVariable::getEnabledLocales() (jmsche)

This PR was merged into the 6.4 branch.

Discussion
----------

[TwigBridge] Add `AppVariable::getEnabledLocales()`

| Q             | A
| ------------- | ---
| Branch?       | 6.4
| Bug fix?      | no
| New feature?  | yes
| Deprecations? | no
| Tickets       | N/A
| License       | MIT
| Doc PR        | symfony/symfony-docs#...

This PR aims to provide a new `app.enabled_locales` getter for templates to retrieve the enabled locales configured using the `framework.enabled_locales` configuration, to make e.g. a locale switcher in the templates without to have to pass the enabled locales using e.g. a Twig global.

The docs PR will me made if the PR is accepted.

Targeting the 6.3 branch for now, will switch to 6.4 when it will be available (as feature freeze is active since late March).

Commits
-------

3e1925c [TwigBridge] Add `AppVariable::getEnabledLocales()` to retrieve the enabled locales

Author: fabpot

src/Symfony/Bridge/Twig/AppVariable.php

@@ -31,6 +31,7 @@ class AppVariable
     private string $environment;
     private bool $debug;
     private LocaleSwitcher $localeSwitcher;
+    private array $enabledLocales;
 
     /**
      * @return void
@@ -69,6 +70,11 @@ public function setLocaleSwitcher(LocaleSwitcher $localeSwitcher): void
         $this->localeSwitcher = $localeSwitcher;
     }
 
+    public function setEnabledLocales(array $enabledLocales): void
+    {
+        $this->enabledLocales = $enabledLocales;
+    }
+
     /**
      * Returns the current token.
      *
@@ -155,6 +161,15 @@ public function getLocale(): string
         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

src/Symfony/Bridge/Twig/CHANGELOG.md

@@ -6,6 +6,7 @@ CHANGELOG
 
  * Allow an array to be passed as the first argument to the `importmap()` Twig function
  * Add `TemplatedEmail::locale()` to set the locale for the email rendering
+ * Add `AppVariable::getEnabledLocales()` to retrieve the enabled locales
 
 6.3
 ---

src/Symfony/Bridge/Twig/Tests/AppVariableTest.php

@@ -112,6 +112,13 @@ public function testGetLocale()
         self::assertEquals('fr', $this->appVariable->getLocale());
     }
 
+    public function testGetEnabledLocales()
+    {
+        $this->appVariable->setEnabledLocales(['en', 'fr']);
+
+        self::assertSame(['en', 'fr'], $this->appVariable->getEnabled_locales());
+    }
+
     public function testGetTokenWithNoToken()
     {
         $tokenStorage = $this->createMock(TokenStorageInterface::class);
@@ -171,6 +178,13 @@ public function testGetLocaleWithLocaleSwitcherNotSet()
         $this->appVariable->getLocale();
     }
 
+    public function testGetEnabledLocalesWithEnabledLocalesNotSet()
+    {
+        $this->expectException(\RuntimeException::class);
+        $this->expectExceptionMessage('The "app.enabled_locales" variable is not available.');
+        $this->appVariable->getEnabled_locales();
+    }
+
     public function testGetFlashesWithNoRequest()
     {
         $this->setRequestStack(null);

src/Symfony/Bundle/TwigBundle/Resources/config/twig.php

@@ -77,6 +77,7 @@
             ->call('setTokenStorage', [service('security.token_storage')->ignoreOnInvalid()])
             ->call('setRequestStack', [service('request_stack')->ignoreOnInvalid()])
             ->call('setLocaleSwitcher', [service('translation.locale_switcher')->ignoreOnInvalid()])
+            ->call('setEnabledLocales', [param('kernel.enabled_locales')])
 
         ->set('twig.template_iterator', TemplateIterator::class)
             ->args([service('kernel'), abstract_arg('Twig paths'), param('twig.default_path'), abstract_arg('File name pattern')])