Skip to content

Commit 68356c0

Browse files
ogizanagiogizanagi
committed
Merge branch '3.4'
* 3.4: CS fixes [Form] Add input + regions options to TimezoneType # Conflicts: # src/Symfony/Component/Form/Extension/Core/Type/TimezoneType.php
2 parents 2ac6a31 + d511cf4 commit 68356c0

File tree

5 files changed

+214
-5
lines changed

5 files changed

+214
-5
lines changed

‎CHANGELOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,8 @@ CHANGELOG
2323
-----
2424

2525
* added `DebugCommand`
26+
* deprecated `ChoiceLoaderInterface` implementation in `TimezoneType`
27+
* added options "input" and "regions" to `TimezoneType`
2628

2729
3.3.0
2830
-----

‎Extension/Core/DataTransformer/DateTimeZoneToStringTransformer.php

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
<?php
2+
3+
/*
4+
* This file is part of the Symfony package.
5+
*
6+
* (c) Fabien Potencier <[email protected]>
7+
*
8+
* For the full copyright and license information, please view the LICENSE
9+
* file that was distributed with this source code.
10+
*/
11+
12+
namespace Symfony\Component\Form\Extension\Core\DataTransformer;
13+
14+
use Symfony\Component\Form\DataTransformerInterface;
15+
use Symfony\Component\Form\Exception\TransformationFailedException;
16+
17+
/**
18+
* Transforms between a timezone identifier string and a DateTimeZone object.
19+
*
20+
* @author Roland Franssen <[email protected]>
21+
*/
22+
class DateTimeZoneToStringTransformer implements DataTransformerInterface
23+
{
24+
private $multiple;
25+
26+
public function __construct($multiple = false)
27+
{
28+
$this->multiple = $multiple;
29+
}
30+
31+
/**
32+
* {@inheritdoc}
33+
*/
34+
public function transform($dateTimeZone)
35+
{
36+
if (null === $dateTimeZone) {
37+
return;
38+
}
39+
40+
if ($this->multiple) {
41+
if (!is_array($dateTimeZone)) {
42+
throw new TransformationFailedException('Expected an array.');
43+
}
44+
45+
return array_map(array(new self(), 'transform'), $dateTimeZone);
46+
}
47+
48+
if (!$dateTimeZone instanceof \DateTimeZone) {
49+
throw new TransformationFailedException('Expected a \DateTimeZone.');
50+
}
51+
52+
return $dateTimeZone->getName();
53+
}
54+
55+
/**
56+
* {@inheritdoc}
57+
*/
58+
public function reverseTransform($value)
59+
{
60+
if (null === $value) {
61+
return;
62+
}
63+
64+
if ($this->multiple) {
65+
if (!is_array($value)) {
66+
throw new TransformationFailedException('Expected an array.');
67+
}
68+
69+
return array_map(array(new self(), 'reverseTransform'), $value);
70+
}
71+
72+
if (!is_string($value)) {
73+
throw new TransformationFailedException('Expected a string.');
74+
}
75+
76+
try {
77+
return new \DateTimeZone($value);
78+
} catch (\Exception $e) {
79+
throw new TransformationFailedException($e->getMessage(), $e->getCode(), $e);
80+
}
81+
}
82+
}

‎Extension/Core/Type/TimezoneType.php

Lines changed: 47 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,11 @@
1313

1414
use Symfony\Component\Form\AbstractType;
1515
use Symfony\Component\Form\ChoiceList\ArrayChoiceList;
16+
use Symfony\Component\Form\ChoiceList\Loader\CallbackChoiceLoader;
1617
use Symfony\Component\Form\ChoiceList\Loader\ChoiceLoaderInterface;
18+
use Symfony\Component\Form\Extension\Core\DataTransformer\DateTimeZoneToStringTransformer;
19+
use Symfony\Component\Form\FormBuilderInterface;
20+
use Symfony\Component\OptionsResolver\Options;
1721
use Symfony\Component\OptionsResolver\OptionsResolver;
1822

