[FrameworkBundle] Add AbstractController::renderBlock() and $block argument to renderView()

nicolas-grekas · nicolas-grekas · commit 29a7ae9c15ab · 2023-08-09T19:43:45.000+02:00
diff --git a/UPGRADE-6.4.md b/UPGRADE-6.4.md
@@ -78,6 +78,7 @@ FrameworkBundle
 ---------------
 
  * [BC break] Add native return type to `Translator` and to `Application::reset()`
+ * Add `$block` argument to `AbstractController::renderView()`
  * Deprecate the integration of Doctrine annotations, either uninstall the `doctrine/annotations` package or disable
    the integration by setting `framework.annotations` to `false`
 
diff --git a/src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md b/src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md
@@ -4,6 +4,7 @@ CHANGELOG
 6.4
 ---
 
+ * Add `AbstractController::renderBlock()` and `$block` argument to `renderView()`
  * Add native return type to `Translator` and to `Application::reset()`
  * Deprecate the integration of Doctrine annotations, either uninstall the `doctrine/annotations` package or disable the integration by setting `framework.annotations` to `false`
  * Enable `json_decode_detailed_errors` context for Serializer by default if `kernel.debug` is true and the `seld/jsonlint` package is installed
diff --git a/src/Symfony/Bundle/FrameworkBundle/Controller/AbstractController.php b/src/Symfony/Bundle/FrameworkBundle/Controller/AbstractController.php
@@ -226,9 +226,13 @@ protected function denyAccessUnlessGranted(mixed $attribute, mixed $subject = nu
      * Returns a rendered view.
      *
      * Forms found in parameters are auto-cast to form views.
+     *
+     * @param string|null $block
      */
-    protected function renderView(string $view, array $parameters = []): string
+    protected function renderView(string $view, array $parameters = []/* , string $block = null */): string
     {
+        $block = 2 < \func_num_args() ? func_get_arg(2) : null;
+
         if (!$this->container->has('twig')) {
             throw new \LogicException('You cannot use the "renderView" method if the Twig Bundle is not available. Try running "composer require symfony/twig-bundle".');
         }
@@ -239,6 +243,10 @@ protected function renderView(string $view, array $parameters = []): string
             }
         }
 
+        if (null !== $block) {
+            return $this->container->get('twig')->load($view)->renderBlock($block, $parameters);
+        }
+
         return $this->container->get('twig')->render($view, $parameters);
     }
 
@@ -250,21 +258,18 @@ protected function renderView(string $view, array $parameters = []): string
      */
     protected function render(string $view, array $parameters = [], Response $response = null): Response
     {
-        $content = $this->renderView($view, $parameters);
-        $response ??= new Response();
-
-        if (200 === $response->getStatusCode()) {
-            foreach ($parameters as $v) {
-                if ($v instanceof FormInterface && $v->isSubmitted() && !$v->isValid()) {
-                    $response->setStatusCode(422);
-                    break;
-                }
-            }
-        }
-
-        $response->setContent($content);
+        return $this->doRender($view, null, $parameters, $response);
+    }
 
-        return $response;
+    /**
+     * Renders a block in a view.
+     *
+     * If an invalid form is found in the list of parameters, a 422 status code is returned.
+     * Forms found in parameters are auto-cast to form views.
+     */
+    protected function renderBlock(string $view, string $block, array $parameters = [], Response $response = null): Response
+    {
+        return $this->doRender($view, $block, $parameters, $response);
     }
 
     /**
@@ -431,4 +436,23 @@ protected function sendEarlyHints(iterable $links = [], Response $response = nul
 
         return $response;
     }
+
+    private function doRender(string $view, ?string $block, array $parameters, ?Response $response): Response
+    {
+        $content = $this->renderView($view, $parameters, $block);
+        $response ??= new Response();
+
+        if (200 === $response->getStatusCode()) {
+            foreach ($parameters as $v) {
+                if ($v instanceof FormInterface && $v->isSubmitted() && !$v->isValid()) {
+                    $response->setStatusCode(422);
+                    break;
+                }
+            }
+        }
+
+        $response->setContent($content);
+
+        return $response;
+    }
 }
