Merge pull request #13904 from cakephp/4.x-allow-empty-null

Make Validator::allowEmptyFor() only allow null as empty when no flags are specified.
cakephp · Nov 21, 2019 · 9b6b0f8 · 9b6b0f8
2 parents 8ae327b + 617a0e4
commit 9b6b0f8
Show file tree

Hide file tree

Showing 4 changed files with 24 additions and 8 deletions.
diff --git a/src/Validation/Validator.php b/src/Validation/Validator.php
@@ -50,6 +50,15 @@ class Validator implements ArrayAccess, IteratorAggregate, Countable
      */
     public const NESTED = '_nested';
 
+    /**
+     * A flag for allowEmptyFor()
+     *
+     * When `null` is given, it will be recognized as empty.
+     *
+     * @var int
+     */
+    public const EMPTY_NULL = 0;
+
     /**
      * A flag for allowEmptyFor()
      *
@@ -202,7 +211,7 @@ public function errors(array $data, bool $newRecord = true): array
 
             $canBeEmpty = $this->_canBeEmpty($field, $context);
 
-            $flags = static::EMPTY_ALL;
+            $flags = static::EMPTY_NULL;
             if (isset($this->_allowEmptyFlags[$name])) {
                 $flags = $this->_allowEmptyFlags[$name];
             }
@@ -705,7 +714,12 @@ public function allowEmpty($field, $when = true, $message = null)
         foreach ($field as $fieldName => $setting) {
             $settings = $this->_convertValidatorToArray($fieldName, $defaults, $setting);
             $fieldName = array_keys($settings)[0];
-            $this->allowEmptyFor($fieldName, null, $settings[$fieldName]['when'], $settings[$fieldName]['message']);
+            $this->allowEmptyFor(
+                $fieldName,
+                static::EMPTY_ALL,
+                $settings[$fieldName]['when'],
+                $settings[$fieldName]['message']
+            );
         }
 
         return $this;
@@ -771,7 +785,8 @@ public function allowEmpty($field, $when = true, $message = null)
      * ```
      *
      * @param string $field The name of the field.
-     * @param int|null $flags A bitmask of EMPTY_* flags which specify what is empty
+     * @param int|null $flags A bitmask of EMPTY_* flags which specify what is empty.
+     *   If no flags/bitmask is provided only `null` will be allowed as empty value.
      * @param bool|string|callable $when Indicates when the field is allowed to be empty
      * Valid values are true, false, 'create', 'update'. If a callable is passed then
      * the field will allowed to be empty only when the callback returns true.
@@ -1161,6 +1176,7 @@ public function notEmpty($field, ?string $message = null, $when = false)
             $whenSetting = $this->invertWhenClause($settings[$fieldName]['when']);
 
             $this->field($fieldName)->allowEmpty($whenSetting);
+            $this->_allowEmptyFlags[$fieldName] = static::EMPTY_ALL;
             if ($settings[$fieldName]['message']) {
                 $this->_allowEmptyMessages[$fieldName] = $settings[$fieldName]['message'];
             }

diff --git a/tests/TestCase/ORM/Behavior/TranslateBehaviorTest.php b/tests/TestCase/ORM/Behavior/TranslateBehaviorTest.php
@@ -1714,7 +1714,7 @@ public function testBuildMarshalMapBuildEntitiesValidationErrors()
             'fields' => ['title', 'body'],
             'validator' => 'custom',
         ]);
-        $validator = (new Validator())->add('title', 'notBlank', ['rule' => 'notBlank']);
+        $validator = (new Validator())->notEmptyString('title');
         $table->setValidator('custom', $validator);
         $translate = $table->behaviors()->get('Translate');
 
@@ -1797,7 +1797,7 @@ public function testBuildMarshalMapUpdateEntitiesValidationErrors()
             'fields' => ['title', 'body'],
             'validator' => 'custom',
         ]);
-        $validator = (new Validator())->add('title', 'notBlank', ['rule' => 'notBlank']);
+        $validator = (new Validator())->notEmptyString('title');
         $table->setValidator('custom', $validator);
         $translate = $table->behaviors()->get('Translate');
 

diff --git a/tests/TestCase/ORM/TableTest.php b/tests/TestCase/ORM/TableTest.php
@@ -5932,7 +5932,7 @@ public function testFindOrCreateWithInvalidEntity()
 
         $articles = $this->getTableLocator()->get('Articles');
         $validator = new Validator();
-        $validator->notBlank('title');
+        $validator->notEmptyString('title');
         $articles->setValidator('default', $validator);
 
         $articles->findOrCreate(['title' => '']);

diff --git a/tests/TestCase/Validation/ValidatorTest.php b/tests/TestCase/Validation/ValidatorTest.php
@@ -616,13 +616,13 @@ public function testAllowEmptyFor()
         $this->assertSame([], $results);
 
         $results = $validator->errors(['title' => '']);
-        $this->assertSame([], $results);
+        $this->assertSame(['title' => ['minLength' => 'Min. length 5 chars']], $results);
 
         $results = $validator->errors(['title' => 0]);
         $this->assertSame(['title' => ['minLength' => 'Min. length 5 chars']], $results);
 
         $results = $validator->errors(['title' => []]);
-        $this->assertSame([], $results);
+        $this->assertSame(['title' => ['minLength' => 'Min. length 5 chars']], $results);
 
         $validator
             ->allowEmptyFor('name', Validator::EMPTY_STRING)