feature #28997 [FrameworkBundle] Deprecating support for legacy translations directory (yceruto)

fabpot · fabpot · commit c333d8569ec0 · 2018-10-27T06:16:49.000+02:00
This PR was merged into the 4.2-dev branch. Discussion ---------- [FrameworkBundle] Deprecating support for legacy translations directory | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | yes | Tests pass? | yes | Fixed tickets | #28810 (comment) | License | MIT | Doc PR | TODO Commits ------- acdece7 Deprecating support for legacy translations directory
diff --git a/UPGRADE-4.2.md b/UPGRADE-4.2.md
@@ -155,6 +155,7 @@ FrameworkBundle
  * The `--no-debug` console option has been deprecated,
    set the "APP_DEBUG" environment variable to "0" instead.
  * The `Templating\Helper\TranslatorHelper::transChoice()` method has been deprecated, use the `trans()` one instead with a `%count%` parameter.
+ * Deprecated support for legacy translations directories `src/Resources/translations/` and `src/Resources/<BundleName>/translations/`, use `translations/` instead.
 
 Messenger
 ---------
diff --git a/UPGRADE-5.0.md b/UPGRADE-5.0.md
@@ -169,6 +169,7 @@ FrameworkBundle
  * The `--no-debug` console option has been removed, 
    set the "APP_DEBUG" environment variable to "0" instead.
  * The `Templating\Helper\TranslatorHelper::transChoice()` method has been removed, use the `trans()` one instead with a `%count%` parameter.
+ * Removed support for legacy translations directories `src/Resources/translations/` and `src/Resources/<BundleName>/translations/`, use `translations/` instead.
 
 HttpFoundation
 --------------
diff --git a/src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md b/src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md
@@ -24,6 +24,7 @@ CHANGELOG
  * Deprecated `CachePoolClearerPass`. Use `Symfony\Component\Cache\DependencyInjection\CachePoolClearerPass` instead.
  * Deprecated `CachePoolPass`. Use `Symfony\Component\Cache\DependencyInjection\CachePoolPass` instead.
  * Deprecated `CachePoolPrunerPass`. Use `Symfony\Component\Cache\DependencyInjection\CachePoolPrunerPass` instead.
+ * Deprecated support for legacy translations directories `src/Resources/translations/` and `src/Resources/<BundleName>/translations/`, use `translations/` instead.
 
 4.1.0
 -----
diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php
@@ -1009,6 +1009,8 @@ private function registerTranslatorConfiguration(array $config, ContainerBuilder
                 $dirs[] = $dir;
             }
             if ($container->fileExists($dir = $rootDir.sprintf('/Resources/%s/translations', $name))) {
+                @trigger_error(sprintf('Translations directory "%s" is deprecated since Symfony 4.2, use "%s" instead.', $dir, $defaultDir), E_USER_DEPRECATED);
+
                 $dirs[] = $dir;
             }
         }
@@ -1025,6 +1027,10 @@ private function registerTranslatorConfiguration(array $config, ContainerBuilder
             $dirs[] = $defaultDir;
         }
         if ($container->fileExists($dir = $rootDir.'/Resources/translations')) {
+            if ($dir !== $defaultDir) {
+                @trigger_error(sprintf('Translations directory "%s" is deprecated since Symfony 4.2, use "%s" instead.', $dir, $defaultDir), E_USER_DEPRECATED);
+            }
+
             $dirs[] = $dir;
         }
 
@@ -1307,7 +1313,7 @@ private function registerSerializerConfiguration(array $config, ContainerBuilder
 
             $annotationLoader = new Definition(
                 'Symfony\Component\Serializer\Mapping\Loader\AnnotationLoader',
-                 array(new Reference('annotation_reader'))
+                array(new Reference('annotation_reader'))
             );
             $annotationLoader->setPublic(false);
 
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/Resources/translations/test_default.en.xlf b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Fixtures/Resources/translations/test_default.en.xlf
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/FrameworkExtensionTest.php b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/FrameworkExtensionTest.php
@@ -691,6 +691,20 @@ public function testTranslator()
         $this->assertEquals(array('fr'), $calls[1][1][0]);
     }
 
+    /**
+     * @group legacy
+     * @expectedDeprecation Translations directory "%s/Resources/translations" is deprecated since Symfony 4.2, use "%s/translations" instead.
+     */
+    public function testLegacyTranslationsDirectory()
+    {
+        $container = $this->createContainerFromFile('full', array('kernel.root_dir' => __DIR__.'/Fixtures'));
+        $options = $container->getDefinition('translator.default')->getArgument(4);
+        $files = array_map('realpath', $options['resource_files']['en']);
+
+        $dir = str_replace('/', \DIRECTORY_SEPARATOR, __DIR__.'/Fixtures/Resources/translations/test_default.en.xlf');
+        $this->assertContains($dir, $files, '->registerTranslatorConfiguration() finds translation resources in legacy directory');
+    }
+
     public function testTranslatorMultipleFallbacks()
     {
         $container = $this->createContainerFromFile('translator_fallbacks');

Original file line number	Diff line number	Diff line change
`@@ -1009,6 +1009,8 @@ private function registerTranslatorConfiguration(array $config, ContainerBuilder`
`1009`	`1009`	`$dirs[] = $dir;`
`1010`	`1010`	`}`
`1011`	`1011`	`if ($container->fileExists($dir = $rootDir.sprintf('/Resources/%s/translations', $name))) {`
	`1012`	`+ @trigger_error(sprintf('Translations directory "%s" is deprecated since Symfony 4.2, use "%s" instead.', $dir, $defaultDir), E_USER_DEPRECATED);`
	`1013`	`+`
`1012`	`1014`	`$dirs[] = $dir;`
`1013`	`1015`	`}`
`1014`	`1016`	`}`
`@@ -1025,6 +1027,10 @@ private function registerTranslatorConfiguration(array $config, ContainerBuilder`
`1025`	`1027`	`$dirs[] = $defaultDir;`
`1026`	`1028`	`}`
`1027`	`1029`	`if ($container->fileExists($dir = $rootDir.'/Resources/translations')) {`
	`1030`	`+ if ($dir !== $defaultDir) {`
	`1031`	`+ @trigger_error(sprintf('Translations directory "%s" is deprecated since Symfony 4.2, use "%s" instead.', $dir, $defaultDir), E_USER_DEPRECATED);`
	`1032`	`+ }`
	`1033`	`+`
`1028`	`1034`	`$dirs[] = $dir;`
`1029`	`1035`	`}`
`1030`	`1036`
`@@ -1307,7 +1313,7 @@ private function registerSerializerConfiguration(array $config, ContainerBuilder`
`1307`	`1313`
`1308`	`1314`	`$annotationLoader = new Definition(`
`1309`	`1315`	`'Symfony\Component\Serializer\Mapping\Loader\AnnotationLoader',`
`1310`		`- array(new Reference('annotation_reader'))`
	`1316`	`+ array(new Reference('annotation_reader'))`
`1311`	`1317`	`);`
`1312`	`1318`	`$annotationLoader->setPublic(false);`
`1313`	`1319`