rename to DefaultParametersTranslator

Jean-Beru · Jean-Beru · commit aab1d7461cbe · 2024-01-05T22:20:19.000+01:00
diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Configuration.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Configuration.php
@@ -929,7 +929,7 @@ private function addTranslatorSection(ArrayNodeDefinition $rootNode, callable $e
                     ->fixXmlConfig('fallback')
                     ->fixXmlConfig('path')
                     ->fixXmlConfig('provider')
-                    ->fixXmlConfig('global')
+                    ->fixXmlConfig('default_parameter')
                     ->children()
                         ->arrayNode('fallbacks')
                             ->info('Defaults to the value of "default_locale".')
@@ -984,9 +984,9 @@ private function addTranslatorSection(ArrayNodeDefinition $rootNode, callable $e
                             ->end()
                             ->defaultValue([])
                         ->end()
-                        ->arrayNode('globals')
-                            ->info('Global parameters.')
-                            ->example(['pi' => 3.14])
+                        ->arrayNode('default_parameters')
+                            ->info('Default parameters.')
+                            ->example(['app_version' => 3.14])
                             ->normalizeKeys(false)
                             ->useAttributeAsKey('name')
                             ->prototype('scalar')->end()
diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php
@@ -164,7 +164,7 @@
 use Symfony\Component\Translation\Bridge as TranslationBridge;
 use Symfony\Component\Translation\Command\XliffLintCommand as BaseXliffLintCommand;
 use Symfony\Component\Translation\Extractor\PhpAstExtractor;
-use Symfony\Component\Translation\GlobalsTranslator;
+use Symfony\Component\Translation\DefaultParametersTranslator;
 use Symfony\Component\Translation\LocaleSwitcher;
 use Symfony\Component\Translation\PseudoLocalizationTranslator;
 use Symfony\Component\Translation\Translator;
@@ -1581,15 +1581,15 @@ private function registerTranslatorConfiguration(array $config, ContainerBuilder
             }
         }
 
-        if (!empty($config['globals'])) {
+        if (!empty($config['default_parameters'])) {
             $def = $container
-                ->register('translator.globals', GlobalsTranslator::class)
+                ->register('translator.default_parameters', DefaultParametersTranslator::class)
                 ->setDecoratedService('translator', null, -1) // Lower priority than "translator.data_collector"
                 ->setArguments([
-                    new Reference('translator.globals.inner'),
+                    new Reference('translator.default_parameters.inner'),
                 ]);
-            foreach ($config['globals'] as $key => $value) {
-                $def->addMethodCall('addGlobal', [$key, $value]);
+            foreach ($config['default_parameters'] as $key => $value) {
+                $def->addMethodCall('addDefaultParameter', [$key, $value]);
             }
         }
 
diff --git a/src/Symfony/Bundle/FrameworkBundle/Resources/config/schema/symfony-1.0.xsd b/src/Symfony/Bundle/FrameworkBundle/Resources/config/schema/symfony-1.0.xsd
@@ -230,15 +230,15 @@
             <xsd:element name="path" type="xsd:string" minOccurs="0" maxOccurs="unbounded" />
             <xsd:element name="pseudo-localization" type="pseudo_localization" minOccurs="0" maxOccurs="1" />
             <xsd:element name="provider" type="translation_provider" minOccurs="0" maxOccurs="unbounded" />
-            <xsd:element name="global" type="translation_global" minOccurs="0" maxOccurs="unbounded" />
+            <xsd:element name="default-parameter" type="translation_default_parameter" minOccurs="0" maxOccurs="unbounded" />
         </xsd:sequence>
         <xsd:attribute name="enabled" type="xsd:boolean" />
         <xsd:attribute name="fallback" type="xsd:string" />
         <xsd:attribute name="logging" type="xsd:boolean" />
         <xsd:attribute name="formatter" type="xsd:string" />
         <xsd:attribute name="cache-dir" type="xsd:string" />
         <xsd:attribute name="default-path" type="xsd:string" />
-        <xsd:attribute name="global" type="xsd:string" />
+        <xsd:attribute name="default-parameter" type="xsd:string" />
     </xsd:complexType>
 
     <xsd:complexType name="pseudo_localization">
@@ -261,7 +261,7 @@
         <xsd:attribute name="dsn" type="xsd:string" />
     </xsd:complexType>
 
-    <xsd:complexType name="translation_global" mixed="true">
+    <xsd:complexType name="translation_default_parameter" mixed="true">
         <xsd:attribute name="name" type="xsd:string" use="required" />
         <xsd:attribute name="value" type="xsd:string" />
     </xsd:complexType>
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/ConfigurationTest.php b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/ConfigurationTest.php
@@ -591,7 +591,7 @@ protected static function getBundleDefaultConfig()
                     'localizable_html_attributes' => [],
                 ],
                 'providers' => [],
-                'globals' => [],
+                'default_parameters' => [],
             ],
             'validation' => [
                 'enabled' => !class_exists(FullStack::class),
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/php/translator_default_parameters.php b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/php/translator_default_parameters.php
@@ -6,7 +6,7 @@
     'handle_all_throwables' => true,
     'php_errors' => ['log' => true],
     'translator' => [
-        'globals' => [
+        'default_parameters' => [
             '%%app_name%%' => 'My application',
             '{app_version}' => '1.2.3',
         ],
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/php/translator_without_default_parameters.php b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/php/translator_without_default_parameters.php
@@ -5,5 +5,5 @@
     'http_method_override' => false,
     'handle_all_throwables' => true,
     'php_errors' => ['log' => true],
-    'translator' => [],
+    'translator' => ['default_parameters' => []],
 ]);
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/xml/translator_default_parameters.xml b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/xml/translator_default_parameters.xml
@@ -10,8 +10,8 @@
         <framework:annotations enabled="false" />
         <framework:php-errors log="true" />
         <framework:translator enabled="true">
-            <framework:global name="%%app_name%%" value="My application" />
-            <framework:global name="{app_version}" value="1.2.3" />
+            <framework:default-parameter name="%%app_name%%" value="My application" />
+            <framework:default-parameter name="{app_version}" value="1.2.3" />
         </framework:translator>
     </framework:config>
 </container>
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/xml/translator_without_default_parameters.xml b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/xml/translator_without_default_parameters.xml
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/yml/translator_default_parameters.yml b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/yml/translator_default_parameters.yml
@@ -5,6 +5,6 @@ framework:
     php_errors:
         log: true
     translator:
-        globals:
+        default_parameters:
             '%%app_name%%': 'My application'
             '{app_version}': '1.2.3'
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/yml/translator_without_default_parameters.yml b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/yml/translator_without_default_parameters.yml
@@ -5,4 +5,4 @@ framework:
     php_errors:
         log: true
     translator:
-        globals: []
+        default_parameters: []
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/FrameworkExtensionTestCase.php b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/FrameworkExtensionTestCase.php
@@ -1182,20 +1182,20 @@ public function testTranslatorCacheDirDisabled()
         $this->assertNull($options['cache_dir']);
     }
 
-    public function testTranslatorGlobals()
+    public function testTranslatorDefaultParameters()
     {
-        $container = $this->createContainerFromFile('translator_globals');
-        $calls = $container->getDefinition('translator.globals')->getMethodCalls();
+        $container = $this->createContainerFromFile('translator_default_parameters');
+        $calls = $container->getDefinition('translator.default_parameters')->getMethodCalls();
         $this->assertSame([
-            ['addGlobal', ['%%app_name%%', 'My application']],
-            ['addGlobal', ['{app_version}', '1.2.3']],
+            ['addDefaultParameter', ['%%app_name%%', 'My application']],
+            ['addDefaultParameter', ['{app_version}', '1.2.3']],
         ], $calls);
     }
 
-    public function testTranslatorWithoutGlobals()
+    public function testTranslatorWithoutDefaultParameters()
     {
-        $container = $this->createContainerFromFile('translator_without_globals');
-        $this->assertFalse($container->hasDefinition('translator.globals'));
+        $container = $this->createContainerFromFile('translator_without_default_parameters');
+        $this->assertFalse($container->hasDefinition('translator.default_parameters'));
     }
 
     public function testValidation()
diff --git a/src/Symfony/Component/Translation/DefaultParametersTranslator.php b/src/Symfony/Component/Translation/DefaultParametersTranslator.php
@@ -13,9 +13,9 @@
 
 use Symfony\Contracts\Translation\TranslatorInterface;
 
-final class GlobalsTranslator implements TranslatorInterface
+final class DefaultParametersTranslator implements TranslatorInterface
 {
-    private array $globals = [];
+    private array $defaultParameters = [];
 
     public function __construct(
         private readonly TranslatorInterface $translator,
@@ -24,7 +24,7 @@ public function __construct(
 
     public function trans(string $id, array $parameters = [], string $domain = null, string $locale = null): string
     {
-        $parameters = array_replace($this->globals, $parameters);
+        $parameters = array_replace($this->defaultParameters, $parameters);
 
         return $this->translator->trans($id, $parameters, $domain, $locale);
     }
@@ -34,8 +34,8 @@ public function getLocale(): string
         return $this->translator->getLocale();
     }
 
-    public function addGlobal(string $name, mixed $value): void
+    public function addDefaultParameter(string $name, mixed $value): void
     {
-        $this->globals[$name] = $value;
+        $this->defaultParameters[$name] = $value;
     }
 }
diff --git a/src/Symfony/Component/Translation/Tests/DefaultParametersTranslatorTest.php b/src/Symfony/Component/Translation/Tests/DefaultParametersTranslatorTest.php
@@ -12,30 +12,30 @@
 namespace Symfony\Component\Translation\Tests;
 
 use PHPUnit\Framework\TestCase;
-use Symfony\Component\Translation\GlobalsTranslator;
+use Symfony\Component\Translation\DefaultParametersTranslator;
 use Symfony\Component\Translation\Loader\ArrayLoader;
 use Symfony\Component\Translation\Translator;
 
-class GlobalTranslatorTest extends TestCase
+class DefaultParametersTranslatorTest extends TestCase
 {
     public function testTrans()
     {
         $translator = new Translator('en');
         $translator->addLoader('array', new ArrayLoader());
         $translator->addResource('array', ['test' => 'Welcome %name%!'], 'en');
 
-        $globalTranslator = new GlobalsTranslator($translator);
-        $globalTranslator->addGlobal('%name%', 'Global name');
+        $defaultParametersTranslator = new DefaultParametersTranslator($translator);
+        $defaultParametersTranslator->addDefaultParameter('%name%', 'Global name');
 
-        $this->assertSame('Welcome Global name!', $globalTranslator->trans('test'));
-        $this->assertSame('Welcome Name!', $globalTranslator->trans('test', ['%name%' => 'Name']));
+        $this->assertSame('Welcome Global name!', $defaultParametersTranslator->trans('test'));
+        $this->assertSame('Welcome Name!', $defaultParametersTranslator->trans('test', ['%name%' => 'Name']));
     }
 
     public function testGetLocale()
     {
         $translator = new Translator('en');
-        $globalTranslator = new GlobalsTranslator($translator);
+        $defaultParametersTranslator = new DefaultParametersTranslator($translator);
 
-        $this->assertSame('en', $globalTranslator->getLocale());
+        $this->assertSame('en', $defaultParametersTranslator->getLocale());
     }
 }
