bug symfony#12151 [Framework][DX] Set the proper validator class according to the configured api version (peterrehm)

webmozart · webmozart · commit d2c6c3406761 · 2014-10-07T14:35:25.000+02:00
This PR was submitted for the master branch but it was merged into the 2.5 branch instead (closes symfony#12151). Discussion ---------- [Framework][DX] Set the proper validator class according to the configured api version | Q | A | ------------- | --- | Bug fix? | [yes] | New feature? | [no] | BC breaks? | [no] | Deprecations? | [no] | Tests pass? | [yes] | Fixed tickets | - | License | MIT | Doc PR | - With this change the proper validator class will be dumped and therefore used for code completion in IDE's like PhpStorm which rely on the dumped container. If you have 2.4 or 2.5-bc API the class will be Symfony\Component\Validator\ValidatorInterface If you use the 2.5 API the class will be Symfony\Component\Validator\Validator\ValidatorInterface I consider this also as important for the developer experience since a wrong type hint can easily cause issues since the method signatures of the validate() method have changed. From ````php public function validate($value, $groups = null, $traverse = false, $deep = false); ```` To ````php public function validate($value, $constraints = null, $groups = null); ```` So if you want to validate specific groups you now have to pass them as the third argument instead of the second. Commits ------- eb3dd0f [Framework][DX] Set the proper validator class according to the configured api version
diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php
@@ -725,6 +725,9 @@ private function registerValidationConfiguration(array $config, ContainerBuilder
                 break;
             case '2.5':
                 $api = Validation::API_VERSION_2_5;
+                // the validation class needs to be changed only for the 2.5 api since the deprecated interface is
+                // set as the default interface
+                $container->setParameter('validator.class', 'Symfony\Component\Validator\Validator\ValidatorInterface');
                 break;
             default:
                 $api = Validation::API_VERSION_2_5_BC;
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/FrameworkExtensionTest.php b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/FrameworkExtensionTest.php
@@ -384,6 +384,7 @@ public function testValidation2Dot4Api()
         $this->assertSame(array('loadValidatorMetadata'), $calls[4][1]);
         $this->assertSame('setApiVersion', $calls[5][0]);
         $this->assertSame(array(Validation::API_VERSION_2_4), $calls[5][1]);
+        $this->assertSame('Symfony\Component\Validator\ValidatorInterface', $container->getParameter('validator.class'));
         // no cache, no annotations
     }
 
@@ -399,6 +400,7 @@ public function testValidation2Dot5Api()
         $this->assertSame(array('loadValidatorMetadata'), $calls[4][1]);
         $this->assertSame('setApiVersion', $calls[5][0]);
         $this->assertSame(array(Validation::API_VERSION_2_5), $calls[5][1]);
+        $this->assertSame('Symfony\Component\Validator\Validator\ValidatorInterface', $container->getParameter('validator.class'));
         // no cache, no annotations
     }
 
@@ -414,6 +416,7 @@ public function testValidation2Dot5BcApi()
         $this->assertSame(array('loadValidatorMetadata'), $calls[4][1]);
         $this->assertSame('setApiVersion', $calls[5][0]);
         $this->assertSame(array(Validation::API_VERSION_2_5_BC), $calls[5][1]);
+        $this->assertSame('Symfony\Component\Validator\ValidatorInterface', $container->getParameter('validator.class'));
         // no cache, no annotations
     }
 

Original file line number	Diff line number	Diff line change
`@@ -384,6 +384,7 @@ public function testValidation2Dot4Api()`
`384`	`384`	`$this->assertSame(array('loadValidatorMetadata'), $calls[4][1]);`
`385`	`385`	`$this->assertSame('setApiVersion', $calls[5][0]);`
`386`	`386`	`$this->assertSame(array(Validation::API_VERSION_2_4), $calls[5][1]);`
	`387`	`+ $this->assertSame('Symfony\Component\Validator\ValidatorInterface', $container->getParameter('validator.class'));`
`387`	`388`	`// no cache, no annotations`
`388`	`389`	`}`
`389`	`390`
`@@ -399,6 +400,7 @@ public function testValidation2Dot5Api()`
`399`	`400`	`$this->assertSame(array('loadValidatorMetadata'), $calls[4][1]);`
`400`	`401`	`$this->assertSame('setApiVersion', $calls[5][0]);`
`401`	`402`	`$this->assertSame(array(Validation::API_VERSION_2_5), $calls[5][1]);`
	`403`	`+ $this->assertSame('Symfony\Component\Validator\Validator\ValidatorInterface', $container->getParameter('validator.class'));`
`402`	`404`	`// no cache, no annotations`
`403`	`405`	`}`
`404`	`406`
`@@ -414,6 +416,7 @@ public function testValidation2Dot5BcApi()`
`414`	`416`	`$this->assertSame(array('loadValidatorMetadata'), $calls[4][1]);`
`415`	`417`	`$this->assertSame('setApiVersion', $calls[5][0]);`
`416`	`418`	`$this->assertSame(array(Validation::API_VERSION_2_5_BC), $calls[5][1]);`
	`419`	`+ $this->assertSame('Symfony\Component\Validator\ValidatorInterface', $container->getParameter('validator.class'));`
`417`	`420`	`// no cache, no annotations`
`418`	`421`	`}`
`419`	`422`