feature #14016 Remove the API version in the validator component (saro0h, fabpot, stof)

This PR was merged into the 2.7 branch.

Discussion
----------

  Remove the API version in the validator component

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

This completes the work of #13517

Commits
-------

9438206 Complete the removal of API versions in the validator component
75088c0 [Validator] deprecated API version
0c69f69 Removed 2.5 bc layer

Author: fabpot

DependencyInjection/Configuration.php

@@ -112,6 +112,14 @@ public function getConfigTreeBuilder()
                     return $v;
                 })
             ->end()
+            ->beforeNormalization()
+                ->ifTrue(function ($v) { return isset($v['validation']['api']); })
+                ->then(function ($v) {
+                    trigger_error('The validation.api configuration key is deprecated since version 2.7 and will be removed in 3.0', E_USER_DEPRECATED);
+
+                    return $v;
+                })
+            ->end()
             ->children()
                 ->scalarNode('secret')->end()
                 ->scalarNode('http_method_override')
@@ -610,6 +618,7 @@ private function addValidationSection(ArrayNodeDefinition $rootNode)
                         ->scalarNode('translation_domain')->defaultValue('validators')->end()
                         ->booleanNode('strict_email')->defaultFalse()->end()
                         ->enumNode('api')
+                            ->info('Deprecated since version 2.7, to be removed in 3.0')
                             ->values(array('2.4', '2.5', '2.5-bc', 'auto'))
                             ->beforeNormalization()
                                 // XML/YAML parse as numbers, not as strings
@@ -620,19 +629,6 @@ private function addValidationSection(ArrayNodeDefinition $rootNode)
                     ->end()
                 ->end()
             ->end()
-            ->validate()
-                ->ifTrue(function ($v) { return !isset($v['validation']['api']) || 'auto' === $v['validation']['api']; })
-                ->then(function ($v) {
-                    // This condition is duplicated in ValidatorBuilder. This
-                    // duplication is necessary in order to know the desired
-                    // API version already during container configuration
-                    // (to adjust service classes etc.)
-                    // See https://github.com/symfony/symfony/issues/11580
-                    $v['validation']['api'] = '2.5-bc';
-
-                    return $v;
-                })
-            ->end()
         ;
     }
 

DependencyInjection/FrameworkExtension.php

@@ -761,20 +761,11 @@ private function registerValidationConfiguration(array $config, ContainerBuilder
             $validatorBuilder->addMethodCall('setMetadataCache', array(new Reference($config['cache'])));
         }
 
-        if ('2.5' === $config['api']) {
-            $api = Validation::API_VERSION_2_5;
-        } else {
-            // 2.4 is now the same as 2.5 BC
-            $api = Validation::API_VERSION_2_5_BC;
-            // the validation class needs to be changed for BC
-            $container->setParameter('validator.class', 'Symfony\Component\Validator\ValidatorInterface');
-        }
-
-        $validatorBuilder->addMethodCall('setApiVersion', array($api));
-
         // You can use this parameter to check the API version in your own
         // bundle extension classes
-        $container->setParameter('validator.api', $api);
+        // This is set to 2.5-bc for compatibility with Symfony 2.5 and 2.6.
+        // @deprecated since version 2.7, to be removed in 3.0
+        $container->setParameter('validator.api', '2.5-bc');
     }
 
     private function getValidatorMappingFiles(ContainerBuilder $container)

Tests/DependencyInjection/ConfigurationTest.php

@@ -153,7 +153,6 @@ protected static function getBundleDefaultConfig()
                 'static_method' => array('loadValidatorMetadata'),
                 'translation_domain' => 'validators',
                 'strict_email' => false,
