[WebProfilerBundle][Form][DX] To expand the form nodes that contains children with errors

yceruto · fabpot · commit d626b285aa24 · 2016-08-22T10:27:17.000-07: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
@@ -164,6 +164,9 @@
             font-weight: bold;
             vertical-align: middle;
         }
+        .has-error {
+            color: #B0413E;
+        }
         .errors h3 {
             color: #B0413E;
         }
@@ -423,11 +426,12 @@
     </script>
 {% endblock %}
 
-{% macro form_tree_entry(name, data, expanded) %}
+{% macro form_tree_entry(name, data, is_root) %}
     {% import _self as tree %}
+    {% set has_error = data.errors is defined and data.errors|length > 0 %}
     <li>
         <div class="tree-inner" data-tab-target-id="{{ data.id }}-details">
-            {% if data.errors is defined and data.errors|length > 0 %}
+            {% if has_error %}
                 <div class="badge-error">{{ data.errors|length }}</div>
             {% endif %}
 
@@ -437,11 +441,13 @@
                 <div class="toggle-icon empty"></div>
             {% endif %}
 
-            {{ name|default('(no name)') }} {% if data.type_class is defined %}[<abbr title="{{ data.type_class }}">{{ data.type_class|split('\\')|last }}</abbr>]{% endif %}
+            <span {% if has_error or data.has_children_error|default(false) %}class="has-error"{% endif %}>
+                {{ name|default('(no name)') }} {% if data.type_class is defined %}[<abbr title="{{ data.type_class }}">{{ data.type_class|split('\\')|last }}</abbr>]{% endif %}
+            </span>
         </div>
 
         {% if data.children is not empty %}
-            <ul id="{{ data.id }}-children" {% if not expanded %}class="hidden"{% endif %}>
+            <ul id="{{ data.id }}-children" {% if not is_root and not data.has_children_error|default(false) %}class="hidden"{% endif %}>
                 {% for childName, childData in data.children %}
                     {{ tree.form_tree_entry(childName, childData, false) }}
                 {% endfor %}
diff --git a/src/Symfony/Component/Form/Extension/DataCollector/FormDataCollector.php b/src/Symfony/Component/Form/Extension/DataCollector/FormDataCollector.php
@@ -155,6 +155,12 @@ public function collectSubmittedData(FormInterface $form)
 
         foreach ($form as $child) {
             $this->collectSubmittedData($child);
+
+            // Expand current form if there are children with errors
+            if (empty($this->dataByForm[$hash]['has_children_error'])) {
+                $childData = $this->dataByForm[spl_object_hash($child)];
+                $this->dataByForm[$hash]['has_children_error'] = !empty($childData['has_children_error']) || !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',
+             'has_children_error' => false,
              'children' => array(
                  'child' => $childFormData,
              ),
@@ -323,6 +324,7 @@ public function testBuildFinalFormTree()
             'config' => 'foo',
             'default_data' => 'foo',
             'submitted_data' => 'foo',
+            'has_children_error' => 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['has_children_error']);
+        $this->assertTrue($child1Data['has_children_error']);
+        $this->assertFalse(isset($child11Data['has_children_error']), 'The leaf data does not contains "has_children_error" property.');
+        $this->assertFalse($child2Data['has_children_error']);
+        $this->assertFalse(isset($child21Data['has_children_error']), 'The leaf data does not contains "has_children_error" property.');
+    }
+
     private function createForm($name)
     {
         $builder = new FormBuilder($name, null, $this->dispatcher, $this->factory);

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