[Validator] NotBlank: add a new option to allow null values

Author: dunglas

CHANGELOG.md

@@ -6,6 +6,7 @@ CHANGELOG
 
  * added options `iban` and `ibanPropertyPath` to Bic constraint
  * added UATP cards support to `CardSchemeValidator`
+ * added option `allowNull` to NotBlank constraint
 
 4.2.0
 -----

Constraints/NotBlank.php

@@ -18,6 +18,7 @@
  * @Target({"PROPERTY", "METHOD", "ANNOTATION"})
  *
  * @author Bernhard Schussek <bschussek@gmail.com>
+ * @author Kévin Dunglas <dunglas@gmail.com>
  */
 class NotBlank extends Constraint
 {
@@ -28,4 +29,5 @@ class NotBlank extends Constraint
     ];
 
     public $message = 'This value should not be blank.';
+    public $allowNull = false;
 }

Constraints/NotBlankValidator.php

@@ -17,6 +17,7 @@
 
 /**
  * @author Bernhard Schussek <bschussek@gmail.com>
+ * @author Kévin Dunglas <dunglas@gmail.com>
  */
 class NotBlankValidator extends ConstraintValidator
 {
@@ -29,6 +30,10 @@ public function validate($value, Constraint $constraint)
             throw new UnexpectedTypeException($constraint, __NAMESPACE__.'\NotBlank');
         }
 
+        if ($constraint->allowNull && null === $value) {
+            return;
+        }
+
         if (false === $value || (empty($value) && '0' != $value)) {
             $this->context->buildViolation($constraint->message)
                 ->setParameter('{{ value }}', $this->formatValue($value))

Tests/Constraints/NotBlankValidatorTest.php

@@ -98,4 +98,30 @@ public function testEmptyArrayIsInvalid()
             ->setCode(NotBlank::IS_BLANK_ERROR)
             ->assertRaised();
     }
+
+    public function testAllowNullTrue()
+    {
+        $constraint = new NotBlank([
+            'message' => 'myMessage',
+            'allowNull' => true,
+        ]);
+
+        $this->validator->validate(null, $constraint);
+        $this->assertNoViolation();
+    }
+
+    public function testAllowNullFalse()
+    {
+        $constraint = new NotBlank([
+            'message' => 'myMessage',
+            'allowNull' => false,
+        ]);
+
+        $this->validator->validate(null, $constraint);
+
+        $this->buildViolation('myMessage')
+            ->setParameter('{{ value }}', 'null')
+            ->setCode(NotBlank::IS_BLANK_ERROR)
+            ->assertRaised();
+    }
 }