[Validator] Add TimezoneValidator
#22262
Update validation message
- Loading branch information
commit 0491875763682690d0c10eb630a5b962c896390f
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -41,7 +41,13 @@ public function validate($value, Constraint $constraint) | |
|
|
||
| $value = (string) $value; | ||
| $zone = null !== $constraint->zone ? $constraint->zone : \DateTimeZone::ALL; | ||
|
|
||
| // @see: https://bugs.php.net/bug.php?id=75928 | ||
| if ($constraint->countryCode) { | ||
| $timezoneIds = \DateTimeZone::listIdentifiers($zone, $constraint->countryCode); | ||
| } else { | ||
| $timezoneIds = \DateTimeZone::listIdentifiers($zone); | ||
| } | ||
|
|
||
| if ($timezoneIds && !in_array($value, $timezoneIds, true)) { | ||
| if ($constraint->countryCode) { | ||
|
|
@@ -52,10 +58,16 @@ public function validate($value, Constraint $constraint) | |
| $code = Timezone::NO_SUCH_TIMEZONE_ERROR; | ||
| } | ||
|
|
||
| $violation = $this->context->buildViolation($constraint->message); | ||
|
|
||
| foreach ($this->generateValidationMessage($constraint->zone, $constraint->countryCode) as $placeholder => $message) { | ||
| $violation->setParameter($placeholder, $message); | ||
| } | ||
|
|
||
| $violation | ||
| ->setCode($code) | ||
| ->addViolation() | ||
| ; | ||
| } | ||
| } | ||
|
|
||
|
|
@@ -68,31 +80,35 @@ public function getDefaultOption() | |
| } | ||
|
|
||
| /** | ||
| * Generates the replace parameters which are used in validation message. | ||
| * | ||
| * @param int|null $zone | ||
| * @param string|null $countryCode | ||
| * | ||
| * @return array | ||
| */ | ||
| private function generateValidationMessage(int $zone = null, string $countryCode = null): array | ||
|
||
| { | ||
| $values = array( | ||
| '{{ country_code_message }}' => '', | ||
| '{{ zone_message }}' => '', | ||
| ); | ||
|
|
||
| if (null !== $zone) { | ||
| if (\DateTimeZone::PER_COUNTRY !== $zone) { | ||
| $r = new \ReflectionClass(\DateTimeZone::class); | ||
| $consts = $r->getConstants(); | ||
| if ($zoneFound = array_search($zone, $consts, true)) { | ||
| $values['{{ zone_message }}'] = ' at "'.$zoneFound.'" zone'; | ||
| } else { | ||
| $values['{{ zone_message }}'] = ' at zone with identifier '.$zone; | ||
| } | ||
| } | ||
| if ($countryCode) { | ||
| $values['{{ country_code_message }}'] = ' for ISO 3166-1 country code "'.$countryCode.'"'; | ||
| } | ||
| } | ||
|
|
||
| return $values; | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
i'd say
This value is not a valid timezone.the standard seems to not include the value in the message (which in this case cannot be translated), see e.g. https://github.com/symfony/symfony/blob/v4.1.5/src/Symfony/Component/Validator/Constraints/Currency.php#L31
also the message should be added too
validators.en.xml+ any language you know