8000 [Form] Add intltimezone input to TimezoneType by ro0NL · Pull Request #31195 · symfony/symfony · GitHub
[go: up one dir, main page]
Skip to content

[Form] Add intltimezone input to TimezoneType #31195

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 27, 2019
Merged

[Form] Add intltimezone input to TimezoneType #31195

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
84 changes: 84 additions & 0 deletions ...Symfony/Component/Form/Extension/Core/DataTransformer/IntlTimeZoneToStringTransformer.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
<?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\Form\Extension\Core\DataTransformer;

use Symfony\Component\Form\DataTransformerInterface;
use Symfony\Component\Form\Exception\TransformationFailedException;

/**
* Transforms between a timezone identifier string and a IntlTimeZone object.
*
* @author Roland Franssen <franssen.roland@gmail.com>
8000 */
class IntlTimeZoneToStringTransformer implements DataTransformerInterface
{
private $multiple;

public function __construct(bool $multiple = false)
{
$this->multiple = $multiple;
}

/**
* {@inheritdoc}
*/
public function transform($intlTimeZone)
{
if (null === $intlTimeZone) {
return;
}

if ($this->multiple) {
if (!\is_array($intlTimeZone)) {
throw new TransformationFailedException('Expected an array of \IntlTimeZone objects.');
}

return array_map([new self(), 'transform'], $intlTimeZone);
}

if (!$intlTimeZone instanceof \IntlTimeZone) {
throw new TransformationFailedException('Expected a \IntlTimeZone object.');
}

return $intlTimeZone->getID();
}

/**
* {@inheritdoc}
*/
public function reverseTransform($value)
{
if (null === $value) {
return;
}

if ($this->multiple) {
if (!\is_array($value)) {
throw new TransformationFailedException('Expected an array of timezone identifier strings.');
}

return array_map([new self(), 'reverseTransform'], $value);
}

if (!\is_string($value)) {
throw new TransformationFailedException('Expected a timezone identifier string.');
}

$intlTimeZone = \IntlTimeZone::createTimeZone($value);

if ('Etc/Unknown' === $intlTimeZone->getID()) {
throw new TransformationFailedException(sprintf('Unknown timezone identifier "%s".', $value));
}

return $intlTimeZone;
}
}
24 changes: 20 additions & 4 deletions src/Symfony/Component/Form/Extension/Core/Type/TimezoneType.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,9 @@

use Symfony\Component\Form\AbstractType;
use Symfony\Component\Form\ChoiceList\Loader\CallbackChoiceLoader;
use Symfony\Component\Form\Exception\LogicException;
use Symfony\Component\Form\Extension\Core\DataTransformer\DateTimeZoneToStringTransformer;
use Symfony\Component\Form\Extension\Core\DataTransformer\IntlTimeZoneToStringTransformer;
use Symfony\Component\Form\FormBuilderInterface;
use Symfony\Component\OptionsResolver\Options;
use Symfony\Component\OptionsResolver\OptionsResolver;
Expand All @@ -27,6 +29,8 @@ public function buildForm(FormBuilderInterface $builder, array $options)
{
if ('datetimezone' === $options['input']) {
$builder->addModelTransformer(new DateTimeZoneToStringTransformer($options['multiple']));
} elseif ('intltimezone' === $options['input']) {
$builder->addModelTransformer(new IntlTimeZoneToStringTransformer($options['multiple']));
}
}

