123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269 |
- <?php
- /**
- * @link http://www.yiiframework.com/
- * @copyright Copyright (c) 2008 Yii Software LLC
- * @license http://www.yiiframework.com/license/
- */
- namespace yii\validators;
- use Yii;
- use yii\base\InvalidConfigException;
- use yii\helpers\Html;
- /**
- * CompareValidator compares the specified attribute value with another value.
- *
- * The value being compared with can be another attribute value
- * (specified via [[compareAttribute]]) or a constant (specified via
- * [[compareValue]]. When both are specified, the latter takes
- * precedence. If neither is specified, the attribute will be compared
- * with another attribute whose name is by appending "_repeat" to the source
- * attribute name.
- *
- * CompareValidator supports different comparison operators, specified
- * via the [[operator]] property.
- *
- * The default comparison function is based on string values, which means the values
- * are compared byte by byte. When comparing numbers, make sure to set the [[$type]]
- * to [[TYPE_NUMBER]] to enable numeric comparison.
- *
- * @author Qiang Xue <qiang.xue@gmail.com>
- * @since 2.0
- */
- class CompareValidator extends Validator
- {
- /**
- * Constant for specifying the comparison [[type]] by numeric values.
- * @since 2.0.11
- * @see type
- */
- const TYPE_STRING = 'string';
- /**
- * Constant for specifying the comparison [[type]] by numeric values.
- * @since 2.0.11
- * @see type
- */
- const TYPE_NUMBER = 'number';
- /**
- * @var string the name of the attribute to be compared with. When both this property
- * and [[compareValue]] are set, the latter takes precedence. If neither is set,
- * it assumes the comparison is against another attribute whose name is formed by
- * appending '_repeat' to the attribute being validated. For example, if 'password' is
- * being validated, then the attribute to be compared would be 'password_repeat'.
- * @see compareValue
- */
- public $compareAttribute;
- /**
- * @var mixed the constant value to be compared with. When both this property
- * and [[compareAttribute]] are set, this property takes precedence.
- * @see compareAttribute
- */
- public $compareValue;
- /**
- * @var string the type of the values being compared. The follow types are supported:
- *
- * - [[TYPE_STRING|string]]: the values are being compared as strings. No conversion will be done before comparison.
- * - [[TYPE_NUMBER|number]]: the values are being compared as numbers. String values will be converted into numbers before comparison.
- */
- public $type = self::TYPE_STRING;
- /**
- * @var string the operator for comparison. The following operators are supported:
- *
- * - `==`: check if two values are equal. The comparison is done is non-strict mode.
- * - `===`: check if two values are equal. The comparison is done is strict mode.
- * - `!=`: check if two values are NOT equal. The comparison is done is non-strict mode.
- * - `!==`: check if two values are NOT equal. The comparison is done is strict mode.
- * - `>`: check if value being validated is greater than the value being compared with.
- * - `>=`: check if value being validated is greater than or equal to the value being compared with.
- * - `<`: check if value being validated is less than the value being compared with.
- * - `<=`: check if value being validated is less than or equal to the value being compared with.
- *
- * When you want to compare numbers, make sure to also set [[type]] to `number`.
- */
- public $operator = '==';
- /**
- * @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
- * - `{compareValue}`: the value or the attribute label to be compared with
- * - `{compareAttribute}`: the label of the attribute to be compared with
- * - `{compareValueOrAttribute}`: the value or the attribute label to be compared with
- */
- public $message;
- /**
- * {@inheritdoc}
- */
- public function init()
- {
- parent::init();
- if ($this->message === null) {
- switch ($this->operator) {
- case '==':
- $this->message = Yii::t('yii', '{attribute} must be equal to "{compareValueOrAttribute}".');
- break;
- case '===':
- $this->message = Yii::t('yii', '{attribute} must be equal to "{compareValueOrAttribute}".');
- break;
- case '!=':
- $this->message = Yii::t('yii', '{attribute} must not be equal to "{compareValueOrAttribute}".');
- break;
- case '!==':
- $this->message = Yii::t('yii', '{attribute} must not be equal to "{compareValueOrAttribute}".');
- break;
- case '>':
- $this->message = Yii::t('yii', '{attribute} must be greater than "{compareValueOrAttribute}".');
- break;
- case '>=':
- $this->message = Yii::t('yii', '{attribute} must be greater than or equal to "{compareValueOrAttribute}".');
- break;
- case '<':
- $this->message = Yii::t('yii', '{attribute} must be less than "{compareValueOrAttribute}".');
- break;
- case '<=':
- $this->message = Yii::t('yii', '{attribute} must be less than or equal to "{compareValueOrAttribute}".');
- break;
- default:
- throw new InvalidConfigException("Unknown operator: {$this->operator}");
- }
- }
- }
- /**
- * {@inheritdoc}
- */
- public function validateAttribute($model, $attribute)
- {
- $value = $model->$attribute;
- if (is_array($value)) {
- $this->addError($model, $attribute, Yii::t('yii', '{attribute} is invalid.'));
- return;
- }
- if ($this->compareValue !== null) {
- $compareLabel = $compareValue = $compareValueOrAttribute = $this->compareValue;
- } else {
- $compareAttribute = $this->compareAttribute === null ? $attribute . '_repeat' : $this->compareAttribute;
- $compareValue = $model->$compareAttribute;
- $compareLabel = $compareValueOrAttribute = $model->getAttributeLabel($compareAttribute);
- }
- if (!$this->compareValues($this->operator, $this->type, $value, $compareValue)) {
- $this->addError($model, $attribute, $this->message, [
- 'compareAttribute' => $compareLabel,
- 'compareValue' => $compareValue,
- 'compareValueOrAttribute' => $compareValueOrAttribute,
- ]);
- }
- }
- /**
- * {@inheritdoc}
- */
- protected function validateValue($value)
- {
- if ($this->compareValue === null) {
- throw new InvalidConfigException('CompareValidator::compareValue must be set.');
- }
- if (!$this->compareValues($this->operator, $this->type, $value, $this->compareValue)) {
- return [$this->message, [
- 'compareAttribute' => $this->compareValue,
- 'compareValue' => $this->compareValue,
- 'compareValueOrAttribute' => $this->compareValue,
- ]];
- }
- return null;
- }
- /**
- * Compares two values with the specified operator.
- * @param string $operator the comparison operator
- * @param string $type the type of the values being compared
- * @param mixed $value the value being compared
- * @param mixed $compareValue another value being compared
- * @return bool whether the comparison using the specified operator is true.
- */
- protected function compareValues($operator, $type, $value, $compareValue)
- {
- if ($type === self::TYPE_NUMBER) {
- $value = (float) $value;
- $compareValue = (float) $compareValue;
- } else {
- $value = (string) $value;
- $compareValue = (string) $compareValue;
- }
- switch ($operator) {
- case '==':
- return $value == $compareValue;
- case '===':
- return $value === $compareValue;
- case '!=':
- return $value != $compareValue;
- case '!==':
- return $value !== $compareValue;
- case '>':
- return $value > $compareValue;
- case '>=':
- return $value >= $compareValue;
- case '<':
- return $value < $compareValue;
- case '<=':
- return $value <= $compareValue;
- default:
- return false;
- }
- }
- /**
- * {@inheritdoc}
- */
- public function clientValidateAttribute($model, $attribute, $view)
- {
- ValidationAsset::register($view);
- $options = $this->getClientOptions($model, $attribute);
- return 'yii.validation.compare(value, messages, ' . json_encode($options, JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE) . ', $form);';
- }
- /**
- * {@inheritdoc}
- */
- public function getClientOptions($model, $attribute)
- {
- $options = [
- 'operator' => $this->operator,
- 'type' => $this->type,
- ];
- if ($this->compareValue !== null) {
- $options['compareValue'] = $this->compareValue;
- $compareLabel = $compareValue = $compareValueOrAttribute = $this->compareValue;
- } else {
- $compareAttribute = $this->compareAttribute === null ? $attribute . '_repeat' : $this->compareAttribute;
- $compareValue = $model->getAttributeLabel($compareAttribute);
- $options['compareAttribute'] = Html::getInputId($model, $compareAttribute);
- $options['compareAttributeName'] = Html::getInputName($model, $compareAttribute);
- $compareLabel = $compareValueOrAttribute = $model->getAttributeLabel($compareAttribute);
- }
- if ($this->skipOnEmpty) {
- $options['skipOnEmpty'] = 1;
- }
- $options['message'] = $this->formatMessage($this->message, [
- 'attribute' => $model->getAttributeLabel($attribute),
- 'compareAttribute' => $compareLabel,
- 'compareValue' => $compareValue,
- 'compareValueOrAttribute' => $compareValueOrAttribute,
- ]);
- return $options;
- }
- }
|