summaryrefslogtreecommitdiff
path: root/framework/validators/CRequiredValidator.php
diff options
context:
space:
mode:
Diffstat (limited to 'framework/validators/CRequiredValidator.php')
-rw-r--r--framework/validators/CRequiredValidator.php108
1 files changed, 108 insertions, 0 deletions
diff --git a/framework/validators/CRequiredValidator.php b/framework/validators/CRequiredValidator.php
new file mode 100644
index 0000000..fd54629
--- /dev/null
+++ b/framework/validators/CRequiredValidator.php
@@ -0,0 +1,108 @@
+<?php
+/**
+ * CRequiredValidator class file.
+ *
+ * @author Qiang Xue <qiang.xue@gmail.com>
+ * @link http://www.yiiframework.com/
+ * @copyright Copyright &copy; 2008-2011 Yii Software LLC
+ * @license http://www.yiiframework.com/license/
+ */
+
+/**
+ * CRequiredValidator validates that the specified attribute does not have null or empty value.
+ *
+ * When using the {@link message} property to define a custom error message, the message
+ * may contain additional placeholders that will be replaced with the actual content. In addition
+ * to the "{attribute}" placeholder, recognized by all validators (see {@link CValidator}),
+ * CRequiredValidator allows for the following placeholders to be specified:
+ * <ul>
+ * <li>{value}: replaced with the desired value {@link requiredValue}.</li>
+ * </ul>
+ *
+ * @author Qiang Xue <qiang.xue@gmail.com>
+ * @version $Id: CRequiredValidator.php 3515 2011-12-28 12:29:24Z mdomba $
+ * @package system.validators
+ * @since 1.0
+ */
+class CRequiredValidator extends CValidator
+{
+ /**
+ * @var mixed the desired value that the attribute must have.
+ * If this is null, the validator will validate that the specified attribute does not have null or empty value.
+ * If this is set as a value that is not null, the validator will validate that
+ * the attribute has a value that is the same as this property value.
+ * Defaults to null.
+ */
+ public $requiredValue;
+ /**
+ * @var boolean whether the comparison to {@link requiredValue} is strict.
+ * When this is true, the attribute value and type must both match those of {@link requiredValue}.
+ * Defaults to false, meaning only the value needs to be matched.
+ * This property is only used when {@link requiredValue} is not null.
+ */
+ public $strict=false;
+ /**
+ * Validates the attribute of the object.
+ * If there is any error, the error message is added to the object.
+ * @param CModel $object the object being validated
+ * @param string $attribute the attribute being validated
+ */
+ protected function validateAttribute($object,$attribute)
+ {
+ $value=$object->$attribute;
+ if($this->requiredValue!==null)
+ {
+ if(!$this->strict && $value!=$this->requiredValue || $this->strict && $value!==$this->requiredValue)
+ {
+ $message=$this->message!==null?$this->message:Yii::t('yii','{attribute} must be {value}.',
+ array('{value}'=>$this->requiredValue));
+ $this->addError($object,$attribute,$message);
+ }
+ }
+ else if($this->isEmpty($value,true))
+ {
+ $message=$this->message!==null?$this->message:Yii::t('yii','{attribute} cannot be blank.');
+ $this->addError($object,$attribute,$message);
+ }
+ }
+
+ /**
+ * Returns the JavaScript needed for performing client-side validation.
+ * @param CModel $object the data object being validated
+ * @param string $attribute the name of the attribute to be validated.
+ * @return string the client-side validation script.
+ * @see CActiveForm::enableClientValidation
+ * @since 1.1.7
+ */
+ public function clientValidateAttribute($object,$attribute)
+ {
+ $message=$this->message;
+ if($this->requiredValue!==null)
+ {
+ if($message===null)
+ $message=Yii::t('yii','{attribute} must be {value}.');
+ $message=strtr($message, array(
+ '{value}'=>$this->requiredValue,
+ '{attribute}'=>$object->getAttributeLabel($attribute),
+ ));
+ return "
+if(value!=" . CJSON::encode($this->requiredValue) . ") {
+ messages.push(".CJSON::encode($message).");
+}
+";
+ }
+ else
+ {
+ if($message===null)
+ $message=Yii::t('yii','{attribute} cannot be blank.');
+ $message=strtr($message, array(
+ '{attribute}'=>$object->getAttributeLabel($attribute),
+ ));
+ return "
+if($.trim(value)=='') {
+ messages.push(".CJSON::encode($message).");
+}
+";
+ }
+ }
+}