[Validator] Add AutoMapping constraint to enable or disable auto-validation

Author: dunglas

CHANGELOG.md

@@ -4,6 +4,7 @@ CHANGELOG
 4.4.0
 -----
 
+ * added `EnableAutoMapping` and `DisableAutoMapping` constraints to enable or disable auto mapping for class or a property 
  * using anything else than a `string` as the code of a `ConstraintViolation` is deprecated, a `string` type-hint will
    be added to the constructor of the `ConstraintViolation` class and to the `ConstraintViolationBuilder::setCode()`
    method in 5.0

Constraints/DisableAutoMapping.php

@@ -0,0 +1,45 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Validator\Constraints;
+
+use Symfony\Component\Validator\Constraint;
+use Symfony\Component\Validator\Exception\ConstraintDefinitionException;
+
+/**
+ * Disables auto mapping.
+ *
+ * Using the annotations on a property has higher precedence than using it on a class,
+ * which has higher precedence than any configuration that might be defined outside the class.
+ *
+ * @Annotation
+ *
+ * @author Kévin Dunglas <[email protected]>
+ */
+class DisableAutoMapping extends Constraint
+{
+    public function __construct($options = null)
+    {
+        if (\is_array($options) && \array_key_exists('groups', $options)) {
+            throw new ConstraintDefinitionException(sprintf('The option "groups" is not supported by the constraint "%s".', __CLASS__));
+        }
+
+        parent::__construct($options);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getTargets()
+    {
+        return [self::PROPERTY_CONSTRAINT, self::CLASS_CONSTRAINT];
+    }
+}

Constraints/EnableAutoMapping.php

@@ -0,0 +1,45 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Validator\Constraints;
+
+use Symfony\Component\Validator\Constraint;
+use Symfony\Component\Validator\Exception\ConstraintDefinitionException;
+
+/**
+ * Enables auto mapping.
+ *
+ * Using the annotations on a property has higher precedence than using it on a class,
+ * which has higher precedence than any configuration that might be defined outside the class.
+ *
+ * @Annotation
+ *
+ * @author Kévin Dunglas <[email protected]>
+ */
+class EnableAutoMapping extends Constraint
+{
+    public function __construct($options = null)
+    {
+        if (\is_array($options) && \array_key_exists('groups', $options)) {
+            throw new ConstraintDefinitionException(sprintf('The option "groups" is not supported by the constraint "%s".', __CLASS__));
+        }
+
+        parent::__construct($options);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getTargets()
+    {
+        return [self::PROPERTY_CONSTRAINT, self::CLASS_CONSTRAINT];
+    }
+}

Mapping/Loader/AutoMappingTrait.php

@@ -0,0 +1,41 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Validator\Mapping\Loader;
+
+use Symfony\Component\Validator\Constraints\DisableAutoMapping;
+use Symfony\Component\Validator\Constraints\EnableAutoMapping;
+use Symfony\Component\Validator\Mapping\ClassMetadata;
+
+/**
+ * Utility methods to create auto mapping loaders.
+ *
+ * @author Kévin Dunglas <[email protected]>
+ */
+trait AutoMappingTrait
+{
+    private function isAutoMappingEnabledForClass(ClassMetadata $metadata, string $classValidatorRegexp = null): bool
+    {
+        // Check if AutoMapping constraint is set first
+        foreach ($metadata->getConstraints() as $constraint) {
+            if ($constraint instanceof DisableAutoMapping) {
+                return false;
+            }
+
+            if ($constraint instanceof EnableAutoMapping) {
+                return true;
+            }
+        }
+
+        // Fallback on the config
+        return null === $classValidatorRegexp || preg_match($classValidatorRegexp, $metadata->getClassName());
+    }
+}

Mapping/Loader/PropertyInfoLoader.php

@@ -16,6 +16,8 @@
 use Symfony\Component\PropertyInfo\PropertyTypeExtractorInterface;
 use Symfony\Component\PropertyInfo\Type as PropertyInfoType;
 use Symfony\Component\Validator\Constraints\All;
+use Symfony\Component\Validator\Constraints\DisableAutoMapping;
+use Symfony\Component\Validator\Constraints\EnableAutoMapping;
 use Symfony\Component\Validator\Constraints\NotBlank;
 use Symfony\Component\Validator\Constraints\NotNull;
 use Symfony\Component\Validator\Constraints\Type;
@@ -28,6 +30,8 @@
  */
 final class PropertyInfoLoader implements LoaderInterface
 {
+    use AutoMappingTrait;
+
     private $listExtractor;
     private $typeExtractor;
     private $accessExtractor;
@@ -47,14 +51,12 @@ public function __construct(PropertyListExtractorInterface $listExtractor, Prope
     public function loadClassMetadata(ClassMetadata $metadata): bool
     {
         $className = $metadata->getClassName();
-        if (null !== $this->classValidatorRegexp && !preg_match($this->classValidatorRegexp, $className)) {
-            return false;
-        }
-
         if (!$properties = $this->listExtractor->getProperties($className)) {
             return false;
         }
 
+        $loaded = false;
+        $enabledForClass = $this->isAutoMappingEnabledForClass($metadata, $this->classValidatorRegexp);
         foreach ($properties as $property) {
             if (false === $this->accessExtractor->isWritable($className, $property)) {
                 continue;
@@ -69,12 +71,22 @@ public function loadClassMetadata(ClassMetadata $metadata): bool
                 continue;
             }
 
+            $enabledForProperty = $enabledForClass;
             $hasTypeConstraint = false;
             $hasNotNullConstraint = false;
             $hasNotBlankConstraint = false;
             $allConstraint = null;
             foreach ($metadata->getPropertyMetadata($property) as $propertyMetadata) {
                 foreach ($propertyMetadata->getConstraints() as $constraint) {
+                    // Enabling or disabling auto-mapping explicitly always takes precedence
+                    if ($constraint instanceof DisableAutoMapping) {
+                        continue 3;
+                    }
+
+                    if ($constraint instanceof EnableAutoMapping) {
+                        $enabledForProperty = true;
+                    }
+
                     if ($constraint instanceof Type) {
                         $hasTypeConstraint = true;
                     } elseif ($constraint instanceof NotNull) {
@@ -87,6 +99,11 @@ public function loadClassMetadata(ClassMetadata $metadata): bool
                 }
             }
 
+            if (!$enabledForProperty) {
+                continue;
+            }
+
+            $loaded = true;
             $builtinTypes = [];
             $nullable = false;
             $scalar = true;
@@ -118,7 +135,7 @@ public function loadClassMetadata(ClassMetadata $metadata): bool
             }
         }
 
-        return true;
+        return $loaded;
     }
 
     private function getTypeConstraint(string $builtinType, PropertyInfoType $type): Type

Tests/Constraints/DisableAutoMappingTest.php

@@ -0,0 +1,30 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Validator\Tests\Constraints;
+
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\Validator\Constraints\DisableAutoMapping;
+use Symfony\Component\Validator\Exception\ConstraintDefinitionException;
+
+/**
+ * @author Kévin Dunglas <[email protected]>
+ */
+class DisableAutoMappingTest extends TestCase
+{
+    public function testGroups()
+    {
+        $this->expectException(ConstraintDefinitionException::class);
+        $this->expectExceptionMessage(sprintf('The option "groups" is not supported by the constraint "%s".', DisableAutoMapping::class));
+
+        new DisableAutoMapping(['groups' => 'foo']);
+    }
+}

Tests/Constraints/EnableAutoMappingTest.php

@@ -0,0 +1,30 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Validator\Tests\Constraints;
+
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\Validator\Constraints\EnableAutoMapping;
+use Symfony\Component\Validator\Exception\ConstraintDefinitionException;
+
+/**
+ * @author Kévin Dunglas <[email protected]>
+ */
+class EnableAutoMappingTest extends TestCase
+{
+    public function testGroups()
+    {
+        $this->expectException(ConstraintDefinitionException::class);
+        $this->expectExceptionMessage(sprintf('The option "groups" is not supported by the constraint "%s".', EnableAutoMapping::class));
+
+        new EnableAutoMapping(['groups' => 'foo']);
+    }
+}

Tests/Fixtures/PropertyInfoLoaderEntity.php

@@ -49,6 +49,11 @@ class PropertyInfoLoaderEntity
 
     public $readOnly;
 
+    /**
+     * @Assert\DisableAutoMapping
+     */
+    public $noAutoMapping;
+
     public function setNonExistentField()
     {
     }

Tests/Fixtures/PropertyInfoLoaderNoAutoMappingEntity.php

@@ -0,0 +1,29 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * 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\Constraints as Assert;
+
+/**
+ * @Assert\DisableAutoMapping
+ *
+ * @author Kévin Dunglas <[email protected]>
+ */
+class PropertyInfoLoaderNoAutoMappingEntity
+{
+    public $string;
+
+    /**
+     * @Assert\EnableAutoMapping
+     */
+    public $autoMappingExplicitlyEnabled;
+}