Implement convert option to Phalcon\Validation\Validator\Uniqueness. F…

…ixes #12005.
phalcon · Jul 26, 2016 · e401134 · e401134
1 parent b444ff4
commit e401134
Show file tree

Hide file tree

Showing 3 changed files with 98 additions and 3 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -110,6 +110,7 @@
 - Fixed wildcard inheritance in `Phalcon\Acl\Adapter\Memory` [#12004](https://github.com/phalcon/cphalcon/issues/12004)
 - Dropped support of Oracle [#12008](https://github.com/phalcon/cphalcon/issues/12008)
 - Improved `Phalcon\Mvc\Collection::findById`. Added check if a `id` in a valid format [#12010](https://github.com/phalcon/cphalcon/issues/12010)
+- Added `convert` option to `Phalcon\Validation\Validator\Uniqueness` to convert values to do the database lookup [#12005](https://github.com/phalcon/cphalcon/issues/12005)
 
 # [2.0.13](https://github.com/phalcon/cphalcon/releases/tag/phalcon-v2.0.13) (2016-05-19)
 - Restored `Phalcon\Text::camelize` behavior [#11767](https://github.com/phalcon/cphalcon/issues/11767)

diff --git a/phalcon/validation/validator/uniqueness.zep b/phalcon/validation/validator/uniqueness.zep
@@ -56,6 +56,18 @@ use Phalcon\Mvc\Model;
  * <code>
  * $validator->add(['firstName', 'lastName'], new UniquenessValidator());
  * </code>
+ *
+ * It is possible to convert values before validation. This is useful in
+ * situations where values need to be converted to do the database lookup:
+ * <code>
+ * $validator->add('username', new UniquenessValidator([
+ *     'convert' => function (array $values) {
+ *         $values['username'] = strtolower($values['username']);
+ *
+ *         return $values;
+ *     }
+ * ]));
+ * </code>
  */
 class Uniqueness extends CombinedFieldsValidator
 {
@@ -90,7 +102,7 @@ class Uniqueness extends CombinedFieldsValidator
 
 	protected function isUniqueness(<Validation> validation, var field) -> boolean
 	{
-		var value, record, attribute, except,
+		var value, values, convert, record, attribute, except,
 			index, params, metaData, primaryField, className, singleField, fieldExcept, singleExcept, notInValues, exceptConditions;
 
 		let exceptConditions = [];
@@ -106,11 +118,26 @@ class Uniqueness extends CombinedFieldsValidator
 			let field[] = singleField;
 		}
 
+		let values = [];
+		let convert = this->getOption("convert");
+
+		for singleField in field {
+			let values[singleField] = validation->getValue(singleField);
+		}
+
+		if convert != null {
+			let values = {convert}(values);
+
+			if !is_array(values) {
+				throw new Exception("Value conversion must return an array");
+			}
+		}
+
 		for singleField in field {
 			let fieldExcept = null;
 			let notInValues = [];
-			let value = validation->getValue(singleField),
-				record = this->getOption("model");
+			let record = this->getOption("model");
+			let value = values[singleField];
 
 			if empty record || typeof record != "object" {
 				// check validation getEntity() method

diff --git a/tests/unit/Validation/Validator/UniquenessTest.php b/tests/unit/Validation/Validator/UniquenessTest.php
@@ -69,6 +69,27 @@ public function testSingleField()
         });
     }
 
+    /**
+     * Tests uniqueness validator with single fields and a converted value
+     *
+     * @author Bas Stottelaar <[email protected]>
+     * @since  2016-07-25
+     */
+    public function testSingleFieldConvert()
+    {
+        $this->specify('Test uniqueness with single field and a converted value.', function () {
+            $validation = new Validation();
+            $validation->add('type', new Uniqueness([
+                'convert' => function (array $values) {
+                    $values['type'] = 'hydraulic'; // mechanical -> hydraulic
+                    return $values;
+                }
+            ]));
+            $messages = $validation->validate(null, $this->robot);
+            expect($messages->count())->equals(0);
+        });
+    }
+
     /**
      * Tests uniqueness validator with single field and a null value
      *
@@ -107,6 +128,27 @@ public function testMultipleFields()
         });
     }
 
+    /**
+     * Tests uniqueness validator with multiple fields and a converted value
+     *
+     * @author Bas Stottelaar <[email protected]>
+     * @since  2016-07-25
+     */
+    public function testMultipleFieldsConvert()
+    {
+        $this->specify('Test uniqueness with combination of fields and a converted value.', function () {
+            $validation = new Validation();
+            $validation->add(['name', 'type'], new Uniqueness([
+                'convert' => function (array $values) {
+                    $values['type'] = 'hydraulic'; // mechanical -> hydraulic
+                    return $values;
+                }
+            ]));
+            $messages = $validation->validate(null, $this->robot);
+            expect($messages->count())->equals(0);
+        });
+    }
+
     /**
      * Tests uniqueness validator with multiple fields and a null value
      *
@@ -213,6 +255,31 @@ public function testExceptMultipleFieldMultipleExcept()
         });
     }
 
+    /**
+     * Tests value conversion for returning an array.
+     *
+     * @author Bas Stottelaar <[email protected]>
+     * @since  2016-07-25
+     */
+    public function testConvertArrayReturnsArray()
+    {
+        $this->specify('Test value conversion to return an array.', function () {
+            $validation = new Validation();
+            $validation->add('type', new Uniqueness([
+                'convert' => function (array $values) {
+                    ($values);
+                    return null;
+                }
+            ]));
+            try {
+                $validation->validate(null, $this->robot);
+                verify_that(false);
+            } catch (\Exception $e) {
+                verify_that(true);
+            }
+        });
+    }
+
     /**
      * Initialize data for the tests
      */