Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
00b8785
[WebProfilerBundle][Form] expand forms that contains children with er…
yceruto Jul 11, 2016
a85adae
highlighting full error path
yceruto Jul 26, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 10 additions & 4 deletions src/Symfony/Bundle/WebProfilerBundle/Resources/views/Collector/form.html.twig
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,6 +164,9 @@
font-weight: bold;
vertical-align: middle;
}
.has-error {
color: #B0413E;
}
.errors h3 {
color: #B0413E;
}
Expand Down Expand Up @@ -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 %}

Expand All @@ -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 %}
Expand Down
6 changes: 6 additions & 0 deletions src/Symfony/Component/Form/Extension/DataCollector/FormDataCollector.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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']);
}
}
}

Expand Down
58 changes: 58 additions & 0 deletions src/Symfony/Component/Form/Tests/Extension/DataCollector/FormDataCollectorTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,6 +123,7 @@ public function testBuildPreliminaryFormTree()
'config' => 'foo',
'default_data' => 'foo',
'submitted_data' => 'foo',
'has_children_error' => false,
'children' => array(
'child' => $childFormData,
),
Expand Down Expand Up @@ -323,6 +324,7 @@ public function testBuildFinalFormTree()
'config' => 'foo',
'default_data' => 'foo',
'submitted_data' => 'foo',
'has_children_error' => false,
'children' => array(
'child' => $childFormData,
),
Expand Down Expand Up @@ -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);
Expand Down