feature #22619 [FrameworkBundle][Translation] Move translation compiler pass (lepiaf)

This PR was merged into the 3.4 branch.

Discussion
----------

[FrameworkBundle][Translation] Move translation compiler pass

| Q             | A
| ------------- | ---
| Branch?       | 3.4
| Bug fix?      | no
| New feature?  | yes
| BC breaks?    | no
| Deprecations? | yes
| Tests pass?   | yes
| Fixed tickets | part of #21284
| License       | MIT
| Doc PR        | n/a

move TranslationDumperPass, TranslationExtractorPass, TranslatorPass to Translation component.

Commits
-------

74c951fa04 [FrameworkBundle][Translation] Move translation compiler pass

Author: fabpot

CHANGELOG.md

@@ -12,6 +12,12 @@ CHANGELOG
  * Deprecated the `KernelTestCase::getPhpUnitXmlDir()` and `KernelTestCase::getPhpUnitCliConfigArgument()` methods.
  * Deprecated `AddCacheClearerPass`, use `Symfony\Component\HttpKernel\DependencyInjection\AddCacheClearerPass` instead.
  * Deprecated `AddCacheWarmerPass`, use `Symfony\Component\HttpKernel\DependencyInjection\AddCacheWarmerPass` instead.
+ * Deprecated `TranslationDumperPass`, use 
+   `Symfony\Component\Translation\DependencyInjection\TranslationDumperPass` instead
+ * Deprecated `TranslationExtractorPass`, use 
+   `Symfony\Component\Translation\DependencyInjection\TranslationExtractorPass` instead
+ * Deprecated `TranslatorPass`, use 
+   `Symfony\Component\Translation\DependencyInjection\TranslatorPass` instead
 
 3.3.0
 -----

DependencyInjection/Compiler/TranslationDumperPass.php

@@ -11,25 +11,15 @@
 
 namespace Symfony\Bundle\FrameworkBundle\DependencyInjection\Compiler;
 
-use Symfony\Component\DependencyInjection\Reference;
-use Symfony\Component\DependencyInjection\ContainerBuilder;
-use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
+@trigger_error(sprintf('The %s class is deprecated since version 3.4 and will be removed in 4.0. Use Symfony\Component\Translation\DependencyInjection\TranslationDumperPass instead.', TranslationDumperPass::class), E_USER_DEPRECATED);
+
+use Symfony\Component\Translation\DependencyInjection\TranslationDumperPass as BaseTranslationDumperPass;
 
 /**
  * Adds tagged translation.formatter services to translation writer.
+ *
+ * @deprecated since version 3.4, to be removed in 4.0. Use {@link BaseTranslationDumperPass instead}.
  */
-class TranslationDumperPass implements CompilerPassInterface
+class TranslationDumperPass extends BaseTranslationDumperPass
 {
-    public function process(ContainerBuilder $container)
-    {
-        if (!$container->hasDefinition('translation.writer')) {
-            return;
-        }
-
-        $definition = $container->getDefinition('translation.writer');
-
-        foreach ($container->findTaggedServiceIds('translation.dumper', true) as $id => $attributes) {
-            $definition->addMethodCall('addDumper', array($attributes[0]['alias'], new Reference($id)));
-        }
-    }
 }

DependencyInjection/Compiler/TranslationExtractorPass.php

@@ -11,30 +11,15 @@
 
 namespace Symfony\Bundle\FrameworkBundle\DependencyInjection\Compiler;
 
-use Symfony\Component\DependencyInjection\Reference;
-use Symfony\Component\DependencyInjection\ContainerBuilder;
-use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
-use Symfony\Component\DependencyInjection\Exception\RuntimeException;
+@trigger_error(sprintf('The %s class is deprecated since version 3.4 and will be removed in 4.0. Use Symfony\Component\Translation\DependencyInjection\TranslationExtractorPass instead.', TranslationExtractorPass::class), E_USER_DEPRECATED);
+
+use Symfony\Component\Translation\DependencyInjection\TranslationExtractorPass as BaseTranslationExtractorPass;
 
 /**
- * Adds tagged translation.extractor services to translation extractor.
+ * Adds tagged translation.formatter services to translation writer.
+ *
+ * @deprecated since version 3.4, to be removed in 4.0. Use {@link BaseTranslationDumperPass instead}.
  */
