TypoScriptTemplateConstantEditorModuleFunctionController.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\Tstemplate\Controller;

/*
 * 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\Module\AbstractFunctionModule;
use TYPO3\CMS\Backend\Utility\BackendUtility;
use TYPO3\CMS\Core\DataHandling\DataHandler;
use TYPO3\CMS\Core\Imaging\Icon;
use TYPO3\CMS\Core\Imaging\IconFactory;
use TYPO3\CMS\Core\TypoScript\ExtendedTemplateService;
use TYPO3\CMS\Core\Utility\ExtensionManagementUtility;
use TYPO3\CMS\Core\Utility\GeneralUtility;
use TYPO3\CMS\Frontend\Page\PageRepository;

class TypoScriptTemplateConstantEditorModuleFunctionController extends AbstractFunctionModule
{
    public $pObj;

    public function initialize_editor($pageId, $template_uid = 0)
    {
        $templateService = GeneralUtility::makeInstance(ExtendedTemplateService::class);
        $GLOBALS['tmpl'] = $templateService;

        // Do not log time-performance information
        $templateService->tt_track = false;

        $templateService->init();
        $templateService->ext_localGfxPrefix = ExtensionManagementUtility::extPath('tstemplate');
        $templateService->ext_localWebGfxPrefix = ExtensionManagementUtility::extRelPath('tstemplate') . 'Resources/Public/';

        // Get the row of the first VISIBLE template of the page. whereclause like the frontend.
        $GLOBALS['tplRow'] = $templateService->ext_getFirstTemplate($pageId, $template_uid);
        // IF there was a template...
        if (is_array($GLOBALS['tplRow'])) {
            // Gets the rootLine
            $sys_page = GeneralUtility::makeInstance(PageRepository::class);
            $rootLine = $sys_page->getRootLine($pageId);
            // This generates the constants/config + hierarchy info for the template.
            $templateService->runThroughTemplates($rootLine, $template_uid);
            // The editable constants are returned in an array.
            $GLOBALS['theConstants'] = $templateService->generateConfig_constants();
            // The returned constants are sorted in categories, that goes into the $tmpl->categories array
            $templateService->ext_categorizeEditableConstants($GLOBALS['theConstants']);
            // This array will contain key=[expanded constant name], value=line number in template. (after edit_divider, if any)
            $templateService->ext_regObjectPositions($GLOBALS['tplRow']['constants']);
            return true;
        }
        return false;
    }

    public function displayExample($theOutput)
    {
        $templateService = $this->getExtendedTemplateService();
        if ($templateService->helpConfig['imagetag'] || $templateService->helpConfig['description'] || $templateService->helpConfig['header']) {
            $theOutput .= '<div style="padding-top: 30px;"></div>';
            $theOutput .= '<div>' . htmlspecialchars($templateService->helpConfig['header'])
                . '<div align="center">' . $templateService->helpConfig['imagetag'] . '</div><br>'
                . ($templateService->helpConfig['description'] ? implode(explode('//', $templateService->helpConfig['description']), '<br>') . '<br>' : '')
                . ($templateService->helpConfig['bulletlist'] ? '<ul><li>' . implode(explode('//', $templateService->helpConfig['bulletlist']), '<li>') . '</ul>' : '<br>')
                . '</div>';
        }
        return $theOutput;
    }

    public function main()
    {
        $lang = $this->getLanguageService();

        $lang->includeLLFile('EXT:tstemplate/Resources/Private/Language/locallang_ceditor.xlf');
        $theOutput = '';
        // Create extension template
        $this->pObj->createTemplate($this->pObj->id);
        // Checking for more than one template an if, set a menu...
        $manyTemplatesMenu = $this->pObj->templateMenu();
        $template_uid = 0;
        if ($manyTemplatesMenu) {
            $template_uid = $this->pObj->MOD_SETTINGS['templatesOnPage'];
        }

        // initialize
        $existTemplate = $this->initialize_editor($this->pObj->id, $template_uid);
        if ($existTemplate) {
            $templateService = $this->getExtendedTemplateService();
            $tplRow = $this->getTemplateRow();
            $theConstants = $this->getConstants();

            $this->getPageRenderer()->loadRequireJsModule('TYPO3/CMS/Tstemplate/ConstantEditor');
            $saveId = $tplRow['_ORIG_uid'] ? $tplRow['_ORIG_uid'] : $tplRow['uid'];
            // Update template ?
            if (GeneralUtility::_POST('_savedok')) {
                $templateService->changed = 0;
                $templateService->ext_procesInput(GeneralUtility::_POST(), [], $theConstants, $tplRow);
                if ($templateService->changed) {
                    // Set the data to be saved
                    $recData = [];
                    $recData['sys_template'][$saveId]['constants'] = implode($templateService->raw, LF);
                    // Create new  tce-object
                    $tce = GeneralUtility::makeInstance(DataHandler::class);
                    $tce->stripslashes_values = false;
                    $tce->start($recData, []);
                    $tce->process_datamap();
                    // Clear the cache (note: currently only admin-users can clear the cache in tce_main.php)
                    $tce->clear_cacheCmd('all');
                    // re-read the template ...
                    $this->initialize_editor($this->pObj->id, $template_uid);
                    // re-read the constants as they have changed
                    $templateService = $this->getExtendedTemplateService();
                    $tplRow = $this->getTemplateRow();
                    $theConstants = $this->getConstants();
                }
            }
            // Resetting the menu (start). I wonder if this in any way is a violation of the menu-system. Haven't checked. But need to do it here, because the menu is dependent on the categories available.
            $this->pObj->MOD_MENU['constant_editor_cat'] = $templateService->ext_getCategoryLabelArray();
            $this->pObj->MOD_SETTINGS = BackendUtility::getModuleData($this->pObj->MOD_MENU, GeneralUtility::_GP('SET'), $this->pObj->MCONF['name']);
            // Resetting the menu (stop)
            $iconFactory = GeneralUtility::makeInstance(IconFactory::class);
            $content = $iconFactory->getIconForRecord('sys_template', $tplRow, Icon::SIZE_SMALL)->render() . '<strong>' . $this->pObj->linkWrapTemplateTitle($tplRow['title'], 'constants') . '</strong>' . (trim($tplRow['sitetitle']) ? htmlspecialchars(' (' . $tplRow['sitetitle'] . ')') : '');
            $theOutput .= '<h2>' . $lang->getLL('editConstants', true) . '</h2><div>' . $content . '</div>';
            if ($manyTemplatesMenu) {
                $theOutput .= '<div>' . $manyTemplatesMenu . '</div>';
            }
            $theOutput .= '<div style="padding-top: 10px;"></div>';
            if (!empty($this->pObj->MOD_MENU['constant_editor_cat'])) {
                $menu = '<div class="form-inline form-inline-spaced">';
                $menu .= BackendUtility::getDropdownMenu($this->pObj->id, 'SET[constant_editor_cat]', $this->pObj->MOD_SETTINGS['constant_editor_cat'], $this->pObj->MOD_MENU['constant_editor_cat']);
                $menu .= '</div>';
                $theOutput .= '<h3>' . $lang->getLL('category', true) . '</h3><div><span class="text-nowrap">' . $menu . '</span></div>';
            } else {
                $theOutput .= '<h3>' . $iconFactory->getIcon('status-dialog-notification', Icon::SIZE_SMALL)->render() . $lang->getLL('noConstants', true) . '</h3><div>' . $lang->getLL('noConstantsDescription', true) . '</div>';
            }
            $theOutput .= '<div style="padding-top: 15px;"></div>';
            // Category and constant editor config:
            $category = $this->pObj->MOD_SETTINGS['constant_editor_cat'];
            $templateService->ext_getTSCE_config($category);

            $printFields = trim($templateService->ext_printFields($theConstants, $category));
            if ($printFields) {
                $theOutput .= '<div>' . $printFields . '</div>';
            }
            $BE_USER_modOptions = BackendUtility::getModTSconfig(0, 'mod.' . $this->pObj->MCONF['name']);
            if ($BE_USER_modOptions['properties']['constantEditor.']['example'] != 'top') {
                $theOutput = $this->displayExample($theOutput);
            }
        } else {
            $theOutput .= $this->pObj->noTemplate(1);
        }
        return $theOutput;
    }

    protected function getExtendedTemplateService()
    {
        return $GLOBALS['tmpl'];
    }

    protected function getTemplateRow()
    {
        return $GLOBALS['tplRow'];
    }

    protected function getConstants()
    {
        return $GLOBALS['theConstants'];
    }
}