[Translation] Allow default parameters

Author: Jean-Beru

CHANGELOG.md

@@ -1,6 +1,11 @@
 CHANGELOG
 =========
 
+7.3
+---
+
+ * Add `Translator::addGlobalParameter()` to allow defining global translation parameters
+
 7.2
 ---
 

DataCollector/TranslationDataCollector.php

@@ -44,6 +44,7 @@ public function collect(Request $request, Response $response, ?\Throwable $excep
     {
         $this->data['locale'] = $this->translator->getLocale();
         $this->data['fallback_locales'] = $this->translator->getFallbackLocales();
+        $this->data['global_parameters'] = $this->translator->getGlobalParameters();
     }
 
     public function reset(): void
@@ -84,6 +85,14 @@ public function getFallbackLocales(): Data|array
         return (isset($this->data['fallback_locales']) && \count($this->data['fallback_locales']) > 0) ? $this->data['fallback_locales'] : [];
     }
 
+    /**
+     * @internal
+     */
+    public function getGlobalParameters(): Data|array
+    {
+        return $this->data['global_parameters'] ?? [];
+    }
+
     public function getName(): string
     {
         return 'translation';

DataCollectorTranslator.php

@@ -82,6 +82,15 @@ public function getFallbackLocales(): array
         return [];
     }
 
+    public function getGlobalParameters(): array
+    {
+        if ($this->translator instanceof Translator || method_exists($this->translator, 'getGlobalParameters')) {
+            return $this->translator->getGlobalParameters();
+        }
+
+        return [];
+    }
+
     public function __call(string $method, array $args): mixed
     {
         return $this->translator->{$method}(...$args);

Tests/DataCollector/TranslationDataCollectorTest.php

@@ -137,17 +137,20 @@ public function testCollectAndReset()
         $translator = $this->getTranslator();
         $translator->method('getLocale')->willReturn('fr');
         $translator->method('getFallbackLocales')->willReturn(['en']);
+        $translator->method('getGlobalParameters')->willReturn(['welcome' => 'Welcome {name}!']);
 
         $dataCollector = new TranslationDataCollector($translator);
         $dataCollector->collect($this->createMock(Request::class), $this->createMock(Response::class));
 
         $this->assertSame('fr', $dataCollector->getLocale());
         $this->assertSame(['en'], $dataCollector->getFallbackLocales());
+        $this->assertSame(['welcome' => 'Welcome {name}!'], $dataCollector->getGlobalParameters());
 
         $dataCollector->reset();
 
         $this->assertNull($dataCollector->getLocale());
         $this->assertSame([], $dataCollector->getFallbackLocales());
+        $this->assertSame([], $dataCollector->getGlobalParameters());
     }
 
     private function getTranslator()

Tests/DataCollectorTranslatorTest.php

@@ -14,6 +14,7 @@
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\Translation\DataCollectorTranslator;
 use Symfony\Component\Translation\Loader\ArrayLoader;
+use Symfony\Component\Translation\TranslatableMessage;
 use Symfony\Component\Translation\Translator;
 
 class DataCollectorTranslatorTest extends TestCase
@@ -84,6 +85,18 @@ public function testCollectMessages()
         $this->assertEquals($expectedMessages, $collector->getCollectedMessages());
     }
 
+    public function testGetGlobalParameters()
+    {
+        $translatable = new TranslatableMessage('url.front');
+
+        $translator = new Translator('en');
+        $translator->addGlobalParameter('app', 'My app');
+        $translator->addGlobalParameter('url', $translatable);
+        $collector = new DataCollectorTranslator($translator);
+
+        $this->assertEquals(['app' => 'My app', 'url' => $translatable], $collector->getGlobalParameters());
+    }
+
     private function createCollector()
     {
         $translator = new Translator('en');

Tests/TranslatorTest.php

@@ -602,6 +602,56 @@ public function testMissingLoaderForResourceError()
 
         $translator->getCatalogue('en');
     }
