[DomCrawler][Form] Fix PHPDoc on get & offsetGet

fancyweb · fancyweb · commit 5ea08fead739 · 2020-02-26T18:12:32.000+01:00
diff --git a/Form.php b/Form.php
@@ -269,7 +269,7 @@ public function remove($name)
      *
      * @param string $name The field name
      *
-     * @return FormField The field instance
+     * @return FormField|FormField[]|FormField[][] The value of the field
      *
      * @throws \InvalidArgumentException When field is not present in this form
      */
@@ -313,7 +313,7 @@ public function offsetExists($name)
      *
      * @param string $name The field name
      *
-     * @return FormField The associated Field instance
+     * @return FormField|FormField[]|FormField[][] The value of the field
      *
      * @throws \InvalidArgumentException if the field does not exist
      */
diff --git a/FormFieldRegistry.php b/FormFieldRegistry.php
@@ -70,7 +70,7 @@ public function remove($name)
      *
      * @param string $name The fully qualified name of the field
      *
-     * @return mixed The value of the field
+     * @return FormField|FormField[]|FormField[][] The value of the field
      *
      * @throws \InvalidArgumentException if the field does not exist
      */
diff --git a/Tests/FormTest.php b/Tests/FormTest.php
@@ -12,6 +12,7 @@
 namespace Symfony\Component\DomCrawler\Tests;
 
 use PHPUnit\Framework\TestCase;
+use Symfony\Component\DomCrawler\Field\TextareaFormField;
 use Symfony\Component\DomCrawler\Form;
 use Symfony\Component\DomCrawler\FormFieldRegistry;
 
@@ -953,7 +954,7 @@ protected function createTestMultipleForm()
         return $dom;
     }
 
-    public function testgetPhpValuesWithEmptyTextarea()
+    public function testGetPhpValuesWithEmptyTextarea()
     {
         $dom = new \DOMDocument();
         $dom->loadHTML('
@@ -968,4 +969,34 @@ public function testgetPhpValuesWithEmptyTextarea()
         $form = new Form($nodes->item(0), 'http://example.com');
         $this->assertEquals($form->getPhpValues(), ['example' => '']);
     }
+
+    public function testGetReturnTypes()
+    {
+        $dom = new \DOMDocument();
+        $dom->loadHTML('
+            <html>
+                <form>
+                    <textarea name="foo[collection][0][bar]">item 0</textarea>
+                </form>
+            </html>'
+        );
+
+        $nodes = $dom->getElementsByTagName('form');
+        $form = new Form($nodes->item(0), 'http://example.com');
+
+        // FormField
+        $this->assertInstanceOf(TextareaFormField::class, $textareaFormField = $form->get('foo[collection][0][bar]'));
+
+        // Array of FormField
+        $this->assertSame([
+            'bar' => $textareaFormField,
+        ], $form->get('foo[collection][0]'));
+
+        // Array of array of FormField
+        $this->assertSame([
+            [
+                'bar' => $textareaFormField,
+            ],
+        ], $form->get('foo[collection]'));
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -269,7 +269,7 @@ public function remove($name)`
`269`	`269`	`*`
`270`	`270`	`* @param string $name The field name`
`271`	`271`	`*`
`272`		`- * @return FormField The field instance`
	`272`	`+ * @return FormField\|FormField[]\|FormField[][] The value of the field`
`273`	`273`	`*`
`274`	`274`	`* @throws \InvalidArgumentException When field is not present in this form`
`275`	`275`	`*/`
`@@ -313,7 +313,7 @@ public function offsetExists($name)`
`313`	`313`	`*`
`314`	`314`	`* @param string $name The field name`
`315`	`315`	`*`
`316`		`- * @return FormField The associated Field instance`
	`316`	`+ * @return FormField\|FormField[]\|FormField[][] The value of the field`
`317`	`317`	`*`
`318`	`318`	`* @throws \InvalidArgumentException if the field does not exist`
`319`	`319`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -70,7 +70,7 @@ public function remove($name)`
`70`	`70`	`*`
`71`	`71`	`* @param string $name The fully qualified name of the field`
`72`	`72`	`*`
`73`		`- * @return mixed The value of the field`
	`73`	`+ * @return FormField\|FormField[]\|FormField[][] The value of the field`
`74`	`74`	`*`
`75`	`75`	`* @throws \InvalidArgumentException if the field does not exist`
`76`	`76`	`*/`