1923
class TimezoneType extends AbstractType implements ChoiceLoaderInterface
@@ -24,18 +28,42 @@ class TimezoneType extends AbstractType implements ChoiceLoaderInterface
2428
* The choices are generated from the ICU function \DateTimeZone::listIdentifiers().
2529
*
2630
* @var ArrayChoiceList
31+
*
32+
* @deprecated since version 3.4, to be removed in 4.0
2733
*/
2834
private $choiceList;
2935

36+
/**
37+
* {@inheritdoc}
38+
*/
39+
public function buildForm(FormBuilderInterface $builder, array $options)
40+
{
41+
if ('datetimezone' === $options['input']) {
42+
$builder->addModelTransformer(new DateTimeZoneToStringTransformer($options['multiple']));
43+
}
44+
}
45+
3046
/**
3147
* {@inheritdoc}
3248
*/
3349
public function configureOptions(OptionsResolver $resolver)
3450
{
3551
$resolver->setDefaults(array(
36-
'choice_loader' => $this,
52+
'choice_loader' => function (Options $options) {
53+
$regions = $options['regions'];
54+
55+
return new CallbackChoiceLoader(function () use ($regions) {
56+
return self::getTimezones($regions);
57+
});
58+
},
3759
'choice_translation_domain' => false,
60+
'input' => 'string',
61+
'regions' => \DateTimeZone::ALL,
3862
));
63+
64+
$resolver->setAllowedValues('input', array('string', 'datetimezone'));
65+
66+
$resolver->setAllowedTypes('regions', 'int');
3967
}
4068

4169
/**
@@ -56,21 +84,29 @@ public function getBlockPrefix()
5684

5785
/**
5886
* {@inheritdoc}
87+
*
88+
* @deprecated since version 3.4, to be removed in 4.0
5989
*/
6090
public function loadChoiceList($value = null)
6191
{
92+
@trigger_error(sprintf('Method "%s" is deprecated since version 3.4 and will be removed in 4.0.', __METHOD__), E_USER_DEPRECATED);
93+
6294
if (null !== $this->choiceList) {
6395
return $this->choiceList;
6496
}
6597

66-
return $this->choiceList = new ArrayChoiceList(self::getTimezones(), $value);
98+
return $this->choiceList = new ArrayChoiceList(self::getTimezones(\DateTimeZone::ALL), $value);
6799
}
68100

