|
1
|
|
|
<?php |
|
2
|
|
|
|
|
3
|
|
|
declare(strict_types=1); |
|
4
|
|
|
|
|
5
|
|
|
namespace Yiisoft\Validator\Rule; |
|
6
|
|
|
|
|
7
|
|
|
use Attribute; |
|
8
|
|
|
use Closure; |
|
9
|
|
|
use InvalidArgumentException; |
|
10
|
|
|
use JetBrains\PhpStorm\ArrayShape; |
|
11
|
|
|
use RuntimeException; |
|
12
|
|
|
use Yiisoft\Validator\ParametrizedRuleInterface; |
|
13
|
|
|
use Yiisoft\Validator\BeforeValidationInterface; |
|
14
|
|
|
use Yiisoft\Validator\Rule\Trait\HandlerClassNameTrait; |
|
15
|
|
|
use Yiisoft\Validator\Rule\Trait\BeforeValidationTrait; |
|
16
|
|
|
use Yiisoft\Validator\Rule\Trait\RuleNameTrait; |
|
17
|
|
|
use Yiisoft\Validator\ValidationContext; |
|
18
|
|
|
|
|
19
|
|
|
/** |
|
20
|
|
|
* Compares the specified value with another value. |
|
21
|
|
|
* |
|
22
|
|
|
* The value being compared with a constant {@see CompareTo::$compareValue}, which is set |
|
23
|
|
|
* in the constructor. |
|
24
|
|
|
* |
|
25
|
|
|
* It supports different comparison operators, specified |
|
26
|
|
|
* via the {@see CompareTo::$operator}. |
|
27
|
|
|
* |
|
28
|
|
|
* The default comparison function is based on string values, which means the values |
|
29
|
|
|
* are compared byte by byte. When comparing numbers, make sure to change {@see CompareTo::$type} to |
|
30
|
|
|
* {@see CompareTo::TYPE_NUMBER} to enable numeric comparison. |
|
31
|
|
|
*/ |
|
32
|
|
|
#[Attribute(Attribute::TARGET_PROPERTY)] |
|
33
|
|
|
final class CompareTo implements ParametrizedRuleInterface, BeforeValidationInterface |
|
34
|
|
|
{ |
|
35
|
|
|
use BeforeValidationTrait; |
|
36
|
|
|
use HandlerClassNameTrait; |
|
37
|
|
|
use RuleNameTrait; |
|
38
|
|
|
|
|
39
|
|
|
/** |
|
40
|
|
|
* Constant for specifying the comparison as string values. |
|
41
|
|
|
* No conversion will be done before comparison. |
|
42
|
|
|
* |
|
43
|
|
|
* @see CompareTo::$type |
|
44
|
|
|
*/ |
|
45
|
|
|
public const TYPE_STRING = 'string'; |
|
46
|
|
|
/** |
|
47
|
|
|
* Constant for specifying the comparison as numeric values. |
|
48
|
|
|
* String values will be converted into numbers before comparison. |
|
49
|
|
|
* |
|
50
|
|
|
* @see CompareTo::$type |
|
51
|
|
|
*/ |
|
52
|
|
|
public const TYPE_NUMBER = 'number'; |
|
53
|
|
|
|
|
54
|
|
|
private array $validOperators = [ |
|
55
|
|
|
'==' => 1, |
|
56
|
|
|
'===' => 1, |
|
57
|
|
|
'!=' => 1, |
|
58
|
|
|
'!==' => 1, |
|
59
|
|
|
'>' => 1, |
|
60
|
|
|
'>=' => 1, |
|
61
|
|
|
'<' => 1, |
|
62
|
|
|
'<=' => 1, |
|
63
|
|
|
]; |
|
64
|
|
|
|
|
65
|
2 |
|
public function __construct( |
|
66
|
|
|
/** |
|
67
|
|
|
* @var mixed the constant value to be compared with. When both this property |
|
68
|
|
|
* and {@see $compareAttribute} are set, this property takes precedence. |
|
69
|
|
|
*/ |
|
70
|
|
|
private $compareValue = null, |
|
71
|
|
|
/** |
|
72
|
|
|
* @var string|null the name of the attribute to be compared with. When both this property |
|
73
|
|
|
* and {@see $compareValue} are set, the latter takes precedence. If neither is set, |
|
74
|
|
|
* it assumes the comparison is against another attribute whose name is formed by |
|
75
|
|
|
* appending '_repeat' to the attribute being validated. For example, if 'password' is |
|
76
|
|
|
* being validated, then the attribute to be compared would be 'password_repeat'. |
|
77
|
|
|
* @see $compareValue |
|
78
|
|
|
*/ |
|
79
|
|
|
private ?string $compareAttribute = null, |
|
80
|
|
|
/** |
|
81
|
|
|
* @var string|null user-defined error message |
|
82
|
|
|
*/ |
|
83
|
|
|
private ?string $message = null, |
|
84
|
|
|
/** |
|
85
|
|
|
* @var string the type of the values being compared. |
|
86
|
|
|
*/ |
|
87
|
|
|
private string $type = self::TYPE_STRING, |
|
88
|
|
|
/** |
|
89
|
|
|
* @var string the operator for comparison. The following operators are supported: |
|
90
|
|
|
* |
|
91
|
|
|
* - `==`: check if two values are equal. The comparison is done is non-strict mode. |
|
92
|
|
|
* - `===`: check if two values are equal. The comparison is done is strict mode. |
|
93
|
|
|
* - `!=`: check if two values are NOT equal. The comparison is done is non-strict mode. |
|
94
|
|
|
* - `!==`: check if two values are NOT equal. The comparison is done is strict mode. |
|
95
|
|
|
* - `>`: check if value being validated is greater than the value being compared with. |
|
96
|
|
|
* - `>=`: check if value being validated is greater than or equal to the value being compared with. |
|
97
|
|
|
* - `<`: check if value being validated is less than the value being compared with. |
|
98
|
|
|
* - `<=`: check if value being validated is less than or equal to the value being compared with. |
|
99
|
|
|
* |
|
100
|
|
|
* When you want to compare numbers, make sure to also change @see CompareTo::$type} to |
|
101
|
|
|
* {@see CompareTo::TYPE_NUMBER}. |
|
102
|
|
|
*/ |
|
103
|
|
|
private string $operator = '==', |
|
104
|
|
|
private bool $skipOnEmpty = false, |
|
105
|
|
|
private bool $skipOnError = false, |
|
106
|
|
|
/** |
|
107
|
|
|
* @var Closure(mixed, ValidationContext):bool|null |
|
108
|
|
|
*/ |
|
109
|
|
|
private ?Closure $when = null, |
|
110
|
|
|
) { |
|
111
|
2 |
|
if (!isset($this->validOperators[$operator])) { |
|
112
|
|
|
throw new InvalidArgumentException("Operator \"$operator\" is not supported."); |
|
113
|
|
|
} |
|
114
|
|
|
} |
|
115
|
|
|
|
|
116
|
|
|
/** |
|
117
|
|
|
* @return mixed |
|
118
|
|
|
*/ |
|
119
|
36 |
|
public function getCompareValue(): mixed |
|
120
|
|
|
{ |
|
121
|
36 |
|
return $this->compareValue; |
|
122
|
|
|
} |
|
123
|
|
|
|
|
124
|
|
|
/** |
|
125
|
|
|
* @return string|null |
|
126
|
|
|
*/ |
|
127
|
36 |
|
public function getCompareAttribute(): ?string |
|
128
|
|
|
{ |
|
129
|
36 |
|
return $this->compareAttribute; |
|
130
|
|
|
} |
|
131
|
|
|
|
|
132
|
|
|
/** |
|
133
|
|
|
* @return string |
|
134
|
|
|
*/ |
|
135
|
36 |
|
public function getType(): string |
|
136
|
|
|
{ |
|
137
|
36 |
|
return $this->type; |
|
138
|
|
|
} |
|
139
|
|
|
|
|
140
|
|
|
/** |
|
141
|
|
|
* @return string |
|
142
|
|
|
*/ |
|
143
|
36 |
|
public function getOperator(): string |
|
144
|
|
|
{ |
|
145
|
36 |
|
return $this->operator; |
|
146
|
|
|
} |
|
147
|
|
|
|
|
148
|
27 |
|
public function getMessage(): string |
|
149
|
|
|
{ |
|
150
|
27 |
|
return $this->message ?? match ($this->operator) { |
|
151
|
9 |
|
'==', '===' => 'Value must be equal to "{compareValueOrAttribute}".', |
|
152
|
7 |
|
'!=', '!==' => 'Value must not be equal to "{compareValueOrAttribute}".', |
|
153
|
2 |
|
'>' => 'Value must be greater than "{compareValueOrAttribute}".', |
|
154
|
2 |
|
'>=' => 'Value must be greater than or equal to "{compareValueOrAttribute}".', |
|
155
|
2 |
|
'<' => 'Value must be less than "{compareValueOrAttribute}".', |
|
156
|
2 |
|
'<=' => 'Value must be less than or equal to "{compareValueOrAttribute}".', |
|
157
|
27 |
|
default => throw new RuntimeException("Unknown operator: {$this->operator}"), |
|
158
|
|
|
}; |
|
159
|
|
|
} |
|
160
|
|
|
|
|
161
|
9 |
|
#[ArrayShape([ |
|
162
|
|
|
'compareValue' => 'mixed', |
|
163
|
|
|
'compareAttribute' => '', |
|
164
|
|
|
'message' => 'array', |
|
165
|
|
|
'type' => 'string', |
|
166
|
|
|
'operator' => 'string', |
|
167
|
|
|
'skipOnEmpty' => 'bool', |
|
168
|
|
|
'skipOnError' => 'bool', |
|
169
|
|
|
])] |
|
170
|
|
|
public function getOptions(): array |
|
171
|
|
|
{ |
|
172
|
|
|
return [ |
|
173
|
9 |
|
'compareValue' => $this->compareValue, |
|
174
|
9 |
|
'compareAttribute' => $this->compareAttribute, |
|
175
|
|
|
'message' => [ |
|
176
|
9 |
|
'message' => $this->getMessage(), |
|
177
|
|
|
'parameters' => [ |
|
178
|
9 |
|
'compareValue' => $this->compareValue, |
|
179
|
9 |
|
'compareAttribute' => $this->compareAttribute, |
|
180
|
9 |
|
'compareValueOrAttribute' => $this->compareValue ?? $this->compareAttribute, |
|
181
|
|
|
], |
|
182
|
|
|
], |
|
183
|
9 |
|
'type' => $this->type, |
|
184
|
9 |
|
'operator' => $this->operator, |
|
185
|
9 |
|
'skipOnEmpty' => $this->skipOnEmpty, |
|
186
|
9 |
|
'skipOnError' => $this->skipOnError, |
|
187
|
|
|
]; |
|
188
|
|
|
} |
|
189
|
|
|
} |
|
190
|
|
|
|
yiisoft /
validator
