[Form] Deprecate TimezoneType regions option

Author: ro0NL

CHANGELOG.md

@@ -40,6 +40,7 @@ CHANGELOG
  * added a cause when a CSRF error has occurred
  * deprecated the `scale` option of the `IntegerType`
  * removed restriction on allowed HTTP methods
+ * deprecated the `regions` option of the `TimezoneType`
 
 4.1.0
 -----

Extension/Core/Type/TimezoneType.php

@@ -37,7 +37,7 @@ public function configureOptions(OptionsResolver $resolver)
     {
         $resolver->setDefaults(array(
             'choice_loader' => function (Options $options) {
-                $regions = $options['regions'];
+                $regions = $options->offsetGet('regions', false);
 
                 return new CallbackChoiceLoader(function () use ($regions) {
                     return self::getTimezones($regions);
@@ -51,6 +51,7 @@ public function configureOptions(OptionsResolver $resolver)
         $resolver->setAllowedValues('input', array('string', 'datetimezone'));
 
         $resolver->setAllowedTypes('regions', 'int');
+        $resolver->setDeprecated('regions', 'The option "%name%" is deprecated since Symfony 4.2.');
     }
 
     /**

Tests/Command/DebugCommandTest.php

@@ -45,7 +45,7 @@ public function testDebugDeprecatedDefaults()
 Built-in form types (Symfony\Component\Form\Extension\Core\Type)
 ----------------------------------------------------------------
 
- IntegerType
+ IntegerType, TimezoneType
 
 Service form types
 ------------------

Tests/Extension/Core/Type/TimezoneTypeTest.php

@@ -53,6 +53,10 @@ public function testDateTimeZoneInput()
         $this->assertEquals(array(new \DateTimeZone('Europe/Amsterdam'), new \DateTimeZone('Europe/Paris')), $form->getData());
     }
 
+    /**
+     * @group legacy
+     * @expectedDeprecation The option "regions" is deprecated since Symfony 4.2.
+     */
     public function testFilterByRegions()
     {
         $choices = $this->factory->create(static::TESTED_TYPE, null, array('regions' => \DateTimeZone::EUROPE))