+
+    public function testTransWithGlobalParameters()
+    {
+        $translator = new Translator('en');
+        $translator->addLoader('array', new ArrayLoader());
+        $translator->addResource('array', ['welcome' => 'Welcome {name}!'], 'en');
+        $translator->addResource('array', ['welcome' => 'Bienvenue {name}!'], 'fr');
+        $translator->addGlobalParameter('{name}', 'Global name');
+
+        $this->assertSame('Welcome Global name!', $translator->trans('welcome'));
+        $this->assertSame('Bienvenue Global name!', $translator->trans('welcome', [], null, 'fr'));
+        $this->assertSame('Welcome John!', $translator->trans('welcome', ['{name}' => 'John']));
+        $this->assertSame('Bienvenue Jean!', $translator->trans('welcome', ['{name}' => 'Jean'], null, 'fr'));
+    }
+
+    public function testTransWithGlobalTranslatableParameters()
+    {
+        $translator = new Translator('en');
+        $translator->addLoader('array', new ArrayLoader());
+        $translator->addResource('array', ['welcome' => 'Welcome on {link}!'], 'en');
+        $translator->addResource('array', ['welcome' => 'Bienvenue sur {link}!'], 'fr');
+
+        $translator->addResource('array', ['url' => 'example.com/admin'], 'en', 'globals');
+        $translator->addResource('array', ['url' => 'example.fr/admin'], 'fr', 'globals');
+
+        $translator->addGlobalParameter('{link}', new TranslatableMessage('url', [], 'globals'));
+
+        $this->assertSame('Welcome on example.com/admin!', $translator->trans('welcome'));
+        $this->assertSame('Bienvenue sur example.fr/admin!', $translator->trans('welcome', [], null, 'fr'));
+        $this->assertSame('Welcome on other.com!', $translator->trans('welcome', ['{link}' => 'other.com']));
+        $this->assertSame('Bienvenue sur autre.fr!', $translator->trans('welcome', ['{link}' => 'autre.fr'], null, 'fr'));
+    }
+
+    /**
+     * @requires extension intl
+     */
+    public function testTransICUWithGlobalParameters()
+    {
+        $domain = 'test.'.MessageCatalogue::INTL_DOMAIN_SUFFIX;
+
+        $translator = new Translator('en');
+        $translator->addLoader('array', new ArrayLoader());
+        $translator->addResource('array', [
+            'apples' => '{apples, plural, =0 {There are no apples} one {There is one apple} other {There are # apples}}',
+        ], 'en', $domain);
+        $translator->addGlobalParameter('{apples}', 42);
+
+        $this->assertSame('There are 42 apples', $translator->trans('apples', [], $domain));
+        $this->assertSame('There is one apple', $translator->trans('apples', ['{apples}' => 1], $domain));
+    }
 }
 
 class StringClass

Translator.php

@@ -60,6 +60,16 @@ class Translator implements TranslatorInterface, TranslatorBagInterface, LocaleA
 
     private bool $hasIntlFormatter;
 
+    /**
+     * @var array<string, string|int|float|TranslatableInterface>
+     */
+    private array $globalParameters = [];
+
+    /**
+     * @var array<string, string|int|float>
+     */
+    private array $globalTranslatedParameters = [];
+
     /**
      * @throws InvalidArgumentException If a locale contains invalid characters
      */
@@ -155,6 +165,17 @@ public function getFallbackLocales(): array
         return $this->fallbackLocales;
     }
 
+    public function addGlobalParameter(string $id, string|int|float|TranslatableInterface $value): void
+    {
+        $this->globalParameters[$id] = $value;
+        $this->globalTranslatedParameters = [];
+    }
+
+    public function getGlobalParameters(): array
+    {
+        return $this->globalParameters;
+    }
+
     public function trans(?string $id, array $parameters = [], ?string $domain = null, ?string $locale = null): string
     {
         if (null === $id || '' === $id) {
@@ -174,7 +195,24 @@ public function trans(?string $id, array $parameters = [], ?string $domain = nul
             }
         }
 
-        $parameters = array_map(fn ($parameter) => $parameter instanceof TranslatableInterface ? $parameter->trans($this, $locale) : $parameter, $parameters);
+        foreach ($parameters as $key => $value) {
+            if ($value instanceof TranslatableInterface) {
+                $parameters[$key] = $value->trans($this, $locale);
+            }
+        }
+
+        if (null === $globalParameters =& $this->globalTranslatedParameters[$locale]) {
+            $globalParameters = $this->globalParameters;
+            foreach ($globalParameters as $key => $value) {
+                if ($value instanceof TranslatableInterface) {
+                    $globalParameters[$key] = $value->trans($this, $locale);
+                }
+            }
+        }
+
+        if ($globalParameters) {
+            $parameters += $globalParameters;
+        }
 
         $len = \strlen(MessageCatalogue::INTL_DOMAIN_SUFFIX);
         if ($this->hasIntlFormatter