allow form behaviors to alter owner model rules instead of just appen…

…ding to them

components/CaptchaFormBehavior.php

@@ -20,13 +20,13 @@ class CaptchaFormBehavior extends FormModelBehavior
 	/**
 	 * @inheritdoc
 	 */
-	public function rules()
+	public function filterRules($rules = array())
 	{
 		$module = Yii::app()->controller !== null ? Yii::app()->controller->module : null;
-		$rules = array(
+		$behaviorRules = array(
 			array('verifyCode', 'captcha', 'captchaAction'=>($module !== null ? $module->getId() : 'usr').'/default/captcha'),
 		);
-		return $this->applyRuleOptions($rules);
+		return array_merge($rules, $this->applyRuleOptions($behaviorRules));
 	}
 
 	/**

components/ExpiredPasswordBehavior.php

@@ -39,12 +39,12 @@ public function setPasswordTimeout($value)
 	/**
 	 * @inheritdoc
 	 */
-	public function rules()
+	public function filterRules($rules = array())
 	{
-		$rules = array(
+		$behaviorRules = array(
 			array('password', 'passwordHasNotExpired', 'except'=>'reset, hybridauth, verifyOTP'),
 		);
-		return $this->applyRuleOptions($rules);
+		return array_merge($rules, $this->applyRuleOptions($behaviorRules));
 	}
 
 	public function passwordHasNotExpired()

components/FormModelBehavior.php

@@ -20,13 +20,13 @@ abstract class FormModelBehavior extends CModelBehavior
 	private $_ruleOptions = array();
 
 	/**
-	 * Validation rules for attributes of this behavior, that should be merged with rules in the owner model.
+	 * Adds validation rules for attributes of this behavior or removes rules from the owner model.
 	 * @return array validation rules
 	 * @see CModel::rules()
 	 */
-	public function rules()
+	public function filterRules($rules = array())
 	{
-		return array();
+		return $rules;
 	}
 
 	/**

components/OneTimePasswordFormBehavior.php

@@ -59,15 +59,15 @@ public function events() {
 	/**
 	 * @inheritdoc
 	 */
-	public function rules()
+	public function filterRules($rules = array())
 	{
-		$rules = array(
+		$behaviorRules = array(
 			array('oneTimePassword', 'filter', 'filter'=>'trim', 'on'=>'verifyOTP'),
 			array('oneTimePassword', 'default', 'setOnEmpty'=>true, 'value' => null, 'on'=>'verifyOTP'),
 			array('oneTimePassword', 'required', 'on'=>'verifyOTP'),
 			array('oneTimePassword', 'validOneTimePassword', 'except'=>'hybridauth'),
 		);
-		return $this->applyRuleOptions($rules);
+		return array_merge($rules, $this->applyRuleOptions($behaviorRules));
 	}
 
 	/**

models/BaseUsrForm.php

@@ -112,16 +112,17 @@ public function getBehaviorLabels()
 	}
 
 	/**
-	 * Returns rules defined in attached behaviors that extend FormModelBehavior.
+     * Filters base rules through each attached behavior that extend FormModelBehavior,
+     * which may add their own rules or remove existing ones.
+     * @param array base form model rules
 	 * @return array validation rules
 	 * @see CModel::rules()
 	 */
-	public function getBehaviorRules()
+	public function filterRules($rules)
 	{
-		$rules = array();
 		foreach($this->_behaviors as $name=>$foo) {
 			if (($behavior=$this->asa($name)) instanceof FormModelBehavior)
-				$rules = array_merge($rules, $behavior->rules());
+				$rules = $behavior->filterRules($rules);
 		}
 		return $rules;
 	}

models/LoginForm.php

@@ -32,12 +32,12 @@ public function getAvailableScenarios()
 	 */
 	public function rules()
 	{
-		$rules = array_merge(array(
+		$rules = $this->filterRules(array_merge(array(
 			array('username, password', 'filter', 'filter'=>'trim'),
 			array('username, password', 'required'),
 			array('rememberMe', 'boolean'),
 			array('password', 'authenticate'),
-		), $this->rulesAddScenario(parent::rules(), 'reset'), $this->getBehaviorRules());
+		), $this->rulesAddScenario(parent::rules(), 'reset')));
 
 		return $rules;
 	}

models/ProfileForm.php

@@ -52,7 +52,7 @@ public function setPictureUploadRules($rules)
 	 */
 	public function rules()
 	{
-		return array_merge($this->getBehaviorRules(), array(
+		return $this->filterRules(array_merge(array(
 			array('username, email, firstName, lastName, removePicture', 'filter', 'filter'=>'trim'),
 			array('username, email, firstName, lastName, removePicture', 'default', 'setOnEmpty'=>true, 'value' => null),
 
@@ -61,7 +61,7 @@ public function rules()
 			array('email', 'email'),
 			array('removePicture', 'boolean'),
 			array('password', 'validCurrentPassword', 'except'=>'register'),
-		), $this->pictureUploadRules);
+		), $this->pictureUploadRules));
 	}
 
 	/**

models/RecoveryForm.php

@@ -22,7 +22,7 @@ class RecoveryForm extends BasePasswordForm
 	 * and password needs to be authenticated.
 	 */
 	public function rules() {
-		$rules = array_merge($this->getBehaviorRules(), array(
+		$rules = $this->filterRules(array_merge(array(
 			array('username, email', 'filter', 'filter'=>'trim'),
 			array('username, email', 'default', 'setOnEmpty'=>true, 'value' => null),
 			array('username, email', 'existingIdentity'),
@@ -32,7 +32,7 @@ public function rules() {
 			array('activationKey', 'default', 'setOnEmpty'=>true, 'value' => null, 'on'=>'reset,verify'),
 			array('activationKey', 'required', 'on'=>'reset,verify'),
 			array('activationKey', 'validActivationKey', 'on'=>'reset,verify'),
-		), $this->rulesAddScenario(parent::rules(), 'reset'));
+		), $this->rulesAddScenario(parent::rules(), 'reset')));
 
 		return $rules;
 	}

tests/unit/LoginFormTest.php

@@ -61,7 +61,7 @@ public function testWithBehavior()
 		$formLabels = $form->attributeLabels();
 		$form->attachBehavior('captcha', array('class' => 'CaptchaFormBehavior'));
 		$behaviorAttributes = $form->asa('captcha')->attributeNames();
-		$behaviorRules = $form->asa('captcha')->rules();
+		$behaviorRules = $form->asa('captcha')->filterRules();
 		$behaviorLabels = $form->asa('captcha')->attributeLabels();
 		$this->assertEquals(array_merge($formAttributes, $behaviorAttributes), $form->attributeNames());
 		$this->assertEquals(array_merge($formRules, $behaviorRules), $form->rules());

tests/unit/ProfileFormTest.php

@@ -54,7 +54,7 @@ public function testWithBehavior()
 		$formLabels = $form->attributeLabels();
 		$form->attachBehavior('captcha', array('class' => 'CaptchaFormBehavior'));
 		$behaviorAttributes = $form->asa('captcha')->attributeNames();
-		$behaviorRules = $form->asa('captcha')->rules();
+		$behaviorRules = $form->asa('captcha')->filterRules();
 		$behaviorLabels = $form->asa('captcha')->attributeLabels();
 		$this->assertEquals(array_merge($formAttributes, $behaviorAttributes), $form->attributeNames());
 		$this->assertEquals(array_merge($behaviorRules, $formRules), $form->rules());

tests/unit/RecoveryFormTest.php

@@ -50,7 +50,7 @@ public function testWithBehavior()
 		$formLabels = $form->attributeLabels();
 		$form->attachBehavior('captcha', array('class' => 'CaptchaFormBehavior'));
 		$behaviorAttributes = $form->asa('captcha')->attributeNames();
-		$behaviorRules = $form->asa('captcha')->rules();
+		$behaviorRules = $form->asa('captcha')->filterRules();
 		$behaviorLabels = $form->asa('captcha')->attributeLabels();
 		$this->assertEquals(array_merge($formAttributes, $behaviorAttributes), $form->attributeNames());
 		$this->assertEquals(array_merge($behaviorRules, $formRules), $form->rules());