[FrameworkBundle] Deprecate renderView() in favor of renderTemplate()

javiereguiluz · fabpot · commit 7b9ff2a445ff · 2020-05-05T08:26:27.000+02:00
diff --git a/UPGRADE-5.1.md b/UPGRADE-5.1.md
@@ -54,6 +54,7 @@ FrameworkBundle
  * Deprecated passing a `RouteCollectionBuilder` to `MicroKernelTrait::configureRoutes()`, type-hint `RoutingConfigurator` instead
  * Deprecated *not* setting the "framework.router.utf8" configuration option as it will default to `true` in Symfony 6.0
  * Deprecated `session.attribute_bag` service and `session.flash_bag` service.
+ * Deprecated the `AbstractController::renderView()` method in favor of `AbstractController::renderTemplate()`
 
 HttpFoundation
 --------------
diff --git a/src/Symfony/Bundle/FrameworkBundle/Controller/AbstractController.php b/src/Symfony/Bundle/FrameworkBundle/Controller/AbstractController.php
@@ -239,22 +239,34 @@ protected function denyAccessUnlessGranted($attributes, $subject = null, string
 
     /**
      * Returns a rendered view.
+     *
+     * @deprecated since Symfony 5.1, use renderTemplate() instead.
      */
     protected function renderView(string $view, array $parameters = []): string
+    {
+        trigger_deprecation('symfony/framework-bundle', '5.1', 'The "%s" method is deprecated, use "renderTemplate()" instead.', __METHOD__);
+
+        return $this->renderTemplate($view, $parameters);
+    }
+
+    /**
+     * Returns a rendered template.
+     */
+    protected function renderTemplate(string $templateName, array $parameters = []): string
     {
         if (!$this->container->has('twig')) {
-            throw new \LogicException('You can not use the "renderView" method if the Twig Bundle is not available. Try running "composer require symfony/twig-bundle".');
+            throw new \LogicException('You can not use the "renderTemplate()" method if the Twig Bundle is not available. Try running "composer require symfony/twig-bundle".');
         }
 
-        return $this->container->get('twig')->render($view, $parameters);
+        return $this->container->get('twig')->render($templateName, $parameters);
     }
 
     /**
-     * Renders a view.
+     * Renders a template.
      */
-    protected function render(string $view, array $parameters = [], Response $response = null): Response
+    protected function render(string $templateName, array $parameters = [], Response $response = null): Response
     {
-        $content = $this->renderView($view, $parameters);
+        $content = $this->renderTemplate($templateName, $parameters);
 
         if (null === $response) {
             $response = new Response();
@@ -266,18 +278,18 @@ protected function render(string $view, array $parameters = [], Response $respon
     }
 
     /**
-     * Streams a view.
+     * Streams a template.
      */
-    protected function stream(string $view, array $parameters = [], StreamedResponse $response = null): StreamedResponse
+    protected function stream(string $templatePath, array $parameters = [], StreamedResponse $response = null): StreamedResponse
     {
         if (!$this->container->has('twig')) {
             throw new \LogicException('You can not use the "stream" method if the Twig Bundle is not available. Try running "composer require symfony/twig-bundle".');
         }
 
         $twig = $this->container->get('twig');
 
-        $callback = function () use ($twig, $view, $parameters) {
-            $twig->display($view, $parameters);
+        $callback = function () use ($twig, $templatePath, $parameters) {
+            $twig->display($templatePath, $parameters);
         };
 
         if (null === $response) {
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Controller/AbstractControllerTest.php b/src/Symfony/Bundle/FrameworkBundle/Tests/Controller/AbstractControllerTest.php
@@ -369,7 +369,7 @@ public function testdenyAccessUnlessGranted()
         $controller->denyAccessUnlessGranted('foo');
     }
 
-    public function testRenderViewTwig()
+    public function testRenderTemplateTwig()
     {
         $twig = $this->getMockBuilder('Twig\Environment')->disableOriginalConstructor()->getMock();
         $twig->expects($this->once())->method('render')->willReturn('bar');
@@ -380,7 +380,7 @@ public function testRenderViewTwig()
         $controller = $this->createController();
         $controller->setContainer($container);
 
-        $this->assertEquals('bar', $controller->renderView('foo'));
+        $this->assertEquals('bar', $controller->renderTemplate('foo'));
     }
 
     public function testRenderTwig()

Original file line number	Diff line number	Diff line change
`@@ -369,7 +369,7 @@ public function testdenyAccessUnlessGranted()`
`369`	`369`	`$controller->denyAccessUnlessGranted('foo');`
`370`	`370`	`}`
`371`	`371`
`372`		`- public function testRenderViewTwig()`
	`372`	`+ public function testRenderTemplateTwig()`
`373`	`373`	`{`
`374`	`374`	`$twig = $this->getMockBuilder('Twig\Environment')->disableOriginalConstructor()->getMock();`
`375`	`375`	`$twig->expects($this->once())->method('render')->willReturn('bar');`
`@@ -380,7 +380,7 @@ public function testRenderViewTwig()`
`380`	`380`	`$controller = $this->createController();`
`381`	`381`	`$controller->setContainer($container);`
`382`	`382`
`383`		`- $this->assertEquals('bar', $controller->renderView('foo'));`
	`383`	`+ $this->assertEquals('bar', $controller->renderTemplate('foo'));`
`384`	`384`	`}`
`385`	`385`
`386`	`386`	`public function testRenderTwig()`< 3885 /td>