[Validator] Allow creating constraints with required arguments

symfony · fabpot · Apr 1, 2022 · Jan 19, 2022 · Apr 1, 2022 · f22433fb7a723d731243963c5c6702f8786c19ef
commit f22433fb7a723d731243963c5c6702f8786c19ef
diff --git a/src/Symfony/Component/Validator/Attribute/HasNamedArguments.php b/src/Symfony/Component/Validator/Attribute/HasNamedArguments.php
@@ -0,0 +1,17 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Validator\Attribute;
+
+#[\Attribute(\Attribute::TARGET_METHOD)]
+final class HasNamedArguments
+{
+}
diff --git a/src/Symfony/Component/Validator/CHANGELOG.md b/src/Symfony/Component/Validator/CHANGELOG.md
@@ -7,6 +7,7 @@ CHANGELOG
  * Deprecate `Constraint::$errorNames`, use `Constraint::ERROR_NAMES` instead
  * Deprecate constraint `ExpressionLanguageSyntax`, use `ExpressionSyntax` instead
  * Add method `__toString()` to `ConstraintViolationInterface` & `ConstraintViolationListInterface`
+ * Allow creating constraints with required arguments
 
 6.0
 ---

diff --git a/src/Symfony/Component/Validator/Mapping/Loader/AbstractLoader.php b/src/Symfony/Component/Validator/Mapping/Loader/AbstractLoader.php
@@ -11,6 +11,7 @@
 
 namespace Symfony\Component\Validator\Mapping\Loader;
 
+use Symfony\Component\Validator\Attribute\HasNamedArguments;
 use Symfony\Component\Validator\Constraint;
 use Symfony\Component\Validator\Exception\MappingException;
 
@@ -34,6 +35,11 @@ abstract class AbstractLoader implements LoaderInterface
 
     protected $namespaces = [];
 
