[FIX] Use latest BE module template API (replace legacy view)

Needed for upcoming TYPO3 13 LTS release. https://docs.typo3.org/c/typo3/cms-core/main/en-us/Changelog/12.0/Feature-96730-SimplifiedExtbackendModuleTemplateAPI.html
fnagel · Mar 26, 2024 · 3cfe6e8 · 3cfe6e8
1 parent e39105d
commit 3cfe6e8
Show file tree

Hide file tree

Showing 7 changed files with 29 additions and 25 deletions.
diff --git a/Classes/Controller/AbstractBackendController.php b/Classes/Controller/AbstractBackendController.php
@@ -100,18 +100,17 @@ protected function initializeView()
             $dateTimeFormat = trim($this->settings['backend']['dateTimeFormat']);
         }
 
-        $this->view->assignMultiple([
+        $this->moduleTemplate = $this->moduleTemplateFactory->create($this->request);
+
+        $this->moduleTemplate->assignMultiple([
             'pageId' => $this->pageId,
             'dateTimeFormat' => $dateTimeFormat,
             'pageNotice' => $this->pageInfo,
         ]);
 
-        $this->moduleTemplate = $this->moduleTemplateFactory->create($this->request);
-
         // Configure module header
         $moduleService = GeneralUtility::makeInstance(
             BackendModuleService::class,
-            $this->view,
             $this->moduleTemplate,
             $this->pageId
         );
@@ -221,27 +220,26 @@ protected function initializeAction()
         }
     }
 
