Global rules: rename + fix #1

Author: EmilienCo

README.md

@@ -93,19 +93,20 @@ $validator->rule(new \Validation\Required);
 
 #### For multiple fields
 
-A single rule can be applied to multiple fields.<br>
+A same rule can be applied to multiple fields. It is called a **global rule**.<br>
 It is useful to avoid repeating the same rule, for example in the case of several fields are required.
 
-These “global rules” are applied to each field until calling `breakRule` function.<br>
+A global rule will be applied to each field until calling `endGlobalRule` function.<br>
 
 There are two type of rules: 'and' and 'or'.
 
 ##### 'and' rule
 
-An 'and' rule is applied to each field added after declaring it.
+An 'and' rule is applied to each field added after declaring it.<br>
+It is the default type of rule.
 
 ```php
-$validator->ruleUntilBreak($rule);
+$validator->globalRule($rule);
 ```
 
 ##### 'or' rule
@@ -114,18 +115,18 @@ An 'or' rule will pass if at least one of the fields added after declaring it pa
 It is typically used with `\Validation\Required`, when at least one of X fields must be filled (for example, at least the user landline or mobile phone number).
 
 ```php
-$validator->ruleUntilBreak($rule, Validator::OPERATOR_OR, $message);
+$validator->globalRule($rule, Validator::OPERATOR_OR, $message);
 ```
 
 `$message` is a required property. It is the user-facing message that will be returned if none of the fields pass the rule.
 
 
 ##### Break
 
-To break the latest global rule declared:
+To end the latest global rule declared:
 
 ```php
-$validator->breakRule();
+$validator->endGlobalRule();
 ```
 
 ### Running the validation
