[Form] Add input + regions options to TimezoneType #23648
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,82 @@ | ||
| <?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 DateTimeZone object. | ||
| * | ||
| * @author Roland Franssen <franssen.roland@gmai.com> | ||
| */ | ||
| class DateTimeZoneToStringTransformer implements DataTransformerInterface | ||
| { | ||
| private $multiple; | ||
|
|
||
| public function __construct($multiple = false) | ||
| { | ||
| $this->multiple = $multiple; | ||
| } | ||
|
|
||
| /** | ||
| * {@inheritdoc} | ||
| */ | ||
| public function transform($dateTimeZone) | ||
| { | ||
| if (null === $dateTimeZone) { | ||
| return; | ||
| } | ||
|
|
||
| if ($this->multiple) { | ||
| if (!is_array($dateTimeZone)) { | ||
| throw new TransformationFailedException('Expected an array.'); | ||
| } | ||
|
|
||
| return array_map(array(new self(), 'transform'), $dateTimeZone); | ||
| } | ||
|
|
||
| if (!$dateTimeZone instanceof \DateTimeZone) { | ||
| throw new TransformationFailedException('Expected a \DateTimeZone.'); | ||
| } | ||
|
|
||
| return $dateTimeZone->getName(); | ||
| } | ||
|
|
||
| /** | ||
| * {@inheritdoc} | ||
| */ | ||
| public function reverseTransform($value) | ||
| { | ||
| if (null === $value) { | ||
| return; | ||
| } | ||
|
|
||
| if ($this->multiple) { | ||
| if (!is_array($value)) { | ||
| throw new TransformationFailedException('Expected an array.'); | ||
| } | ||
|
|
||
| return array_map(array(new self(), 'reverseTransform'), $value); | ||
| } | ||
|
|
||
| if (!is_string($value)) { | ||
| throw new TransformationFailedException('Expected a string.'); | ||
| } | ||
|
|
||
| try { | ||
| return new \DateTimeZone($value); | ||
| } catch (\Exception $e) { | ||
| throw new TransformationFailedException($e->getMessage(), $e->getCode(), $e); | ||
| } | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,56 @@ | ||
| <?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 Symfony\Component\Form\Extension\Core\DataTransformer\DateTimeZoneToStringTransformer; | ||
| use PHPUnit\Framework\TestCase; | ||
|
|
||
| class DateTimeZoneToStringTransformerTest extends TestCase | ||
| { | ||
| public function testSingle() | ||
| { | ||
| $transformer = new DateTimeZoneToStringTransformer(); | ||
|
|
||
| $this->assertNull($transformer->transform(null)); | ||
| $this->assertNull($transformer->reverseTransform(null)); | ||
|
|
||
| $this->assertSame('Europe/Amsterdam', $transformer->transform(new \DateTimeZone('Europe/Amsterdam'))); | ||
| $this->assertEquals(new \DateTimeZone('Europe/Amsterdam'), $transformer->reverseTransform('Europe/Amsterdam')); | ||
| } | ||
|
|
||
| public function testMultiple() | ||
| { | ||
| $transformer = new DateTimeZoneToStringTransformer(true); | ||
|
|
||
| $this->assertNull($transformer->transform(null)); | ||
| $this->assertNull($transformer->reverseTransform(null)); | ||
|
|
||
| $this->assertSame(array('Europe/Amsterdam'), $transformer->transform(array(new \DateTimeZone('Europe/Amsterdam')))); | ||
| $this->assertEquals(array(new \DateTimeZone('Europe/Amsterdam')), $transformer->reverseTransform(array('Europe/Amsterdam'))); | ||
| } | ||
|
|
||
| /** | ||
| * @expectedException \Symfony\Component\Form\Exception\TransformationFailedException | ||
| */ | ||
| public function testInvalidTimezone() | ||
| { | ||
| (new DateTimeZoneToStringTransformer())->transform(1); | ||
| } | ||
|
|
||
| /** | ||
| * @expectedException \Symfony\Component\Form\Exception\TransformationFailedException | ||
| */ | ||
| public function testUnknownTimezone() | ||
| { | ||
| (new DateTimeZoneToStringTransformer(true))->reverseTransform(array('Foo/Bar')); | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
How about we name the option value
DateTimeZoneso people can use['input' => \DateTimeZone::class]? This avoids typos and makes things more explicit as the value directly maps to a class.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I like this suggestion and we could also apply it for other
Date*Typehaving this input option.But I'd keep
datetimezoneas alias for consistency, as I'm not convinced deprecating old option values for other types would be worth it and such aliases are handful too (for configuration based form generation like in EasyAdmin for instance).There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
so.. strtolower? :)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
strtolowering the whole FQCN won't help you much ;)
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
i meant
if ('datetimezone' === strtolower($options['input'])) {..then again im not sure using class-ish values for
inputmakes sense (compared todata_class). It kinda implies it supports any class name, which it doesnt.