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.

109 lines
3.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
* 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.
13 years ago
*
* @author Qiang Xue <qiang.xue@gmail.com>
13 years ago
* @since 2.0
13 years ago
*/
13 years ago
class BooleanValidator extends Validator
13 years ago
{
/**
* @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';
/**
13 years ago
* @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]].
13 years ago
* Defaults to false, meaning only the value needs to be matched.
*/
public $strict = false;
/**
* Initializes the validator.
*/
public function init()
{
parent::init();
if ($this->message === null) {
$this->message = Yii::t('yii', '{attribute} must be either "{true}" or "{false}".');
}
}
/**
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
{
$value = $object->$attribute;
if (!$this->validateValue($value)) {
$this->addError($object, $attribute, $this->message, array(
13 years ago
'{true}' => $this->trueValue,
'{false}' => $this->falseValue,
));
}
}
/**
* Validates the given value.
* @param mixed $value the value to be validated.
* @return boolean whether the value is valid.
*/
12 years ago
public function validateValue($value)
{
12 years ago
return !$this->strict && ($value == $this->trueValue || $value == $this->falseValue)
|| $this->strict && ($value === $this->trueValue || $value === $this->falseValue);
12 years ago
}
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
{
$options = array(
12 years ago
'trueValue' => $this->trueValue,
'falseValue' => $this->falseValue,
'message' => Html::encode(strtr($this->message, array(
'{attribute}' => $object->getAttributeLabel($attribute),
'{value}' => $object->$attribute,
'{true}' => $this->trueValue,
'{false}' => $this->falseValue,
))),
);
if ($this->skipOnEmpty) {
$options['skipOnEmpty'] = 1;
}
if ($this->strict) {
$options['strict'] = 1;
}
ValidationAsset::register($view);
12 years ago
return 'yii.validation.boolean(value, messages, ' . json_encode($options) . ');';
13 years ago
}
}