[FrameworkBundle] Register an identity translator as fallback

yceruto · nicolas-grekas · commit 43d20b1a205d · 2018-09-20T13:37:41.000+02:00
The Form component can be used without the Translation component.
However, to be able to use the default form themes provided by the
FrameworkBundle you need to have the `translator` helper to be
available.

This change ensure that there will always be a `translator` helper which
as a fallback will just return the message key if no translator is
present.
diff --git a/src/Symfony/Bridge/Twig/Extension/TranslationExtension.php b/src/Symfony/Bridge/Twig/Extension/TranslationExtension.php
@@ -17,6 +17,7 @@
 use Symfony\Bridge\Twig\TokenParser\TransDefaultDomainTokenParser;
 use Symfony\Bridge\Twig\TokenParser\TransTokenParser;
 use Symfony\Contracts\Translation\TranslatorInterface;
+use Symfony\Contracts\Translation\TranslatorTrait;
 use Twig\Extension\AbstractExtension;
 use Twig\NodeVisitor\NodeVisitorInterface;
 use Twig\TokenParser\AbstractTokenParser;
@@ -29,6 +30,13 @@
  */
 class TranslationExtension extends AbstractExtension
 {
+    use TranslatorTrait {
+        getLocale as private;
+        setLocale as private;
+        trans as private doTrans;
+        transChoice as private doTransChoice;
+    }
+
     private $translator;
     private $translationNodeVisitor;
 
@@ -50,7 +58,7 @@ public function getFilters()
     {
         return array(
             new TwigFilter('trans', array($this, 'trans')),
-            new TwigFilter('transchoice', array($this, 'transchoice')),
+            new TwigFilter('transchoice', array($this, 'transChoice')),
         );
     }
 
@@ -91,16 +99,16 @@ public function getTranslationNodeVisitor()
     public function trans($message, array $arguments = array(), $domain = null, $locale = null)
     {
         if (null === $this->translator) {
-            return strtr($message, $arguments);
+            return $this->doTrans($message, $arguments, $domain, $locale);
         }
 
         return $this->translator->trans($message, $arguments, $domain, $locale);
     }
 
-    public function transchoice($message, $count, array $arguments = array(), $domain = null, $locale = null)
+    public function transChoice($message, $count, array $arguments = array(), $domain = null, $locale = null)
     {
         if (null === $this->translator) {
-            return strtr($message, $arguments);
+            return $this->doTransChoice($message, $count, array_merge(array('%count%' => $count), $arguments), $domain, $locale);
         }
 
         return $this->translator->transChoice($message, $count, array_merge(array('%count%' => $count), $arguments), $domain, $locale);
diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php
@@ -873,10 +873,6 @@ private function registerTemplatingConfiguration(array $config, ContainerBuilder
             } else {
                 $container->removeDefinition('templating.helper.assets');
             }
-
-            if (!$this->translationConfigEnabled) {
-                $container->removeDefinition('templating.helper.translator');
-            }
         }
     }
 
diff --git a/src/Symfony/Bundle/FrameworkBundle/Resources/config/templating_php.xml b/src/Symfony/Bundle/FrameworkBundle/Resources/config/templating_php.xml
@@ -58,7 +58,7 @@
 
         <service id="templating.helper.translator" class="Symfony\Bundle\FrameworkBundle\Templating\Helper\TranslatorHelper">
             <tag name="templating.helper" alias="translator" />
-            <argument type="service" id="translator" />
+            <argument type="service" id="translator" on-invalid="null" />
         </service>
 
         <service id="templating.helper.form" class="Symfony\Bundle\FrameworkBundle\Templating\Helper\FormHelper">
diff --git a/src/Symfony/Bundle/FrameworkBundle/Templating/Helper/TranslatorHelper.php b/src/Symfony/Bundle/FrameworkBundle/Templating/Helper/TranslatorHelper.php
@@ -13,15 +13,23 @@
 
 use Symfony\Component\Templating\Helper\Helper;
 use Symfony\Contracts\Translation\TranslatorInterface;
