Allow arrays of constraints on parameters (#1752)

* Allow arrays of constraints on parameters

* Add deprecation notices

* Silence deprecation notices

* Tag tests that produce deprecation notices

* Use class constant instead of FQCN string

* Limit deprecations

Author: sandermarechal

Controller/Annotations/AbstractScalarParam.php

@@ -54,6 +54,14 @@ public function getConstraints()
                 'pattern' => '#^(?:'.$this->requirements['rule'].')$#xsu',
                 'message' => $this->requirements['error_message'],
             ));
+        } elseif (is_array($this->requirements)) {
+            foreach ($this->requirements as $requirement) {
+                if ($requirement instanceof Constraint) {
+                    $constraints[] = $requirement;
+                } else {
+                    @trigger_error('Using an array not only containing `Constraint`s as requirements is deprecated since version 2.6.', E_USER_DEPRECATED);
+                }
+            }
         }
 
         if (false === $this->allowBlank) {

Resources/doc/param_fetcher_listener.rst

@@ -49,6 +49,12 @@ configured for the matched controller so that the user does not need to do this
          * Note that if the value matches the default then no validation is run.
          * So make sure the default value really matches your expectations.
          *
+         * @RequestParam(name="simpleEmail", requirements=@Constraints\Email)
+         * @RequestParam(name="complexEmail", requirements={@Constraints\Email, @Constraints\NotEqualTo("[email protected]")})
+         * You can use one or multiple Symfony Validator constraints for more complex requirements checking. The first
+         * example above checks for a correctly formatted e-mail adress. The second example also ensures that it does not
+         * matches some default example value.
+         *
          * @RequestParam(name="search", requirements="[a-z]+", description="search")
          * @RequestParam(name="byauthor", requirements="[a-z]+", description="by author", incompatibles={"search"})
          * Imagine you have an api for a blog with to get Articles with two ways of filtering

Tests/Controller/Annotations/AbstractScalarParamTest.php

@@ -11,8 +11,10 @@
 
 namespace FOS\RestBundle\Tests\Controller\Annotations;
 
+use FOS\RestBundle\Controller\Annotations\AbstractScalarParam;
 use FOS\RestBundle\Validator\Constraints\Regex;
 use PHPUnit\Framework\TestCase;
+use Symfony\Component\Validator\Constraint;
 use Symfony\Component\Validator\Constraints;
 
 /**
@@ -24,12 +26,12 @@ class AbstractScalarParamTest extends TestCase
 {
     public function setUp()
     {
-        $this->param = $this->getMockForAbstractClass('FOS\RestBundle\Controller\Annotations\AbstractScalarParam');
+        $this->param = $this->getMockForAbstractClass(AbstractScalarParam::class);
     }
 
     public function testInterface()
     {
-        $this->assertInstanceOf('FOS\RestBundle\Controller\Annotations\AbstractParam', $this->param);
+        $this->assertInstanceOf(AbstractScalarParam::class, $this->param);
     }
 
     public function testDefaultValues()
@@ -48,13 +50,26 @@ public function testScalarConstraint()
 
     public function testComplexRequirements()
     {
-        $this->param->requirements = $requirement = $this->getMockBuilder('Symfony\Component\Validator\Constraint')->getMock();
+        $this->param->requirements = $requirement = $this->getMockBuilder(Constraint::class)->getMock();
         $this->assertEquals(array(
             new Constraints\NotNull(),
             $requirement,
         ), $this->param->getConstraints());
     }
 
+    public function testMultipleComplexRequirements()
+    {
+        $requirement1 = $this->getMockBuilder(Constraint::class)->getMock();
+        $requirement2 = $this->getMockBuilder(Constraint::class)->getMock();
+        $this->param->requirements = array($requirement1, $requirement2);
+
+        $this->assertEquals(array(
+            new Constraints\NotNull(),
+            $requirement1,
+            $requirement2,
+        ), $this->param->getConstraints());
+    }
+
     public function testScalarRequirements()
     {
         $this->param->name = 'bar';