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.
112 lines
3.7 KiB
112 lines
3.7 KiB
<?php |
|
/** |
|
* @link http://www.yiiframework.com/ |
|
* @copyright Copyright (c) 2008 Yii Software LLC |
|
* @license http://www.yiiframework.com/license/ |
|
*/ |
|
|
|
namespace yii\validators; |
|
|
|
use Yii; |
|
|
|
/** |
|
* RequiredValidator validates that the specified attribute does not have null or empty value. |
|
* |
|
* @author Qiang Xue <qiang.xue@gmail.com> |
|
* @since 2.0 |
|
*/ |
|
class RequiredValidator extends Validator |
|
{ |
|
/** |
|
* @var boolean whether to skip this validator if the value being validated is empty. |
|
*/ |
|
public $skipOnEmpty = false; |
|
/** |
|
* @var mixed the desired value that the attribute must have. |
|
* If this is null, the validator will validate that the specified attribute is not empty. |
|
* 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. |
|
* @see strict |
|
*/ |
|
public $requiredValue; |
|
/** |
|
* @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. |
|
*/ |
|
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; |
|
|
|
|
|
/** |
|
* @inheritdoc |
|
*/ |
|
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}".'); |
|
} |
|
} |
|
|
|
/** |
|
* @inheritdoc |
|
*/ |
|
protected function validateValue($value) |
|
{ |
|
if ($this->requiredValue === null) { |
|
if ($this->strict && $value !== null || !$this->strict && !$this->isEmpty(is_string($value) ? trim($value) : $value)) { |
|
return null; |
|
} |
|
} elseif (!$this->strict && $value == $this->requiredValue || $this->strict && $value === $this->requiredValue) { |
|
return null; |
|
} |
|
if ($this->requiredValue === null) { |
|
return [$this->message, []]; |
|
} else { |
|
return [$this->message, [ |
|
'requiredValue' => $this->requiredValue, |
|
]]; |
|
} |
|
} |
|
|
|
/** |
|
* @inheritdoc |
|
*/ |
|
public function clientValidateAttribute($object, $attribute, $view) |
|
{ |
|
$options = []; |
|
if ($this->requiredValue !== null) { |
|
$options['message'] = Yii::$app->getI18n()->format($this->message, [ |
|
'requiredValue' => $this->requiredValue, |
|
], Yii::$app->language); |
|
$options['requiredValue'] = $this->requiredValue; |
|
} else { |
|
$options['message'] = $this->message; |
|
} |
|
if ($this->strict) { |
|
$options['strict'] = 1; |
|
} |
|
|
|
$options['message'] = Yii::$app->getI18n()->format($options['message'], [ |
|
'attribute' => $object->getAttributeLabel($attribute), |
|
], Yii::$app->language); |
|
|
|
ValidationAsset::register($view); |
|
|
|
return 'yii.validation.required(value, messages, ' . json_encode($options) . ');'; |
|
} |
|
}
|
|
|