+use Symfony\Contracts\Translation\TranslatorTrait;
 
 /**
  * @author Fabien Potencier <fabien@symfony.com>
  */
 class TranslatorHelper extends Helper
 {
+    use TranslatorTrait {
+        getLocale as private;
+        setLocale as private;
+        trans as private doTrans;
+        transChoice as private doTransChoice;
+    }
+
     protected $translator;
 
-    public function __construct(TranslatorInterface $translator)
+    public function __construct(TranslatorInterface $translator = null)
     {
         $this->translator = $translator;
     }
@@ -31,6 +39,10 @@ public function __construct(TranslatorInterface $translator)
      */
     public function trans($id, array $parameters = array(), $domain = 'messages', $locale = null)
     {
+        if (null === $this->translator) {
+            return $this->doTrans($id, $parameters, $domain, $locale);
+        }
+
         return $this->translator->trans($id, $parameters, $domain, $locale);
     }
 
@@ -39,6 +51,10 @@ public function trans($id, array $parameters = array(), $domain = 'messages', $l
      */
     public function transChoice($id, $number, array $parameters = array(), $domain = 'messages', $locale = null)
     {
+        if (null === $this->translator) {
+            return $this->doTransChoice($id, $number, $parameters, $domain, $locale);
+        }
+
         return $this->translator->transChoice($id, $number, $parameters, $domain, $locale);
     }
 
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/php/templating_php_translator_disabled.php b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/php/templating_php_translator_disabled.php
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/php/templating_php_translator_enabled.php b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/php/templating_php_translator_enabled.php
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/FrameworkExtensionTest.php b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/FrameworkExtensionTest.php
@@ -701,20 +701,6 @@ public function testTranslatorMultipleFallbacks()
         $this->assertEquals(array('en', 'fr'), $calls[1][1][0]);
     }
 
-    public function testTranslatorHelperIsRegisteredWhenTranslatorIsEnabled()
-    {
-        $container = $this->createContainerFromFile('templating_php_translator_enabled');
-
-        $this->assertTrue($container->has('templating.helper.translator'));
-    }
-
-    public function testTranslatorHelperIsNotRegisteredWhenTranslatorIsDisabled()
-    {
-        $container = $this->createContainerFromFile('templating_php_translator_disabled');
-
-        $this->assertFalse($container->has('templating.helper.translator'));
-    }
-
     /**
      * @expectedException \Symfony\Component\Config\Definition\Exception\InvalidConfigurationException
      */

Original file line number	Diff line number	Diff line change
`@@ -17,6 +17,7 @@`
`17`	`17`	`use Symfony\Bridge\Twig\TokenParser\TransDefaultDomainTokenParser;`
`18`	`18`	`use Symfony\Bridge\Twig\TokenParser\TransTokenParser;`
`19`	`19`	`use Symfony\Contracts\Translation\TranslatorInterface;`
	`20`	`+use Symfony\Contracts\Translation\TranslatorTrait;`
`20`	`21`	`use Twig\Extension\AbstractExtension;`
`21`	`22`	`use Twig\NodeVisitor\NodeVisitorInterface;`
`22`	`23`	`use Twig\TokenParser\AbstractTokenParser;`
`@@ -29,6 +30,13 @@`
`29`	`30`	`*/`
`30`	`31`	`class TranslationExtension extends AbstractExtension`
`31`	`32`	`{`
	`33`	`+ use TranslatorTrait {`
	`34`	`+ getLocale as private;`
	`35`	`+ setLocale as private;`
	`36`	`+ trans as private doTrans;`
	`37`	`+ transChoice as private doTransChoice;`
	`38`	`+ }`
	`39`	`+`
`32`	`40`	`private $translator;`
`33`	`41`	`private $translationNodeVisitor;`
`34`	`42`
`@@ -50,7 +58,7 @@ public function getFilters()`
`50`	`58`	`{`
`51`	`59`	`return array(`
`52`	`60`	`new TwigFilter('trans', array($this, 'trans')),`
`53`		`- new TwigFilter('transchoice', array($this, 'transchoice')),`
	`61`	`+ new TwigFilter('transchoice', array($this, 'transChoice')),`
`54`	`62`	`);`
`55`	`63`	`}`
`56`	`64`
`@@ -91,16 +99,16 @@ public function getTranslationNodeVisitor()`
`91`	`99`	`public function trans($message, array $arguments = array(), $domain = null, $locale = null)`
`92`	`100`	`{`
`93`	`101`	`if (null === $this->translator) {`
`94`		`- return strtr($message, $arguments);`
	`102`	`+ return $this->doTrans($message, $arguments, $domain, $locale);`
`95`	`103`	`}`
`96`	`104`
`97`	`105`	`return $this->translator->trans($message, $arguments, $domain, $locale);`
`98`	`106`	`}`
`99`	`107`
`100`		`- public function transchoice($message, $count, array $arguments = array(), $domain = null, $locale = null)`
	`108`	`+ public function transChoice($message, $count, array $arguments = array(), $domain = null, $locale = null)`
`101`	`109`	`{`
`102`	`110`	`if (null === $this->translator) {`
`103`		`- return strtr($message, $arguments);`
	`111`	`+ return $this->doTransChoice($message, $count, array_merge(array('%count%' => $count), $arguments), $domain, $locale);`
`104`	`112`	`}`
`105`	`113`
`106`	`114`	`return $this->translator->transChoice($message, $count, array_merge(array('%count%' => $count), $arguments), $domain, $locale);`
Original file line number	Diff line number	Diff line change
`@@ -873,10 +873,6 @@ private function registerTemplatingConfiguration(array $config, ContainerBuilder`
`873`	`873`	`} else {`
`874`	`874`	`$container->removeDefinition('templating.helper.assets');`
`875`	`875`	`}`
`876`		`-`
`877`		`- if (!$this->translationConfigEnabled) {`
`878`		`- $container->removeDefinition('templating.helper.translator');`
`879`		`- }`
`880`	`876`	`}`
`881`	`877`	`}`
`882`	`878`