Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit fd3ad65

Browse files
fabpotfabpot
committed
feature #32435 [Validator] Add a new constraint message when there is both min and max (Lctrs)
This PR was squashed before being merged into the 4.4 branch (closes #32435). Discussion ---------- [Validator] Add a new constraint message when there is both min and max | Q | A | ------------- | --- | Branch? | 4.4 | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | Part of #31503 | License | MIT | Doc PR | to do Currently, the failed validation messages in the `Range` constraint doesn't carry a notion of range. This can be confusing and error-prone if we report these messages to the user as-is. This PR introduces a new message to the `Range` constraint (`This value should be between {{ min }} and {{ max }}.`) that will be displayed if both `min` and `max` are not `null`. Commits ------- c5488bc [Validator] Add a new constraint message when there is both min and max
2 parents aefb8bd + c5488bc commit fd3ad65

File tree

6 files changed

+78
-42
lines changed

6 files changed

+78
-42
lines changed

‎src/Symfony/Component/Validator/CHANGELOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,8 @@ CHANGELOG
1818
* added the `min_limit_path` and `max_limit_path` parameters in violations when using
1919
`Range` constraint with respectively the `minPropertyPath` and
2020
`maxPropertyPath` options.
21+
* added a new `notInRangeMessage` options to the `Range` constraint that will
22+
be used in the violation builder when both `min` and `max` are not null.
2123

2224
4.3.0
2325
-----

‎src/Symfony/Component/Validator/Constraints/Range.php

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,15 +26,18 @@
2626
class Range extends Constraint
2727
{
2828
const INVALID_CHARACTERS_ERROR = 'ad9a9798-7a99-4df7-8ce9-46e416a1e60b';
29+
const NOT_IN_RANGE_ERROR = '04b91c99-a946-4221-afc5-e65ebac401eb';
2930
const TOO_HIGH_ERROR = '2d28afcb-e32e-45fb-a815-01c431a86a69';
3031
const TOO_LOW_ERROR = '76454e69-502c-46c5-9643-f447d837c4d5';
3132

3233
protected static $errorNames = [
3334
self::INVALID_CHARACTERS_ERROR => 'INVALID_CHARACTERS_ERROR',
35+
self::NOT_IN_RANGE_ERROR => 'NOT_IN_RANGE_ERROR',
3436
self::TOO_HIGH_ERROR => 'TOO_HIGH_ERROR',
3537
self::TOO_LOW_ERROR => 'TOO_LOW_ERROR',
3638
];
3739

40+
public $notInRangeMessage = 'This value should be between {{ min }} and {{ max }}.';
3841
public $minMessage = 'This value should be {{ limit }} or more.';
3942
public $maxMessage = 'This value should be {{ limit }} or less.';
4043
public $invalidMessage = 'This value should be a valid number.';

‎src/Symfony/Component/Validator/Constraints/RangeValidator.php

Lines changed: 25 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,30 @@ public function validate($value, Constraint $constraint)
7070
}
7171
}
7272

