feature #21283 [Form][FrameworkBundle] Move FormPass to the Form component (chalasr)

This PR was merged into the 3.3-dev branch.

Discussion
----------

[Form][FrameworkBundle] Move FormPass to the Form component

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

So that anyone using only Form and DI can use it for registering form types/type guessers.
Follows #19443, related to #21284

Commits
-------

e68a6d963c [FrameworkBundle][Form] Move FormPass to the Form component

Author: fabpot

CHANGELOG.md

@@ -14,6 +14,7 @@ CHANGELOG
  * Deprecated `Symfony\Bundle\FrameworkBundle\DependencyInjection\Compiler\AddConsoleCommandPass`. Use `Symfony\Component\Console\DependencyInjection\AddConsoleCommandPass` instead.
  * Added configurable paths for validation files 
  * Deprecated `SerializerPass`, use `Symfony\Component\Serializer\DependencyInjection\SerializerPass` instead.
+ * Deprecated `FormPass`, use `Symfony\Component\Form\DependencyInjection\FormPass` instead.
 
 3.2.0
 -----

DependencyInjection/Compiler/FormPass.php

@@ -11,74 +11,18 @@
 
 namespace Symfony\Bundle\FrameworkBundle\DependencyInjection\Compiler;
 
-use Symfony\Component\DependencyInjection\Compiler\PriorityTaggedServiceTrait;
-use Symfony\Component\DependencyInjection\ContainerBuilder;
-use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
-use Symfony\Component\DependencyInjection\Exception\InvalidArgumentException;
+@trigger_error(sprintf('The %s class is deprecated since version 3.3 and will be removed in 4.0. Use Symfony\Component\Form\DependencyInjection\FormPass instead.', FormPass::class), E_USER_DEPRECATED);
+
+use Symfony\Component\Form\DependencyInjection\FormPass as BaseFormPass;
 
 /**
  * Adds all services with the tags "form.type" and "form.type_guesser" as
  * arguments of the "form.extension" service.
  *
+ * @deprecated since version 3.3, to be removed in 4.0. Use {@link BaseFormPass} instead.
+ *
  * @author Bernhard Schussek <bschussek@gmail.com>
  */
-class FormPass implements CompilerPassInterface
+class FormPass extends BaseFormPass
 {
-    use PriorityTaggedServiceTrait;
-
-    public function process(ContainerBuilder $container)
-    {
-        if (!$container->hasDefinition('form.extension')) {
-            return;
-        }
-
-        $definition = $container->getDefinition('form.extension');
-
-        // Builds an array with fully-qualified type class names as keys and service IDs as values
-        $types = array();
-
-        foreach ($container->findTaggedServiceIds('form.type') as $serviceId => $tag) {
-            $serviceDefinition = $container->getDefinition($serviceId);
-            if (!$serviceDefinition->isPublic()) {
-                throw new InvalidArgumentException(sprintf('The service "%s" must be public as form types are lazy-loaded.', $serviceId));
-            }
-
-            // Support type access by FQCN
-            $types[$serviceDefinition->getClass()] = $serviceId;
-        }
-
-        $definition->replaceArgument(1, $types);
-
-        $typeExtensions = array();
-
-        foreach ($this->findAndSortTaggedServices('form.type_extension', $container) as $reference) {
-            $serviceId = (string) $reference;
-            $serviceDefinition = $container->getDefinition($serviceId);
-            if (!$serviceDefinition->isPublic()) {
-                throw new InvalidArgumentException(sprintf('The service "%s" must be public as form type extensions are lazy-loaded.', $serviceId));
-            }
-
-            $tag = $serviceDefinition->getTag('form.type_extension');
-            if (isset($tag[0]['extended_type'])) {
-                $extendedType = $tag[0]['extended_type'];
-            } else {
-                throw new InvalidArgumentException(sprintf('Tagged form type extension must have the extended type configured using the extended_type/extended-type attribute, none was configured for the "%s" service.', $serviceId));
-            }
-
-            $typeExtensions[$extendedType][] = $serviceId;
-        }
-
-        $definition->replaceArgument(2, $typeExtensions);
-
-        // Find all services annotated with "form.type_guesser"
-        $guessers = array_keys($container->findTaggedServiceIds('form.type_guesser'));
-        foreach ($guessers as $serviceId) {
-            $serviceDefinition = $container->getDefinition($serviceId);
-            if (!$serviceDefinition->isPublic()) {
-                throw new InvalidArgumentException(sprintf('The service "%s" must be public as form type guessers are lazy-loaded.', $serviceId));
-            }
-        }
-
-        $definition->replaceArgument(3, $guessers);
-    }
 }

FrameworkBundle.php