+    /**
+     * @var array<class-string, bool>
+     */
+    private array $namedArgumentsCache = [];
+
     /**
      * Adds a namespace alias.
      *
@@ -78,6 +84,10 @@ protected function newConstraint(string $name, mixed $options = null): Constrain
             $className = self::DEFAULT_NAMESPACE.$name;
         }
 
+        if ($this->namedArgumentsCache[$className] ??= (bool) (new \ReflectionMethod($className, '__construct'))->getAttributes(HasNamedArguments::class)) {
+            return new $className(...$options);
+        }
+
         return new $className($options);
     }
 }
diff --git a/src/Symfony/Component/Validator/Tests/Fixtures/ConstraintWithRequiredArgument.php b/src/Symfony/Component/Validator/Tests/Fixtures/ConstraintWithRequiredArgument.php
@@ -0,0 +1,29 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Validator\Tests\Fixtures;
+
+use Symfony\Component\Validator\Attribute\HasNamedArguments;
+use Symfony\Component\Validator\Constraint;
+
+#[\Attribute]
+final class ConstraintWithRequiredArgument extends Constraint
+{
+    public string $requiredArg;
+
+    #[HasNamedArguments]
+    public function __construct(string $requiredArg, array $groups = null, mixed $payload = null)
+    {
+        parent::__construct([], $groups, $payload);
+
+        $this->requiredArg = $requiredArg;
+    }
+}
diff --git a/src/Symfony/Component/Validator/Tests/Fixtures/Entity_81.php b/src/Symfony/Component/Validator/Tests/Fixtures/Entity_81.php
@@ -0,0 +1,8 @@
+<?php
+
+namespace Symfony\Component\Validator\Tests\Fixtures;
+
+class Entity_81
+{
+    public $title;
+}
diff --git a/src/Symfony/Component/Validator/Tests/Mapping/Loader/XmlFileLoaderTest.php b/src/Symfony/Component/Validator/Tests/Mapping/Loader/XmlFileLoaderTest.php
@@ -28,6 +28,8 @@
 use Symfony\Component\Validator\Tests\Fixtures\Annotation\GroupSequenceProviderEntity;
 use Symfony\Component\Validator\Tests\Fixtures\ConstraintA;
 use Symfony\Component\Validator\Tests\Fixtures\ConstraintB;
+use Symfony\Component\Validator\Tests\Fixtures\ConstraintWithRequiredArgument;
+use Symfony\Component\Validator\Tests\Fixtures\Entity_81;
 
 class XmlFileLoaderTest extends TestCase
 {
@@ -98,6 +100,19 @@ public function testLoadClassMetadataWithNonStrings()
         $this->assertFalse($constraints[0]->match);
     }
 
+    public function testLoadClassMetadataWithRequiredArguments()
+    {
+        $loader = new XmlFileLoader(__DIR__.'/constraint-mapping-required-arg.xml');
+        $metadata = new ClassMetadata(Entity_81::class);
+
+        $loader->loadClassMetadata($metadata);
+
+        $expected = new ClassMetadata(Entity_81::class);
+        $expected->addPropertyConstraint('title', new ConstraintWithRequiredArgument('X'));
+
+        $this->assertEquals($expected, $metadata);
+    }
+
     public function testLoadGroupSequenceProvider()
     {
         $loader = new XmlFileLoader(__DIR__.'/constraint-mapping.xml');

diff --git a/src/Symfony/Component/Validator/Tests/Mapping/Loader/YamlFileLoaderTest.php b/src/Symfony/Component/Validator/Tests/Mapping/Loader/YamlFileLoaderTest.php
@@ -25,6 +25,8 @@
 use Symfony\Component\Validator\Tests\Fixtures\Annotation\GroupSequenceProviderEntity;
 use Symfony\Component\Validator\Tests\Fixtures\ConstraintA;
 use Symfony\Component\Validator\Tests\Fixtures\ConstraintB;
+use Symfony\Component\Validator\Tests\Fixtures\ConstraintWithRequiredArgument;
+use Symfony\Component\Validator\Tests\Fixtures\Entity_81;
 
 class YamlFileLoaderTest extends TestCase
 {
@@ -138,6 +140,19 @@ public function testLoadClassMetadataWithConstants()
         $this->assertEquals($expected, $metadata);
     }
 
+    public function testLoadClassMetadataWithRequiredArguments()
+    {
+        $loader = new YamlFileLoader(__DIR__.'/constraint-mapping-required-arg.yml');
+        $metadata = new ClassMetadata(Entity_81::class);
+
+        $loader->loadClassMetadata($metadata);
+
+        $expected = new ClassMetadata(Entity_81::class);
+        $expected->addPropertyConstraint('title', new ConstraintWithRequiredArgument('X'));
+
+        $this->assertEquals($expected, $metadata);
+    }
+
     public function testLoadGroupSequenceProvider()
     {
         $loader = new YamlFileLoader(__DIR__.'/constraint-mapping.yml');

diff --git a/src/Symfony/Component/Validator/Tests/Mapping/Loader/constraint-mapping-required-arg.xml b/src/Symfony/Component/Validator/Tests/Mapping/Loader/constraint-mapping-required-arg.xml
@@ -0,0 +1,16 @@
+<?xml version="1.0" ?>
+
+<constraint-mapping xmlns="http://symfony.com/schema/dic/constraint-mapping"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xsi:schemaLocation="http://symfony.com/schema/dic/constraint-mapping https://symfony.com/schema/dic/constraint-mapping/constraint-mapping-1.0.xsd">
+
+    <class name="Symfony\Component\Validator\Tests\Fixtures\Entity_81">
+
+        <property name="title">
+            <constraint name="Symfony\Component\Validator\Tests\Fixtures\ConstraintWithRequiredArgument">
+                <option name="requiredArg">X</option>
+            </constraint>
+        </property>
+    </class>
+
+</constraint-mapping>
diff --git a/src/Symfony/Component/Validator/Tests/Mapping/Loader/constraint-mapping-required-arg.yml b/src/Symfony/Component/Validator/Tests/Mapping/Loader/constraint-mapping-required-arg.yml
@@ -0,0 +1,5 @@
+Symfony\Component\Validator\Tests\Fixtures\Entity_81:
+  properties:
+    title:
+      - Symfony\Component\Validator\Tests\Fixtures\ConstraintWithRequiredArgument:
+          requiredArg: 'X'