Yiisoft\Validator\Rule\CompareTo

Complexity

Total Complexity

27

Size/Duplication

Total Lines	154
Duplicated Lines	0 %

Test Coverage

Coverage

54.84%

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
B	getMessage()	0	19	9
A	asNumber()	0	4	1
B	compareValues()	0	28	10
A	asString()	0	4	1
A	__construct()	0	3	1
A	operator()	0	8	2
A	validateValue()	0	14	3

<?php

namespace Yiisoft\Validator\Rule;

use Yiisoft\Validator\DataSetInterface;
use Yiisoft\Validator\Result;
use Yiisoft\Validator\Rule;

/**
 * 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.
 */
class CompareTo extends Rule
{
    /**
     * Constant for specifying the comparison [[type]] by numeric values.
     * @see type
     */
    private const TYPE_STRING = 'string';
    /**
     * Constant for specifying the comparison [[type]] by numeric values.
     * @see type
     */
    private const TYPE_NUMBER = 'number';

    /**
     * @var mixed the constant value to be compared with. When both this property
     * and [[compareAttribute]] are set, this property takes precedence.
     * @see compareAttribute
     */
    private $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.
     */
    private string $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`.
     */
    private string $operator = '==';

    private array $validOperators = [
        '==' => 1,
        '===' => 1,
        '!=' => 1,
        '!==' => 1,
        '>' => 1,
        '>=' => 1,
        '<' => 1,
        '<=' => 1,
    ];

    private function getMessage(array $arguments): string
    {
        switch ($this->operator) {
            case '==':
            case '===':
                return $this->formatMessage('Value must be equal to "{value}".', $arguments);
            case '!=':
            case '!==':
                return $this->formatMessage('Value must not be equal to "{value}".', $arguments);
            case '>':
                return $this->formatMessage('Value must be greater than "{value}".', $arguments);
            case '>=':
                return $this->formatMessage('Value must be greater than or equal to "{value}".', $arguments);
            case '<':
                return $this->formatMessage('Value must be less than "{value}".', $arguments);
            case '<=':
                return $this->formatMessage('Value must be less than or equal to "{value}".', $arguments);
            default:
                throw new \RuntimeException("Unknown operator: {$this->operator}");
        }
    }

    public function __construct($value)
    {
        $this->compareValue = $value;
    }

    public function operator(string $operator): self
    {
        if (!isset($this->validOperators[$operator])) {
            throw new \InvalidArgumentException("Operator \"$operator\" is not supported.");
        }

        $this->operator = $operator;
        return $this;
    }

    public function asString(): self
    {
        $this->type = self::TYPE_STRING;
        return $this;
    }

    public function asNumber(): self
    {
        $this->type = self::TYPE_NUMBER;
        return $this;
    }

    protected function validateValue($value, DataSetInterface $dataSet = null): Result
    {
        $result = new Result();

        if ($this->compareValue === null) {
            throw new \RuntimeException('CompareValidator::compareValue must be set.');
        }
        if (!$this->compareValues($this->operator, $this->type, $value, $this->compareValue)) {
            $result->addError($this->getMessage([
                'value' => $this->compareValue,
            ]));
        }

        return $result;
    }

    /**
     * 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(string $operator, string $type, $value, $compareValue): bool
    {
        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;
        }
    }
}