@@ -19,7 +19,6 @@
 use Symfony\Bundle\FrameworkBundle\DependencyInjection\Compiler\CachePoolPass;
 use Symfony\Bundle\FrameworkBundle\DependencyInjection\Compiler\CachePoolClearerPass;
 use Symfony\Bundle\FrameworkBundle\DependencyInjection\Compiler\ControllerArgumentValueResolverPass;
-use Symfony\Bundle\FrameworkBundle\DependencyInjection\Compiler\FormPass;
 use Symfony\Bundle\FrameworkBundle\DependencyInjection\Compiler\PropertyInfoPass;
 use Symfony\Bundle\FrameworkBundle\DependencyInjection\Compiler\TemplatingPass;
 use Symfony\Bundle\FrameworkBundle\DependencyInjection\Compiler\RoutingResolverPass;
@@ -43,8 +42,10 @@
 use Symfony\Component\DependencyInjection\Compiler\PassConfig;
 use Symfony\Component\EventDispatcher\DependencyInjection\RegisterListenersPass;
 use Symfony\Component\HttpKernel\DependencyInjection\FragmentRendererPass;
+use Symfony\Component\Form\DependencyInjection\FormPass;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpKernel\Bundle\Bundle;
+use Symfony\Component\Config\Resource\ClassExistenceResource;
 
 /**
  * Bundle.
@@ -83,10 +84,6 @@ public function build(ContainerBuilder $container)
         $container->addCompilerPass(new AddConstraintValidatorsPass(), PassConfig::TYPE_BEFORE_REMOVING);
         $container->addCompilerPass(new AddAnnotationsCachedReaderPass(), PassConfig::TYPE_BEFORE_REMOVING);
         $container->addCompilerPass(new AddValidatorInitializersPass());
-        if (class_exists(AddConsoleCommandPass::class)) {
-            $container->addCompilerPass(new AddConsoleCommandPass());
-        }
-        $container->addCompilerPass(new FormPass());
         $container->addCompilerPass(new TranslatorPass());
         $container->addCompilerPass(new LoggingTranslatorPass());
         $container->addCompilerPass(new AddCacheWarmerPass());
@@ -103,6 +100,8 @@ public function build(ContainerBuilder $container)
         $container->addCompilerPass(new CachePoolPass(), PassConfig::TYPE_BEFORE_OPTIMIZATION, 32);
         $container->addCompilerPass(new ValidateWorkflowsPass());
         $container->addCompilerPass(new CachePoolClearerPass(), PassConfig::TYPE_AFTER_REMOVING);
+        $this->addCompilerPassIfExists($container, AddConsoleCommandPass::class);
+        $this->addCompilerPassIfExists($container, FormPass::class);
 
         if ($container->getParameter('kernel.debug')) {
             $container->addCompilerPass(new AddDebugLogProcessorPass(), PassConfig::TYPE_BEFORE_OPTIMIZATION, -32);
@@ -113,4 +112,13 @@ public function build(ContainerBuilder $container)
             $container->addCompilerPass(new CacheCollectorPass());
         }
     }
+
+    private function addCompilerPassIfExists(ContainerBuilder $container, $class, $type = PassConfig::TYPE_BEFORE_OPTIMIZATION, $priority = 0)
+    {
+        $container->addResource(new ClassExistenceResource($class));
+
+        if (class_exists($class)) {
+            $container->addCompilerPass(new $class(), $type, $priority);
+        }
+    }
 }

Tests/DependencyInjection/Compiler/FormPassTest.php

@@ -18,6 +18,8 @@
 use Symfony\Component\Form\AbstractType;
 
 /**
+ * @group legacy
+ *
  * @author Bernhard Schussek <bschussek@gmail.com>
  */
 class FormPassTest extends \PHPUnit_Framework_TestCase

composer.json

@@ -41,7 +41,7 @@
         "symfony/dom-crawler": "~2.8|~3.0",
         "symfony/polyfill-intl-icu": "~1.0",
         "symfony/security": "~2.8|~3.0",
-        "symfony/form": "~2.8.16|~3.1.9|^3.2.2",
+        "symfony/form": "~3.3",
         "symfony/expression-language": "~2.8|~3.0",
         "symfony/process": "~2.8|~3.0",
         "symfony/security-core": "~3.2",
@@ -61,7 +61,8 @@
         "phpdocumentor/reflection-docblock": "<3.0",
         "phpdocumentor/type-resolver": "<0.2.0",
         "symfony/console": "<3.3",
-        "symfony/serializer": "<3.3"
+        "symfony/serializer": "<3.3",
+        "symfony/form": "<3.3"
     },
     "suggest": {
         "ext-apcu": "For best performance of the system caches",