73-
if (null !== $max && $value > $max) {
73+
$hasLowerLimit = null !== $min;
74+
$hasUpperLimit = null !== $max;
75+
76+
if ($hasLowerLimit && $hasUpperLimit && ($value < $min || $value > $max)) {
77+
$violationBuilder = $this->context->buildViolation($constraint->notInRangeMessage)
78+
->setParameter('{{ value }}', $this->formatValue($value, self::PRETTY_DATE))
79+
->setParameter('{{ min }}', $this->formatValue($min, self::PRETTY_DATE))
80+
->setParameter('{{ max }}', $this->formatValue($max, self::PRETTY_DATE))
81+
->setCode(Range::NOT_IN_RANGE_ERROR);
82+
83+
if (null !== $constraint->maxPropertyPath) {
84+
$violationBuilder->setParameter('{{ max_limit_path }}', $constraint->maxPropertyPath);
85+
}
86+
87+
if (null !== $constraint->minPropertyPath) {
88+
$violationBuilder->setParameter('{{ min_limit_path }}', $constraint->minPropertyPath);
89+
}
90+
91+
$violationBuilder->addViolation();
92+
93+
return;
94+
}
95+
96+
if ($hasUpperLimit && $value > $max) {
7497
$violationBuilder = $this->context->buildViolation($constraint->maxMessage)
7598
->setParameter('{{ value }}', $this->formatValue($value, self::PRETTY_DATE))
7699
->setParameter('{{ limit }}', $this->formatValue($max, self::PRETTY_DATE))
@@ -89,7 +112,7 @@ public function validate($value, Constraint $constraint)
89112
return;
90113
}
91114

92-
if (null !== $min && $value < $min) {
115+
if ($hasLowerLimit && $value < $min) {
93116
$violationBuilder = $this->context->buildViolation($constraint->minMessage)
94117
->setParameter('{{ value }}', $this->formatValue($value, self::PRETTY_DATE))
95118
->setParameter('{{ limit }}', $this->formatValue($min, self::PRETTY_DATE))

‎src/Symfony/Component/Validator/Resources/translations/validators.en.xlf

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -362,6 +362,10 @@
362362
<source>This password has been leaked in a data breach, it must not be used. Please use another password.</source>
363363
<target>This password has been leaked in a data breach, it must not be used. Please use another password.</target>
364364
</trans-unit>
365+
<trans-unit id="94">
366+
<source>This value should be between {{ min }} and {{ max }}.</source>
367+
<target>This value should be between {{ min }} and {{ max }}.</target>
368+
</trans-unit>
365369
</body>
366370
</file>
367371
</xliff>

‎src/Symfony/Component/Validator/Resources/translations/validators.fr.xlf

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -362,6 +362,10 @@
362362
<source>This password has been leaked in a data breach, it must not be used. Please use another password.</source>
363363
<target>Ce mot de passe a été divulgué lors d'une fuite de données, il ne doit plus être utilisé. Veuillez utiliser un autre mot de passe.</target>
364364
</trans-unit>
365+
<trans-unit id="94">
366+
<source>This value should be between {{ min }} and {{ max }}.</source>
367+
<target>Cette valeur doit être comprise entre {{ min }} et {{ max }}.</target>
368+
</trans-unit>
365369
</body>
366370
</file>
367371
</xliff>

‎src/Symfony/Component/Validator/Tests/Constraints/RangeValidatorTest.php

Lines changed: 40 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -143,16 +143,16 @@ public function testInvalidValuesCombinedMax($value, $formattedValue)
143143
$constraint = new Range([
144144
'min' => 10,
145145
'max' => 20,
146-
'minMessage' => 'myMinMessage',
147-
'maxMessage' => 'myMaxMessage',
146+
'notInRangeMessage' => 'myNotInRangeMessage',
148147
]);
149148

150149
$this->validator->validate($value, $constraint);
151150

152-
$this->buildViolation('myMaxMessage')
151+
$this->buildViolation('myNotInRangeMessage')
153152
->setParameter('{{ value }}', $formattedValue)
154-
->setParameter('{{ limit }}', 20)
155-
->setCode(Range::TOO_HIGH_ERROR)
153+
->setParameter('{{ min }}', 10)
154+
->setParameter('{{ max }}', 20)
155+
->setCode(Range::NOT_IN_RANGE_ERROR)
156156
->assertRaised();
157157
}
158158

@@ -164,16 +164,16 @@ public function testInvalidValuesCombinedMin($value, $formattedValue)
164164
$constraint = new Range([
165165
'min' => 10,
166166
'max' => 20,
167-
'minMessage' => 'myMinMessage',
168-
'maxMessage' => 'myMaxMessage',
167+
'notInRangeMessage' => 'myNotInRangeMessage',
169168
]);
170169

171170
$this->validator->validate($value, $constraint);
172171

173-
$this->buildViolation('myMinMessage')
172+
$this->buildViolation('myNotInRangeMessage')
174173
->setParameter('{{ value }}', $formattedValue)
175-
->setParameter('{{ limit }}', 10)
176-
->setCode(Range::TOO_LOW_ERROR)
174+
->setParameter('{{ min }}', 10)
175+
->setParameter('{{ max }}', 20)
176+
->setCode(Range::NOT_IN_RANGE_ERROR)
177177
->assertRaised();
178178
}
179179

@@ -327,16 +327,16 @@ public function testInvalidDatesCombinedMax($value, $dateTimeAsString)
327327
$constraint = new Range([
328328
'min' => 'March 10, 2014',
329329
'max' => 'March 20, 2014',
330-
'minMessage' => 'myMinMessage',
331-
'maxMessage' => 'myMaxMessage',
330+
'notInRangeMessage' => 'myNotInRangeMessage',
332331
]);
333332

334333
$this->validator->validate($value, $constraint);
335334

336-
$this->buildViolation('myMaxMessage')
335+
$this->buildViolation('myNotInRangeMessage')
337336
->setParameter('{{ value }}', $dateTimeAsString)
338-
->setParameter('{{ limit }}', 'Mar 20, 2014, 12:00 AM')
339-
->setCode(Range::TOO_HIGH_ERROR)
337+
->setParameter('{{ min }}', 'Mar 10, 2014, 12:00 AM')
338+
->setParameter('{{ max }}', 'Mar 20, 2014, 12:00 AM')
339+
->setCode(Range::NOT_IN_RANGE_ERROR)
340340
->assertRaised();
341341
}
342342

