[WebProfilerBundle][Form] expand forms that contains children with errors

yceruto · yceruto · commit 587fa4369c78 · 2016-07-11T11:23:00.000-04:00
diff --git a/src/Symfony/Bundle/WebProfilerBundle/Resources/views/Collector/form.html.twig b/src/Symfony/Bundle/WebProfilerBundle/Resources/views/Collector/form.html.twig
@@ -443,7 +443,7 @@
         {% if data.children is not empty %}
             <ul id="{{ data.id }}-children" {% if not expanded %}class="hidden"{% endif %}>
                 {% for childName, childData in data.children %}
-                    {{ tree.form_tree_entry(childName, childData, false) }}
+                    {{ tree.form_tree_entry(childName, childData, childData.expanded|default(false)) }}
                 {% endfor %}
             </ul>
         {% endif %}
diff --git a/src/Symfony/Component/Form/Extension/DataCollector/FormDataCollector.php b/src/Symfony/Component/Form/Extension/DataCollector/FormDataCollector.php
@@ -157,6 +157,12 @@ public function collectSubmittedData(FormInterface $form)
 
         foreach ($form as $child) {
             $this->collectSubmittedData($child);
+
+            // Expand current form if there are children expanded or with errors
+            if (empty($this->dataByForm[$hash]['expanded'])) {
+                $childData = $this->dataByForm[spl_object_hash($child)];
+                $this->dataByForm[$hash]['expanded'] = !empty($childData['expanded']) || !empty($childData['errors']);
+            }
         }
     }
 
diff --git a/src/Symfony/Component/Form/Tests/Extension/DataCollector/FormDataCollectorTest.php b/src/Symfony/Component/Form/Tests/Extension/DataCollector/FormDataCollectorTest.php
@@ -123,6 +123,7 @@ public function testBuildPreliminaryFormTree()
              'config' => 'foo',
              'default_data' => 'foo',
              'submitted_data' => 'foo',
+             'expanded' => false,
              'children' => array(
                  'child' => $childFormData,
              ),
@@ -323,6 +324,7 @@ public function testBuildFinalFormTree()
             'config' => 'foo',
             'default_data' => 'foo',
             'submitted_data' => 'foo',
+            'expanded' => false,
             'children' => array(
                 'child' => $childFormData,
             ),
@@ -528,6 +530,62 @@ public function testCollectSubmittedDataCountsErrors()
         $this->assertSame(4, $data['nb_errors']);
     }
 
+    public function testCollectSubmittedDataExpandedFormsErrors()
+    {
+        $child1Form = $this->createForm('child1');
+        $child11Form = $this->createForm('child11');
+        $child2Form = $this->createForm('child2');
+        $child21Form = $this->createForm('child21');
+
+        $child1Form->add($child11Form);
+        $child2Form->add($child21Form);
+        $this->form->add($child1Form);
+        $this->form->add($child2Form);
+
+        $this->dataExtractor
+            ->method('extractConfiguration')
+            ->will($this->returnValue(array()));
+        $this->dataExtractor
+            ->method('extractDefaultData')
+            ->will($this->returnValue(array()));
+        $this->dataExtractor->expects($this->at(10))
+            ->method('extractSubmittedData')
+            ->with($this->form)
+            ->will($this->returnValue(array('errors' => array())));
+        $this->dataExtractor->expects($this->at(11))
+            ->method('extractSubmittedData')
+            ->with($child1Form)
+            ->will($this->returnValue(array('errors' => array())));
+        $this->dataExtractor->expects($this->at(12))
+            ->method('extractSubmittedData')
+            ->with($child11Form)
+            ->will($this->returnValue(array('errors' => array('foo'))));
+        $this->dataExtractor->expects($this->at(13))
+            ->method('extractSubmittedData')
+            ->with($child2Form)
+            ->will($this->returnValue(array('errors' => array())));
+        $this->dataExtractor->expects($this->at(14))
+            ->method('extractSubmittedData')
+            ->with($child21Form)
+            ->will($this->returnValue(array('errors' => array())));
+
+        $this->dataCollector->collectSubmittedData($this->form);
+        $this->dataCollector->buildPreliminaryFormTree($this->form);
+
+        $data = $this->dataCollector->getData();
+        $formData = $data['forms']['name'];
+        $child1Data = $formData['children']['child1'];
+        $child11Data = $child1Data['children']['child11'];
+        $child2Data = $formData['children']['child2'];
+        $child21Data = $child2Data['children']['child21'];
+
+        $this->assertTrue($formData['expanded']);
+        $this->assertTrue($child1Data['expanded']);
+        $this->assertFalse(isset($child11Data['expanded']), 'The leaf data does not contains "expanded" property.');
+        $this->assertFalse($child2Data['expanded']);
+        $this->assertFalse(isset($child21Data['expanded']), 'The leaf data does not contains "expanded" property.');
+    }
+
     private function createForm($name)
     {
         $builder = new FormBuilder($name, null, $this->dispatcher, $this->factory);

Original file line number	Diff line number	Diff line change
`@@ -157,6 +157,12 @@ public function collectSubmittedData(FormInterface $form)`
`157`	`157`
`158`	`158`	`foreach ($form as $child) {`
`159`	`159`	`$this->collectSubmittedData($child);`
	`160`	`+`
	`161`	`+ // Expand current form if there are children expanded or with errors`
	`162`	`+ if (empty($this->dataByForm[$hash]['expanded'])) {`
	`163`	`+ $childData = $this->dataByForm[spl_object_hash($child)];`
	`164`	`+ $this->dataByForm[$hash]['expanded'] = !empty($childData['expanded']) \|\| !empty($childData['errors']);`
	`165`	`+ }`
`160`	`166`	`}`
`161`	`167`	`}`
`162`	`168`