feature #31451 [FrameworkBundle] Allow dots in translation domains (jschaedl)

fabpot · fabpot · commit c33f69c5d9d5 · 2019-06-11T08:42:31.000+02:00
This PR was merged into the 4.4 branch. Discussion ---------- [FrameworkBundle] Allow dots in translation domains | Q | A | ------------- | --- | Branch? | 4.4 | Bug fix? | yes | New feature? | no  | BC breaks? | no  | Deprecations? | no  | Tests pass? | yes  | Fixed tickets | #31400  | License | MIT | Doc PR | tbd.  ### Description With this fix it is now possible to have `.` in translation domains like `app.security.en.yaml`. ### Todo - [x] add a test case Commits ------- 4b593b0 [FrameworkBundle] Allow dots in translation domains
diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php
@@ -1167,14 +1167,15 @@ private function registerTranslatorConfiguration(array $config, ContainerBuilder
                 ->followLinks()
                 ->files()
                 ->filter(function (\SplFileInfo $file) {
-                    return 2 === substr_count($file->getBasename(), '.') && preg_match('/\.\w+$/', $file->getBasename());
+                    return 2 <= substr_count($file->getBasename(), '.') && preg_match('/\.\w+$/', $file->getBasename());
                 })
                 ->in($dirs)
                 ->sortByName()
             ;
 
             foreach ($finder as $file) {
-                list(, $locale) = explode('.', $file->getBasename(), 3);
+                $fileNameParts = explode('.', basename($file));
+                $locale = $fileNameParts[\count($fileNameParts) - 2];
                 if (!isset($files[$locale])) {
                     $files[$locale] = [];
                 }
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/translations/domain.with.dots.en.yml b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/translations/domain.with.dots.en.yml
@@ -0,0 +1,3 @@
+domain:
+    with:
+        dots: It works!
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/FrameworkExtensionTest.php b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/FrameworkExtensionTest.php
@@ -817,6 +817,11 @@ public function testTranslator()
             $files,
             '->registerTranslatorConfiguration() finds translation resources in default path'
         );
+        $this->assertContains(
+            strtr(__DIR__.'/Fixtures/translations/domain.with.dots.en.yml', '/', \DIRECTORY_SEPARATOR),
+            $files,
+            '->registerTranslatorConfiguration() finds translation resources with dots in domain'
+        );
 
         $calls = $container->getDefinition('translator.default')->getMethodCalls();
         $this->assertEquals(['fr'], $calls[1][1][0]);
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Fixtures/Resources/translations/domain.with.dots.en.yml b/src/Symfony/Bundle/FrameworkBundle/Tests/Fixtures/Resources/translations/domain.with.dots.en.yml
@@ -0,0 +1 @@
+message: It works!
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Translation/TranslatorTest.php b/src/Symfony/Bundle/FrameworkBundle/Tests/Translation/TranslatorTest.php
@@ -373,6 +373,21 @@ public function testWarmup()
         $this->assertEquals('répertoire', $translator->trans('folder'));
     }
 
+    public function testLoadingTranslationFilesWithDotsInMessageDomain()
+    {
+        $loader = new \Symfony\Component\Translation\Loader\YamlFileLoader();
+        $resourceFiles = [
+            'en' => [
+                __DIR__.'/../Fixtures/Resources/translations/domain.with.dots.en.yml',
+            ],
+        ];
+
+        $translator = $this->getTranslator($loader, ['cache_dir' => $this->tmpDir, 'resource_files' => $resourceFiles], 'yml');
+        $translator->setLocale('en');
+        $translator->setFallbackLocales(['fr']);
+        $this->assertEquals('It works!', $translator->trans('message', [], 'domain.with.dots'));
+    }
+
     private function createTranslator($loader, $options, $translatorClass = '\Symfony\Bundle\FrameworkBundle\Translation\Translator', $loaderFomat = 'loader', $defaultLocale = 'en')
     {
         if (null === $defaultLocale) {
diff --git a/src/Symfony/Bundle/FrameworkBundle/Translation/Translator.php b/src/Symfony/Bundle/FrameworkBundle/Translation/Translator.php
@@ -165,7 +165,10 @@ private function addResourceFiles()
         foreach ($filesByLocale as $locale => $files) {
             foreach ($files as $key => $file) {
                 // filename is domain.locale.format
-                list($domain, $locale, $format) = explode('.', basename($file), 3);
+                $fileNameParts = explode('.', basename($file));
+                $format = array_pop($fileNameParts);
+                $locale = array_pop($fileNameParts);
+                $domain = implode('.', $fileNameParts);
                 $this->addResource($format, $file, $locale, $domain);
             }
         }

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+domain:`
	`2`	`+ with:`
	`3`	`+ dots: It works!`
Original file line number	Diff line number	Diff line change
`@@ -165,7 +165,10 @@ private function addResourceFiles()`
`165`	`165`	`foreach ($filesByLocale as $locale => $files) {`
`166`	`166`	`foreach ($files as $key => $file) {`
`167`	`167`	`// filename is domain.locale.format`
`168`		`- list($domain, $locale, $format) = explode('.', basename($file), 3);`
	`168`	`+ $fileNameParts = explode('.', basename($file));`
	`169`	`+ $format = array_pop($fileNameParts);`
	`170`	`+ $locale = array_pop($fileNameParts);`
	`171`	`+ $domain = implode('.', $fileNameParts);`
`169`	`172`	`$this->addResource($format, $file, $locale, $domain);`
`170`	`173`	`}`
`171`	`174`	`}`