@@ -170,20 +171,20 @@ The following examples validates a simple user information form.
 ```php
 $validator = new Validator;
 
-$validator->ruleuntilbreak(new \Validation\Required)
+$validator->globalRule(new \Validation\Required)
 
-              ->ruleuntilbreak(new \Validation\LengthGreaterThan(3))
+              ->globalRule(new \Validation\LengthGreaterThan(3))
                   ->field('firstname')
                   ->field('lastname')
-              ->breakRule()
+              ->endGlobalRule()
 
               ->field('email')
                   ->rule(new \Validation\Email)
 
               ->field('dob')
                   ->rule(new \Validation\Dob)
 
-          ->breakRule();
+          ->endGlobalRule();
 
 if( ! $validator->run($_POST))
   print_r($validator->getErrors());

sample/full.php

@@ -34,43 +34,43 @@ public static function isUsernameTaken($username)
 
 $validator	=	new Validator;
 
-$validator->ruleuntilbreak(new \Validation\Required())
+$validator->globalRule(new \Validation\Required())
 
-			->ruleuntilbreak(new \Validation\LengthGreaterThan(3))
+				->globalRule(new \Validation\LengthGreaterThan(3))
 
-				->field('firstname')
+					->field('firstname')
 
-				->field('lastname')
+					->field('lastname')
 
-				->field('username')
-				->rule('User::isUsernameTaken')
+					->field('username')
+					->rule('User::isUsernameTaken')
 
-			->breakRule()
+				->endGlobalRule()
 
-			->field('email')
-			->rule(new \Validation\Email)
+				->field('email')
+				->rule(new \Validation\Email)
 
-			->field('dob')
-			->rule(new \Validation\Date)
+				->field('dob')
+				->rule(new \Validation\Date)
 
-			->field('agreement')
-			->rule(function($value)
-			{
-				if($value !== 'I AGREE')
-					throw new Exception('Please write “I AGREE” if you agree with the rules');
-			})
+				->field('agreement')
+				->rule(function($value)
+				{
+					if($value !== 'I AGREE')
+						throw new Exception('Please write “I AGREE” if you agree with the rules');
+				})
 
-			->field('age')
-			->rule('ctype_digit')
+				->field('age')
+				->rule('ctype_digit')
 
-		->breakRule()
+		->endGlobalRule()
 
-		->ruleuntilbreak(new \Validation\Required, Validator::OPERATOR_OR, 'Please indicate your phone number')
+		->globalRule(new \Validation\Required, Validator::OPERATOR_OR, 'Please indicate your phone number')
 
 			->field('landline_number')
 			->field('mobile_number')
 
-		->breakRule();
+		->endGlobalRule();
 
 if( ! $validator->run($data))
 	print_r($validator->getErrors());

src/validator.php

@@ -22,12 +22,15 @@ class Validator
 	protected $_global_errors	=	[ ];
 
 	// Hold temporary 'and' and 'or' rules
-	protected $_temp_and	=	[ ];
-	protected $_temp_or		=	[ ];
+	protected $_temp_or			=	[ ];
+	protected $_temp_and		=	[ ];
 
 	// Hold final 'or' rules
 	protected $_or	=	[ ];
 
+	// Hold the stack of 'and' and 'or' to break in the right order
+	private $__and_or_stack	=	[ ];
+
 	/**
 	 * Declare a field
 	 *
@@ -64,7 +67,7 @@ public function __call($name, $arguments)
 		try
 		{
 			if( ! $this->_current_field)
-				throw new Exception('Please declare a field before calling '.$name.', or use `ruleUntilBreak`', E_ERROR);
+				throw new Exception('Please declare a field before calling '.$name.', or use `globalRule`', E_ERROR);
 
 			$field	=	$this->_fields[$this->_current_field];
 
@@ -80,7 +83,7 @@ public function __call($name, $arguments)
 
 	/**
 	 * Declare a global rule to be applied to multiple field.
-	 * A global rule is disabled with `breakRule` function.
+	 * A global rule is disabled with `endGlobalRule` function.
 	 *
 	 *   - An 'and' rule is applied to each field added after declaring it.
 	 *
@@ -93,8 +96,10 @@ public function __call($name, $arguments)
 	 * @param string $message Error message (in the case of 'or' rule)
 	 * @return \Validator
 	 */
-	public function ruleUntilBreak($rule, $operator = self::OPERATOR_AND, $message = null)
+	public function globalRule($rule, $operator = self::OPERATOR_AND, $message = null)
 	{
+		$this->__and_or_stack[]	=	$operator;
+
 		switch($operator)
 		{
 			case self::OPERATOR_AND:
@@ -115,24 +120,44 @@ public function ruleUntilBreak($rule, $operator = self::OPERATOR_AND, $message =
 				];
 
 			break;
+
+			default:
+
+				throw new Exception('Unknown operator \''.$operator.'\' for global rule');
 		}
 
 		return $this;
 	}
 
 	/**
-	 * Break the latest global rule declared.
+	 * Disable the latest global rule declared.
 	 *
 	 * @return \Validator
 	 */
-	public function breakRule()
+	public function endGlobalRule()
 	{
-		// Merge temporary 'or' rules
-		if($this->_temp_or)
-			$this->_or[]	=	array_pop($this->_temp_or);
+		switch(array_pop($this->__and_or_stack))
+		{
+			case self::OPERATOR_AND:
+
+				// Remove latest pushed 'and' rule
+				array_pop($this->_temp_and);
 
-		// Remove latest pushed 'and' rule
-		array_pop($this->_temp_and);
+			break;
+
+			case self::OPERATOR_OR:
+
+				// Merge temporary 'or' rules
+				if($this->_temp_or)
+					$this->_or[]	=	array_pop($this->_temp_or);
+
+			break;
+
+			default:
+
+				// No more rule in the stack
+				throw new Exception('Called `endGlobalRule` when no global rule remaining');
+		}
 
 		return $this;
 	}
@@ -194,7 +219,7 @@ public function run(array $values)
 
 		$this->_has_error	=	false;
 
-		$this->_breakAllRules();
+		$this->_endAllGlobalRules();
 
 		// First, run all 'or' validation rules
 		foreach($this->_or as $or)
@@ -298,11 +323,11 @@ public function setHasError($has_error)
 	}
 
 	/**
-	 * Break all global rules declared till now.
+	 * Close and disable all the remaining global rules.
 	 *
 	 * @return \Validator
 	 */
-	protected function _breakAllRules()
+	protected function _endAllGlobalRules()
 	{
 		// Merge temporary 'or' rules
 		if($this->_temp_or)