[Form] Deprecate searchAndRenderBlock returning empty string

ostrolucky · ostrolucky · commit ad0430265aff · 2018-05-13T01:52:23.000+02:00
diff --git a/UPGRADE-4.1.md b/UPGRADE-4.1.md
@@ -63,6 +63,24 @@ 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 fields %}
+    {{ form_widget(field) }}
+ {% endfor %}
+ ```
+ 
+ After:
+ ```twig
+ {% for field in fields %}
+   {% if not field.rendered %}
+    {{ form_widget(field) }}
+   {% endif %}
+ {% endfor %}
+ ```
 
 FrameworkBundle
 ---------------
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
@@ -398,7 +398,7 @@
 {# Support #}
 
 {%- block form_rows -%}
-    {% for child in form %}
+    {% for child in form if not child.rendered %}
         {{- form_row(child) -}}
     {% endfor %}
 {%- endblock form_rows -%}
diff --git a/src/Symfony/Bundle/FrameworkBundle/Resources/views/Form/form_rows.html.php b/src/Symfony/Bundle/FrameworkBundle/Resources/views/Form/form_rows.html.php
@@ -1,3 +1,5 @@
 <?php foreach ($form as $child) : ?>
-    <?php echo $view['form']->row($child) ?>
+    <?php if (!$child->isRendered()): ?>
+        <?php echo $view['form']->row($child) ?>
+    <?php endif ?>
 <?php endforeach; ?>
diff --git a/src/Symfony/Component/Form/CHANGELOG.md b/src/Symfony/Component/Form/CHANGELOG.md
@@ -10,6 +10,7 @@ CHANGELOG
  * deprecated the `ChoiceLoaderInterface` implementation in `CountryType`, `LanguageType`, `LocaleType` and `CurrencyType`
  * added `input=datetime_immutable` to DateType, TimeType, DateTimeType
  * added `rounding_mode` option to MoneyType
+ * deprecated calling `FormRenderer::searchAndRenderBlock` for fields which were already rendered.
 
 4.0.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`