-                'api' => '2.5-bc',
             ),
             'annotations' => array(
                 'cache' => 'file',

Tests/DependencyInjection/Fixtures/php/validation_2_5_api.php

@@ -276,7 +276,7 @@ public function testValidation()
 
         $calls = $container->getDefinition('validator.builder')->getMethodCalls();
 
-        $this->assertCount(7, $calls);
+        $this->assertCount(6, $calls);
         $this->assertSame('setConstraintValidatorFactory', $calls[0][0]);
         $this->assertEquals(array(new Reference('validator.validator_factory')), $calls[0][1]);
         $this->assertSame('setTranslator', $calls[1][0]);
@@ -289,8 +289,6 @@ public function testValidation()
         $this->assertSame(array('loadValidatorMetadata'), $calls[4][1]);
         $this->assertSame('setMetadataCache', $calls[5][0]);
         $this->assertEquals(array(new Reference('validator.mapping.cache.apc')), $calls[5][1]);
-        $this->assertSame('setApiVersion', $calls[6][0]);
-        $this->assertEquals(array(Validation::API_VERSION_2_5_BC), $calls[6][1]);
     }
 
     /**
@@ -306,14 +304,14 @@ public function testLegacyFullyConfiguredValidationService()
 
         $container = $this->createContainerFromFile('full');
 
-        $this->assertInstanceOf('Symfony\Component\Validator\ValidatorInterface', $container->get('validator'));
+        $this->assertInstanceOf('Symfony\Component\Validator\Validator\ValidatorInterface', $container->get('validator'));
     }
 
     public function testValidationService()
     {
         $container = $this->createContainerFromFile('validation_annotations');
 
-        $this->assertInstanceOf('Symfony\Component\Validator\ValidatorInterface', $container->get('validator'));
+        $this->assertInstanceOf('Symfony\Component\Validator\Validator\ValidatorInterface', $container->get('validator'));
     }
 
     public function testAnnotations()
@@ -337,7 +335,7 @@ public function testValidationAnnotations()
 
         $calls = $container->getDefinition('validator.builder')->getMethodCalls();
 
-        $this->assertCount(7, $calls);
+        $this->assertCount(6, $calls);
         $this->assertSame('enableAnnotationMapping', $calls[4][0]);
         $this->assertEquals(array(new Reference('annotation_reader')), $calls[4][1]);
         $this->assertSame('addMethodMapping', $calls[5][0]);
@@ -355,7 +353,7 @@ public function testValidationPaths()
 
         $calls = $container->getDefinition('validator.builder')->getMethodCalls();
 
-        $this->assertCount(8, $calls);
+        $this->assertCount(7, $calls);
         $this->assertSame('addXmlMappings', $calls[3][0]);
         $this->assertSame('addYamlMappings', $calls[4][0]);
         $this->assertSame('enableAnnotationMapping', $calls[5][0]);
@@ -378,79 +376,11 @@ public function testValidationNoStaticMethod()
 
         $calls = $container->getDefinition('validator.builder')->getMethodCalls();
 
-        $this->assertCount(5, $calls);
+        $this->assertCount(4, $calls);
         $this->assertSame('addXmlMappings', $calls[3][0]);
         // no cache, no annotations, no static methods
     }
 
-    public function testValidation2Dot5Api()
-    {
-        $container = $this->createContainerFromFile('validation_2_5_api');
-
-        $calls = $container->getDefinition('validator.builder')->getMethodCalls();
-
-        $this->assertCount(6, $calls);
-        $this->assertSame('addXmlMappings', $calls[3][0]);
-        $this->assertSame('addMethodMapping', $calls[4][0]);
-        $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
-    }
-
-    public function testValidation2Dot5BcApi()
-    {
-        $container = $this->createContainerFromFile('validation_2_5_bc_api');
-
-        $calls = $container->getDefinition('validator.builder')->getMethodCalls();
-
-        $this->assertCount(6, $calls);
-        $this->assertSame('addXmlMappings', $calls[3][0]);
-        $this->assertSame('addMethodMapping', $calls[4][0]);
-        $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
-    }
-
-    public function testValidationImplicitApi()
-    {
-        $container = $this->createContainerFromFile('validation_implicit_api');
-
-        $calls = $container->getDefinition('validator.builder')->getMethodCalls();
-
-        $this->assertCount(6, $calls);
-        $this->assertSame('addXmlMappings', $calls[3][0]);
-        $this->assertSame('addMethodMapping', $calls[4][0]);
-        $this->assertSame(array('loadValidatorMetadata'), $calls[4][1]);
-        $this->assertSame('setApiVersion', $calls[5][0]);
-        // no cache, no annotations
-
-        $this->assertSame(array(Validation::API_VERSION_2_5_BC), $calls[5][1]);
-    }
-
-    /**
-     * This feature is equivalent to the implicit api, only that the "api"
-     * key is explicitly set to "auto".
-     */
-    public function testValidationAutoApi()
-    {
-        $container = $this->createContainerFromFile('validation_auto_api');
-
-        $calls = $container->getDefinition('validator.builder')->getMethodCalls();
-
-        $this->assertCount(6, $calls);
-        $this->assertSame('addXmlMappings', $calls[3][0]);
-        $this->assertSame('addMethodMapping', $calls[4][0]);
-        $this->assertSame(array('loadValidatorMetadata'), $calls[4][1]);
-        $this->assertSame('setApiVersion', $calls[5][0]);
-        // no cache, no annotations
-
-        $this->assertSame(array(Validation::API_VERSION_2_5_BC), $calls[5][1]);
-    }
-
     public function testFormsCanBeEnabledWithoutCsrfProtection()
     {
         $container = $this->createContainerFromFile('form_no_csrf');