[Form] Deprecate searchAndRenderBlock returning empty string

ostrolucky · ostrolucky · commit 259ef8bd0839 · 2018-05-15T21:20:53.000+02:00
diff --git a/UPGRADE-4.2.md b/UPGRADE-4.2.md
@@ -0,0 +1,24 @@
+UPGRADE FROM 4.1 to 4.2
+=======================
+
+Form
+----
+
+ * Deprecated calling `FormRenderer::searchAndRenderBlock` for fields which were already rendered. 
+ Instead of expecting such calls return empty string, check if field has already been rendered.
+ 
+ Before:
+ ```twig
+ {% for field in fieldsWithPotentialDuplicates %}
+    {{ form_widget(field) }}
+ {% endfor %}
+ ```
+ 
+ After:
+ ```twig
+ {% for field in fieldsWithPotentialDuplicates %}
+   {% if not field.rendered %}
+    {{ form_widget(field) }}
+   {% endif %}
+ {% endfor %}
+ ```
diff --git a/src/Symfony/Bridge/Twig/Resources/views/Form/form_div_layout.html.twig b/src/Symfony/Bridge/Twig/Resources/views/Form/form_div_layout.html.twig
@@ -22,7 +22,6 @@
         {%- if form is rootform -%}
             {{ form_errors(form) }}
         {%- endif -%}
-        {{- block('form_rows') -}}
         {{- form_rest(form) -}}
     </div>
 {%- endblock form_widget_compound -%}
diff --git a/src/Symfony/Bundle/FrameworkBundle/Resources/views/Form/form_widget_compound.html.php b/src/Symfony/Bundle/FrameworkBundle/Resources/views/Form/form_widget_compound.html.php
@@ -2,6 +2,5 @@
     <?php if (!$form->parent && $errors): ?>
     <?php echo $view['form']->errors($form) ?>
     <?php endif ?>
-    <?php echo $view['form']->block($form, 'form_rows') ?>
     <?php echo $view['form']->rest($form) ?>
 </div>
diff --git a/src/Symfony/Component/Form/CHANGELOG.md b/src/Symfony/Component/Form/CHANGELOG.md
@@ -1,6 +1,11 @@
 CHANGELOG
 =========
 
+4.2.0
+-----
+
+ * deprecated calling `FormRenderer::searchAndRenderBlock` for fields which were already rendered.
+
 4.1.0
 -----
 
diff --git a/src/Symfony/Component/Form/FormRenderer.php b/src/Symfony/Component/Form/FormRenderer.php
@@ -132,6 +132,9 @@ public function searchAndRenderBlock(FormView $view, $blockNameSuffix, array $va
         $renderOnlyOnce = 'row' === $blockNameSuffix || 'widget' === $blockNameSuffix;
 
         if ($renderOnlyOnce && $view->isRendered()) {
+            // This is not allowed, because it would result in rendering same IDs multiple times, which is not valid.
+            @trigger_error(sprintf('Calling the "%s()" method for fields which were already rendered is deprecated since Symfony 4.1 and will throw an exception in 5.0.', __METHOD__), E_USER_DEPRECATED);
+            // throw new BadMethodCallException(sprintf('Field "%s" has already been rendered. Save result of previous  render call to variable and output that instead.'));
             return '';
         }
 

Original file line number	Diff line number	Diff line change
`@@ -132,6 +132,9 @@ public function searchAndRenderBlock(FormView $view, $blockNameSuffix, array $va`
`132`	`132`	`$renderOnlyOnce = 'row' === $blockNameSuffix \|\| 'widget' === $blockNameSuffix;`
`133`	`133`
`134`	`134`	`if ($renderOnlyOnce && $view->isRendered()) {`
	`135`	`+ // This is not allowed, because it would result in rendering same IDs multiple times, which is not valid.`
	`136`	`+ @trigger_error(sprintf('Calling the "%s()" method for fields which were already rendered is deprecated since Symfony 4.1 and will throw an exception in 5.0.', __METHOD__), E_USER_DEPRECATED);`
	`137`	`+ // throw new BadMethodCallException(sprintf('Field "%s" has already been rendered. Save result of previous render call to variable and output that instead.'));`
`135`	`138`	`return '';`
`136`	`139`	`}`
`137`	`140`