[Translation] Support adding custom message formatter

aitboudad · aitboudad · commit e070bc5a8519 · 2017-09-12T13:17:01.000+01:00
diff --git a/DependencyInjection/Configuration.php b/DependencyInjection/Configuration.php
@@ -668,6 +668,7 @@ private function addTranslatorSection(ArrayNodeDefinition $rootNode)
                             ->defaultValue(array('en'))
                         ->end()
                         ->booleanNode('logging')->defaultValue($this->debug)->end()
+                        ->scalarNode('formatter')->defaultValue('translator.formatter.default')->end()
                         ->arrayNode('paths')
                             ->prototype('scalar')->end()
                         ->end()
diff --git a/DependencyInjection/FrameworkExtension.php b/DependencyInjection/FrameworkExtension.php
@@ -1075,6 +1075,7 @@ private function registerTranslatorConfiguration(array $config, ContainerBuilder
 
         // Use the "real" translator instead of the identity default
         $container->setAlias('translator', 'translator.default');
+        $container->setAlias('translator.formatter', new Alias($config['formatter'], false));
         $translator = $container->findDefinition('translator.default');
         $translator->addMethodCall('setFallbackLocales', array($config['fallbacks']));
 
diff --git a/Resources/config/schema/symfony-1.0.xsd b/Resources/config/schema/symfony-1.0.xsd
@@ -184,6 +184,7 @@
         <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:complexType>
 
     <xsd:complexType name="validation">
diff --git a/Resources/config/translation.xml b/Resources/config/translation.xml
@@ -9,7 +9,7 @@
 
         <service id="translator.default" class="Symfony\Bundle\FrameworkBundle\Translation\Translator" public="true">
             <argument /> <!-- translation loaders locator -->
-            <argument type="service" id="translator.selector" />
+            <argument type="service" id="translator.formatter" />
             <argument>%kernel.default_locale%</argument>
             <argument type="collection" /> <!-- translation loaders ids -->
             <argument type="collection">
@@ -28,6 +28,10 @@
             <tag name="monolog.logger" channel="translation" />
         </service>
 
+        <service id="translator.formatter.default" class="Symfony\Component\Translation\Formatter\MessageFormatter">
+            <argument type="service" id="translator.selector" />
+        </service>
+
         <service id="translation.loader.php" class="Symfony\Component\Translation\Loader\PhpFileLoader" public="true">
             <tag name="translation.loader" alias="php" />
         </service>
diff --git a/Tests/DependencyInjection/ConfigurationTest.php b/Tests/DependencyInjection/ConfigurationTest.php
@@ -255,6 +255,7 @@ protected static function getBundleDefaultConfig()
                 'enabled' => !class_exists(FullStack::class),
                 'fallbacks' => array('en'),
                 'logging' => true,
+                'formatter' => 'translator.formatter.default',
                 'paths' => array(),
             ),
             'validation' => array(
diff --git a/Tests/Translation/TranslatorTest.php b/Tests/Translation/TranslatorTest.php
@@ -14,9 +14,9 @@
 use PHPUnit\Framework\TestCase;
 use Psr\Container\ContainerInterface;
 use Symfony\Bundle\FrameworkBundle\Translation\Translator;
+use Symfony\Component\Translation\Formatter\MessageFormatter;
 use Symfony\Component\Translation\MessageCatalogue;
 use Symfony\Component\Filesystem\Filesystem;
-use Symfony\Component\Translation\MessageSelector;
 
 class TranslatorTest extends TestCase
 {
@@ -149,7 +149,7 @@ public function testGetDefaultLocaleOmittingLocale()
             ->with('kernel.default_locale')
             ->will($this->returnValue('en'))
         ;
-        $translator = new Translator($container, new MessageSelector());
+        $translator = new Translator($container, new MessageFormatter());
 
         $this->assertSame('en', $translator->getLocale());
     }
@@ -162,7 +162,7 @@ public function testGetDefaultLocaleOmittingLocale()
     public function testGetDefaultLocaleOmittingLocaleWithPsrContainer()
     {
         $container = $this->getMockBuilder(ContainerInterface::class)->getMock();
-        $translator = new Translator($container, new MessageSelector());
+        $translator = new Translator($container, new MessageFormatter());
     }
 
     /**
@@ -277,7 +277,7 @@ public function testLoadResourcesWithoutCaching()
     public function testGetDefaultLocale()
     {
         $container = $this->getMockBuilder(ContainerInterface::class)->getMock();
-        $translator = new Translator($container, new MessageSelector(), 'en');
+        $translator = new Translator($container, new MessageFormatter(), 'en');
 
         $this->assertSame('en', $translator->getLocale());
     }
@@ -290,7 +290,7 @@ public function testInvalidOptions()
     {
         $container = $this->getMockBuilder('Symfony\Component\DependencyInjection\ContainerInterface')->getMock();
 
-        (new Translator($container, new MessageSelector(), 'en', array(), array('foo' => 'bar')));
+        (new Translator($container, new MessageFormatter(), 'en', array(), array('foo' => 'bar')));
     }
 
     /** @dataProvider getDebugModeAndCacheDirCombinations */
@@ -468,15 +468,15 @@ private function createTranslator($loader, $options, $translatorClass = '\Symfon
         if (null === $defaultLocale) {
             return new $translatorClass(
                 $this->getContainer($loader),
-                new MessageSelector(),
+                new MessageFormatter(),
                 array($loaderFomat => array($loaderFomat)),
                 $options
             );
         }
 
         return new $translatorClass(
             $this->getContainer($loader),
-            new MessageSelector(),
+            new MessageFormatter(),
             $defaultLocale,
             array($loaderFomat => array($loaderFomat)),
             $options
diff --git a/Translation/Translator.php b/Translation/Translator.php
@@ -15,8 +15,8 @@
 use Symfony\Component\DependencyInjection\ContainerInterface as SymfonyContainerInterface;
 use Symfony\Component\HttpKernel\CacheWarmer\WarmableInterface;
 use Symfony\Component\Translation\Translator as BaseTranslator;
-use Symfony\Component\Translation\MessageSelector;
 use Symfony\Component\Translation\Exception\InvalidArgumentException;
+use Symfony\Component\Translation\Formatter\MessageFormatterInterface;
 
 /**
  * Translator.
@@ -56,15 +56,15 @@ class Translator extends BaseTranslator implements WarmableInterface
      *   * debug:     Whether to enable debugging or not (false by default)
      *   * resource_files: List of translation resources available grouped by locale.
      *
-     * @param ContainerInterface $container     A ContainerInterface instance
-     * @param MessageSelector    $selector      The message selector for pluralization
-     * @param string             $defaultLocale
-     * @param array              $loaderIds     An array of loader Ids
-     * @param array              $options       An array of options
+     * @param ContainerInterface        $container     A ContainerInterface instance
+     * @param MessageFormatterInterface $formatter     The message formatter
+     * @param string                    $defaultLocale
+     * @param array                     $loaderIds     An array of loader Ids
+     * @param array                     $options       An array of options
      *
      * @throws InvalidArgumentException
      */
-    public function __construct(ContainerInterface $container, MessageSelector $selector, $defaultLocale = null, array $loaderIds = array(), array $options = array())
+    public function __construct(ContainerInterface $container, $formatter, $defaultLocale = null, array $loaderIds = array(), array $options = array())
     {
         // BC 3.x, to be removed in 4.0 along with the $defaultLocale default value
         if (is_array($defaultLocale) || 3 > func_num_args()) {
@@ -90,7 +90,7 @@ public function __construct(ContainerInterface $container, MessageSelector $sele
         $this->resourceLocales = array_keys($this->options['resource_files']);
         $this->addResourceFiles($this->options['resource_files']);
 
-        parent::__construct($defaultLocale, $selector, $this->options['cache_dir'], $this->options['debug']);
+        parent::__construct($defaultLocale, $formatter, $this->options['cache_dir'], $this->options['debug']);
     }
 
     /**

Original file line number	Diff line number	Diff line change
`@@ -14,9 +14,9 @@`
`14`	`14`	`use PHPUnit\Framework\TestCase;`
`15`	`15`	`use Psr\Container\ContainerInterface;`
`16`	`16`	`use Symfony\Bundle\FrameworkBundle\Translation\Translator;`
	`17`	`+use Symfony\Component\Translation\Formatter\MessageFormatter;`
`17`	`18`	`use Symfony\Component\Translation\MessageCatalogue;`
`18`	`19`	`use Symfony\Component\Filesystem\Filesystem;`
`19`		`-use Symfony\Component\Translation\MessageSelector;`
`20`	`20`
`21`	`21`	`class TranslatorTest extends TestCase`
`22`	`22`	`{`
`@@ -149,7 +149,7 @@ public function testGetDefaultLocaleOmittingLocale()`
`149`	`149`	`->with('kernel.default_locale')`
`150`	`150`	`->will($this->returnValue('en'))`
`151`	`151`	`;`
`152`		`- $translator = new Translator($container, new MessageSelector());`
	`152`	`+ $translator = new Translator($container, new MessageFormatter());`
`153`	`153`
`154`	`154`	`$this->assertSame('en', $translator->getLocale());`
`155`	`155`	`}`
`@@ -162,7 +162,7 @@ public function testGetDefaultLocaleOmittingLocale()`
`162`	`162`	`public function testGetDefaultLocaleOmittingLocaleWithPsrContainer()`
`163`	`163`	`{`
`164`	`164`	`$container = $this->getMockBuilder(ContainerInterface::class)->getMock();`
`165`		`- $translator = new Translator($container, new MessageSelector());`
	`165`	`+ $translator = new Translator($container, new MessageFormatter());`
`166`	`166`	`}`
`167`	`167`
`168`	`168`	`/**`
`@@ -277,7 +277,7 @@ public function testLoadResourcesWithoutCaching()`
`277`	`277`	`public function testGetDefaultLocale()`
`278`	`278`	`{`
`279`	`279`	`$container = $this->getMockBuilder(ContainerInterface::class)->getMock();`
`280`		`- $translator = new Translator($container, new MessageSelector(), 'en');`
	`280`	`+ $translator = new Translator($container, new MessageFormatter(), 'en');`
`281`	`281`
`282`	`282`	`$this->assertSame('en', $translator->getLocale());`
`283`	`283`	`}`
`@@ -290,7 +290,7 @@ public function testInvalidOptions()`
`290`	`290`	`{`
`291`	`291`	`$container = $this->getMockBuilder('Symfony\Component\DependencyInjection\ContainerInterface')->getMock();`
`292`	`292`
`293`		`- (new Translator($container, new MessageSelector(), 'en', array(), array('foo' => 'bar')));`
	`293`	`+ (new Translator($container, new MessageFormatter(), 'en', array(), array('foo' => 'bar')));`
`294`	`294`	`}`
`295`	`295`
`296`	`296`	`/** @dataProvider getDebugModeAndCacheDirCombinations */`
`@@ -468,15 +468,15 @@ private function createTranslator($loader, $options, $translatorClass = '\Symfon`
`468`	`468`	`if (null === $defaultLocale) {`
`469`	`469`	`return new $translatorClass(`
`470`	`470`	`$this->getContainer($loader),`
`471`		`- new MessageSelector(),`
	`471`	`+ new MessageFormatter(),`
`472`	`472`	`array($loaderFomat => array($loaderFomat)),`
`473`	`473`	`$options`
`474`	`474`	`);`
`475`	`475`	`}`
`476`	`476`
`477`	`477`	`return new $translatorClass(`
`478`	`478`	`$this->getContainer($loader),`
`479`		`- new MessageSelector(),`
	`479`	`+ new MessageFormatter(),`
`480`	`480`	`$defaultLocale,`
`481`	`481`	`array($loaderFomat => array($loaderFomat)),`
`482`	`482`	`$options`