Expand All @@ -38,17 +42,25 @@ public function configureOptions(OptionsResolver $resolv 8000 er)
$resolver->setDefaults([
'choice_loader' => function (Options $options) {
$regions = $options->offsetGet('regions', false);
$input = $options['input'];

return new CallbackChoiceLoader(function () use ($regions) {
return self::getTimezones($regions);
return new CallbackChoiceLoader(function () use ($regions, $input) {
return self::getTimezones($regions, $input);
});
},
'choice_translation_domain' => false,
'input' => 'string',
'regions' => \DateTimeZone::ALL,
]);

$resolver->setAllowedValues('input', ['string', 'datetimezone']);
$resolver->setAllowedValues('input', ['string', 'datetimezone', 'intltimezone']);
$resolver->setNormalizer('input', function (Options $options, $value) {
if ('intltimezone' === $value && !class_exists(\IntlTimeZone::class)) {
throw new LogicException('Cannot use "intltimezone" input because the PHP intl extension is not available.');
}

return $value;
});

$resolver->setAllowedTypes('regions', 'int');
$resolver->setDeprecated('regions', 'The option "%name%" is deprecated since Symfony 4.2.');
Expand All @@ -73,11 +85,15 @@ public function getBlockPrefix()
/**
* Returns a normalized array of timezone choices.
*/
private static function getTimezones(int $regions): array
private static function getTimezones(int $regions, string $input): array
{
$timezones = [];

foreach (\DateTimeZone::listIdentifiers($regions) as $timezone) {
if ('intltimezone' === $input && 'Etc/Unknown' === \IntlTimeZone::createTimeZone($timezone)->getID()) {
continue;
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

for reference, the following PHP timezone IDs become unavailable:

America/Punta_Arenas
Asia/Atyrau
Asia/Famagusta
Asia/Qostanay
Asia/Tomsk
Asia/Yangon
Europe/Kirov
Europe/Saratov

(see https://github.com/unicode-org/icu/blob/master/icu4c/source/data/misc/metaZones.txt for expiration dates)

}

$parts = explode('/', $timezone);

if (\count($parts) > 2) {
Expand Down
59 changes: 59 additions & 0 deletions ...mponent/Form/Tests/Extension/Core/DataTransformer/IntlTimeZoneToStringTransformerTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
<?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\Form\Tests\Extension\Core\DataTransformer;

use PHPUnit\Framework\TestCase;
use Symfony\Component\Form\Extension\Core\DataTransformer\IntlTimeZoneToStringTransformer;

/**
* @requires extension intl
*/
class IntlTimeZoneToStringTransformerTest extends TestCase
{
public function testSingle()
{
$transformer = new IntlTimeZoneToStringTransformer();

$this->assertNull($transformer->transform(null));
$this->assertNull($transformer->reverseTransform(null));

$this->assertSame('Europe/Amsterdam', $transformer->transform(\IntlTimeZone::createTimeZone('Europe/Amsterdam')));
$this->assertEquals(\IntlTimeZone::createTimeZone('Europe/Amsterdam'), $transformer->reverseTransform('Europe/Amsterdam'));
}

public function testMultiple()
{
$transformer = new IntlTimeZoneToStringTransformer(true);

$this->assertNull($transformer->transform(null));
$this->assertNull($transformer->reverseTransform(null));

$this->assertSame(['Europe/Amsterdam'], $transformer->transform([\IntlTimeZone::createTimeZone('Europe/Amsterdam')]));
$this->assertEquals([\IntlTimeZone::createTimeZone('Europe/Amsterdam')], $transformer->reverseTransform(['Europe/Amsterdam']));
}

/**
* @expectedException \Symfony\Component\Form\Exception\TransformationFailedException
*/
public function testInvalidTimezone()
{
(new IntlTimeZoneToStringTransformer())->transform(1);
}

/**
* @expectedException \Symfony\Component\Form\Exception\TransformationFailedException
*/
public function testUnknownTimezone()
{
(new IntlTimeZoneToStringTransformer(true))->reverseTransform(['Foo/Bar']);
}
}
43 changes: 43 additions & 0 deletions src/Symfony/Component/Form/Tests/Extension/Core/Type/TimezoneTypeTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,15 @@ public function testDateTimeZoneInput()
$this->assertEquals([new \DateTimeZone('Europe/Amsterdam'), new \DateTimeZone('Europe/Paris')], $form->getData());
}

public function testDateTimeZoneInputWithBc()
{
$form = $this->factory->create(static::TESTED_TYPE, null, ['input' => 'datetimezone']);
$form->submit('Europe/Saratov');

$this->assertEquals(new \DateTimeZone('Europe/Saratov'), $form->getData());
$this->assertContains('Europe/Saratov', $form->getConfig()->getAttribute('choice_list')->getValues());
}

/**
* @group legacy
* @expectedDeprecation The option "regions" is deprecated since Symfony 4.2.
Expand All @@ -76,4 +85,38 @@ public function testFilterByRegions()

$this->assertContains(new ChoiceView('Europe/Amsterdam', 'Europe/Amsterdam', 'Amsterdam'), $choices, '', false, false);
}

/**
* @requires extension intl
*/
public function testIntlTimeZoneInput()
{
$form = $this->factory->create(static::TESTED_TYPE, \IntlTimeZone::createTimeZone('America/New_York'), ['input' => 'intltimezone']);

$this->assertSame('America/New_York', $form->createView()->vars['value']);

$form->submit('Europe/Amsterdam');

$this->assertEquals(\IntlTimeZone::createTimeZone('Europe/Amsterdam'), $form->getData());

$form = $this->factory->create(static::TESTED_TYPE, [\IntlTimeZone::createTimeZone('America/New_York')], ['input' => 'intltimezone', 'multiple' => true]);

$this->assertSame(['America/New_York'], $form->createView()->vars['value']);

$form->submit(['Europe/Amsterdam', 'Europe/Paris']);

$this->assertEquals([\IntlTimeZone::createTimeZone('Europe/Amsterdam'), \IntlTimeZone::createTimeZone('Europe/Paris')], $form->getData());
}

/**
* @requires extension intl
*/
public function testIntlTimeZoneInputWithBc()
{
$form = $this->factory->create(static::TESTED_TYPE, null, ['input' => 'intltimezone']);
$form->submit('Europe/Saratov');

$this->assertNull($form->getData());
$this->assertNotContains('Europe/Saratov', $form->getConfig()->getAttribute('choice_list')->getValues());
}
}
0