main/_module_template_8php_source.html

<?php


declare(strict_types=1);


/*

 * This file is part of the TYPO3 CMS project.

 *

 * It is free software; you can redistribute it and/or modify it under

 * the terms of the GNU General Public License, either version 2

 * of the License, or any later version.

 *

 * For the full copyright and license information, please read the

 * LICENSE.txt file that was distributed with this source code.

 *

 * The TYPO3 project - inspiring people to share!

 */


namespace ‪TYPO3\CMS\Backend\Template;


use Psr\Http\Message\ResponseInterface;

use Psr\Http\Message\ServerRequestInterface;

use ‪TYPO3\CMS\Backend\Module\ModuleInterface;

use ‪TYPO3\CMS\Backend\Module\ModuleProvider;

use ‪TYPO3\CMS\Backend\Routing\UriBuilder;

use ‪TYPO3\CMS\Backend\Template\Components\DocHeaderComponent;

use TYPO3\CMS\Backend\Utility\BackendUtility;

use ‪TYPO3\CMS\Core\Authentication\BackendUserAuthentication;

use ‪TYPO3\CMS\Core\Configuration\ExtensionConfiguration;

use ‪TYPO3\CMS\Core\Imaging\IconFactory;

use ‪TYPO3\CMS\Core\Localization\LanguageService;

use ‪TYPO3\CMS\Core\Messaging\FlashMessage;

use ‪TYPO3\CMS\Core\Messaging\FlashMessageQueue;

use ‪TYPO3\CMS\Core\Messaging\FlashMessageService;

use ‪TYPO3\CMS\Core\Page\JavaScriptModuleInstruction;

use ‪TYPO3\CMS\Core\Page\PageRenderer;

use ‪TYPO3\CMS\Core\Type\ContextualFeedbackSeverity;

use ‪TYPO3\CMS\Core\Utility\GeneralUtility;

use ‪TYPO3\CMS\Core\View\ResponsableViewInterface;

use ‪TYPO3\CMS\Core\View\ViewInterface;


final class ‪ModuleTemplate implements ‪ViewInterface, ‪ResponsableViewInterface

{

    use ‪PageRendererBackendSetupTrait;


    protected bool ‪$uiBlock = false;


    protected string ‪$moduleId = '';

    protected string ‪$moduleName = '';

    protected string ‪$moduleClass = '';

    protected string ‪$title = '';

    protected string ‪$bodyTag = '<body>';

    protected string ‪$formTag = '';


    protected ‪FlashMessageQueue ‪$flashMessageQueue;

    protected ‪DocHeaderComponent ‪$docHeaderComponent;


    public function ‪__construct(

        protected readonly ‪PageRenderer $pageRenderer,

        protected readonly ‪IconFactory $iconFactory,

        protected readonly ‪UriBuilder $uriBuilder,

        protected readonly ‪ModuleProvider $moduleProvider,

        protected readonly ‪FlashMessageService $flashMessageService,

        protected readonly ‪ExtensionConfiguration $extensionConfiguration,

        protected readonly ‪ViewInterface $view,

        protected readonly ServerRequestInterface $request,

    ) {

        $module = $request->getAttribute('module');

        if ($module instanceof ‪ModuleInterface) {

            // third level, needs the second level in order to keep highlighting in the module menu

            if ($module->getParentModule()?->getParentModule()) {

                $this->‪setModuleName($module->getParentModule()->getIdentifier());

            } else {

                $this->‪setModuleName($module->getIdentifier());

            }

            $this->‪setModuleName($module->getIdentifier());

        } else {

            $this->‪setModuleName($request->getAttribute('route')?->getOption('_identifier') ?? '');

        }

        $this->flashMessageQueue = $flashMessageService->getMessageQueueByIdentifier();

        $this->docHeaderComponent = GeneralUtility::makeInstance(DocHeaderComponent::class);

        $this->setUpBasicPageRendererForBackend($pageRenderer, $extensionConfiguration, $request, $this->‪getLanguageService());

    }


    public function ‪assign(string $key, mixed $value): self

    {

        $this->view->assign($key, $value);

        return $this;

    }


    public function ‪assignMultiple(array $values): self

    {

        $this->view->assignMultiple($values);

        return $this;

    }


    public function ‪render(string $templateFileName = ''): string

    {

        $this->‪prepareRender($templateFileName);

        return $this->pageRenderer->render();

    }


    public function ‪renderResponse(string $templateFileName = ''): ResponseInterface

    {

        $this->‪prepareRender($templateFileName);

        return $this->pageRenderer->renderResponse();

    }


    protected function ‪prepareRender(string $templateFileName): void