@@ -352,16 +352,16 @@ public function testInvalidDatesCombinedMin($value, $dateTimeAsString)
352352
$constraint = new Range([
353353
'min' => 'March 10, 2014',
354354
'max' => 'March 20, 2014',
355-
'minMessage' => 'myMinMessage',
356-
'maxMessage' => 'myMaxMessage',
355+
'notInRangeMessage' => 'myNotInRangeMessage',
357356
]);
358357

359358
$this->validator->validate($value, $constraint);
360359

361-
$this->buildViolation('myMinMessage')
360+
$this->buildViolation('myNotInRangeMessage')
362361
->setParameter('{{ value }}', $dateTimeAsString)
363-
->setParameter('{{ limit }}', 'Mar 10, 2014, 12:00 AM')
364-
->setCode(Range::TOO_LOW_ERROR)
362+
->setParameter('{{ min }}', 'Mar 10, 2014, 12:00 AM')
363+
->setParameter('{{ max }}', 'Mar 20, 2014, 12:00 AM')
364+
->setCode(Range::NOT_IN_RANGE_ERROR)
365365
->assertRaised();
366366
}
367367

@@ -499,18 +499,18 @@ public function testInvalidValuesCombinedMaxPropertyPath($value, $formattedValue
499499
$constraint = new Range([
500500
'minPropertyPath' => 'min',
501501
'maxPropertyPath' => 'max',
502-
'minMessage' => 'myMinMessage',
503-
'maxMessage' => 'myMaxMessage',
502+
'notInRangeMessage' => 'myNotInRangeMessage',
504503
]);
505504

506505
$this->validator->validate($value, $constraint);
507506

508-
$this->buildViolation('myMaxMessage')
507+
$this->buildViolation('myNotInRangeMessage')
509508
->setParameter('{{ value }}', $formattedValue)
510-
->setParameter('{{ limit }}', 20)
509+
->setParameter('{{ min }}', 10)
510+
->setParameter('{{ max }}', 20)
511511
->setParameter('{{ max_limit_path }}', 'max')
512512
->setParameter('{{ min_limit_path }}', 'min')
513-
->setCode(Range::TOO_HIGH_ERROR)
513+
->setCode(Range::NOT_IN_RANGE_ERROR)
514514
->assertRaised();
515515
}
516516

