[Validator] Add `TimezoneValidator` #22262

phansys · 2017-04-04T04:25:51Z

Q	A
Branch	master
Bug fix?	no
New feature?	yes
BC breaks?	no
Deprecations?	no
Tests pass?	yes
Fixed tickets	n/a
License	MIT
Doc PR	n/a (yet)

Add TimezoneValidator in order to validate timezones against \DateTimeZone::listIdentifiers().

TODO:

Add support for constraints with \DateTimeZone::PER_COUNTRY argument
Improve the validation message

nicolas-grekas · 2017-04-04T14:24:20Z

should be with a lowercase "z", see #21875

phansys · 2017-04-04T19:28:12Z

Simple question: since DateTimeZone::listIdentifiers() accepts a string with "a two-letter ISO 3166-1 compatible country code" as second argument, could we use Country validator at Timezone constructor in order to validate the countryCode argument?

ro0NL · 2017-07-14T07:15:24Z

src/Symfony/Component/Validator/Constraints/TimezoneValidator.php

+            }
+
+            $this->context->buildViolation($constraint->message)
+                ->setParameter('{{ extra_info }}', $this->formatExtraInfo($constraint->zone, $constraint->countryCode))


This is a weird parameter, and binds localized text to this constraint validator... 👎 for that.

What about specialized params instead like zone_id / zone_name or so?

ro0NL · 2017-07-14T07:17:51Z

src/Symfony/Component/Validator/Constraints/Timezone.php