    {

        $this->‪assignMultiple([

            'docHeader' => $this->docHeaderComponent->docHeaderContent(),

            'moduleId' => $this->moduleId,

            'moduleName' => $this->moduleName,

            'moduleClass' => $this->moduleClass,

            'uiBlock' => $this->uiBlock,

            'flashMessageQueueIdentifier' => $this->flashMessageQueue->getIdentifier(),

            'formTag' => $this->formTag,

        ]);

        $this->pageRenderer->loadJavaScriptModule('bootstrap');

        $this->pageRenderer->loadJavaScriptModule('@typo3/backend/context-help.js');

        $this->pageRenderer->loadJavaScriptModule('@typo3/backend/document-header.js');

        $this->pageRenderer->loadJavaScriptModule('@typo3/backend/global-event-handler.js');

        $this->pageRenderer->loadJavaScriptModule('@typo3/backend/action-dispatcher.js');

        $this->pageRenderer->loadJavaScriptModule('@typo3/backend/element/immediate-action-element.js');

        $this->pageRenderer->loadJavaScriptModule('@typo3/backend/live-search/live-search-shortcut.js');

        $this->pageRenderer->addBodyContent($this->bodyTag . $this->view->render($templateFileName));

        $this->pageRenderer->setTitle($this->title);

        $updateSignalDetails = BackendUtility::getUpdateSignalDetails();

        if (!empty($updateSignalDetails['html'])) {

            $this->pageRenderer->addHeaderData(implode("\n", $updateSignalDetails['html']));

        }

        $this->‪dispatchNotificationMessages();

    }


    public function ‪setBodyTag(string $bodyTag): self

    {

        $this->bodyTag = ‪$bodyTag;

        return $this;

    }


    public function ‪setTitle(string ‪$title, string $context = ''): self

    {

        $titleComponents = [‪$title];

        if ($context !== '') {

            $titleComponents[] = $context;

        }

        $this->title = implode(' · ', $titleComponents);

        return $this;

    }


    public function ‪getDocHeaderComponent(): ‪DocHeaderComponent

    {

        return ‪$this->docHeaderComponent;

    }


    public function ‪setForm(string ‪$formTag = ''): self

    {

        $this->formTag = ‪$formTag;

        return $this;

    }


    public function ‪setModuleId(string ‪$moduleId): self

    {

        $this->moduleId = ‪$moduleId;

        return $this;

    }


    public function ‪setModuleName(string ‪$moduleName): self

    {

        $this->moduleName = ‪$moduleName;

        return $this;

    }


    public function ‪setModuleClass(string ‪$moduleClass): self

    {

        $this->moduleClass = ‪$moduleClass;

        return $this;

    }


    public function ‪addFlashMessage(string $messageBody, string $messageTitle = '', ‪ContextualFeedbackSeverity $severity = ContextualFeedbackSeverity::OK, bool $storeInSession = true): self

    {

        $flashMessage = GeneralUtility::makeInstance(FlashMessage::class, $messageBody, $messageTitle, $severity, $storeInSession);

        $this->flashMessageQueue->enqueue($flashMessage);

        return $this;

    }


    public function ‪setFlashMessageQueue(‪FlashMessageQueue ‪$flashMessageQueue): self

    {

        $this->flashMessageQueue = ‪$flashMessageQueue;

        return $this;

    }


    public function ‪setUiBlock(bool ‪$uiBlock): self

    {

        $this->uiBlock = ‪$uiBlock;

        return $this;

    }


    public function ‪makeDocHeaderModuleMenu(array $additionalQueryParams = []): self

    {

        $currentModule = $this->request->getAttribute('module');

        if (!($currentModule instanceof ‪ModuleInterface)) {

            // Early return in case the current request does not provide a module

            return $this;

        }

        if ($currentModule->getParentModule()?->hasParentModule()) {

            $menuModule = $this->moduleProvider->getModuleForMenu($currentModule->getParentIdentifier(), $this->getBackendUser());

        } else {

            // This is a fallback in case a second level module is called here

            $menuModule = $this->moduleProvider->getModuleForMenu($currentModule->getIdentifier(), $this->getBackendUser());

        }

        if ($menuModule === null) {

            return $this;

        }

        $menu = $this->‪getDocHeaderComponent()->getMenuRegistry()->makeMenu();

        $menu->setIdentifier('moduleMenu');

        $menu->setLabel(

            $this->‪getLanguageService()->sL(

                'LLL:EXT:backend/Resources/Private/Language/locallang.xlf:moduleMenu.dropdown.label'

            )

        );


        foreach ($menuModule->getSubModules() as $module) {

            $item = $menu

                ->makeMenuItem()

                ->setHref(

                    (string)$this->uriBuilder->buildUriFromRoute(

                        $module->getIdentifier(),

                        $additionalQueryParams,

                    )

                )

                ->setTitle($this->‪getLanguageService()->sL($module->getTitle()));

            if ($module->getIdentifier() === $currentModule->getIdentifier()) {

                $item->setActive(true);

            }

            $menu->addMenuItem($item);

        }

        $this->‪getDocHeaderComponent()->getMenuRegistry()->addMenu($menu);

        return $this;

    }


    protected function ‪dispatchNotificationMessages(): void

    {

        $notificationQueue = $this->flashMessageService->getMessageQueueByIdentifier(‪FlashMessageQueue::NOTIFICATION_QUEUE);

        foreach ($notificationQueue->getAllMessagesAndFlush() as $message) {

            $notificationInstruction = ‪JavaScriptModuleInstruction::create('@typo3/backend/notification.js');

            $notificationInstruction->invoke('showMessage', $message->getTitle(), $message->getMessage(), $message->getSeverity());

            $this->pageRenderer->getJavaScriptRenderer()->addJavaScriptModuleInstruction($notificationInstruction);

        }

    }


    protected function ‪getLanguageService(): ‪LanguageService

    {

        return ‪$GLOBALS['LANG'];

    }


    protected function ‪getBackendUser(): ‪BackendUserAuthentication

    {

        return ‪$GLOBALS['BE_USER'];

    }

}