-class TranslationExtractorPass implements CompilerPassInterface
+class TranslationExtractorPass extends BaseTranslationExtractorPass
 {
-    public function process(ContainerBuilder $container)
-    {
-        if (!$container->hasDefinition('translation.extractor')) {
-            return;
-        }
-
-        $definition = $container->getDefinition('translation.extractor');
-
-        foreach ($container->findTaggedServiceIds('translation.extractor', true) as $id => $attributes) {
-            if (!isset($attributes[0]['alias'])) {
-                throw new RuntimeException(sprintf('The alias for the tag "translation.extractor" of service "%s" must be set.', $id));
-            }
-
-            $definition->addMethodCall('addExtractor', array($attributes[0]['alias'], new Reference($id)));
-        }
-    }
 }

DependencyInjection/Compiler/TranslatorPass.php

@@ -11,42 +11,15 @@
 
 namespace Symfony\Bundle\FrameworkBundle\DependencyInjection\Compiler;
 
-use Symfony\Component\DependencyInjection\Reference;
-use Symfony\Component\DependencyInjection\ContainerBuilder;
-use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
-use Symfony\Component\DependencyInjection\Compiler\ServiceLocatorTagPass;
+@trigger_error(sprintf('The %s class is deprecated since version 3.4 and will be removed in 4.0. Use Symfony\Component\Translation\DependencyInjection\TranslatorPass instead.', TranslatorPass::class), E_USER_DEPRECATED);
 