@@ -524,18 +524,18 @@ public function testInvalidValuesCombinedMinPropertyPath($value, $formattedValue
524524
$constraint = new Range([
525525
'minPropertyPath' => 'min',
526526
'maxPropertyPath' => 'max',
527-
'minMessage' => 'myMinMessage',
528-
'maxMessage' => 'myMaxMessage',
527+
'notInRangeMessage' => 'myNotInRangeMessage',
529528
]);
530529

531530
$this->validator->validate($value, $constraint);
532531

533-
$this->buildViolation('myMinMessage')
532+
$this->buildViolation('myNotInRangeMessage')
534533
->setParameter('{{ value }}', $formattedValue)
535-
->setParameter('{{ limit }}', 10)
534+
->setParameter('{{ min }}', 10)
535+
->setParameter('{{ max }}', 20)
536536
->setParameter('{{ max_limit_path }}', 'max')
537537
->setParameter('{{ min_limit_path }}', 'min')
538-
->setCode(Range::TOO_LOW_ERROR)
538+
->setCode(Range::NOT_IN_RANGE_ERROR)
539539
->assertRaised();
540540
}
541541

@@ -685,18 +685,18 @@ public function testInvalidDatesCombinedMaxPropertyPath($value, $dateTimeAsStrin
685685
$constraint = new Range([
686686
'minPropertyPath' => 'min',
687687
'maxPropertyPath' => 'max',
688-
'minMessage' => 'myMinMessage',
689-
'maxMessage' => 'myMaxMessage',
688+
'notInRangeMessage' => 'myNotInRangeMessage',
690689
]);
691690

692691
$this->validator->validate($value, $constraint);
693692

694-
$this->buildViolation('myMaxMessage')
693+
$this->buildViolation('myNotInRangeMessage')
695694
->setParameter('{{ value }}', $dateTimeAsString)
696-
->setParameter('{{ limit }}', 'Mar 20, 2014, 12:00 AM')
695+
->setParameter('{{ min }}', 'Mar 10, 2014, 12:00 AM')
696+
->setParameter('{{ max }}', 'Mar 20, 2014, 12:00 AM')
697697
->setParameter('{{ max_limit_path }}', 'max')
698698
->setParameter('{{ min_limit_path }}', 'min')
699-
->setCode(Range::TOO_HIGH_ERROR)
699+
->setCode(Range::NOT_IN_RANGE_ERROR)
700700
->assertRaised();
701701
}
702702

@@ -714,18 +714,18 @@ public function testInvalidDatesCombinedMinPropertyPath($value, $dateTimeAsStrin
714714
$constraint = new Range([
715715
'minPropertyPath' => 'min',
716716
'maxPropertyPath' => 'max',
717-
'minMessage' => 'myMinMessage',
718-
'maxMessage' => 'myMaxMessage',
717+
'notInRangeMessage' => 'myNotInRangeMessage',
719718
]);
720719

721720
$this->validator->validate($value, $constraint);
722721

723-
$this->buildViolation('myMinMessage')
722+
$this->buildViolation('myNotInRangeMessage')
724723
->setParameter('{{ value }}', $dateTimeAsString)
725-
->setParameter('{{ limit }}', 'Mar 10, 2014, 12:00 AM')
724+
->setParameter('{{ min }}', 'Mar 10, 2014, 12:00 AM')
725+
->setParameter('{{ max }}', 'Mar 20, 2014, 12:00 AM')
726726
->setParameter('{{ max_limit_path }}', 'max')
727727
->setParameter('{{ min_limit_path }}', 'min')
728-
->setCode(Range::TOO_LOW_ERROR)
728+
->setCode(Range::NOT_IN_RANGE_ERROR)
729729
->assertRaised();
730730
}
731731
}

0 commit comments

Comments
 (0)