-    protected function moduleResponse(): ResponseInterface
+    protected function moduleResponse(string $templateFileName): ResponseInterface
     {
-        $this->moduleTemplate->setContent($this->view->render());
-
-        return $this->htmlResponse($this->moduleTemplate->renderContent());
+        return $this->moduleTemplate->renderResponse('Backend'.$templateFileName);
     }
 
     protected function paginationHtmlResponse(
+        string $templateFileName,
         QueryResultInterface $result,
         array $paginationConfig,
         int $page = 1
     ): ResponseInterface {
         $paginator = new QueryResultPaginator($result, $page, (int)$paginationConfig['itemsPerPage'] ?: 10);
 
-        $this->view->assignMultiple([
+        $this->moduleTemplate->assignMultiple([
             'totalAmountOfItems' => $result->count(),
             'paginator' => $paginator,
             'pagination' => new SimplePagination($paginator),
         ]);
 
-        return $this->moduleResponse();
+        return $this->moduleResponse($templateFileName);
     }
 
     /**

diff --git a/Classes/Controller/BackendCommentController.php b/Classes/Controller/BackendCommentController.php
@@ -24,9 +24,10 @@ class BackendCommentController extends AbstractBackendController
      */
     public function indexAction(int $page = 1): ResponseInterface
     {
-        $this->view->assign('pendingCommentsCount', $this->commentRepository->countPendingByPage($this->pageId));
+        $this->moduleTemplate->assign('pendingCommentsCount', $this->commentRepository->countPendingByPage($this->pageId));
 
         return $this->response(
+            'Index',
             $this->commentRepository->findByPage($this->pageId),
             $page
         );
@@ -38,6 +39,7 @@ public function indexAction(int $page = 1): ResponseInterface
     public function listPendingAction(int $page = 1): ResponseInterface
     {
         return $this->response(
+            'ListPending',
             $this->commentRepository->findPendingByPage($this->pageId),
             $page
         );
@@ -54,14 +56,16 @@ public function listByPostAction(Post $post, int $page = 1): ResponseInterface
         ]);
 
         return $this->response(
+            'ListByPost',
             $this->commentRepository->findByPost($post, false),
             $page
         );
     }
 
-    protected function response(QueryResultInterface $result, int $page = 1): ResponseInterface
+    protected function response(string $templateFileName, QueryResultInterface $result, int $page = 1): ResponseInterface
     {
         return $this->paginationHtmlResponse(
+            'Comment/'.$templateFileName,
             $result,
             $this->settings['backend']['comments']['paginate'],
             $page

diff --git a/Classes/Controller/BackendDashboardController.php b/Classes/Controller/BackendDashboardController.php
@@ -22,12 +22,12 @@ class BackendDashboardController extends AbstractBackendController
     public function indexAction(): ResponseInterface
     {
         if (!isset($this->settings['backend'])) {
-            return $this->moduleResponse();
+            return $this->moduleResponse('Dashboard/Index');
         }
 
         $settings = $this->settings['backend']['dashboard'];
 
-        $this->view->assignMultiple([
+        $this->moduleTemplate->assignMultiple([
             'postDrafts' => $this->postRepository->findDrafts(
                 $this->pageId,
                 (int)$settings['postDrafts']['paginate']['itemsPerPage']
@@ -55,6 +55,6 @@ public function indexAction(): ResponseInterface
             'validBlogSubscribersCount' => $this->blogSubscriberRepository->findByPage($this->pageId)->count(),
         ]);
 
-        return $this->moduleResponse();
+        return $this->moduleResponse('Dashboard/Index');
     }
 }
diff --git a/Classes/Controller/BackendPostController.php b/Classes/Controller/BackendPostController.php
@@ -26,6 +26,7 @@ class BackendPostController extends AbstractBackendController
     public function indexAction(int $page = 1): ResponseInterface
     {
         return $this->paginationHtmlResponse(
+            'Post/Index',
             $this->postRepository->findByPage($this->pageId, false),
             $this->settings['backend']['posts']['paginate'],
             $page

diff --git a/Classes/Controller/BackendSubscriberController.php b/Classes/Controller/BackendSubscriberController.php
@@ -22,6 +22,7 @@ class BackendSubscriberController extends AbstractBackendController
     public function indexPostSubscriberAction(int $page = 1): ResponseInterface
     {
         return $this->paginationHtmlResponse(
+            'Subscriber/IndexPostSubscriber',
             $this->postSubscriberRepository->findByPage($this->pageId, false),
             $this->settings['backend']['subscriber']['post']['paginate'],
             $page
@@ -34,6 +35,7 @@ public function indexPostSubscriberAction(int $page = 1): ResponseInterface
     public function indexBlogSubscriberAction(int $page = 1): ResponseInterface
     {
         return $this->paginationHtmlResponse(
+            'Subscriber/IndexBlogSubscriber',
             $this->blogSubscriberRepository->findByPage($this->pageId, false),
             $this->settings['backend']['subscriber']['blog']['paginate'],
             $page

diff --git a/Classes/Service/BackendModuleService.php b/Classes/Service/BackendModuleService.php
@@ -13,7 +13,6 @@
 use TYPO3\CMS\Backend\Template\ModuleTemplate;
 use TYPO3\CMS\Backend\Utility\BackendUtility;
 use TYPO3\CMS\Core\Page\PageRenderer;
-use TYPO3\CMS\Fluid\View\TemplateView as View;
 use TYPO3\CMS\Core\Authentication\BackendUserAuthentication;
 use TYPO3\CMS\Core\Imaging\Icon;
 use TYPO3\CMS\Core\Imaging\IconFactory;
@@ -33,13 +32,8 @@ class BackendModuleService
 {
     /**
      * BackendModuleService constructor.
-     *
      */
-    public function __construct(
-        protected View $view,
-        protected ModuleTemplate $moduleTemplate,
-        protected int $pid
-    ) {
+    public function __construct(protected ModuleTemplate $moduleTemplate, protected int $pid) {
     }
 
     /**

diff --git a/Resources/Private/Layouts/Backend.html b/Resources/Private/Layouts/Backend.html
@@ -1,17 +1,22 @@
 <html xmlns:f="http://typo3.org/ns/TYPO3/Fluid/ViewHelpers" data-namespace-typo3-fluid="true">
 
-	<div class="t3extblog">
+<div class="module t3extblog" data-module-name="{moduleName}">
+	<f:render partial="DocHeader" arguments="{docHeader:docHeader}" />
+
+	<div class="module-body t3js-module-body">
 		<h1>
 			<f:translate key="module.title" />
-			<small>
+			<small class="text-body-secondary">
 				<f:render section="headline" optional="1" />
 			</small>
 		</h1>
 
 		<f:flashMessages />
+
 		<f:render partial="Backend/PageNotice" arguments="{data: pageNotice}" />
 
-		<f:render section="main" />
+		<f:render section="main" arguments="{_all}" />
 	</div>
+</div>
 
 </html>