+     */
+    public function __construct($options = null)
+    {
+        if (isset($options['zone'])) {


What about \DateTimeZone::ALL as a default, or, if countryCode is given default to \DateTimeZone::PER_COUNTRY instead. So we dont have to expect null :)

ro0NL · 2017-07-14T07:18:31Z

src/Symfony/Component/Validator/Constraints/Timezone.php

+    public $message = 'This value is not a valid timezone{{ extra_info }}.';
+
+    protected static $errorNames = array(
+        self::NO_SUCH_TIMEZONE_ERROR => 'NO_SUCH_TIMEZONE_ERROR',


missing few codes here

ro0NL · 2017-07-14T07:19:41Z

src/Symfony/Component/Validator/Constraints/Timezone.php

+    const NO_SUCH_TIMEZONE_IN_COUNTRY_ERROR = 'c4a22222-dc92-4fc0-abb0-d95b268c7d0b';
+
+    public $zone;
+


newlines between public props can be removed

ro0NL · 2017-07-14T07:23:34Z

src/Symfony/Component/Validator/Constraints/TimezoneValidator.php

+
+        $value = (string) $value;
+        $zone = null !== $constraint->zone ? $constraint->zone : \DateTimeZone::ALL;
+        $timezoneIds = \DateTimeZone::listIdentifiers($zone, $constraint->countryCode);


listIdentifiers actually allows zones like \DateTimeZone::AMERICA | \DateTimeZone::EUROPE.. thats cool 👍

nicolas-grekas · 2017-10-08T16:02:38Z

Moving to 4.1. Rebase on master might be needed, where PHP 7.1 features can be used btw.

phansys · 2018-02-06T18:02:48Z

Rebased. I'll be waiting for feedback about the @ro0NL's proposal to use DateTimeZone::ALL as default zone. The other comments were already attended.

ro0NL · 2018-09-30T19:49:02Z

src/Symfony/Component/Validator/Constraints/Timezone.php

+     */
+    public function __construct(array $options = null)
+    {
+        $this->zone = $options['zone'] ?? null;


calling the parent constructor actually sets the options on properties, so i think we should do the validation step after based on the property values set.

ro0NL · 2018-09-30T19:51:53Z

src/Symfony/Component/Validator/Constraints/TimezoneValidator.php

+     *
+     * @return array
+     */
+    private function generateValidationMessage(int $zone = null, string $countryCode = null): array


i'd prefer not to have this method, the generated messages are also not translator friendly. Instead i would always set the (standard) {{ value }} parameter (being the zone ID in this case) see e.g. https://github.com/symfony/symfony/blob/v4.1.5/src/Symfony/Component/Validator/Constraints/CurrencyValidator.php#L48

ro0NL · 2018-09-30T19:57:44Z

src/Symfony/Component/Validator/Constraints/Timezone.php

+
+    public $zone;
+    public $countryCode;
+    public $message = 'This value is not a valid timezone{{ zone_message }}{{ country_code_message }}.';


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

ro0NL

see also #28831, as we have to decide wether we use PHP or Intl for validating.

hhamon · 2019-04-06T08:38:41Z

Hey!

What's the status of this PR please? Can I try to finish it?

hhamon · 2019-04-06T14:04:21Z

This PR has been reworked here #30900.

fabpot · 2019-04-06T14:05:27Z

Closing in favor of #30900.

…phansys) This PR was merged into the 4.3-dev branch. Discussion ---------- [Validator] add new `Timezone` validation constraint | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | License | MIT | Doc PR | symfony/symfony-docs#11317 Rework of #22262. Commits ------- 536e53f [Validator] add new `Timezone` validation constraint.

carsonbot added Status: Needs Review Feature labels Apr 4, 2017

phansys changed the title ~~Add TimeZoneValidator~~ [Validator] Add TimeZoneValidator Apr 4, 2017

phansys force-pushed the tz_validator branch from c82febb to 5e8a99f Compare April 4, 2017 04:27

phansys changed the title ~~[Validator] Add TimeZoneValidator~~ [Validator] [WIP] Add TimeZoneValidator Apr 4, 2017

phansys force-pushed the tz_validator branch from 5e8a99f to 171e4b9 Compare April 4, 2017 04:30

nicolas-grekas added this to the 3.4 milestone Apr 4, 2017

phansys force-pushed the tz_validator branch 2 times, most recently from dbe965b to 0328eb0 Compare April 4, 2017 16:08

phansys changed the title ~~[Validator] [WIP] Add TimeZoneValidator~~ [Validator] [WIP] Add TimezoneValidator Apr 4, 2017

phansys force-pushed the tz_validator branch from 7ae8f65 to 4d15750 Compare April 4, 2017 19:48

phansys changed the title ~~[Validator] [WIP] Add TimezoneValidator~~ [Validator] Add TimezoneValidator Apr 4, 2017

phansys force-pushed the tz_validator branch 2 times, most recently from bbc03de to e5b599f Compare April 9, 2017 20:21

phansys force-pushed the tz_validator branch from e5b599f to 00eb8b7 Compare April 19, 2017 02:07

ro0NL reviewed Jul 14, 2017

View reviewed changes

nicolas-grekas modified the milestones: 3.4, 4.1 Oct 8, 2017

phansys force-pushed the tz_validator branch 2 times, most recently from 58de37e to b8cce71 Compare February 6, 2018 17:50

phansys force-pushed the tz_validator branch 2 times, most recently from 386a46c to 72505af Compare February 26, 2018 03:03

nicolas-grekas modified the milestones: 4.1, next Apr 20, 2018

ro0NL reviewed Sep 30, 2018

View reviewed changes

ro0NL mentioned this pull request Oct 11, 2018

[Form] Intl and TimezoneType are not interchangeable #22302

Closed

phansys added 12 commits November 29, 2018 09:04

Add TimeZoneValidator

4b87fb7

Add support for \DateTimeZone::PER_COUNTRY

6cceda0

Update constraint message

6124ef6

Renamed "timezone" group to "zone"

49e4b51

Apply CS fixes from fabbot

288a413

Update method visibility at TimezoneValidator

7545275

Update validation messages

de78802

Update way of handling zone option

dfa4f98

Add specific errors to be used when zone or countryCode are provided

6be950a

Add support for deprecated timezones

6d23035

Remove surplus quotes in validation message

13bc629

Update validation message

0491875

phansys force-pushed the tz_validator branch from 72505af to e1831c4 Compare November 29, 2018 13:15

Update TimezoneValidator

14689f7

phansys force-pushed the tz_validator branch from e1831c4 to 14689f7 Compare November 29, 2018 13:17

ro0NL reviewed Nov 29, 2018

View reviewed changes

Add simple assertion at TimezoneTest::testValidTimezoneConstraints()

c3dce5c

nicolas-grekas added the ⭐️ EUFOSSA Hackathon label Apr 6, 2019

hhamon mentioned this pull request Apr 6, 2019

[Validator] add new Timezone validation constraint #30900

Merged

fabpot closed this Apr 6, 2019

phansys deleted the tz_validator branch April 6, 2019 17:57

nicolas-grekas modified the milestones: next, 4.3 Apr 30, 2019

		const NO_SUCH_TIMEZONE_IN_COUNTRY_ERROR = 'c4a22222-dc92-4fc0-abb0-d95b268c7d0b';

		public $zone;

Uh oh!

[Validator] Add TimezoneValidator #22262

[Validator] Add TimezoneValidator #22262

Uh oh!

Conversation

phansys commented Apr 4, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

nicolas-grekas commented Apr 4, 2017

Uh oh!

phansys commented Apr 4, 2017

Uh oh!

ro0NL Jul 14, 2017

Choose a reason for hiding this comment

Uh oh!

ro0NL Jul 14, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ro0NL Jul 14, 2017

Choose a reason for hiding this comment

Uh oh!

ro0NL Jul 14, 2017

Choose a reason for hiding this comment

Uh oh!

ro0NL Jul 14, 2017

Choose a reason for hiding this comment

Uh oh!

nicolas-grekas commented Oct 8, 2017

Uh oh!

phansys commented Feb 6, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ro0NL Sep 30, 2018

Choose a reason for hiding this comment

Uh oh!

ro0NL Sep 30, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ro0NL Sep 30, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ro0NL left a comment

Choose a reason for hiding this comment

Uh oh!

hhamon commented Apr 6, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

hhamon commented Apr 6, 2019

Uh oh!

fabpot commented Apr 6, 2019

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

[Validator] Add `TimezoneValidator` #22262

[Validator] Add `TimezoneValidator` #22262

phansys commented Apr 4, 2017 •

edited

Loading

ro0NL Jul 14, 2017 •

edited

Loading

phansys commented Feb 6, 2018 •

edited

Loading

ro0NL Sep 30, 2018 •

edited

Loading

ro0NL Sep 30, 2018 •

edited

Loading

hhamon commented Apr 6, 2019 •

edited

Loading