BooleanValidator.php 2.23 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 14 15 16
 * BooleanValidator checks if the attribute value is a boolean value.
 *
 * Possible boolean values can be configured via the [[trueValue]] and [[falseValue]] properties.
 * And the comparison can be either [[strict]] or not.
w  
Qiang Xue committed
17 18
 *
 * @author Qiang Xue <qiang.xue@gmail.com>
w  
Qiang Xue committed
19
 * @since 2.0
w  
Qiang Xue committed
20
 */
w  
Qiang Xue committed
21
class BooleanValidator extends Validator
w  
Qiang Xue committed
22 23 24 25 26 27 28 29 30 31
{
	/**
	 * @var mixed the value representing true status. Defaults to '1'.
	 */
	public $trueValue = '1';
	/**
	 * @var mixed the value representing false status. Defaults to '0'.
	 */
	public $falseValue = '0';
	/**
w  
Qiang Xue committed
32 33
	 * @var boolean whether the comparison to [[trueValue]] and [[falseValue]] is strict.
	 * When this is true, the attribute value and type must both match those of [[trueValue]] or [[falseValue]].
w  
Qiang Xue committed
34 35 36 37
	 * Defaults to false, meaning only the value needs to be matched.
	 */
	public $strict = false;

Qiang Xue committed
38
	/**
Qiang Xue committed
39
	 * @inheritdoc
Qiang Xue committed
40 41 42 43 44
	 */
	public function init()
	{
		parent::init();
		if ($this->message === null) {
45
			$this->message = Yii::t('yii', '{attribute} must be either "{true}" or "{false}".');
Qiang Xue committed
46 47 48
		}
	}

w  
Qiang Xue committed
49
	/**
Qiang Xue committed
50
	 * @inheritdoc
w  
Qiang Xue committed
51
	 */
Qiang Xue committed
52
	protected function validateValue($value)
w  
Qiang Xue committed
53
	{
Qiang Xue committed
54 55 56 57
		$valid = !$this->strict && ($value == $this->trueValue || $value == $this->falseValue)
			|| $this->strict && ($value === $this->trueValue || $value === $this->falseValue);
		if (!$valid) {
			return [$this->message, [
58 59
				'true' => $this->trueValue,
				'false' => $this->falseValue,
Qiang Xue committed
60 61 62
			]];
		} else {
			return null;
w  
Qiang Xue committed
63 64 65
		}
	}

Qiang Xue committed
66
	/**
Qiang Xue committed
67
	 * @inheritdoc
w  
Qiang Xue committed
68
	 */
69
	public function clientValidateAttribute($object, $attribute, $view)
w  
Qiang Xue committed
70
	{
Alexander Makarov committed
71
		$options = [
Qiang Xue committed
72 73
			'trueValue' => $this->trueValue,
			'falseValue' => $this->falseValue,
74
			'message' => Yii::$app->getI18n()->format($this->message, [
75 76 77
				'attribute' => $object->getAttributeLabel($attribute),
				'true' => $this->trueValue,
				'false' => $this->falseValue,
78
			], Yii::$app->language),
Alexander Makarov committed
79
		];
Qiang Xue committed
80 81 82 83 84 85 86
		if ($this->skipOnEmpty) {
			$options['skipOnEmpty'] = 1;
		}
		if ($this->strict) {
			$options['strict'] = 1;
		}

87
		ValidationAsset::register($view);
Qiang Xue committed
88
		return 'yii.validation.boolean(value, messages, ' . json_encode($options) . ');';
w  
Qiang Xue committed
89 90
	}
}