CompareTo::getOptions() - Code Metrics - Inspection of "Other usage of translator in validator (concept, d..." - yiisoft/validator - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#99)

by Def

created 2021-01-20 17:22 UTC

CompareTo::getOptions() A

↳ Parent: CompareTo

Complexity

Conditions	1
Paths	1

Size

Total Lines	9
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	7
CRAP Score	1

Importance

Changes

Metric	Value
cc	1
eloc	6
nc	1
nop	0
dl	0
loc	9
ccs	7
cts	7
cp	1
crap	1
rs	10
c	0
b	0
f	0

<?php

declare(strict_types=1);

namespace Yiisoft\Validator\Rule;

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

/**
 * CompareValidator compares the specified attribute value with another value.
 *
 * The value being compared with a constant [[compareValue]], which is set
 * in the constructor.
 *
 * 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.
     */
    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(): string
    {
        switch ($this->operator) {
            case '==':
            case '===':
                return 'Value must be equal to "{value}".';
            case '!=':
            case '!==':
                return 'Value must not be equal to "{value}".';
            case '>':
                return 'Value must be greater than "{value}".';
            case '>=':
                return 'Value must be greater than or equal to "{value}".';
            case '<':
                return 'Value must be less than "{value}".';
            case '<=':
                return 'Value must be less than or equal to "{value}".';
            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.");
        }

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

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

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

    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(
                new ErrorMessage(
                    $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;
        }
    }

    public function getRawOptions(): array
    {
        return array_merge(
            parent::getRawOptions(),
            [
                'type' => $this->type,
                'operator' => $this->operator,
                'compareValue' => $this->compareValue,
                'message' => new ErrorMessage($this->getMessage(), ['value' => $this->compareValue]),
            ],
        );
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace Yiisoft\Validator\Rule;
6
7		use Yiisoft\Validator\DataSetInterface;
8		use Yiisoft\Validator\ErrorMessage;
9		use Yiisoft\Validator\ErrorMessageFormatterInterface;
10		use Yiisoft\Validator\Result;
11		use Yiisoft\Validator\Rule;
12
13		/**
14		* CompareValidator compares the specified attribute value with another value.
15		*
16		* The value being compared with a constant [[compareValue]], which is set
17		* in the constructor.
18		*
19		* CompareValidator supports different comparison operators, specified
20		* via the [[operator]] property.
21		*
22		* The default comparison function is based on string values, which means the values
23		* are compared byte by byte. When comparing numbers, make sure to set the [[$type]]
24		* to [[TYPE_NUMBER]] to enable numeric comparison.
25		*/
26		class CompareTo extends Rule
27		{
28		/**
29		* Constant for specifying the comparison [[type]] by numeric values.
30		*
31		* @see type
32		*/
33		private const TYPE_STRING = 'string';
34		/**
35		* Constant for specifying the comparison [[type]] by numeric values.
36		*
37		* @see type
38		*/
39		private const TYPE_NUMBER = 'number';
40
41		/**
42		* @var mixed the constant value to be compared with.
43		*/
44		private $compareValue;
45		/**
46		* @var string the type of the values being compared. The follow types are supported:
47		*
48		* - [[TYPE_STRING\|string]]: the values are being compared as strings. No conversion will be done before comparison.
49		* - [[TYPE_NUMBER\|number]]: the values are being compared as numbers. String values will be converted into numbers before comparison.
50		*/
51		private string $type = self::TYPE_STRING;
52		/**
53		* @var string the operator for comparison. The following operators are supported:
54		*
55		* - `==`: check if two values are equal. The comparison is done is non-strict mode.
56		* - `===`: check if two values are equal. The comparison is done is strict mode.
57		* - `!=`: check if two values are NOT equal. The comparison is done is non-strict mode.
58		* - `!==`: check if two values are NOT equal. The comparison is done is strict mode.
59		* - `>`: check if value being validated is greater than the value being compared with.
60		* - `>=`: check if value being validated is greater than or equal to the value being compared with.
61		* - `<`: check if value being validated is less than the value being compared with.
62		* - `<=`: check if value being validated is less than or equal to the value being compared with.
63		*
64		* When you want to compare numbers, make sure to also set [[type]] to `number`.
65		*/
66		private string $operator = '==';
67
68		private array $validOperators = [
69		'==' => 1,
70		'===' => 1,
71		'!=' => 1,
72		'!==' => 1,
73		'>' => 1,
74		'>=' => 1,
75		'<' => 1,
76		'<=' => 1,
77		];
78
79	7	private function getMessage(): string
80		{
81	7	switch ($this->operator) {
82	7	case '==':
83	3	case '===':
84	5	return 'Value must be equal to "{value}".';
85	3	case '!=':
86	3	case '!==':
87	2	return 'Value must not be equal to "{value}".';
88	2	case '>':
89	1	return 'Value must be greater than "{value}".';
90	2	case '>=':
91	2	return 'Value must be greater than or equal to "{value}".';
92	1	case '<':
93	1	return 'Value must be less than "{value}".';
94	1	case '<=':
95	1	return 'Value must be less than or equal to "{value}".';
96		default:
97		throw new \RuntimeException("Unknown operator: {$this->operator}");
98		}
99		}
100
101	2	public function __construct($value)
102		{
103	2	$this->compareValue = $value;
104	2	}
105
106	1	public function operator(string $operator): self
107		{
108	1	if (!isset($this->validOperators[$operator])) {
109		throw new \InvalidArgumentException("Operator \"$operator\" is not supported.");
110		}
111
112	1	$new = clone $this;
113	1	$new->operator = $operator;
114	1	return $new;
115		}
116
117		public function asString(): self
118		{
119		$new = clone $this;
120		$new->type = self::TYPE_STRING;
121		return $new;
122		}
123
124		public function asNumber(): self
125		{
126		$new = clone $this;
127		$new->type = self::TYPE_NUMBER;
128		return $new;
129		}
130
131	1	protected function validateValue($value, DataSetInterface $dataSet = null): Result
132		{
133	1	$result = new Result();
134
135	1	if ($this->compareValue === null) {
136		throw new \RuntimeException('CompareValidator::compareValue must be set.');
137		}
138
139	1	if (!$this->compareValues($this->operator, $this->type, $value, $this->compareValue)) {
140	1	$result->addError(
141	1	new ErrorMessage(
142	1	$this->getMessage(),
143		[
144	1	'value' => $this->compareValue,
145		]
146		)
147		);
148		}
149
150	1	return $result;
151		}
152
153		/**
154		* Compares two values with the specified operator.
155		*
156		* @param string $operator the comparison operator
157		* @param string $type the type of the values being compared
158		* @param mixed $value the value being compared
159		* @param mixed $compareValue another value being compared
160		*
161		* @return bool whether the comparison using the specified operator is true.
162		*/
163	1	protected function compareValues(string $operator, string $type, $value, $compareValue): bool
164		{
165	1	if ($type === self::TYPE_NUMBER) {
166		$value = (float)$value;
167		$compareValue = (float)$compareValue;
168		} else {
169	1	$value = (string)$value;
170	1	$compareValue = (string)$compareValue;
171		}
172	1	switch ($operator) {
173	1	case '==':
174	1	return $value == $compareValue;
175	1	case '===':
176	1	return $value === $compareValue;
177	1	case '!=':
178	1	return $value != $compareValue;
179	1	case '!==':
180	1	return $value !== $compareValue;
181	1	case '>':
182	1	return $value > $compareValue;
183	1	case '>=':
184	1	return $value >= $compareValue;
185	1	case '<':
186	1	return $value < $compareValue;
187	1	case '<=':
188	1	return $value <= $compareValue;
189		default:
190		return false;
191		}
192		}
193
194	6	public function getRawOptions(): array
195		{
196	6	return array_merge(
197	6	parent::getRawOptions(),
198		[
199	6	'type' => $this->type,
200	6	'operator' => $this->operator,
201	6	'compareValue' => $this->compareValue,
202	6	'message' => new ErrorMessage($this->getMessage(), ['value' => $this->compareValue]),
203		],
204		);
205		}
206		}
207

yiisoft / validator

Pull Request — master (#99)

CompareTo::getOptions() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like