8000 [Form] deprecate custom formats with HTML5 widgets by xabbuh · Pull Request #28723 · symfony/symfony · GitHub
[go: up one dir, main page]
Skip to content

[Form] deprecate custom formats with HTML5 widgets #28723

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
Feb 21, 2019
Merged

[Form] deprecate custom formats with HTML5 widgets #28723

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
1 change: 1 addition & 0 deletions UPGRADE-4.3.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ Config
Form
----

* Using the `format` option of `DateType` and `DateTimeType` when the `html5` option is enabled is deprecated.
* Using names for buttons that do not start with a letter, a digit, or an underscore is deprecated and will lead to an
exception in 5.0.
* Using names for buttons that do not contain only letters, digits, underscores, hyphens, and colons is deprecated and
Expand Down
1 change: 1 addition & 0 deletions UPGRADE-5.0.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,7 @@ Finder
Form
----

* Removed support for using the `format` option of `DateType` and `DateTimeType` when the `html5` option is enabled.
* Using names for buttons that do not start with a letter, a digit, or an underscore leads to an exception.
* Using names for buttons that do not contain only letters, digits, underscores, hyphens, and colons leads to an
exception.
Expand Down
1 change: 1 addition & 0 deletions src/Symfony/Component/Form/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ CHANGELOG
4.3.0
-----

* Using the `format` option of `DateType` and `DateTimeType` when the `html5` option is enabled is deprecated.
* Using names for buttons that do not start with a letter, a digit, or an underscore is deprecated and will lead to an
exception in 5.0.
* Using names for buttons that do not contain only letters, digits, underscores, hyphens, and colons is deprecated and
Expand Down
14 changes: 13 additions & 1 deletion src/Symfony/Component/Form/Extension/Core/Type/DateTimeType.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -159,6 +159,10 @@ public function buildForm(FormBuilderInterface $builder, array $options)
$dateOptions['input'] = $timeOptions['input'] = 'array';
$dateOptions['error_bubbling'] = $timeOptions['error_bubbling'] = true;

if (isset($dateOptions['format']) && DateType::HTML5_FORMAT !== $dateOptions['format']) {
$dateOptions['html5'] = false;
}