69101
/**
70102
* {@inheritdoc}
103+
*
104+
* @deprecated since version 3.4, to be removed in 4.0
71105
*/
72106
public function loadChoicesForValues(array $values, $value = null)
73107
{
108+
@trigger_error(sprintf('Method "%s" is deprecated since version 3.4 and will be removed in 4.0.', __METHOD__), E_USER_DEPRECATED);
109+
74110
// Optimize
75111
$values = array_filter($values);
76112
if (empty($values)) {
@@ -87,9 +123,13 @@ public function loadChoicesForValues(array $values, $value = null)
87123

88124
/**
89125
* {@inheritdoc}
126+
*
127+
* @deprecated since version 3.4, to be removed in 4.0
90128
*/
91129
public function loadValuesForChoices(array $choices, $value = null)
92130
{
131+
@trigger_error(sprintf('Method "%s" is deprecated since version 3.4 and will be removed in 4.0.', __METHOD__), E_USER_DEPRECATED);
132+
93133
// Optimize
94134
$choices = array_filter($choices);
95135
if (empty($choices)) {
@@ -107,13 +147,15 @@ public function loadValuesForChoices(array $choices, $value = null)
107147
/**
108148
* Returns a normalized array of timezone choices.
109149
*
150+
* @param int $regions
151+
*
110152
* @return array The timezone choices
111153
*/
112-
private static function getTimezones()
154+
private static function getTimezones($regions)
113155
{
114156
$timezones = array();
115157

116-
foreach (\DateTimeZone::listIdentifiers() as $timezone) {
158+
foreach (\DateTimeZone::listIdentifiers($regions) as $timezone) {
117159
$parts = explode('/', $timezone);
118160

119161
if (count($parts) > 2) {
@@ -130,6 +172,6 @@ private static function getTimezones()
130172
$timezones[$region][str_replace('_', ' ', $name)] = $timezone;
131173
}
132174

133-
return $timezones;
175+
return 1 === count($timezones) ? reset($timezones) : $timezones;
134176
}
135177
}

‎Tests/Extension/Core/DataTransformer/DateTimeZoneToStringTransformerTest.php

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
<?php
2+
3+
/*
4+
* This file is part of the Symfony package.
5+
*
6+
* (c) Fabien Potencier <[email protected]>
7+
*
8+
* For the full copyright and license information, please view the LICENSE
9+
* file that was distributed with this source code.
10+
*/
11+
12+
namespace Symfony\Component\Form\Tests\Extension\Core\DataTransformer;
13+
14+
use Symfony\Component\Form\Extension\Core\DataTransformer\DateTimeZoneToStringTransformer;
15+
use PHPUnit\Framework\TestCase;
16+
17+
class DateTimeZoneToStringTransformerTest extends TestCase
18+
{
19+
public function testSingle()
20+
{
21+
$transformer = new DateTimeZoneToStringTransformer();
22+
23+
$this->assertNull($transformer->transform(null));
24+
$this->assertNull($transformer->reverseTransform(null));
25+
26+
$this->assertSame('Europe/Amsterdam', $transformer->transform(new \DateTimeZone('Europe/Amsterdam')));
27+
$this->assertEquals(new \DateTimeZone('Europe/Amsterdam'), $transformer->reverseTransform('Europe/Amsterdam'));
28+
}
29+
30+
public function testMultiple()
31+
{
32+
$transformer = new DateTimeZoneToStringTransformer(true);
33+
34+
$this->assertNull($transformer->transform(null));
35+
$this->assertNull($transformer->reverseTransform(null));
36+
37+
$this->assertSame(array('Europe/Amsterdam'), $transformer->transform(array(new \DateTimeZone('Europe/Amsterdam'))));
38+
$this->assertEquals(array(new \DateTimeZone('Europe/Amsterdam')), $transformer->reverseTransform(array('Europe/Amsterdam')));
39+
}
40+
41+
/**
42+
* @expectedException \Symfony\Component\Form\Exception\TransformationFailedException
43+
*/
44+
public function testInvalidTimezone()
45+
{
46+
(new DateTimeZoneToStringTransformer())->transform(1);
47+
}
48+
49+
/**
50+
* @expectedException \Symfony\Component\Form\Exception\TransformationFailedException
51+
*/
52+
public function testUnknownTimezone()
53+
{
54+
(new DateTimeZoneToStringTransformer(true))->reverseTransform(array('Foo/Bar'));
55+
}
56+
}

‎Tests/Extension/Core/Type/TimezoneTypeTest.php

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,4 +33,31 @@ public function testSubmitNull($expected = null, $norm = null, $view = null)
3333
{
3434
parent::testSubmitNull($expected, $norm, '');
3535
}
36+
37+
public function testDateTimeZoneInput()
38+
{
39+
$form = $this->factory->create(static::TESTED_TYPE, new \DateTimeZone('America/New_York'), array('input' => 'datetimezone'));
40+
41+
$this->assertSame('America/New_York', $form->createView()->vars['value']);
42+
43+
$form->submit('Europe/Amsterdam');
44+
45+
$this->assertEquals(new \DateTimeZone('Europe/Amsterdam'), $form->getData());
46+
47+
$form = $this->factory->create(static::TESTED_TYPE, array(new \DateTimeZone('America/New_York')), array('input' => 'datetimezone', 'multiple' => true));
48+
49+
$this->assertSame(array('America/New_York'), $form->createView()->vars['value']);
50+
51+
$form->submit(array('Europe/Amsterdam', 'Europe/Paris'));
52+
53+
$this->assertEquals(array(new \DateTimeZone('Europe/Amsterdam'), new \DateTimeZone('Europe/Paris')), $form->getData());
54+
}
55+
56+
public function testFilterByRegions()
57+
{
58+
$choices = $this->factory->create(static::TESTED_TYPE, null, array('regions' => \DateTimeZone::EUROPE))
59+
->createView()->vars['choices'];
60+
61+
$this->assertContains(new ChoiceView('Europe/Amsterdam', 'Europe/Amsterdam', 'Amsterdam'), $choices, '', false, false);
62+
}
3663
}

0 commit comments

Comments
 (0)