Implementing 'on' key in ValidationRule to accept closures

cakephp · Nov 20, 2013 · ce4684b · ce4684b
1 parent d5c4637
commit ce4684b
Show file tree

Hide file tree

Showing 2 changed files with 52 additions and 16 deletions.
diff --git a/Cake/ORM/Validation/ValidationRule.php b/Cake/ORM/Validation/ValidationRule.php
@@ -78,21 +78,6 @@ public function __construct($validator = array()) {
 		$this->_addValidatorProps($validator);
 	}
 
-/**
- * Checks if the validation rule should be skipped
- *
- * @param boolean $newRecord whether the rule to be processed is new or pre-existent
- * @return boolean True if the ValidationRule should be skipped
- */
-	public function skip($newRecord) {
-		if (!empty($this->_on)) {
-			if ($this->_on === 'create' && !$newRecord || $this->_on === 'update' && $newRecord) {
-				return true;
-			}
-		}
-		return false;
-	}
-
 /**
  * Returns whether this rule should break validation process for associated field
  * after it fails
@@ -118,7 +103,7 @@ public function isLast() {
  * callable for the configured scope
  */
 	public function process($data, $scopes, $newRecord) {
-		if ($this->skip($newRecord)) {
+		if ($this->_skip($newRecord, $scopes)) {
 			return true;
 		}
 
@@ -148,6 +133,29 @@ public function process($data, $scopes, $newRecord) {
 		return $result;
 	}
 
+/**
+ * Checks if the validation rule should be skipped
+ *
+ * @param boolean $newRecord whether the rule to be processed is new or pre-existent
+ * @param array $scopes associative array with objects or class names that will
+ * be passed as the last argument for the validation method
+ * @return boolean True if the ValidationRule should be skipped
+ */
+	protected function _skip($newRecord, $scopes) {
+		if (is_callable($this->_on)) {
+			$function = $this->_on;
+			return !$function($scopes);
+		}
+
+		if (!empty($this->_on)) {
+			if ($this->_on === 'create' && !$newRecord || $this->_on === 'update' && $newRecord) {
+				return true;
+			}
+		}
+		return false;
+	}
+
+
 /**
  * Sets the rule properties from the rule entry in validate
  *

diff --git a/Cake/Test/TestCase/ORM/Validation/ValidationRuleTest.php b/Cake/Test/TestCase/ORM/Validation/ValidationRuleTest.php
@@ -119,4 +119,32 @@ public function testSkip() {
 		]);
 		$this->assertFalse($Rule->process($data, $scopes, false));
 	}
+
+/**
+ * Tests that the 'on' key can be a callable function
+ *
+ * @return void
+ */
+	public function testCallableOn() {
+		$data = 'some data';
+		$scopes = ['default' => $this];
+
+		$Rule = new ValidationRule([
+			'rule' => 'myTestRule',
+			'on' => function($s) use ($scopes) {
+				$this->assertEquals($scopes, $s);
+				return true;
+			}
+		]);
+		$this->assertFalse($Rule->process($data, $scopes, true));
+
+		$Rule = new ValidationRule([
+			'rule' => 'myTestRule',
+			'on' => function($s) use ($scopes) {
+				$this->assertEquals($scopes, $s);
+				return false;
+			}
+		]);
+		$this->assertTrue($Rule->process($data, $scopes, true));
+	}
 }