Use "twig" service instead of deprecated "templating" where possible

sonata-project · Aug 10, 2019 · d9406ff · d9406ff
1 parent 7314904
commit d9406ff
Show file tree

Hide file tree

Showing 20 changed files with 194 additions and 142 deletions.
diff --git a/src/Action/CheckEmailAction.php b/src/Action/CheckEmailAction.php
@@ -15,18 +15,18 @@
 
 use Sonata\AdminBundle\Admin\Pool;
 use Sonata\AdminBundle\Templating\TemplateRegistryInterface;
-use Symfony\Bundle\FrameworkBundle\Templating\EngineInterface;
 use Symfony\Component\HttpFoundation\RedirectResponse;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
+use Twig\Environment;
 
 final class CheckEmailAction
 {
     /**
-     * @var EngineInterface
+     * @var Environment
      */
-    private $templating;
+    private $twig;
 
     /**
      * @var UrlGeneratorInterface
@@ -49,13 +49,13 @@ final class CheckEmailAction
     private $resetTtl;
 
     public function __construct(
-        EngineInterface $templating,
+        Environment $twig,
         UrlGeneratorInterface $urlGenerator,
         Pool $adminPool,
         TemplateRegistryInterface $templateRegistry,
         int $resetTtl
     ) {
-        $this->templating = $templating;
+        $this->twig = $twig;
         $this->urlGenerator = $urlGenerator;
         $this->adminPool = $adminPool;
         $this->templateRegistry = $templateRegistry;
@@ -71,10 +71,10 @@ public function __invoke(Request $request): Response
             return new RedirectResponse($this->urlGenerator->generate('sonata_user_admin_resetting_request'));
         }
 
-        return $this->templating->renderResponse('@SonataUser/Admin/Security/Resetting/checkEmail.html.twig', [
+        return new Response($this->twig->render('@SonataUser/Admin/Security/Resetting/checkEmail.html.twig', [
             'base_template' => $this->templateRegistry->getTemplate('layout'),
             'admin_pool' => $this->adminPool,
             'tokenLifetime' => ceil($this->resetTtl / 3600),
-        ]);
+        ]));
     }
 }
diff --git a/src/Action/LoginAction.php b/src/Action/LoginAction.php
@@ -16,7 +16,6 @@
 use Sonata\AdminBundle\Admin\Pool;
 use Sonata\AdminBundle\Templating\TemplateRegistryInterface;
 use Sonata\UserBundle\Model\UserInterface;
-use Symfony\Bundle\FrameworkBundle\Templating\EngineInterface;
 use Symfony\Component\HttpFoundation\RedirectResponse;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
@@ -27,13 +26,14 @@
 use Symfony\Component\Security\Core\Exception\AuthenticationException;
 use Symfony\Component\Security\Core\Security;
 use Symfony\Component\Security\Csrf\CsrfTokenManagerInterface;
+use Twig\Environment;
 
 final class LoginAction
 {
     /**
-     * @var EngineInterface
+     * @var Environment
      */
-    private $templating;
+    private $twig;
 
     /**
      * @var UrlGeneratorInterface
@@ -71,15 +71,15 @@ final class LoginAction
     private $csrfTokenManager;
 
     public function __construct(
-        EngineInterface $templating,
+        Environment $twig,
         UrlGeneratorInterface $urlGenerator,
         AuthorizationCheckerInterface $authorizationChecker,
         Pool $adminPool,
         TemplateRegistryInterface $templateRegistry,
         TokenStorageInterface $tokenStorage,
         Session $session
     ) {
-        $this->templating = $templating;
+        $this->twig = $twig;
         $this->urlGenerator = $urlGenerator;
         $this->authorizationChecker = $authorizationChecker;
         $this->adminPool = $adminPool;
@@ -126,14 +126,14 @@ public function __invoke(Request $request): Response
             $csrfToken = $this->csrfTokenManager->getToken('authenticate')->getValue();
         }
 
-        return $this->templating->renderResponse('@SonataUser/Admin/Security/login.html.twig', [
+        return new Response($this->twig->render('@SonataUser/Admin/Security/login.html.twig', [
             'admin_pool' => $this->adminPool,
             'base_template' => $this->templateRegistry->getTemplate('layout'),
             'csrf_token' => $csrfToken,
             'error' => $error,
             'last_username' => (null === $session) ? '' : $session->get(Security::LAST_USERNAME),
             'reset_route' => $this->urlGenerator->generate('sonata_user_admin_resetting_request'),
-        ]);
+        ]));
     }
 
     public function setCsrfTokenManager(CsrfTokenManagerInterface $csrfTokenManager): void

diff --git a/src/Action/RequestAction.php b/src/Action/RequestAction.php
@@ -15,19 +15,19 @@
 
 use Sonata\AdminBundle\Admin\Pool;
 use Sonata\AdminBundle\Templating\TemplateRegistryInterface;
-use Symfony\Bundle\FrameworkBundle\Templating\EngineInterface;
 use Symfony\Component\HttpFoundation\RedirectResponse;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
 use Symfony\Component\Security\Core\Authorization\AuthorizationCheckerInterface;
+use Twig\Environment;
 
 final class RequestAction
 {
     /**
-     * @var EngineInterface
+     * @var Environment
      */
-    private $templating;
+    private $twig;
 
     /**
      * @var UrlGeneratorInterface
@@ -50,13 +50,13 @@ final class RequestAction
     private $templateRegistry;
 
     public function __construct(
-        EngineInterface $templating,
+        Environment $twig,
         UrlGeneratorInterface $urlGenerator,
         AuthorizationCheckerInterface $authorizationChecker,
         Pool $adminPool,
         TemplateRegistryInterface $templateRegistry
     ) {
-        $this->templating = $templating;
+        $this->twig = $twig;
         $this->urlGenerator = $urlGenerator;
         $this->authorizationChecker = $authorizationChecker;
         $this->adminPool = $adminPool;
@@ -69,9 +69,9 @@ public function __invoke(Request $request): Response
             return new RedirectResponse($this->urlGenerator->generate('sonata_admin_dashboard'));
         }
 
-        return $this->templating->renderResponse('@SonataUser/Admin/Security/Resetting/request.html.twig', [
+        return new Response($this->twig->render('@SonataUser/Admin/Security/Resetting/request.html.twig', [
             'base_template' => $this->templateRegistry->getTemplate('layout'),
             'admin_pool' => $this->adminPool,
-        ]);
+        ]));
     }
 }
diff --git a/src/Action/ResetAction.php b/src/Action/ResetAction.php
@@ -20,7 +20,6 @@
 use Psr\Log\NullLogger;
 use Sonata\AdminBundle\Admin\Pool;
 use Sonata\AdminBundle\Templating\TemplateRegistryInterface;
-use Symfony\Bundle\FrameworkBundle\Templating\EngineInterface;
 use Symfony\Component\HttpFoundation\RedirectResponse;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
@@ -30,15 +29,16 @@
 use Symfony\Component\Security\Core\Authorization\AuthorizationCheckerInterface;
 use Symfony\Component\Security\Core\Exception\AccountStatusException;
 use Symfony\Component\Translation\TranslatorInterface;
+use Twig\Environment;
 
 final class ResetAction
 {
     use LoggerAwareTrait;
 
     /**
-     * @var EngineInterface
+     * @var Environment
      */
-    private $templating;
+    private $twig;
 
     /**
      * @var UrlGeneratorInterface
@@ -96,7 +96,7 @@ final class ResetAction
     private $firewallName;
 
     public function __construct(
-        EngineInterface $templating,
+        Environment $twig,
         UrlGeneratorInterface $urlGenerator,
         AuthorizationCheckerInterface $authorizationChecker,
         Pool $adminPool,
@@ -109,7 +109,7 @@ public function __construct(
         int $resetTtl,
         string $firewallName
     ) {
-        $this->templating = $templating;
+        $this->twig = $twig;
         $this->urlGenerator = $urlGenerator;
         $this->authorizationChecker = $authorizationChecker;
         $this->adminPool = $adminPool;
@@ -172,11 +172,11 @@ public function __invoke(Request $request, $token): Response
             return $response;
         }
 
-        return $this->templating->renderResponse('@SonataUser/Admin/Security/Resetting/reset.html.twig', [
+        return new Response($this->twig->render('@SonataUser/Admin/Security/Resetting/reset.html.twig', [
             'token' => $token,
             'form' => $form->createView(),
             'base_template' => $this->templateRegistry->getTemplate('layout'),
             'admin_pool' => $this->adminPool,
-        ]);
+        ]));
     }
 }
diff --git a/src/Action/SendEmailAction.php b/src/Action/SendEmailAction.php
@@ -18,18 +18,18 @@
 use FOS\UserBundle\Util\TokenGeneratorInterface;
 use Sonata\AdminBundle\Admin\Pool;
 use Sonata\AdminBundle\Templating\TemplateRegistryInterface;
-use Symfony\Bundle\FrameworkBundle\Templating\EngineInterface;
 use Symfony\Component\HttpFoundation\RedirectResponse;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
+use Twig\Environment;
 
 final class SendEmailAction
 {
     /**
-     * @var EngineInterface
+     * @var Environment
      */
-    private $templating;
+    private $twig;
 
     /**
      * @var UrlGeneratorInterface
@@ -67,7 +67,7 @@ final class SendEmailAction
     private $resetTtl;
 
     public function __construct(
-        EngineInterface $templating,
+        Environment $twig,
         UrlGeneratorInterface $urlGenerator,
         Pool $adminPool,
         TemplateRegistryInterface $templateRegistry,
@@ -76,7 +76,7 @@ public function __construct(
         TokenGeneratorInterface $tokenGenerator,
         int $resetTtl
     ) {
-        $this->templating = $templating;
+        $this->twig = $twig;
         $this->urlGenerator = $urlGenerator;
         $this->adminPool = $adminPool;
         $this->templateRegistry = $templateRegistry;
@@ -93,11 +93,11 @@ public function __invoke(Request $request): Response
         $user = $this->userManager->findUserByUsernameOrEmail($username);
 
         if (null === $user) {
-            return $this->templating->renderResponse('@SonataUser/Admin/Security/Resetting/request.html.twig', [
+            return new Response($this->twig->render('@SonataUser/Admin/Security/Resetting/request.html.twig', [
                 'base_template' => $this->templateRegistry->getTemplate('layout'),
                 'admin_pool' => $this->adminPool,
                 'invalid_username' => $username,
-            ]);
+            ]));
         }
 
         if (null !== $user && !$user->isPasswordRequestNonExpired($this->resetTtl)) {

diff --git a/src/EventListener/TwoFactorLoginSuccessHandler.php b/src/EventListener/TwoFactorLoginSuccessHandler.php
@@ -16,13 +16,13 @@
 use FOS\UserBundle\Model\UserManagerInterface;
 use Sonata\UserBundle\GoogleAuthenticator\Helper;
 use Sonata\UserBundle\Model\User;
-use Symfony\Bundle\FrameworkBundle\Templating\EngineInterface;
 use Symfony\Component\HttpFoundation\RedirectResponse;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
 use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
 use Symfony\Component\Security\Http\Authentication\AuthenticationSuccessHandlerInterface;
+use Twig\Environment;
 
 /**
  * Class TwoFactorLoginSuccessHandler is used for handling 2FA authorization for enabled roles and ips.
@@ -32,7 +32,7 @@
 final class TwoFactorLoginSuccessHandler implements AuthenticationSuccessHandlerInterface
 {
     /**
-     * @var EngineInterface
+     * @var Environment
      */
     private $engine;
 
@@ -52,7 +52,7 @@ final class TwoFactorLoginSuccessHandler implements AuthenticationSuccessHandler
     private $urlGenerator;
 
     public function __construct(
-        EngineInterface $engine,
+        Environment $engine,
         Helper $helper,
         UserManagerInterface $userManager,
         UrlGeneratorInterface $urlGenerator = null // NEXT_MAJOR: make it mandatory.
@@ -66,7 +66,7 @@ public function __construct(
     /**
      * @return RedirectResponse|Response
      */
-    public function onAuthenticationSuccess(Request $request, TokenInterface $token)
+    public function onAuthenticationSuccess(Request $request, TokenInterface $token): Response
     {
         /** @var $user User */
         $user = $token->getUser();
@@ -79,15 +79,15 @@ public function onAuthenticationSuccess(Request $request, TokenInterface $token)
             $qrCodeUrl = $this->googleAuthenticator->getUrl($user);
             $this->userManager->updateUser($user);
 
-            return $this->engine->renderResponse(
+            return new Response($this->engine->render(
                 '@SonataUser/Admin/Security/login.html.twig',
                 [
                     'qrCodeUrl' => $qrCodeUrl,
                     'qrSecret' => $secret,
                     'base_template' => '@SonataAdmin/standard_layout.html.twig',
                     'error' => [],
                 ]
-            );
+            ));
         } elseif ($needToHave2FA && $user->getTwoStepVerificationCode()) {
             $request->getSession()->set($this->googleAuthenticator->getSessionKey($token), null);
         }