bug #34081 [Validator] Set Length::$allowEmptyString to false when a NotBlank contraint is defined (nicolas-grekas)

This PR was merged into the 4.4 branch.

Discussion
----------

[Validator] Set Length::$allowEmptyString to false when a NotBlank contraint is defined

| Q             | A
| ------------- | ---
| Branch?       | 4.4
| Bug fix?      | yes
| New feature?  | no
| Deprecations? | no
| Tickets       | -
| License       | MIT
| Doc PR        | -

Since #31528, we are told to do this kind of changes to our entities:
```diff
     /**
      * @Assert\NotBlank()
-     * @Assert\Length(min="10")
+     * @Assert\Length(min="10", allowEmptyString=false)
      */
     public $description;
```

But the `NotBlank` already says it - this is just boilerplate. More critically, this also means we cannot write annotations that are compatible with 3.4, 4.4 and 5.0 at the same time, making FC/BC hard.

By setting `Length::$allowEmptyString` to `false` when a `NotBlank` contraint is defined, we fix both issues.

/cc @ogizanagi

Commits
-------

840f7e7d88 [Validator] Set Length::$allowEmptyString to false when a NotBlank contraint is defined
This commit is contained in:
Nicolas Grekas 2019-10-23 14:11:54 +02:00
commit 791810a4e1
3 changed files with 35 additions and 11 deletions

View File

@ -57,13 +57,6 @@ class Length extends Constraint
parent::__construct($options);
if (null === $this->allowEmptyString) {
$this->allowEmptyString = true;
if (null !== $this->min) {
@trigger_error(sprintf('Using the "%s" constraint with the "min" option without setting the "allowEmptyString" one is deprecated and defaults to true. In 5.0, it will become optional and default to false.', self::class), E_USER_DEPRECATED);
}
}
if (null === $this->min && null === $this->max) {
throw new MissingOptionsException(sprintf('Either option "min" or "max" must be given for constraint %s', __CLASS__), ['min', 'max']);
}

View File

@ -30,7 +30,11 @@ class LengthValidator extends ConstraintValidator
throw new UnexpectedTypeException($constraint, __NAMESPACE__.'\Length');
}
if (null === $value || ('' === $value && $constraint->allowEmptyString)) {
if (null !== $constraint->min && null === $constraint->allowEmptyString) {
@trigger_error(sprintf('Using the "%s" constraint with the "min" option without setting the "allowEmptyString" one is deprecated and defaults to true. In 5.0, it will become optional and default to false.', Length::class), E_USER_DEPRECATED);
}
if (null === $value || ('' === $value && ($constraint->allowEmptyString ?? true))) {
return;
}

View File

@ -12,6 +12,8 @@
namespace Symfony\Component\Validator\Mapping;
use Symfony\Component\Validator\Constraint;
use Symfony\Component\Validator\Constraints\Length;
use Symfony\Component\Validator\Constraints\NotBlank;
use Symfony\Component\Validator\Constraints\Traverse;
use Symfony\Component\Validator\Constraints\Valid;
use Symfony\Component\Validator\Exception\ConstraintDefinitionException;
@ -167,6 +169,8 @@ class GenericMetadata implements MetadataInterface
*/
public function getConstraints()
{
$this->configureLengthConstraints($this->constraints);
return $this->constraints;
}
@ -187,9 +191,10 @@ class GenericMetadata implements MetadataInterface
*/
public function findConstraints($group)
{
return isset($this->constraintsByGroup[$group])
? $this->constraintsByGroup[$group]
: [];
$constraints = $this->constraintsByGroup[$group] ?? [];
$this->configureLengthConstraints($constraints);
return $constraints;
}
/**
@ -207,4 +212,26 @@ class GenericMetadata implements MetadataInterface
{
return $this->traversalStrategy;
}
private function configureLengthConstraints(array $constraints): void
{
$allowEmptyString = true;
foreach ($constraints as $constraint) {
if ($constraint instanceof NotBlank) {
$allowEmptyString = false;
break;
}
}
if ($allowEmptyString) {
return;
}
foreach ($constraints as $constraint) {
if ($constraint instanceof Length && null === $constraint->allowEmptyString) {
$constraint->allowEmptyString = false;
}
}
}
}