9.5/_module_template_8php_source.html

<?php

namespace ‪TYPO3\CMS\Backend\Template;


/*

 * 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!

 */


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

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

use ‪TYPO3\CMS\Backend\Utility\BackendUtility;

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

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\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\Fluid\View\Exception\InvalidTemplateResourceException;

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


class ‪ModuleTemplate

{

    const ‪STATUS_ICON_ERROR = 3;


    const ‪STATUS_ICON_WARNING = 2;


    const ‪STATUS_ICON_NOTIFICATION = 1;


    const ‪STATUS_ICON_OK = -1;


    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;


    protected ‪$moduleId = '';


    protected ‪$moduleName = '';


    protected ‪$title = '';


    protected ‪$bodyTag = '<body>';


    protected ‪$flashMessageQueue;


    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): self

    {

        $this->title = ‪$title;

        return $this;

    }


    public function ‪getIconFactory()

    {

        return ‪$this->iconFactory;

    }


    public function ‪__construct()

    {

        $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);

        $this->pageRenderer = GeneralUtility::makeInstance(PageRenderer::class);

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

        $this->iconFactory = GeneralUtility::makeInstance(IconFactory::class);

    }


    protected function ‪loadJavaScripts()

    {

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

        if (TYPO3_MODE === 'BE' && $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/SplitButtons');

        }

    }


    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']);

        }

    }


    protected function ‪setupPage()

    {

        // Yes, hardcoded on purpose

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

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

        $this->pageRenderer->setLanguage(‪$GLOBALS['LANG']->lang);

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

    }


    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->‪setupPage();

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

        $this->‪loadJavaScripts();

        $this->‪setJavaScriptCodeArray();

        $this->‪loadStylesheets();


        $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);

        }

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

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

        $renderedPage = $this->pageRenderer->render(‪PageRenderer::PART_HEADER);

        $renderedPage .= ‪$this->bodyTag;

        $renderedPage .= $this->view->render();

        $this->pageRenderer->addJsFooterInlineCode('updateSignals', ‪BackendUtility::getUpdateSignalCode());

        $renderedPage .= $this->pageRenderer->render(‪PageRenderer::PART_FOOTER);


        return $renderedPage;

    }


    public function ‪getPageRenderer()

    {

        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 ‪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-' . GeneralUtility::shortMD5($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 ‪loadJavascriptLib($lib): self

    {

        trigger_error('ModuleTemplate->loadJavascriptLib() should not be used any longer, as this method will be removed in TYPO3 v10.0.', E_USER_DEPRECATED);

        $this->pageRenderer->addJsFile($lib);

        return $this;

    }


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

    {

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

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

        $pathInfo = parse_url(GeneralUtility::getIndpEnv('REQUEST_URI'));

        // 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;

        }

        if ((int)$motherModName === 1) {

            $motherModule = 'top.currentModuleLoaded';

        } elseif ($motherModName) {

            $motherModule = GeneralUtility::quoteJSvalue($motherModName);

        } else {

            $motherModule = '\'\'';

        }

        $confirmationText = GeneralUtility::quoteJSvalue(

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

        );


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

        $shortcutRepository = GeneralUtility::makeInstance(ShortcutRepository::class);

        $shortcutExist = $shortcutRepository->shortcutExists($shortcutUrl);


        if ($shortcutExist) {

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

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

        }


        $url = GeneralUtility::quoteJSvalue(rawurlencode($shortcutUrl));

        $onClick = 'top.TYPO3.ShortcutMenu.createShortcut(' . GeneralUtility::quoteJSvalue(rawurlencode($modName)) .

            ', ' . $url . ', ' . $confirmationText . ', ' . $motherModule . ', this, ' . GeneralUtility::quoteJSvalue($displayName) . ');return false;';


        return '<a href="#" class="' . htmlspecialchars($classes) . '" onclick="' . htmlspecialchars($onClick) . '" title="' .

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

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

    }


    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 ‪getBackendUserAuthentication()

    {

        return ‪$GLOBALS['BE_USER'];

    }


    protected function ‪getLanguageService()

    {

        return ‪$GLOBALS['LANG'];

    }


    public function ‪icons($type)

    {

        trigger_error('ModuleTemplate->icons() should not be used any longer, as this will be removed in TYPO3 v10.0.', E_USER_DEPRECATED);

        $icon = '';

        switch ($type) {

            case ‪self::STATUS_ICON_ERROR:

                $icon = 'status-dialog-error';

                break;

            case ‪self::STATUS_ICON_WARNING:

                $icon = 'status-dialog-warning';

                break;

            case ‪self::STATUS_ICON_NOTIFICATION:

                $icon = 'status-dialog-notification';

                break;

            case ‪self::STATUS_ICON_OK:

                $icon = 'status-dialog-ok';

                break;

            default:

                // Do nothing

        }

        if ($icon != '') {

            return $this->iconFactory->getIcon($icon, ‪Icon::SIZE_SMALL)->render();

        }

        return '';

    }


    public function ‪redirectUrls($thisLocation = '')

    {

        $thisLocation = $thisLocation ? $thisLocation : GeneralUtility::linkThisScript([

            'CB' => '',

            'SET' => '',

            'cmd' => '',

            'popViewId' => ''

        ]);

        $out = '

    var T3_RETURN_URL = ' . GeneralUtility::quoteJSvalue(str_replace('%20', '', rawurlencode(GeneralUtility::sanitizeLocalUrl(GeneralUtility::_GP('returnUrl'))))) . ';

    var T3_THIS_LOCATION = ' . GeneralUtility::quoteJSvalue(str_replace('%20', '', rawurlencode($thisLocation))) . '

        ';

        return $out;

    }


    public function ‪header($text)

    {

        return '


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

    <h1 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(

            \‪TYPO3\CMS\Core\Messaging\FlashMessage::class,

            $messageBody,

            $messageTitle,

            $severity,

            $storeInSession

        );

        $this->‪getFlashMessageQueue()->enqueue($flashMessage);

        return $this;

    }


    public function ‪setFlashMessageQueue(‪$flashMessageQueue): self

    {

        $this->flashMessageQueue = ‪$flashMessageQueue;

        return $this;

    }


    protected function ‪getFlashMessageQueue()

    {

        if (!isset($this->flashMessageQueue)) {

            $service = GeneralUtility::makeInstance(FlashMessageService::class);

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

        }

        return ‪$this->flashMessageQueue;

    }


    public function ‪isUiBlock(): bool

    {

        return ‪$this->uiBlock;

    }


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

    {

        $this->uiBlock = ‪$uiBlock;

        return $this;

    }

}