Merge pull request #7549 from kenjis/fix-validation-placeholder-DBGroup

fix: [Validation] DBGroup is ignored when checking the value of a placeholder

Author: kenjis

system/Validation/Validation.php

@@ -116,12 +116,15 @@ public function __construct($config, RendererInterface $view)
      * @param array|null  $data    The array of data to validate.
      * @param string|null $group   The predefined group of rules to apply.
      * @param string|null $dbGroup The database group to use.
+     *
+     * @TODO Type ?string for $dbGroup should be removed.
+     *      See https://github.com/codeigniter4/CodeIgniter4/issues/6723
      */
     public function run(?array $data = null, ?string $group = null, ?string $dbGroup = null): bool
     {
         $data ??= $this->data;
 
-        // i.e. is_unique
+        // `DBGroup` is a reserved name. For is_unique and is_not_unique
         $data['DBGroup'] = $dbGroup;
 
         $this->loadRuleSets();
@@ -184,17 +187,28 @@ public function run(?array $data = null, ?string $group = null, ?string $dbGroup
     }
 
     /**
-     * Runs the validation process, returning true or false
-     * determining whether validation was successful or not.
+     * Runs the validation process, returning true or false determining whether
+     * validation was successful or not.
      *
      * @param array|bool|float|int|object|string|null $value
+     * @param array|string                            $rules
      * @param string[]                                $errors
+     * @param string|null                             $dbGroup The database group to use.
      */
-    public function check($value, string $rule, array $errors = []): bool
+    public function check($value, $rules, array $errors = [], $dbGroup = null): bool
     {
         $this->reset();
 
-        return $this->setRule('check', null, $rule, $errors)->run(['check' => $value]);
+        return $this->setRule(
+            'check',
+            null,
+            $rules,
+            $errors
+        )->run(
+            ['check' => $value],
+            null,
+            $dbGroup
+        );
     }
 
     /**
@@ -679,6 +693,7 @@ protected function fillPlaceholders(array $rules, array $data): array
 
                     foreach ($placeholderFields as $field) {
                         $validator ??= Services::validation(null, false);
+                        assert($validator instanceof Validation);
 
                         $placeholderRules = $rules[$field]['rules'] ?? null;
 
@@ -699,7 +714,8 @@ protected function fillPlaceholders(array $rules, array $data): array
                         }
 
                         // Validate the placeholder field
-                        if (! $validator->check($data[$field], implode('|', $placeholderRules))) {
+                        $dbGroup = $data['DBGroup'] ?? null;
+                        if (! $validator->check($data[$field], $placeholderRules, [], $dbGroup)) {
                             // if fails, do nothing
                             continue;
                         }

system/Validation/ValidationInterface.php

@@ -32,12 +32,14 @@ public function run(?array $data = null, ?string $group = null, ?string $dbGroup
      * Check; runs the validation process, returning true or false
      * determining whether or not validation was successful.
      *
-     * @param array|bool|float|int|object|string|null $value  Value to validate.
+     * @param array|bool|float|int|object|string|null $value   Value to validate.
+     * @param array|string                            $rules
      * @param string[]                                $errors
+     * @param string|null                             $dbGroup The database group to use.
      *
      * @return bool True if valid, else false.
      */
-    public function check($value, string $rule, array $errors = []): bool;
+    public function check($value, $rules, array $errors = [], $dbGroup = null): bool;
 
     /**
      * Takes a Request object and grabs the input data to use from its

tests/system/Validation/StrictRules/DatabaseRelatedRulesTest.php

@@ -16,6 +16,7 @@
 use CodeIgniter\Validation\Validation;
 use Config\Database;
 use Config\Services;
+use InvalidArgumentException;
 use Tests\Support\Validation\TestRules;
 
 /**
@@ -82,7 +83,17 @@ public function testIsUniqueTrue(): void
         $this->assertTrue($this->validation->run($data));
     }
 
-    public function testIsUniqueIgnoresParams(): void
+    public function testIsUniqueWithInvalidDBGroup(): void
+    {
+        $this->expectException(InvalidArgumentException::class);
+        $this->expectExceptionMessage('invalidGroup is not a valid database connection group');
+
+        $this->validation->setRules(['email' => 'is_unique[user.email]']);
+        $data = ['email' => '[email protected]'];
+        $this->assertTrue($this->validation->run($data, null, 'invalidGroup'));
+    }
+
+    public function testIsUniqueWithIgnoreValue(): void
     {
         $db = Database::connect();
         $db
@@ -102,7 +113,7 @@ public function testIsUniqueIgnoresParams(): void
         $this->assertTrue($this->validation->run($data));
     }
 
-    public function testIsUniqueIgnoresParamsPlaceholders(): void
+    public function testIsUniqueWithIgnoreValuePlaceholder(): void
     {
         $this->hasInDatabase('user', [
             'name'    => 'Derek',

user_guide_src/source/changelogs/v4.3.6.rst

@@ -12,6 +12,28 @@ Release Date: Unreleased
 BREAKING
 ********
 
+Interface Changes
+=================
+
+.. note:: As long as you have not extended the relevant CodeIgniter core classes
+    or implemented these interfaces, all these changes are backward compatible
+    and require no intervention.
+
+ValidationInterface::check()
+----------------------------
+
+- The second parameter has changed from ``string $rule`` to ``$rules``.
+- The optional fourth parameter ``$dbGroup = null`` has been added.
+
+Method Signature Changes
+========================
+
+Validation::check()
+-------------------
+
+- The second parameter has changed from ``string $rule`` to ``$rules``.
+- The optional fourth parameter ``$dbGroup = null`` has been added.
+
 Message Changes
 ***************
 
@@ -24,6 +46,11 @@ Deprecations
 Bugs Fixed
 **********
 
+- **Validation:** Fixed a bug that ``$DBGroup`` is ignored when checking
+  the value of a placeholder.
+- **Validation:** Fixed a bug that ``check()`` cannot specify non-default
+  database group.
+
 See the repo's
 `CHANGELOG.md <https://github.com/codeigniter4/CodeIgniter4/blob/develop/CHANGELOG.md>`_
 for a complete list of bugs fixed.

user_guide_src/source/installation/upgrade_436.rst

@@ -21,6 +21,9 @@ Breaking Changes
 Breaking Enhancements
 *********************
 
+- The method signatures of ``ValidationInterface::check()`` and ``Validation::check()``
+  have been changed. If you implement or extend them, update the signatures.
+
 Project Files
 *************