[Form][ButtonBuilder] Prevent buttons names from starting with a capital letter

fancyweb · fancyweb · commit fe82230b1969 · 2019-11-18T22:50:02.000+01:00
diff --git a/src/Symfony/Component/Form/ButtonBuilder.php b/src/Symfony/Component/Form/ButtonBuilder.php
@@ -50,18 +50,14 @@ class ButtonBuilder implements \IteratorAggregate, FormBuilderInterface
     private $options;
 
     /**
-     * @throws InvalidArgumentException if the name is empty
+     * @throws InvalidArgumentException if the name is empty or invalid
      */
     public function __construct(?string $name, array $options = [])
     {
-        if ('' === $name || null === $name) {
-            throw new InvalidArgumentException('Buttons cannot have empty names.');
-        }
+        self::validateName($name);
 
         $this->name = $name;
         $this->options = $options;
-
-        FormConfigBuilder::validateName($name);
     }
 
     /**
@@ -757,4 +753,31 @@ public function getIterator()
     {
         return new \EmptyIterator();
     }
+
+    /**
+     * Validates whether the given variable is a valid button name.
+     *
+     * @throws InvalidArgumentException if the name is empty or contains invalid characters
+     *
+     * @internal
+     */
+    final public static function validateName(?string $name)
+    {
+        if ('' === $name || null === $name) {
+            throw new InvalidArgumentException('Buttons cannot have empty names.');
+        }
+
+        if (!self::isValidName($name)) {
+            throw new InvalidArgumentException(sprintf('The name "%s" contains illegal characters. Names should start with a lowercase letter, digit or underscore and only contain letters, digits, numbers, underscores ("_"), hyphens ("-") and colons (":").', $name));
+        }
+    }
+
+    /**
+     * A name is accepted if it starts with a lowercase letter, digit or underscore
+     * and contains only letters, digits, numbers, underscores ("_"), hyphens ("-") and colons (":").
+     */
+    final public static function isValidName(string $name): bool
+    {
+        return preg_match('/^[a-z0-9_][a-zA-Z0-9_\-:]*$/', $name);
+    }
 }
diff --git a/src/Symfony/Component/Form/Tests/ButtonBuilderTest.php b/src/Symfony/Component/Form/Tests/ButtonBuilderTest.php
@@ -42,16 +42,16 @@ public function testValidNames($name)
     public function testNameContainingIllegalCharacters()
     {
         $this->expectException('Symfony\Component\Form\Exception\InvalidArgumentException');
-        $this->expectExceptionMessage('The name "button[]" contains illegal characters. Names should start with a letter, digit or underscore and only contain letters, digits, numbers, underscores ("_"), hyphens ("-") and colons (":").');
+        $this->expectExceptionMessage('The name "button[]" contains illegal characters. Names should start with a lowercase letter, digit or underscore and only contain letters, digits, numbers, underscores ("_"), hyphens ("-") and colons (":").');
 
         $this->assertInstanceOf('\Symfony\Component\Form\ButtonBuilder', new ButtonBuilder('button[]'));
     }
 
-    /**
-     * @group legacy
-     */
     public function testNameStartingWithIllegalCharacters()
     {
+        $this->expectException(InvalidArgumentException::class);
+        $this->expectExceptionMessage('The name "Button" contains illegal characters. Names should start with a lowercase letter, digit or underscore and only contain letters, digits, numbers, underscores ("_"), hyphens ("-") and colons (":").');
+
         $this->assertInstanceOf('\Symfony\Component\Form\ButtonBuilder', new ButtonBuilder('Button'));
     }
 

Original file line number	Diff line number	Diff line change
`@@ -42,16 +42,16 @@ public function testValidNames($name)`
`42`	`42`	`public function testNameContainingIllegalCharacters()`
`43`	`43`	`{`
`44`	`44`	`$this->expectException('Symfony\Component\Form\Exception\InvalidArgumentException');`
`45`		`- $this->expectExceptionMessage('The name "button[]" contains illegal characters. Names should start with a letter, digit or underscore and only contain letters, digits, numbers, underscores ("_"), hyphens ("-") and colons (":").');`
	`45`	`+ $this->expectExceptionMessage('The name "button[]" contains illegal characters. Names should start with a lowercase letter, digit or underscore and only contain letters, digits, numbers, underscores ("_"), hyphens ("-") and colons (":").');`
`46`	`46`
`47`	`47`	`$this->assertInstanceOf('\Symfony\Component\Form\ButtonBuilder', new ButtonBuilder('button[]'));`
`48`	`48`	`}`
`49`	`49`
`50`		`- /**`
`51`		`- * @group legacy`
`52`		`- */`
`53`	`50`	`public function testNameStartingWithIllegalCharacters()`
`54`	`51`	`{`
	`52`	`+ $this->expectException(InvalidArgumentException::class);`
	`53`	`+ $this->expectExceptionMessage('The name "Button" contains illegal characters. Names should start with a lowercase letter, digit or underscore and only contain letters, digits, numbers, underscores ("_"), hyphens ("-") and colons (":").');`
	`54`	`+`
`55`	`55`	`$this->assertInstanceOf('\Symfony\Component\Form\ButtonBuilder', new ButtonBuilder('Button'));`
`56`	`56`	`}`
`57`	`57`