Merge pull request #4545 from paulbalandan/validation-dot-notation-if-exist

Fix dot notation for if_exist

Author: paulbalandan

system/Validation/Validation.php

@@ -215,11 +215,30 @@ protected function processRules(string $field, string $label = null, $value, $ru
 
 		if (in_array('if_exist', $rules, true))
 		{
-			// If the if_exist rule is defined
-			// and the current field does not exist in the input data
-			// we can return true, ignoring all other rules to this field.
-			if (! array_key_exists($field, array_flatten_with_dots($data)))
+			$flattenedData = array_flatten_with_dots($data);
+			$ifExistField  = $field;
+
+			if (strpos($field, '.*') !== false)
+			{
+				// We'll change the dot notation into a PCRE pattern
+				// that can be used later
+				$ifExistField = str_replace('\.\*', '\.(?:[^\.]+)', preg_quote($field, '/'));
+
+				$dataIsExisting = array_reduce(array_keys($flattenedData), static function ($carry, $item) use ($ifExistField) {
+					$pattern = sprintf('/%s/u', $ifExistField);
+					return $carry || preg_match($pattern, $item) === 1;
+				}, false);
+			}
+			else
+			{
+				$dataIsExisting = array_key_exists($ifExistField, $flattenedData);
+			}
+
+			unset($ifExistField, $flattenedData);
+
+			if (! $dataIsExisting)
 			{
+				// we return early if `if_exist` is not satisfied. we have nothing to do here.
 				return true;
 			}
 
@@ -345,6 +364,7 @@ protected function processRules(string $field, string $label = null, $value, $ru
 	 */
 	public function withRequest(RequestInterface $request): ValidationInterface
 	{
+		/** @var IncomingRequest $request */
 		if (strpos($request->getHeaderLine('Content-Type'), 'application/json') !== false)
 		{
 			$this->data = $request->getJSON(true);
@@ -365,7 +385,6 @@ public function withRequest(RequestInterface $request): ValidationInterface
 		return $this;
 	}
 
-	//--------------------------------------------------------------------
 	//--------------------------------------------------------------------
 	// Rules
 	//--------------------------------------------------------------------
@@ -814,24 +833,21 @@ protected function splitRules(string $rules): array
 	{
 		$nonEscapeBracket = '((?<!\\\\)(?:\\\\\\\\)*[\[\]])';
 		$pipeNotInBracket = sprintf(
-				'/\|(?=(?:[^\[\]]*%s[^\[\]]*%s)*(?![^\[\]]*%s))/',
-				$nonEscapeBracket,
-				$nonEscapeBracket,
-				$nonEscapeBracket
+			'/\|(?=(?:[^\[\]]*%s[^\[\]]*%s)*(?![^\[\]]*%s))/',
+			$nonEscapeBracket,
+			$nonEscapeBracket,
+			$nonEscapeBracket
 		);
 
-		$_rules = preg_split(
-				$pipeNotInBracket,
-				$rules
-		);
+		$_rules = preg_split($pipeNotInBracket, $rules);
 
 		return array_unique($_rules);
 	}
 
-	//--------------------------------------------------------------------
 	//--------------------------------------------------------------------
 	// Misc
 	//--------------------------------------------------------------------
+
 	/**
 	 * Resets the class to a blank slate. Should be called whenever
 	 * you need to process more than one array.
@@ -847,6 +863,4 @@ public function reset(): ValidationInterface
 
 		return $this;
 	}
-
-	//--------------------------------------------------------------------
 }

tests/system/Validation/ValidationTest.php

@@ -1,4 +1,6 @@
-<?php namespace CodeIgniter\Validation;
+<?php
+
+namespace CodeIgniter\Validation;
 
 use CodeIgniter\HTTP\IncomingRequest;
 use CodeIgniter\HTTP\URI;
@@ -9,9 +11,11 @@
 use Config\Services;
 use Tests\Support\Validation\TestRules;
 
-class ValidationTest extends CIUnitTestCase
+/**
+ * @internal
+ */
+final class ValidationTest extends CIUnitTestCase
 {
-
 	/**
 	 * @var Validation
 	 */
@@ -945,5 +949,75 @@ public function testTranslatedLabelTagReplacement()
 		$this->assertEquals($expected, $errors['Username']);
 	}
 
-	//--------------------------------------------------------------------
+	/**
+	 * @dataProvider dotNotationForIfExistProvider
+	 *
+	 * @see https://github.com/codeigniter4/CodeIgniter4/issues/4521
+	 *
+	 * @param boolean $expected
+	 * @param array $rules
+	 * @param array $data
+	 *
+	 * @return void
+	 */
+	public function testDotNotationOnIfExistRule(bool $expected, array $rules, array $data): void
+	{
+		$actual = $this->validation->setRules($rules)->run($data);
+		$this->assertSame($expected, $actual);
+	}
+
+	public function dotNotationForIfExistProvider()
+	{
+		yield 'dot-on-end-fail' => [
+			false,
+			['status.*' => 'if_exist|in_list[status_1,status_2]'],
+			['status'   => ['bad-status']],
+		];
+
+		yield 'dot-on-end-pass' => [
+			true,
+			['status.*' => 'if_exist|in_list[status_1,status_2]'],
+			['status'   => ['status_1']],
+		];
+
+		yield 'dot-on-middle-fail' => [
+			false,
+			['fizz.*.baz' => 'if_exist|numeric'],
+			['fizz'       => [
+				'bar' => ['baz' => 'yes'],
+			]],
+		];
+
+		yield 'dot-on-middle-pass' => [
+			true,
+			['fizz.*.baz' => 'if_exist|numeric'],
+			['fizz'       => [
+				'bar' => ['baz' => 30],
+			]],
+		];
+
+		yield 'dot-multiple-fail' => [
+			false,
+			['fizz.*.bar.*' => 'if_exist|numeric'],
+			['fizz' => [
+				'bos' => [
+					'bar' => [
+						'bub' => 'noo',
+					],
+				],
+			]],
+		];
+
+		yield 'dot-multiple-pass' => [
+			true,
+			['fizz.*.bar.*' => 'if_exist|numeric'],
+			['fizz' => [
+				'bos' => [
+					'bar' => [
+						'bub' => 5,
+					],
+				],
+			]],
+		];
+	}
 }