[Validator] Add the excluded option to the Cascade constraint

alexandre-daubois · alexandre-daubois · commit fef6e80ce017 · 2023-03-04T10:07:53.000+01:00
diff --git a/src/Symfony/Component/Validator/CHANGELOG.md b/src/Symfony/Component/Validator/CHANGELOG.md
@@ -10,6 +10,7 @@ CHANGELOG
  * Add a `NoSuspiciousCharacters` constraint to validate a string is not a spoofing attempt
  * Add the `countUnit` option to the `Length` constraint to allow counting the string length either by code points (like before, now the default setting `Length::COUNT_CODEPOINTS`), bytes (`Length::COUNT_BYTES`) or graphemes (`Length::COUNT_GRAPHEMES`)
  * Add the `filenameMaxLength` option to the `File` constraint
+ * Add the `excluded` option to the `Cascade` constraint
 
 6.2
 ---
diff --git a/src/Symfony/Component/Validator/Constraints/Cascade.php b/src/Symfony/Component/Validator/Constraints/Cascade.php
@@ -16,19 +16,28 @@
 
 /**
  * @Annotation
+ *
  * @Target({"CLASS"})
  *
  * @author Jules Pietri <jules@heahprod.com>
  */
 #[\Attribute(\Attribute::TARGET_CLASS)]
 class Cascade extends Constraint
 {
-    public function __construct(array $options = null)
+    public array $excluded = [];
+
+    public function __construct(array|string|null $excluded = null, array $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__));
         }
 
+        if (\is_array($excluded) && \is_string(key($excluded))) {
+            $options = array_merge($excluded, $options);
+        } else {
+            $this->excluded = (array) $excluded;
+        }
+
         parent::__construct($options);
     }
 
diff --git a/src/Symfony/Component/Validator/Mapping/ClassMetadata.php b/src/Symfony/Component/Validator/Mapping/ClassMetadata.php
@@ -194,6 +194,10 @@ public function addConstraint(Constraint $constraint): static
             $this->cascadingStrategy = CascadingStrategy::CASCADE;
 
             foreach ($this->getReflectionClass()->getProperties() as $property) {
+                if (\in_array($property->getName(), $constraint->excluded)) {
+                    continue;
+                }
+
                 if ($property->hasType() && (('array' === $type = $property->getType()->getName()) || class_exists($type))) {
                     $this->addPropertyConstraint($property->getName(), new Valid());
                 }
diff --git a/src/Symfony/Component/Validator/Tests/Mapping/ClassMetadataTest.php b/src/Symfony/Component/Validator/Tests/Mapping/ClassMetadataTest.php
@@ -351,6 +351,20 @@ public function testCascadeConstraint()
             'children',
         ], $metadata->getConstrainedProperties());
     }
+
+    public function testCascadeConstraintWithExcludedProperties()
+    {
+        $metadata = new ClassMetadata(CascadingEntity::class);
+
+        $metadata->addConstraint(new Cascade(excluded: ['requiredChild', 'optionalChild']));
+
+        $this->assertSame(CascadingStrategy::CASCADE, $metadata->getCascadingStrategy());
+        $this->assertCount(2, $metadata->properties);
+        $this->assertSame([
+            'staticChild',
+            'children',
+        ], $metadata->getConstrainedProperties());
+    }
 }
 
 class ClassCompositeConstraint extends Composite

Original file line number	Diff line number	Diff line change
`@@ -16,19 +16,28 @@`
`16`	`16`
`17`	`17`	`/**`
`18`	`18`	`* @Annotation`
	`19`	`+ *`
`19`	`20`	`* @Target({"CLASS"})`
`20`	`21`	`*`
`21`	`22`	`* @author Jules Pietri <[email protected]>`
`22`	`23`	`*/`
`23`	`24`	`#[\Attribute(\Attribute::TARGET_CLASS)]`
`24`	`25`	`class Cascade extends Constraint`
`25`	`26`	`{`
`26`		`- public function __construct(array $options = null)`
	`27`	`+ public array $excluded = [];`
	`28`	`+`
	`29`	`+ public function __construct(array\|string\|null $excluded = null, array $options = null)`
`27`	`30`	`{`
`28`	`31`	`if (\is_array($options) && \array_key_exists('groups', $options)) {`
`29`	`32`	`throw new ConstraintDefinitionException(sprintf('The option "groups" is not supported by the constraint "%s".', __CLASS__));`
`30`	`33`	`}`
`31`	`34`
	`35`	`+ if (\is_array($excluded) && \is_string(key($excluded))) {`
	`36`	`+ $options = array_merge($excluded, $options);`
	`37`	`+ } else {`
	`38`	`+ $this->excluded = (array) $excluded;`
	`39`	`+ }`
	`40`	`+`
`32`	`41`	`parent::__construct($options);`
`33`	`42`	`}`
`34`	`43`