RequiredValidator.php 3.24 KB
Newer Older
w  
Qiang Xue committed
1 2 3
<?php
/**
 * @link http://www.yiiframework.com/
Qiang Xue committed
4
 * @copyright Copyright (c) 2008 Yii Software LLC
w  
Qiang Xue committed
5 6 7
 * @license http://www.yiiframework.com/license/
 */

w  
Qiang Xue committed
8 9
namespace yii\validators;

Qiang Xue committed
10 11
use Yii;

w  
Qiang Xue committed
12
/**
w  
Qiang Xue committed
13
 * RequiredValidator validates that the specified attribute does not have null or empty value.
w  
Qiang Xue committed
14 15
 *
 * @author Qiang Xue <qiang.xue@gmail.com>
w  
Qiang Xue committed
16
 * @since 2.0
w  
Qiang Xue committed
17
 */
w  
Qiang Xue committed
18
class RequiredValidator extends Validator
w  
Qiang Xue committed
19
{
Qiang Xue committed
20 21 22 23
	/**
	 * @var boolean whether to skip this validator if the value being validated is empty.
	 */
	public $skipOnEmpty = false;
w  
Qiang Xue committed
24 25
	/**
	 * @var mixed the desired value that the attribute must have.
w  
Qiang Xue committed
26
	 * If this is null, the validator will validate that the specified attribute is not empty.
w  
Qiang Xue committed
27 28 29
	 * 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.
w  
Qiang Xue committed
30
	 * @see strict
w  
Qiang Xue committed
31 32 33
	 */
	public $requiredValue;
	/**
w  
Qiang Xue committed
34 35 36 37 38 39
	 * @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.
w  
Qiang Xue committed
40 41
	 */
	public $strict = false;
42 43 44 45 46 47 48 49 50
	/**
	 * @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;
w  
Qiang Xue committed
51

Qiang Xue committed
52
	/**
Qiang Xue committed
53
	 * @inheritdoc
Qiang Xue committed
54 55 56 57 58
	 */
	public function init()
	{
		parent::init();
		if ($this->message === null) {
59 60
			$this->message = $this->requiredValue === null ? Yii::t('yii', '{attribute} cannot be blank.')
				: Yii::t('yii', '{attribute} must be "{requiredValue}".');
Qiang Xue committed
61 62 63
		}
	}

w  
Qiang Xue committed
64
	/**
Qiang Xue committed
65
	 * @inheritdoc
w  
Qiang Xue committed
66
	 */
Qiang Xue committed
67
	protected function validateValue($value)
Qiang Xue committed
68 69 70
	{
		if ($this->requiredValue === null) {
			if ($this->strict && $value !== null || !$this->strict && !$this->isEmpty($value, true)) {
Qiang Xue committed
71
				return null;
Qiang Xue committed
72 73
			}
		} elseif (!$this->strict && $value == $this->requiredValue || $this->strict && $value === $this->requiredValue) {
Qiang Xue committed
74 75 76 77 78 79 80 81
			return null;
		}
		if ($this->requiredValue === null) {
			return [$this->message, []];
		} else {
			return [$this->message, [
				'requiredValue' => $this->requiredValue,
			]];
Qiang Xue committed
82 83 84
		}
	}

w  
Qiang Xue committed
85
	/**
Qiang Xue committed
86
	 * @inheritdoc
w  
Qiang Xue committed
87
	 */
88
	public function clientValidateAttribute($object, $attribute, $view)
w  
Qiang Xue committed
89
	{
Alexander Makarov committed
90
		$options = [];
w  
Qiang Xue committed
91
		if ($this->requiredValue !== null) {
92
			$options['message'] = Yii::$app->getI18n()->format($this->message, [
93
				'requiredValue' => $this->requiredValue,
94
			], Yii::$app->language);
Qiang Xue committed
95
			$options['requiredValue'] = $this->requiredValue;
Qiang Xue committed
96
		} else {
Qiang Xue committed
97 98 99 100
			$options['message'] = $this->message;
		}
		if ($this->strict) {
			$options['strict'] = 1;
w  
Qiang Xue committed
101
		}
Qiang Xue committed
102

103
		$options['message'] = Yii::$app->getI18n()->format($options['message'], [
104
			'attribute' => $object->getAttributeLabel($attribute),
105
		], Yii::$app->language);
Qiang Xue committed
106

107
		ValidationAsset::register($view);
Qiang Xue committed
108
		return 'yii.validation.required(value, messages, ' . json_encode($options) . ');';
w  
Qiang Xue committed
109 110
	}
}