symfony · phansys · Apr 4, 2017 · Apr 4, 2017 · Apr 4, 2017 · Apr 4, 2017
diff --git a/src/Symfony/Component/Validator/Constraints/Timezone.php b/src/Symfony/Component/Validator/Constraints/Timezone.php
@@ -0,0 +1,49 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Validator\Constraints;
+
+use Symfony\Component\Validator\Constraint;
+use Symfony\Component\Validator\Exception\ConstraintDefinitionException;
+
+/**
+ * @Annotation
+ * @Target({"PROPERTY", "METHOD", "ANNOTATION"})
+ *
+ * @author Javier Spagnoletti <phansys@gmail.com>
+ */
+class Timezone extends Constraint
+{
+    const NO_SUCH_TIMEZONE_ERROR = '45de6628-3479-46d6-a210-00ad584f530a';
+    const NO_SUCH_TIMEZONE_IN_ZONE_ERROR = 'b57767b1-36c0-40ac-a3d7-629420c775b8';
+    const NO_SUCH_TIMEZONE_IN_COUNTRY_ERROR = 'c4a22222-dc92-4fc0-abb0-d95b268c7d0b';
+    public $zone = \DateTimeZone::ALL;
+    public $countryCode;
+    public $message = 'This value is not a valid timezone.';
+
+    protected static $errorNames = array(
+        self::NO_SUCH_TIMEZONE_ERROR => 'NO_SUCH_TIMEZONE_ERROR',
+        self::NO_SUCH_TIMEZONE_IN_ZONE_ERROR => 'NO_SUCH_TIMEZONE_IN_ZONE_ERROR',
+        self::NO_SUCH_TIMEZONE_IN_COUNTRY_ERROR => 'NO_SUCH_TIMEZONE_IN_COUNTRY_ERROR',
+    );
+
+    /**
+     * {@inheritdoc}
+     */
+    public function __construct(array $options = null)
+    {
+        parent::__construct($options);
+
+        if ($this->countryCode && \DateTimeZone::PER_COUNTRY !== $this->zone) {
+            throw new ConstraintDefinitionException('The option "countryCode" can only be used when "zone" option has `\DateTimeZone::PER_COUNTRY` as value');
+        }
+    }
+}
diff --git a/src/Symfony/Component/Validator/Constraints/TimezoneValidator.php b/src/Symfony/Component/Validator/Constraints/TimezoneValidator.php
@@ -0,0 +1,95 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Validator\Constraints;
+
+use Symfony\Component\Validator\Constraint;
+use Symfony\Component\Validator\ConstraintValidator;
+use Symfony\Component\Validator\Exception\UnexpectedTypeException;
+
+/**
+ * Validates whether a value is a valid timezone identifier.
+ *
+ * @author Javier Spagnoletti <phansys@gmail.com>
+ */
+class TimezoneValidator extends ConstraintValidator
+{
+    /**
+     * {@inheritdoc}
+     */
+    public function validate($value, Constraint $constraint)
+    {
+        if (!$constraint instanceof Timezone) {
+            throw new UnexpectedTypeException($constraint, __NAMESPACE__.'\Timezone');
+        }
+
+        if (null === $value || '' === $value) {
+            return;
+        }
+
+        if (!is_scalar($value) && !(\is_object($value) && method_exists($value, '__toString'))) {
+            throw new UnexpectedTypeException($value, 'string');
+        }
+
+        $value = (string) $value;
+
+        // @see: https://bugs.php.net/bug.php?id=75928
+        if ($constraint->countryCode) {
+            $timezoneIds = \DateTimeZone::listIdentifiers($constraint->zone, $constraint->countryCode);
+        } else {
+            $timezoneIds = \DateTimeZone::listIdentifiers($constraint->zone);
+        }
+
+        if ($timezoneIds && !\in_array($value, $timezoneIds, true)) {
+            if ($constraint->countryCode) {
+                $code = Timezone::NO_SUCH_TIMEZONE_IN_COUNTRY_ERROR;
+            } elseif (\DateTimeZone::ALL !== $constraint->zone) {
+                $code = Timezone::NO_SUCH_TIMEZONE_IN_ZONE_ERROR;
+            } else {
+                $code = Timezone::NO_SUCH_TIMEZONE_ERROR;
+            }
+
+            $this->context->buildViolation($constraint->message)
+                ->setParameter('{{ value }}', $this->formatValue($value))
+                ->setCode($code)
+                ->addViolation();
+        }
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getDefaultOption()
+    {
+        return 'zone';
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function formatValue($value, $format = 0)
+    {
+        $value = parent::formatValue($value, $format);
+        if ($value) {
+            if (\DateTimeZone::PER_COUNTRY !== $value) {
+                $r = new \ReflectionClass(\DateTimeZone::class);
+                $consts = $r->getConstants();
+                if ($zoneFound = array_search($value, $consts, true)) {
+                    return $zoneFound;
+                }
+
+                return $value;
+            }
+        }
+
+        return $value;
+    }
+}
diff --git a/src/Symfony/Component/Validator/Resources/translations/validators.en.xlf b/src/Symfony/Component/Validator/Resources/translations/validators.en.xlf
@@ -326,6 +326,10 @@
                <source>This value should be a multiple of {{ compared_value }}.</source>
                <target>This value should be a multiple of {{ compared_value }}.</target>
            </trans-unit>
+            <trans-unit id="85">
+                <source>This value is not a valid timezone.</source>
+                <target>This value is not a valid timezone.</target>
+            </trans-unit>
        </body>
    </file>
 </xliff>
diff --git a/src/Symfony/Component/Validator/Resources/translations/validators.es.xlf b/src/Symfony/Component/Validator/Resources/translations/validators.es.xlf
@@ -326,6 +326,10 @@
                <source>This value should be a multiple of {{ compared_value }}.</source>
                <target>Este valor debería ser un múltiplo de {{ compared_value }}.</target>
            </trans-unit>
+            <trans-unit id="85">
+                <source>This value is not a valid timezone.</source>
+                <target>Este valor no es una zona horaria válida.</target>
+            </trans-unit>
        </body>
    </file>
 </xliff>
diff --git a/src/Symfony/Component/Validator/Tests/Constraints/TimezoneTest.php b/src/Symfony/Component/Validator/Tests/Constraints/TimezoneTest.php
@@ -0,0 +1,63 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Validator\Tests\Constraints;
+
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\Validator\Constraints\Timezone;
+
+/**
+ * @author Javier Spagnoletti <phansys@gmail.com>
+ */
+class TimezoneTest extends TestCase
+{
+    public function testValidTimezoneConstraints()
+    {
+        $constraint = new Timezone();
+
+        $constraint = new Timezone(array(
+            'message' => 'myMessage',
+            'zone' => \DateTimeZone::PER_COUNTRY,
+            'countryCode' => 'AR',
+        ));
+
+        $constraint = new Timezone(array(
+            'message' => 'myMessage',
+            'zone' => \DateTimeZone::ALL,
+        ));
+
+        // Make an assertion in order to avoid this test to be marked as risky
+        $this->assertInstanceOf(Timezone::class, $constraint);
+    }
+
+    /**
+     * @expectedException \Symfony\Component\Validator\Exception\ConstraintDefinitionException
+     */
+    public function testExceptionForGroupedTimezonesByCountryWithWrongTimezone()
+    {
+        $constraint = new Timezone(array(
+            'message' => 'myMessage',
+            'zone' => \DateTimeZone::ALL,
+            'countryCode' => 'AR',
+        ));
+    }
+
+    /**
+     * @expectedException \Symfony\Component\Validator\Exception\ConstraintDefinitionException
+     */
+    public function testExceptionForGroupedTimezonesByCountryWithoutTimezone()
+    {
+        $constraint = new Timezone(array(
+            'message' => 'myMessage',
+            'countryCode' => 'AR',
+        ));
+    }
+}