bug symfony#32335 [Form] Names for buttons should start with lowercase (mcfedr)

fabpot · fabpot · commit d04fdee000ce · 2019-09-25T21:19:30.000+02:00
This PR was merged into the 4.3 branch. Discussion ---------- [Form] Names for buttons should start with lowercase | Q | A | ------------- | --- | Branch? | 4.3 | Bug fix? | yes | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | N/A | License | MIT | Doc PR | N/A This fix changes the messages related to the changes in symfony#28969 - the message used to state that names should start with a letter, a digit ... - so I got a confusing message: ``` Using names for buttons that do not start with a letter, a digit, or an underscore is deprecated since Symfony 4.3 and will throw an exception in 5.0 ("Search" given).' ``` Which made me find the message, look at the regex that was used, and work out that actually it should start with a lowercase letter, and hence this PR - where I assume there is a reason that the name must start with lowercase letters. Commits ------- f65524e Names for buttons should start with lowercase
diff --git a/UPGRADE-4.3.md b/UPGRADE-4.3.md
@@ -96,7 +96,7 @@ 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
+ * Using names for buttons that do not start with a lowercase 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
    will lead to an exception in 5.0.
diff --git a/UPGRADE-5.0.md b/UPGRADE-5.0.md
@@ -110,7 +110,7 @@ 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 start with a lowercase 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.
  * Using the `date_format`, `date_widget`, and `time_widget` options of the `DateTimeType` when the `widget` option is
diff --git a/src/Symfony/Component/Form/ButtonBuilder.php b/src/Symfony/Component/Form/ButtonBuilder.php
@@ -63,7 +63,7 @@ public function __construct(?string $name, array $options = [])
 
         if (preg_match('/^([^a-z0-9_].*)?(.*[^a-zA-Z0-9_\-:].*)?$/D', $name, $matches)) {
             if (isset($matches[1])) {
-                @trigger_error(sprintf('Using names for buttons that do not start with a letter, a digit, or an underscore is deprecated since Symfony 4.3 and will throw an exception in 5.0 ("%s" given).', $name), E_USER_DEPRECATED);
+                @trigger_error(sprintf('Using names for buttons that do not start with a lowercase letter, a digit, or an underscore is deprecated since Symfony 4.3 and will throw an exception in 5.0 ("%s" given).', $name), E_USER_DEPRECATED);
             }
             if (isset($matches[2])) {
                 @trigger_error(sprintf('Using names for buttons that do not contain only letters, digits, underscores ("_"), hyphens ("-") and colons (":") ("%s" given) is deprecated since Symfony 4.3 and will throw an exception in 5.0.', $name), E_USER_DEPRECATED);
diff --git a/src/Symfony/Component/Form/CHANGELOG.md b/src/Symfony/Component/Form/CHANGELOG.md
@@ -6,7 +6,7 @@ CHANGELOG
 
  * added a `symbol` option to the `PercentType` that allows to disable or customize the output of the percent character
  * 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
+ * Using names for buttons that do not start with a lowercase 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
    will lead to an exception in 5.0.
diff --git a/src/Symfony/Component/Form/Tests/ButtonBuilderTest.php b/src/Symfony/Component/Form/Tests/ButtonBuilderTest.php
@@ -47,6 +47,14 @@ public function testNameContainingIllegalCharacters()
         $this->assertInstanceOf('\Symfony\Component\Form\ButtonBuilder', new ButtonBuilder('button[]'));
     }
 
+    /**
+     * @group legacy
+     */
+    public function testNameStartingWithIllegalCharacters()
+    {
+        $this->assertInstanceOf('\Symfony\Component\Form\ButtonBuilder', new ButtonBuilder('Button'));
+    }
+
     public function getInvalidNames()
     {
         return [

Original file line number	Diff line number	Diff line change
`@@ -63,7 +63,7 @@ public function __construct(?string $name, array $options = [])`
`63`	`63`
`64`	`64`	`if (preg_match('/^([^a-z0-9_].)?(.[^a-zA-Z0-9_\-:].*)?$/D', $name, $matches)) {`
`65`	`65`	`if (isset($matches[1])) {`
`66`		`- @trigger_error(sprintf('Using names for buttons that do not start with a letter, a digit, or an underscore is deprecated since Symfony 4.3 and will throw an exception in 5.0 ("%s" given).', $name), E_USER_DEPRECATED);`
	`66`	`+ @trigger_error(sprintf('Using names for buttons that do not start with a lowercase letter, a digit, or an underscore is deprecated since Symfony 4.3 and will throw an exception in 5.0 ("%s" given).', $name), E_USER_DEPRECATED);`
`67`	`67`	`}`
`68`	`68`	`if (isset($matches[2])) {`
`69`	`69`	`@trigger_error(sprintf('Using names for buttons that do not contain only letters, digits, underscores ("_"), hyphens ("-") and colons (":") ("%s" given) is deprecated since Symfony 4.3 and will throw an exception in 5.0.', $name), E_USER_DEPRECATED);`
Original file line number	Diff line number	Diff line change
`@@ -47,6 +47,14 @@ public function testNameContainingIllegalCharacters()`
`47`	`47`	`$this->assertInstanceOf('\Symfony\Component\Form\ButtonBuilder', new ButtonBuilder('button[]'));`
`48`	`48`	`}`
`49`	`49`
	`50`	`+ /**`
	`51`	`+ * @group legacy`
	`52`	`+ */`
	`53`	`+ public function testNameStartingWithIllegalCharacters()`
	`54`	`+ {`
	`55`	`+ $this->assertInstanceOf('\Symfony\Component\Form\ButtonBuilder', new ButtonBuilder('Button'));`
	`56`	`+ }`
	`57`	`+`
`50`	`58`	`public function getInvalidNames()`
`51`	`59`	`{`
`52`	`60`	`return [`