-class TranslatorPass implements CompilerPassInterface
-{
-    public function process(ContainerBuilder $container)
-    {
-        if (!$container->hasDefinition('translator.default')) {
-            return;
-        }
-
-        $loaders = array();
-        $loaderRefs = array();
-        foreach ($container->findTaggedServiceIds('translation.loader', true) as $id => $attributes) {
-            $loaderRefs[$id] = new Reference($id);
-            $loaders[$id][] = $attributes[0]['alias'];
-            if (isset($attributes[0]['legacy-alias'])) {
-                $loaders[$id][] = $attributes[0]['legacy-alias'];
-            }
-        }
-
-        if ($container->hasDefinition('translation.loader')) {
-            $definition = $container->getDefinition('translation.loader');
-            foreach ($loaders as $id => $formats) {
-                foreach ($formats as $format) {
-                    $definition->addMethodCall('addLoader', array($format, $loaderRefs[$id]));
-                }
-            }
-        }
+use Symfony\Component\Translation\DependencyInjection\TranslatorPass as BaseTranslatorPass;
 
-        $container
-            ->findDefinition('translator.default')
-            ->replaceArgument(0, ServiceLocatorTagPass::register($container, $loaderRefs))
-            ->replaceArgument(3, $loaders)
-        ;
-    }
+/**
+ * Adds tagged translation.formatter services to translation writer.
+ *
+ * @deprecated since version 3.4, to be removed in 4.0. Use {@link BaseTranslatorPass instead}.
+ */
+class TranslatorPass extends BaseTranslatorPass
+{
 }

FrameworkBundle.php

@@ -19,12 +19,9 @@
 use Symfony\Bundle\FrameworkBundle\DependencyInjection\Compiler\DataCollectorTranslatorPass;
 use Symfony\Bundle\FrameworkBundle\DependencyInjection\Compiler\TemplatingPass;
 use Symfony\Bundle\FrameworkBundle\DependencyInjection\Compiler\ProfilerPass;
-use Symfony\Bundle\FrameworkBundle\DependencyInjection\Compiler\TranslatorPass;
 use Symfony\Bundle\FrameworkBundle\DependencyInjection\Compiler\LoggingTranslatorPass;
 use Symfony\Bundle\FrameworkBundle\DependencyInjection\Compiler\AddExpressionLanguageProvidersPass;
 use Symfony\Bundle\FrameworkBundle\DependencyInjection\Compiler\ContainerBuilderDebugDumpPass;
-use Symfony\Bundle\FrameworkBundle\DependencyInjection\Compiler\TranslationExtractorPass;
-use Symfony\Bundle\FrameworkBundle\DependencyInjection\Compiler\TranslationDumperPass;
 use Symfony\Bundle\FrameworkBundle\DependencyInjection\Compiler\UnusedTagsPass;
 use Symfony\Component\Config\DependencyInjection\ConfigCachePass;
 use Symfony\Component\Console\DependencyInjection\AddConsoleCommandPass;
@@ -45,6 +42,9 @@
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpKernel\Bundle\Bundle;
 use Symfony\Component\Config\Resource\ClassExistenceResource;
+use Symfony\Component\Translation\DependencyInjection\TranslationDumperPass;
+use Symfony\Component\Translation\DependencyInjection\TranslationExtractorPass;
+use Symfony\Component\Translation\DependencyInjection\TranslatorPass;
 use Symfony\Component\Validator\DependencyInjection\AddConstraintValidatorsPass;
 use Symfony\Component\Validator\DependencyInjection\AddValidatorInitializersPass;
 use Symfony\Component\Workflow\DependencyInjection\ValidateWorkflowsPass;
@@ -93,13 +93,13 @@ public function build(ContainerBuilder $container)
         $container->addCompilerPass(new AddAnnotationsCachedReaderPass(), PassConfig::TYPE_BEFORE_REMOVING);
         $this->addCompilerPassIfExists($container, AddValidatorInitializersPass::class);
         $this->addCompilerPassIfExists($container, AddConsoleCommandPass::class);
-        $container->addCompilerPass(new TranslatorPass());
+        $this->addCompilerPassIfExists($container, TranslatorPass::class);
         $container->addCompilerPass(new LoggingTranslatorPass());
         $container->addCompilerPass(new AddCacheWarmerPass());
         $container->addCompilerPass(new AddCacheClearerPass());
         $container->addCompilerPass(new AddExpressionLanguageProvidersPass());
-        $container->addCompilerPass(new TranslationExtractorPass());
-        $container->addCompilerPass(new TranslationDumperPass());
+        $this->addCompilerPassIfExists($container, TranslationExtractorPass::class);
+        $this->addCompilerPassIfExists($container, TranslationDumperPass::class);
         $container->addCompilerPass(new FragmentRendererPass(), PassConfig::TYPE_AFTER_REMOVING);
         $this->addCompilerPassIfExists($container, SerializerPass::class);
         $this->addCompilerPassIfExists($container, PropertyInfoPass::class);

Tests/DependencyInjection/Compiler/TranslatorPassTest.php

@@ -18,6 +18,9 @@
 use Symfony\Component\DependencyInjection\Definition;
 use Symfony\Component\DependencyInjection\Reference;
 
+/**
+ * @group legacy
+ */
 class TranslatorPassTest extends TestCase
 {
     public function testValidCollector()

Tests/DependencyInjection/FrameworkExtensionTest.php

@@ -12,7 +12,6 @@
 namespace Symfony\Bundle\FrameworkBundle\Tests\DependencyInjection;
 
 use Doctrine\Common\Annotations\Annotation;
-use Symfony\Bundle\FrameworkBundle\DependencyInjection\Compiler\TranslatorPass;
 use Symfony\Bundle\FullStack;
 use Symfony\Bundle\FrameworkBundle\Tests\TestCase;
 use Symfony\Bundle\FrameworkBundle\DependencyInjection\Compiler\AddAnnotationsCachedReaderPass;
@@ -41,6 +40,7 @@
 use Symfony\Component\Serializer\Normalizer\DataUriNormalizer;
 use Symfony\Component\Serializer\Normalizer\DateTimeNormalizer;
 use Symfony\Component\Serializer\Normalizer\JsonSerializableNormalizer;
+use Symfony\Component\Translation\DependencyInjection\TranslatorPass;
 use Symfony\Component\Validator\DependencyInjection\AddConstraintValidatorsPass;
 
 abstract class FrameworkExtensionTest extends TestCase

composer.json

@@ -47,7 +47,7 @@
         "symfony/security-csrf": "~2.8|~3.0|~4.0",
         "symfony/serializer": "~3.3|~4.0",
         "symfony/stopwatch": "~2.8|~3.0|~4.0",
-        "symfony/translation": "~3.2|~4.0",
+        "symfony/translation": "~3.4|~4.0",
         "symfony/templating": "~2.8|~3.0|~4.0",
         "symfony/validator": "~3.4|~4.0",
         "symfony/var-dumper": "~3.3|~4.0",
@@ -69,7 +69,7 @@
         "symfony/http-kernel": "<3.4",
         "symfony/property-info": "<3.3",
         "symfony/serializer": "<3.3",
-        "symfony/translation": "<3.2",
+        "symfony/translation": "<3.4",
         "symfony/validator": "<3.4",
         "symfony/workflow": "<3.3"
     },