$builder
->addViewTransformer(new DataTransformerChain([
new DateTimeToArrayTransformer($options['model_timezone'], $options['view_timezone'], $parts),
Expand Down Expand Up @@ -294,6 +298,8 @@ public function configureOptions(OptionsResolver $resolver)
'choice',
]);

$resolver->setAllowedTypes('input_format', 'string');

$resolver->setDeprecated('date_format', function (Options $options, $dateFormat) {
if (null !== $dateFormat && 'single_text' === $options['widget'] && self::HTML5_FORMAT === $options['format']) {
return sprintf('Using the "date_format" option of %s with an HTML5 date widget is deprecated since Symfony 4.3 and will lead to an exception in 5.0.', self::class);
Expand All @@ -318,8 +324,14 @@ public function configureOptions(OptionsResolver $resolver)

return '';
});
$resolver->setDeprecated('html5', function (Options $options, $html5) {
if ($html5 && self::HTML5_FORMAT !== $options['format']) {
return sprintf('Using a custom format when the "html5" option of %s is enabled is deprecated since Symfony 4.3 and will lead to an exception in 5.0.', self::class);
//throw new LogicException(sprintf('Cannot use the "format" option of %s when the "html5" option is disabled.', self::class));
}

$resolver->setAllowedTypes('input_format', 'string');
return '';
});
}

/**
Expand Down
10 changes: 9 additions & 1 deletion src/Symfony/Component/Form/Extension/Core/Type/DateType.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -306,8 +306,16 @@ public function configureOptions(OptionsResolver $resolver)
$resolver->setAllowedTypes('years', 'array');
$resolver->setAllowedTypes('months', 'array');
$resolver->setAllowedTypes('days', 'array');

$resolver->setAllowedTypes('input_format', 'string');

$resolver->setDeprecated('html5', function (Options $options, $html5) {
if ($html5 && 'single_text' === $options['widget'] && self::HTML5_FORMAT !== $options['format']) {
return sprintf('Using a custom format when the "html5" option of %s is enabled is deprecated since Symfony 4.3 and will lead to an exception in 5.0.', self::class);
//throw new LogicException(sprintf('Cannot use the "format" option of %s when the "html5" option is disabled.', self::class));
}

return '';
});
}

/**
Expand Down
2 changes: 1 addition & 1 deletion src/Symfony/Component/Form/Tests/Command/DebugCommandTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ public function testDebugDeprecatedDefaults()
Built-in form types (Symfony\Component\Form\Extension\Core\Type)
----------------------------------------------------------------

DateTimeType, IntegerType, TimezoneType
BirthdayType, DateTimeType, DateType, IntegerType, TimezoneType

Service form types
------------------
Expand Down
3 changes: 3 additions & 0 deletions src/Symfony/Component/Form/Tests/Extension/Core/Type/DateTimeTypeTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -470,6 +470,9 @@ public function testDontPassHtml5TypeIfHtml5NotAllowed()
$this->assertArrayNotHasKey('type', $view->vars);
}

/**
* @group legacy
*/
public function testDontPassHtml5TypeIfNotHtml5Format()
{
$view = $this->factory->create(static::TESTED_TYPE, null, [
Expand Down
15 changes: 15 additions & 0 deletions src/Symfony/Component/Form/Tests/Extension/Core/Type/DateTypeTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,7 @@ public function testSubmitFromSingleTextDateTimeWithCustomFormat()
'widget' => 'single_text',
'input' => 'datetime',
'format' => 'yyyy',
'html5' => false,
]);

$form->submit('2010');
Expand All @@ -93,6 +94,7 @@ public function testSubmitFromSingleTextDateTime()

$form = $this->factory->create(static::TESTED_TYPE, null, [
'format' => \IntlDateFormatter::MEDIUM,
'html5' => false,
'model_timezone' => 'UTC',
'view_timezone' => 'UTC',
'widget' => 'single_text',
Expand All @@ -114,6 +116,7 @@ public function testSubmitFromSingleTextDateTimeImmutable()

$form = $this->factory->create(static::TESTED_TYPE, null, [
'format' => \IntlDateFormatter::MEDIUM,
'html5' => false,
'model_timezone' => 'UTC',
'view_timezone' => 'UTC',
'widget' => 'single_text',
Expand All @@ -136,6 +139,7 @@ public function testSubmitFromSingleTextString()

$form = $this->factory->create(static::TESTED_TYPE, null, [
'format' => \IntlDateFormatter::MEDIUM,
'html5' => false,
'model_timezone' => 'UTC',
'view_timezone' => 'UTC',
'widget' => 'single_text',
Expand All @@ -157,6 +161,7 @@ public function testSubmitFromSingleTextTimestamp()

$form = $this->factory->create(static::TESTED_TYPE, null, [
'format' => \IntlDateFormatter::MEDIUM,
'html5' => false,
'model_timezone' => 'UTC',
'view_timezone' => 'UTC',
'widget' => 'single_text',
Expand All @@ -180,6 +185,7 @@ public function testSubmitFromSingleTextRaw()

$form = $this->factory->create(static::TESTED_TYPE, null, [
'format' => \IntlDateFormatter::MEDIUM,
'html5' => false,
'model_timezone' => 'UTC',
'view_timezone' => 'UTC',
'widget' => 'single_text',
Expand Down Expand Up @@ -270,6 +276,7 @@ public function testSubmitFromInputDateTimeDifferentPattern()
'model_timezone' => 'UTC',
'view_timezone' => 'UTC',
'format' => 'MM*yyyy*dd',
'html5' => false,
'widget' => 'single_text',
'input' => 'datetime',
]);
Expand All @@ -286,6 +293,7 @@ public function testSubmitFromInputStringDifferentPattern()
'model_timezone' => 'UTC',
'view_timezone' => 'UTC',
'format' => 'MM*yyyy*dd',
'html5' => false,
'widget' => 'single_text',
'input' => 'string',
]);
Expand All @@ -302,6 +310,7 @@ public function testSubmitFromInputTimestampDifferentPattern()
'model_timezone' => 'UTC',
'view_timezone' => 'UTC',
'format' => 'MM*yyyy*dd',
'html5' => false,
'widget' => 'single_text',
'input' => 'timestamp',
]);
Expand All @@ -320,6 +329,7 @@ public function testSubmitFromInputRawDifferentPattern()
'model_timezone' => 'UTC',
'view_timezone' => 'UTC',
'format' => 'MM*yyyy*dd',
'html5' => false,
'widget' => 'single_text',
'input' => 'array',
]);
Expand Down Expand Up @@ -368,6 +378,7 @@ public function testThrowExceptionIfFormatIsNoPattern()
{
$this->factory->create(static::TESTED_TYPE, null, [
'format' => '0',
'html5' => false,
'widget' => 'single_text',
'input' => 'string',
]);
Expand All @@ -394,6 +405,7 @@ public function testThrowExceptionIfFormatMissesYearMonthAndDayWithSingleTextWid
$this->factory->create(static::TESTED_TYPE, null, [
'widget' => 'single_text',
'format' => 'wrong',
'html5' => false,
]);
}

Expand Down Expand Up @@ -456,6 +468,7 @@ public function testSetDataWithNegativeTimezoneOffsetStringInput()

$form = $this->factory->create(static::TESTED_TYPE, null, [
'format' => \IntlDateFormatter::MEDIUM,
'html5' => false,
'model_timezone' => 'UTC',
'view_timezone' => 'America/New_York',
'input' => 'string',
Expand All @@ -478,6 +491,7 @@ public function testSetDataWithNegativeTimezoneOffsetDateTimeInput()

$form = $this->factory->create(static::TESTED_TYPE, null, [
'format' => \IntlDateFormatter::MEDIUM,
'html5' => false,
'model_timezone' => 'UTC',
'view_timezone' => 'America/New_York',
'input' => 'datetime',
Expand Down Expand Up @@ -856,6 +870,7 @@ public function testDontPassHtml5TypeIfNotHtml5Format()
$view = $this->factory->create(static::TESTED_TYPE, null, [
'widget' => 'single_text',
'format' => \IntlDateFormatter::MEDIUM,
'html5' => false,
])
->createView();

Expand Down
0