11.5/_module_template_8php_source.html

<?php


/*

 * 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\ServerRequestInterface;

use ‪TYPO3\CMS\Backend\Backend\Shortcut\ShortcutRepository;

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

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

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\Icon;

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

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

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

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

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

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

use TYPO3\CMS\Core\Page\PageRenderer;

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

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

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

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

use ‪TYPO3\CMS\Fluid\View\StandaloneView;

use TYPO3Fluid\Fluid\View\ViewInterface;


class ‪ModuleTemplate

{

    protected ‪$docHeaderComponent;


    protected ‪$javascriptCodeArray = [];


    protected ‪$pageRenderer;


    protected ‪$uiBlock = false;


    protected ‪$templateRootPaths = ['EXT:backend/Resources/Private/Templates'];


    protected ‪$partialRootPaths = ['EXT:backend/Resources/Private/Partials'];


    protected ‪$layoutRootPaths = ['EXT:backend/Resources/Private/Layouts'];


    protected ‪$templateFile = 'Module.html';


    protected ‪$view;


    protected ‪$content = '';


    protected ‪IconFactory ‪$iconFactory;

    protected ‪FlashMessageQueue ‪$flashMessageQueue;

    protected ServerRequestInterface ‪$request;


    protected ‪$moduleId = '';


    protected ‪$moduleName = '';


    protected ‪$moduleClass = '';


    protected ‪$title = '';


    protected ‪$bodyTag = '<body>';


    public function ‪getBodyTag()

    {

        return ‪$this->bodyTag;

    }


    public function ‪setBodyTag(‪$bodyTag): self

    {

        $this->bodyTag = ‪$bodyTag;

        return $this;

    }


    public function ‪getView()

    {

        return ‪$this->view;

    }


    public function ‪setContent(‪$content): self

    {

        $this->view->assign('content', ‪$content);

        return $this;

    }


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

    {

        $titleComponents = [

            ‪$title,

        ];

        if ($context !== '') {

            $titleComponents[] = $context;

        }

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

        return $this;

    }


    public function ‪getIconFactory(): ‪IconFactory

    {

        trigger_error(

            'Method ' . __METHOD__ . ' is deprecated and will be removed in TYPO3 12.0. Inject the service directly instead.',

            E_USER_DEPRECATED

        );

        return ‪$this->iconFactory;

    }


    public function ‪__construct(

        PageRenderer ‪$pageRenderer,

        ‪IconFactory ‪$iconFactory,

        ‪FlashMessageService $flashMessageService,

        ServerRequestInterface ‪$request = null,

        ViewInterface ‪$view = null

    ) {

        $this->pageRenderer = ‪$pageRenderer;

        $this->iconFactory = ‪$iconFactory;

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

        // @todo: Make $request argument non-optional in v12.

        $this->request = ‪$request ?? ‪$GLOBALS['TYPO3_REQUEST'];


        $currentRoute = $this->request->getAttribute('route');

        if ($currentRoute instanceof ‪Route) {

            if ($currentRoute->hasOption('module') && $currentRoute->getOption('module')) {

                $moduleConfiguration = $currentRoute->getOption('moduleConfiguration');

                if ($moduleConfiguration['name']) {

                    $this->‪setModuleName($moduleConfiguration['name']);

                }

            } else {

                $this->‪setModuleName($currentRoute->getOption('_identifier'));

            }

        }

        if (‪$view === null) {

            $this->view = GeneralUtility::makeInstance(StandaloneView::class);

            $this->view->setPartialRootPaths($this->partialRootPaths);

            $this->view->setTemplateRootPaths($this->templateRootPaths);

            $this->view->setLayoutRootPaths($this->layoutRootPaths);

            $this->view->setTemplate($this->templateFile);

        } else {

            $this->view = ‪$view;

        }

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

        $this->‪setupPage();

        $this->‪loadJavaScripts();

        $this->‪loadStylesheets();

    }


    protected function ‪loadJavaScripts()

    {

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


        if ($this->‪getBackendUserAuthentication() && !empty($this->‪getBackendUserAuthentication()->user)) {

            $this->pageRenderer->loadRequireJsModule('TYPO3/CMS/Backend/ContextHelp');

            $this->pageRenderer->loadRequireJsModule('TYPO3/CMS/Backend/DocumentHeader');

        }

        $this->pageRenderer->loadRequireJsModule('TYPO3/CMS/Backend/GlobalEventHandler');

        $this->pageRenderer->loadRequireJsModule('TYPO3/CMS/Backend/ActionDispatcher');

        $this->pageRenderer->loadRequireJsModule('TYPO3/CMS/Backend/Element/ImmediateActionElement');

    }


    protected function ‪loadStylesheets()

    {

        if (!empty(‪$GLOBALS['TBE_STYLES']['stylesheet'])) {

            $this->pageRenderer->addCssFile(‪$GLOBALS['TBE_STYLES']['stylesheet']);

        }

        if (!empty(‪$GLOBALS['TBE_STYLES']['stylesheet2'])) {

            $this->pageRenderer->addCssFile(‪$GLOBALS['TBE_STYLES']['stylesheet2']);

        }

        // Add all *.css files of the directory $path to the stylesheets

        foreach ($this->‪getRegisteredStylesheetFolders() as $folder) {

            // Read all files in directory and sort them alphabetically

            foreach (GeneralUtility::getFilesInDir($folder, 'css', true) as $cssFile) {

                $this->pageRenderer->addCssFile($cssFile);

            }

        }

    }


    protected function ‪getRegisteredStylesheetFolders(): array

    {

        $stylesheetDirectories = [];

        foreach (‪$GLOBALS['TBE_STYLES']['skins'] ?? [] as $skin) {

            foreach ($skin['stylesheetDirectories'] ?? [] as $stylesheetDir) {

                $directory = GeneralUtility::getFileAbsFileName($stylesheetDir);

                if (!empty($directory)) {

                    $stylesheetDirectories[] = $directory;

                }

            }

        }

        return $stylesheetDirectories;

    }


    protected function ‪setupPage()

    {

        // Yes, hardcoded on purpose

        $this->pageRenderer->setXmlPrologAndDocType('<!DOCTYPE html>');

        $this->pageRenderer->setCharSet('utf-8');

        $this->pageRenderer->setLanguage($this->‪getLanguageService()->lang);

        $this->pageRenderer->setMetaTag('name', 'viewport', 'width=device-width, initial-scale=1');

        $this->pageRenderer->setFavIcon($this->‪getBackendFavicon());

        $this->pageRenderer->disableConcatenateCss();

        $this->pageRenderer->disableConcatenateJavascript();

        $this->pageRenderer->disableCompressCss();

        $this->pageRenderer->disableCompressJavascript();

        $languageCode = $this->pageRenderer->getLanguage() === 'default' ? 'en' : $this->pageRenderer->getLanguage();

        $this->pageRenderer->setHtmlTag('<html lang="' . htmlspecialchars($languageCode) . '">');

        if (‪$GLOBALS['TYPO3_CONF_VARS']['BE']['debug']) {

            $this->pageRenderer->enableDebugMode();

        }

    }


    protected function ‪setJavaScriptCodeArray()

    {

        foreach ($this->javascriptCodeArray as $name => $code) {

            $this->pageRenderer->addJsInlineCode($name, $code, false);

        }

    }


    public function ‪addJavaScriptCode($name = '', $code = ''): self

    {

        $this->javascriptCodeArray[$name] = $code;

        return $this;

    }


    public function ‪getDocHeaderComponent()

    {

        return ‪$this->docHeaderComponent;

    }


    public function ‪renderContent()

    {

        $this->‪setJavaScriptCodeArray();

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


        $this->view->assign('docHeader', $this->docHeaderComponent->docHeaderContent());

        if ($this->moduleId) {

            $this->view->assign('moduleId', $this->moduleId);

        }

        if ($this->moduleName) {

            $this->view->assign('moduleName', $this->moduleName);

        }

        if ($this->moduleClass) {

            $this->view->assign('moduleClass', $this->moduleClass);

        }

        $this->view->assign('uiBlock', $this->uiBlock);

        $this->view->assign('flashMessageQueueIdentifier', $this->flashMessageQueue->getIdentifier());

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


        $updateSignalDetails = BackendUtility::getUpdateSignalDetails();

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

            $this->pageRenderer->addHeaderData(

                implode("\n", $updateSignalDetails['html'])

            );

        }

        // @todo deprecate inline JavaScript in TYPO3 v12.0

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

            $this->pageRenderer->addJsFooterInlineCode(

                'updateSignals',

                implode("\n", $updateSignalDetails['script'])

            );

        }

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

    }


    public function ‪getPageRenderer(): PageRenderer

    {

        trigger_error(

            'Method ' . __METHOD__ . ' is deprecated and will be removed in TYPO3 12.0. Inject the service directly instead.',

            E_USER_DEPRECATED

        );

        return ‪$this->pageRenderer;

    }


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

    {

        $this->view->assign('formTag', $formTag);

        return $this;

    }


    public function ‪setModuleId(‪$moduleId): self

    {

        $this->moduleId = ‪$moduleId;

        $this->‪registerModuleMenu(‪$moduleId);

        return $this;

    }


    public function ‪setModuleName(‪$moduleName): self

    {

        $this->moduleName = ‪$moduleName;

        return $this;

    }


    public function ‪setModuleClass(‪$moduleClass): self

    {

        $this->moduleClass = ‪$moduleClass;

        return $this;

    }


    public function ‪registerModuleMenu($moduleMenuIdentifier): self

    {

        if (isset(‪$GLOBALS['TBE_MODULES_EXT'][$moduleMenuIdentifier])) {

            $menuEntries =

                ‪$GLOBALS['TBE_MODULES_EXT'][$moduleMenuIdentifier]['MOD_MENU']['function'];

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

            foreach ($menuEntries as $menuEntry) {

                $menuItem = $menu->‪makeMenuItem()

                    ->‪setTitle($menuEntry['title'])

                    ->setHref('#');

                $menu->addMenuItem($menuItem);

            }

            $this->docHeaderComponent->getMenuRegistry()->addMenu($menu);

        }

        return $this;

    }


    public function ‪getDynamicTabMenu(array $menuItems, $domId, $defaultTabIndex = 1, $collapsible = false, $wrapContent = true, $storeLastActiveTab = true)

    {

        $this->pageRenderer->loadRequireJsModule('TYPO3/CMS/Backend/Tabs');

        $templatePath = ‪ExtensionManagementUtility::extPath('backend')

            . 'Resources/Private/Templates/DocumentTemplate/';

        ‪$view = GeneralUtility::makeInstance(StandaloneView::class);

        ‪$view->setTemplatePathAndFilename($templatePath . ($collapsible ? 'Collapse.html' : 'Tabs.html'));

        ‪$view->setPartialRootPaths([$templatePath . 'Partials']);

        ‪$view->assignMultiple([

            'id' => 'DTM-' . md5($domId),

            'items' => $menuItems,

            'defaultTabIndex' => $defaultTabIndex,

            'wrapContent' => $wrapContent,

            'storeLastActiveTab' => $storeLastActiveTab,

        ]);

        return ‪$view->render();

    }


    /*******************************************

     * THE FOLLOWING METHODS ARE SUBJECT TO BE DEPRECATED / DROPPED!

     *

     * These methods have been copied over from DocumentTemplate and enables

     * core modules to drop the dependency to DocumentTemplate altogether without

     * rewriting these modules now.

     * The methods below are marked as internal and will be removed

     * one-by-one with further refactoring of modules.

     *

     * Do not use these methods within own extensions if possible or

     * be prepared to change this later again.

     *******************************************/

    public function ‪makeShortcutIcon($gvList, $setList, $modName, $motherModName = '', $displayName = '', $classes = 'btn btn-default btn-sm')

    {

        trigger_error('Method makeShortcutIcon() is deprecated and will be removed in v12. Please use ShortcutButton->setArguments() instead.', E_USER_DEPRECATED);

        $gvList = 'route,id,' . $gvList;

        $storeUrl = $this->‪makeShortcutUrl($gvList, $setList);

        $pathInfo = parse_url(‪$GLOBALS['TYPO3_REQUEST']->getAttribute('normalizedParams')->getRequestUri());

        // Fallback for alt_mod. We still pass in the old xMOD... stuff,

        // but TBE_MODULES only knows about "record_edit".

        // We still need to pass the xMOD name to createShortcut below,

        // since this is used for icons.

        ‪$moduleName = $modName === 'xMOD_alt_doc.php' ? 'record_edit' : $modName;

        // Add the module identifier automatically if typo3/index.php is used:

        // @todo: routing

        if (GeneralUtility::_GET('route') !== null) {

            $storeUrl = '&route=' . ‪$moduleName . $storeUrl;

        }


        $shortcutUrl = $pathInfo['path'] . '?' . $storeUrl;


        // We simply let the above functionality as it is for maximum backwards compatibility and now

        // just process the generated $shortcutUrl to match the new format (routeIdentifier & arguments)

        [$routeIdentifier, $arguments] = $this->‪getCreateShortcutProperties($shortcutUrl);


        if (GeneralUtility::makeInstance(ShortcutRepository::class)->shortcutExists($routeIdentifier, $arguments)) {

            return '<a class="active ' . htmlspecialchars($classes) . '" title="">' .

            $this->iconFactory->getIcon('actions-system-shortcut-active', ‪Icon::SIZE_SMALL)->render() . '</a>';

        }


        $confirmationText =  $this->‪getLanguageService()->‪sL('LLL:EXT:core/Resources/Private/Language/locallang_core.xlf:labels.makeBookmark');


        $attrs = [

            'href' => '#',

            'class' => $classes,

            'title' => $confirmationText,

            'data-dispatch-action' => 'TYPO3.ShortcutMenu.createShortcut',

            'data-dispatch-args' => GeneralUtility::jsonEncodeForHtmlAttribute([

                $routeIdentifier,

                $arguments,

                $displayName,

                $confirmationText,

                '{$target}',

            ], false),

        ];

        return sprintf(

            '<a %s>%s</a>',

            GeneralUtility::implodeAttributes($attrs, true),

            $this->iconFactory->getIcon('actions-system-shortcut-new', ‪Icon::SIZE_SMALL)->render()

        );

    }


    public function ‪makeShortcutUrl($gvList, $setList)

    {

        $getParams = GeneralUtility::_GET();

        $storeArray = array_merge(

            GeneralUtility::compileSelectedGetVarsFromArray($gvList, $getParams),

            ['SET' => GeneralUtility::compileSelectedGetVarsFromArray($setList, (array)(‪$GLOBALS['SOBE']->MOD_SETTINGS ?? []))]

        );

        return ‪HttpUtility::buildQueryString($storeArray, '&');

    }


    protected function ‪getCreateShortcutProperties(string $shortcutUrl): array

    {

        $routeIdentifier = '';

        $arguments = [];


        parse_str(parse_url($shortcutUrl)['query'] ?? '', $arguments);

        $routePath = (string)($arguments['route'] ?? '');


        if ($routePath !== '') {

            foreach (GeneralUtility::makeInstance(Router::class)->getRoutes() as $identifier => $route) {

                if ($route->getPath() === $routePath

                    && (

                        $route->hasOption('moduleName')

                        || in_array($identifier, ['record_edit', 'file_edit', 'wizard_rte'], true)

                    )

                ) {

                    $routeIdentifier = $identifier;

                }

            }

        }


        unset($arguments['route'], $arguments['returnUrl']);


        return [$routeIdentifier, json_encode($arguments)];

    }


    protected function ‪getBackendFavicon()

    {

        $backendFavicon = GeneralUtility::makeInstance(ExtensionConfiguration::class)->get('backend', 'backendFavicon');

        if (!empty($backendFavicon)) {

            return $this->‪getUriForFileName($backendFavicon);

        }


        return ‪PathUtility::getPublicResourceWebPath('EXT:backend/Resources/Public/Icons/favicon.ico');

    }


    protected function ‪getUriForFileName($filename)

    {

        if (‪PathUtility::hasProtocolAndScheme($filename)) {

            return $filename;

        }

        $urlPrefix = '';

        if (‪PathUtility::isExtensionPath($filename)) {

            $filename = ‪PathUtility::getPublicResourceWebPath($filename);

        } elseif (strpos($filename, '/') !== 0) {

            $urlPrefix = GeneralUtility::getIndpEnv('TYPO3_SITE_PATH');

        }

        return $urlPrefix . $filename;

    }


    protected function ‪getBackendUserAuthentication()

    {

        return ‪$GLOBALS['BE_USER'];

    }


    protected function ‪getLanguageService()

    {

        return ‪$GLOBALS['LANG'];

    }


    public function ‪header(string $text, bool $inlineEdit = true)

    {

        return '


    <!-- MAIN Header in page top -->

    <h1 ' . ($inlineEdit ? 'class="t3js-title-inlineedit"' : '') . '>' . htmlspecialchars($text) . '</h1>

';

    }


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

    {

        if (!is_string($messageBody)) {

            throw new \InvalidArgumentException('The message body must be of type string, "' . gettype($messageBody) . '" given.', 1446483133);

        }

        /* @var \TYPO3\CMS\Core\Messaging\FlashMessage $flashMessage */

        $flashMessage = GeneralUtility::makeInstance(

            FlashMessage::class,

            $messageBody,

            $messageTitle,

            $severity,

            $storeInSession

        );

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

        return $this;

    }


    public function ‪setFlashMessageQueue(‪$flashMessageQueue): self

    {

        $this->flashMessageQueue = ‪$flashMessageQueue;

        return $this;

    }


    public function ‪isUiBlock(): bool

    {

        return ‪$this->uiBlock;

    }


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

    {

        $this->uiBlock = ‪$uiBlock;

        return $this;

    }

}