You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

133 lines
4.2 KiB

13 years ago
<?php
/**
* @link http://www.yiiframework.com/
* @copyright Copyright (c) 2008 Yii Software LLC
13 years ago
* @license http://www.yiiframework.com/license/
*/
13 years ago
namespace yii\validators;
use Yii;
12 years ago
use yii\helpers\Html;
13 years ago
/**
13 years ago
* RequiredValidator validates that the specified attribute does not have null or empty value.
13 years ago
*
* @author Qiang Xue <qiang.xue@gmail.com>
13 years ago
* @since 2.0
13 years ago
*/
13 years ago
class RequiredValidator extends Validator
13 years ago
{
/**
* @var boolean whether to skip this validator if the value being validated is empty.
*/
public $skipOnEmpty = false;
/**
13 years ago
* @var mixed the desired value that the attribute must have.
13 years ago
* If this is null, the validator will validate that the specified attribute is not empty.
13 years ago
* 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.
13 years ago
* @see strict
13 years ago
*/
public $requiredValue;
/**
13 years ago
* @var boolean whether the comparison between the attribute value and [[requiredValue]] is strict.
* When this is true, both the values and types must match.
* Defaults to false, meaning only the values need to match.
* Note that when [[requiredValue]] is null, if this property is true, the validator will check
* if the attribute value is null; If this property is false, the validator will call [[isEmpty]]
* to check if the attribute value is empty.
13 years ago
*/
public $strict = false;
/**
* @var string the user-defined error message. It may contain the following placeholders which
* will be replaced accordingly by the validator:
*
* - `{attribute}`: the label of the attribute being validated
* - `{value}`: the value of the attribute being validated
* - `{requiredValue}`: the value of [[requiredValue]]
*/
public $message;
13 years ago
/**
* Initializes the validator.
*/
public function init()
{
parent::init();
if ($this->message === null) {
$this->message = $this->requiredValue === null ? Yii::t('yii', '{attribute} cannot be blank.')
: Yii::t('yii', '{attribute} must be "{requiredValue}".');
}
}
/**
13 years ago
* Validates the attribute of the object.
* If there is any error, the error message is added to the object.
13 years ago
* @param \yii\base\Model $object the object being validated
13 years ago
* @param string $attribute the attribute being validated
*/
13 years ago
public function validateAttribute($object, $attribute)
13 years ago
{
12 years ago
if (!$this->validateValue($object->$attribute)) {
if ($this->requiredValue === null) {
$this->addError($object, $attribute, $this->message);
12 years ago
} else {
$this->addError($object, $attribute, $this->message, array(
'{requiredValue}' => $this->requiredValue,
));
13 years ago
}
13 years ago
}
}
/**
* Validates the given value.
* @param mixed $value the value to be validated.
* @return boolean whether the value is valid.
*/
public function validateValue($value)
{
if ($this->requiredValue === null) {
if ($this->strict && $value !== null || !$this->strict && !$this->isEmpty($value, true)) {
return true;
}
} elseif (!$this->strict && $value == $this->requiredValue || $this->strict && $value === $this->requiredValue) {
return true;
}
return false;
}
/**
13 years ago
* Returns the JavaScript needed for performing client-side validation.
13 years ago
* @param \yii\base\Model $object the data object being validated
13 years ago
* @param string $attribute the name of the attribute to be validated.
* @param \yii\base\View $view the view object that is going to be used to render views or view files
* containing a model form with this validator applied.
13 years ago
* @return string the client-side validation script.
*/
public function clientValidateAttribute($object, $attribute, $view)
13 years ago
{
12 years ago
$options = array();
13 years ago
if ($this->requiredValue !== null) {
12 years ago
$options['message'] = strtr($this->message, array(
13 years ago
'{requiredValue}' => $this->requiredValue,
13 years ago
));
12 years ago
$options['requiredValue'] = $this->requiredValue;
13 years ago
} else {
12 years ago
$options['message'] = $this->message;
}
if ($this->strict) {
$options['strict'] = 1;
13 years ago
}
12 years ago
$options['message'] = Html::encode(strtr($options['message'], array(
'{attribute}' => $object->getAttributeLabel($attribute),
'{value}' => $object->$attribute,
)));
ValidationAsset::register($view);
12 years ago
return 'yii.validation.required(value, messages, ' . json_encode($options) . ');';
13 years ago
}
}