feature #22808 [FrameworkBundle][Validator] Deprecate passing validator instances/aliases over using the service locator (ogizanagi)

nicolas-grekas · nicolas-grekas · commit f6d3b148cf76 · 2017-05-23T11:02:41.000+02:00
This PR was merged into the 3.3 branch. Discussion ---------- [FrameworkBundle][Validator] Deprecate passing validator instances/aliases over using the service locator | Q | A | ------------- | --- | Branch? | 3.3  | Bug fix? | no | New feature? | no  | BC breaks? | no | Deprecations? | yes  | Tests pass? | yes | Fixed tickets | symfony/symfony#22800 (comment)  | License | MIT | Doc PR | N/A Commits ------- df747ce [FrameworkBundle][Validator] Deprecate passing validator instances/aliases over using the service locator
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -49,6 +49,7 @@ CHANGELOG
    `Symfony\Component\Validator\DependencyInjection\AddConstraintValidatorsPass` instead
  * Deprecated `ValidateWorkflowsPass`, use 
    `Symfony\Component\Workflow\DependencyInjection\ValidateWorkflowsPass` instead
+ * Deprecated `ConstraintValidatorFactory::__construct()` second argument.
 
 3.2.0
 -----
diff --git a/Tests/Validator/ConstraintValidatorFactoryTest.php b/Tests/Validator/ConstraintValidatorFactoryTest.php
@@ -14,7 +14,10 @@
 use PHPUnit\Framework\TestCase;
 use Symfony\Bundle\FrameworkBundle\Validator\ConstraintValidatorFactory;
 use Symfony\Component\DependencyInjection\Container;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\Validator\Constraint;
 use Symfony\Component\Validator\Constraints\Blank as BlankConstraint;
+use Symfony\Component\Validator\ConstraintValidator;
 
 class ConstraintValidatorFactoryTest extends TestCase
 {
@@ -41,6 +44,38 @@ public function testGetInstanceReturnsExistingValidator()
     }
 
     public function testGetInstanceReturnsService()
+    {
+        $service = 'validator_constraint_service';
+        $validator = $this->getMockForAbstractClass(ConstraintValidator::class);
+
+        // mock ContainerBuilder b/c it implements TaggedContainerInterface
+        $container = $this->getMockBuilder(ContainerBuilder::class)->setMethods(array('get', 'has'))->getMock();
+        $container
+            ->expects($this->once())
+            ->method('get')
+            ->with($service)
+            ->willReturn($validator);
+        $container
+            ->expects($this->once())
+            ->method('has')
+            ->with($service)
+            ->willReturn(true);
+
+        $constraint = $this->getMockBuilder(Constraint::class)->getMock();
+        $constraint
+            ->expects($this->once())
+            ->method('validatedBy')
+            ->will($this->returnValue($service));
+
+        $factory = new ConstraintValidatorFactory($container);
+        $this->assertSame($validator, $factory->getInstance($constraint));
+    }
+
+    /**
+     * @group legacy
+     * @expectedDeprecation Passing an array of validators or validator aliases as the second argument of "Symfony\Bundle\FrameworkBundle\Validator\ConstraintValidatorFactory::__construct" is deprecated since 3.3 and will be removed in 4.0. Use the service locator instead.
+     */
+    public function testGetInstanceReturnsServiceWithAlias()
     {
         $service = 'validator_constraint_service';
         $alias = 'validator_constraint_alias';
diff --git a/Validator/ConstraintValidatorFactory.php b/Validator/ConstraintValidatorFactory.php
@@ -45,15 +45,16 @@ class ConstraintValidatorFactory implements ConstraintValidatorFactoryInterface
     protected $container;
     protected $validators;
 
-    /**
-     * Constructor.
-     *
-     * @param ContainerInterface $container  The service container
-     * @param array              $validators An array of validators
-     */
-    public function __construct(ContainerInterface $container, array $validators = array())
+    public function __construct(ContainerInterface $container, array $validators = null)
     {
         $this->container = $container;
+
+        if (null !== $validators) {
+            @trigger_error(sprintf('Passing an array of validators or validator aliases as the second argument of "%s" is deprecated since 3.3 and will be removed in 4.0. Use the service locator instead.', __METHOD__), E_USER_DEPRECATED);
+        } else {
+            $validators = array();
+        }
+
         $this->validators = $validators;
     }
 
@@ -82,6 +83,7 @@ public function getInstance(Constraint $constraint)
                 $this->validators[$name] = new $name();
             }
         } elseif (is_string($this->validators[$name])) {
+            // To be removed in 4.0
             $this->validators[$name] = $this->container->get($this->validators[$name]);
         }
 
