diogo
/
symfony
Archived
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

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

This commit is contained in:
Javier Eguiluz 2020-03-24 10:56:49 +01:00 committed by Fabien Potencier
parent b9d41490fe
commit 7b9ff2a445
3 changed files with 26 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
UPGRADE-5.1.md
View File

@ -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
--------------

34
src/Symfony/Bundle/FrameworkBundle/Controller/AbstractController.php
View File

@ -239,22 +239,34 @@ abstract class AbstractController implements ServiceSubscriberInterface
/**
* Returns a rendered view.
*
* @deprecated since Symfony 5.1, use renderTemplate() instead.
*/
protected function renderView(string $view, 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".');
}
trigger_deprecation('symfony/framework-bundle', '5.1', 'The "%s" method is deprecated, use "renderTemplate()" instead.', __METHOD__);
return $this->container->get('twig')->render($view, $parameters);
return $this->renderTemplate($view, $parameters);
}
/**
* Renders a view.
* Returns a rendered template.
*/
protected function render(string $view, array $parameters = [], Response $response = null): Response
protected function renderTemplate(string $templateName, array $parameters = []): string
{
$content = $this->renderView($view, $parameters);
if (!$this->container->has('twig')) {
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($templateName, $parameters);
}
/**
* Renders a template.
*/
protected function render(string $templateName, array $parameters = [], Response $response = null): Response
{
$content = $this->renderTemplate($templateName, $parameters);
if (null === $response) {
$response = new Response();
@ -266,9 +278,9 @@ abstract class AbstractController implements ServiceSubscriberInterface
}
/**
* 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".');
@ -276,8 +288,8 @@ abstract class AbstractController implements ServiceSubscriberInterface
$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) {

4
src/Symfony/Bundle/FrameworkBundle/Tests/Controller/AbstractControllerTest.php
View File

@ -369,7 +369,7 @@ class AbstractControllerTest extends TestCase
$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 @@ class AbstractControllerTest extends TestCase
$controller = $this->createController();
$controller->setContainer($container);
$this->assertEquals('bar', $controller->renderView('foo'));
$this->assertEquals('bar', $controller->renderTemplate('foo'));
}
public function testRenderTwig()