Skip to content

[Validator] Add invalid datetime message in Range validator #36326

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 24, 2020
Merged

[Validator] Add invalid datetime message in Range validator #36326

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions src/Symfony/Component/Validator/Constraints/Range.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ class Range extends Constraint
public $minMessage = 'This value should be {{ limit }} or more.';
public $maxMessage = 'This value should be {{ limit }} or less.';
public $invalidMessage = 'This value should be a valid number.';
public $invalidDateTimeMessage = 'This value should be a valid datetime.';
public $min;
public $minPropertyPath;
public $max;
Expand Down
40 changes: 33 additions & 7 deletions src/Symfony/Component/Validator/Constraints/RangeValidator.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,18 +44,25 @@ public function validate($value, Constraint $constraint)
return;
}

$min = $this->getLimit($constraint->minPropertyPath, $constraint->min, $constraint);
$max = $this->getLimit($constraint->maxPropertyPath, $constraint->max, $constraint);

if (!is_numeric($value) && !$value instanceof \DateTimeInterface) {
$this->context->buildViolation($constraint->invalidMessage)
->setParameter('{{ value }}', $this->formatValue($value, self::PRETTY_DATE))
->setCode(Range::INVALID_CHARACTERS_ERROR)
->addViolation();
if ($this->isParsableDatetimeString($min) && $this->isParsableDatetimeString($max)) {
$this->context->buildViolation($constraint->invalidDateTimeMessage)
->setParameter('{{ value }}', $this->formatValue($value, self::PRETTY_DATE))
->setCode(Range::INVALID_CHARACTERS_ERROR)
->addViolation();
} else {
$this->context->buildViolation($constraint->invalidMessage)
->setParameter('{{ value }}', $this->formatValue($value, self::PRETTY_DATE))
->setCode(Range::INVALID_CHARACTERS_ERROR)
->addViolation();
}

return;
}

$min = $this->getLimit($constraint->minPropertyPath, $constraint->min, $constraint);
$max = $this->getLimit($constraint->maxPropertyPath, $constraint->max, $constraint);

// Convert strings to DateTimes if comparing another DateTime
// This allows to compare with any date/time value supported by
// the DateTime constructor:
Expand Down Expand Up @@ -182,4 +189,23 @@ private function getPropertyAccessor(): PropertyAccessorInterface

return $this->propertyAccessor;
}

private function isParsableDatetimeString($boundary): bool
{
if (null === $boundary) {
return true;
}

if (!\is_string($boundary)) {
return false;
}

try {
new \DateTime($boundary);
} catch (\Exception $e) {
return false;
}

return true;
}
}
97 changes: 93 additions & 4 deletions src/Symfony/Component/Validator/Tests/Constraints/RangeValidatorTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -379,13 +379,102 @@ public function getInvalidValues()

public function testNonNumeric()
{
$this->validator->validate('abcd', new Range([
$constraint = new Range([
'min' => 10,
'max' => 20,
'invalidMessage' => 'myMessage',
]));
]);

$this->buildViolation('myMessage')
$this->validator->validate('abcd', $constraint);

$this->buildViolation($constraint->invalidMessage)
->setParameter('{{ value }}', '"abcd"')
->setCode(Range::INVALID_CHARACTERS_ERROR)
->assertRaised();
}

public function testNonNumericWithParsableDatetimeMinAndMaxNull()
{
$constraint = new Range([
'min' => 'March 10, 2014',
]);

$this->validator->validate('abcd', $constraint);

$this->buildViolation($constraint->invalidDateTimeMessage)
->setParameter('{{ value }}', '"abcd"')
->setCode(Range::INVALID_CHARACTERS_ERROR)
->assertRaised();
}

public function testNonNumericWithParsableDatetimeMaxAndMinNull()
{
$constraint = new Range([
'max' => 'March 20, 2014',
]);

$this->validator->validate('abcd', $constraint);

$this->buildViolation($constraint->invalidDateTimeMessage)
->setParameter('{{ value }}', '"abcd"')
->setCode(Range::INVALID_CHARACTERS_ERROR)
->assertRaised();
}

public function testNonNumericWithParsableDatetimeMinAndMax()
{
$constraint = new Range([
'min' => 'March 10, 2014',
'max' => 'March 20, 2014',
]);

$this->validator->validate('abcd', $constraint);

$this->buildViolation($constraint->invalidDateTimeMessage)
->setParameter('{{ value }}', '"abcd"')
->setCode(Range::INVALID_CHARACTERS_ERROR)
->assertRaised();
}

public function testNonNumericWithNonParsableDatetimeMin()
{
$constraint = new Range([
'min' => 'March 40, 2014',
'max' => 'March 20, 2014',
]);

$this->validator->validate('abcd', $constraint);

$this->buildViolation($constraint->invalidMessage)
->setParameter('{{ value }}', '"abcd"')
->setCode(Range::INVALID_CHARACTERS_ERROR)
->assertRaised();
}

public function testNonNumericWithNonParsableDatetimeMax()
{
$constraint = new Range([
'min' => 'March 10, 2014',
'max' => 'March 50, 2014',
]);

$this->validator->validate('abcd', $constraint);

$this->buildViolation($constraint->invalidMessage)
->setParameter('{{ value }}', '"abcd"')
->setCode(Range::INVALID_CHARACTERS_ERROR)
->assertRaised();
}

public function testNonNumericWithNonParsableDatetimeMinAndMax()
{
$constraint = new Range([
'min' => 'March 40, 2014',
'max' => 'March 50, 2014',
]);

$this->validator->validate('abcd', $constraint);

$this->buildViolation($constraint->invalidMessage)
->setParameter('{{ value }}', '"abcd"')
->setCode(Range::INVALID_CHARACTERS_ERROR)
->assertRaised();
Expand Down