9.5/_typo_script_waterfall_8php_source.html

<?php

declare(strict_types = 1);


namespace ‪TYPO3\CMS\Adminpanel\Modules\TsDebug;


/*

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

use ‪TYPO3\CMS\Adminpanel\ModuleApi\AbstractSubModule;

use ‪TYPO3\CMS\Adminpanel\ModuleApi\InitializableInterface;

use ‪TYPO3\CMS\Adminpanel\ModuleApi\ModuleData;

use ‪TYPO3\CMS\Adminpanel\ModuleApi\ModuleSettingsProviderInterface;

use ‪TYPO3\CMS\Adminpanel\Service\ConfigurationService;

use ‪TYPO3\CMS\Backend\FrontendBackendUserAuthentication;

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

use ‪TYPO3\CMS\Core\TimeTracker\TimeTracker;

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

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

use ‪TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController;


class ‪TypoScriptWaterfall extends ‪AbstractSubModule implements ‪InitializableInterface, ‪ModuleSettingsProviderInterface

{

    protected ‪$configurationService;


    public function ‪__construct()

    {

        $this->configurationService = GeneralUtility::makeInstance(ConfigurationService::class);

    }


    public function ‪getIdentifier(): string

    {

        return 'typoscript-waterfall';

    }


    public function ‪getLabel(): string

    {

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

            'LLL:EXT:adminpanel/Resources/Private/Language/locallang_tsdebug.xlf:sub.waterfall.label'

        );

    }


    public function ‪initializeModule(ServerRequestInterface $request): void

    {

        $typoScriptFrontend = $this->‪getTypoScriptFrontendController();

        $typoScriptFrontend->forceTemplateParsing = $this->‪getConfigurationOption(

            'forceTemplateParsing'

        );

        if ($typoScriptFrontend->forceTemplateParsing) {

            $typoScriptFrontend->set_no_cache('Admin Panel: Force template parsing', true);

        }

        $this->‪getTimeTracker()->LR = (bool)$this->‪getConfigurationOption('LR');

    }


    public function ‪getContent(ModuleData $data): string

    {

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

        $templateNameAndPath = 'EXT:adminpanel/Resources/Private/Templates/Modules/TsDebug/TypoScript.html';

        $view->setTemplatePathAndFilename(GeneralUtility::getFileAbsFileName($templateNameAndPath));

        $view->setPartialRootPaths(['EXT:adminpanel/Resources/Private/Partials']);


        $view->assignMultiple(

            [

                'tree' => (int)$this->‪getConfigurationOption('tree'),

                'display' => [

                    'times' => (int)$this->‪getConfigurationOption('displayTimes'),

                    'messages' => (int)$this->‪getConfigurationOption('displayMessages'),

                    'content' => (int)$this->‪getConfigurationOption('displayContent'),

                ],

                'trackContentRendering' => (int)$this->‪getConfigurationOption('LR'),

                'forceTemplateParsing' => (int)$this->‪getConfigurationOption('forceTemplateParsing'),

                'typoScriptLog' => $this->‪renderTypoScriptLog(),

            ]

        );


        return $view->render();

    }


    public function ‪getSettings(): string

    {

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

        $templateNameAndPath = 'EXT:adminpanel/Resources/Private/Templates/Modules/TsDebug/TypoScriptSettings.html';

        $view->setTemplatePathAndFilename(GeneralUtility::getFileAbsFileName($templateNameAndPath));

        $view->setPartialRootPaths(['EXT:adminpanel/Resources/Private/Partials']);


        $view->assignMultiple(

            [

                'tree' => (int)$this->‪getConfigurationOption('tree'),

                'display' => [

                    'times' => (int)$this->‪getConfigurationOption('displayTimes'),

                    'messages' => (int)$this->‪getConfigurationOption('displayMessages'),

                    'content' => (int)$this->‪getConfigurationOption('displayContent'),

                ],

                'trackContentRendering' => (int)$this->‪getConfigurationOption('LR'),

                'forceTemplateParsing' => (int)$this->‪getConfigurationOption('forceTemplateParsing')

            ]

        );


        return $view->render();

    }


    protected function ‪getBackendUser(): BackendUserAuthentication

    {

        return ‪$GLOBALS['BE_USER'];

    }


    protected function ‪getConfigurationOption(string $option): bool

    {

        return (bool)$this->configurationService->getConfigurationOption('tsdebug', $option);

    }


    protected function ‪renderTypoScriptLog(): string

    {

        $timeTracker = $this->‪getTimeTracker();

        $timeTracker->printConf['flag_tree'] = $this->‪getConfigurationOption('tree');

        $timeTracker->printConf['allTime'] = $this->‪getConfigurationOption(

            'displayTimes'

        );

        $timeTracker->printConf['flag_messages'] = $this->‪getConfigurationOption(

            'displayMessages'

        );

        $timeTracker->printConf['flag_content'] = $this->‪getConfigurationOption(

            'displayContent'

        );

        return $timeTracker->printTSlog();

    }


    protected function ‪getTimeTracker(): TimeTracker

    {

        return GeneralUtility::makeInstance(TimeTracker::class);

    }


    protected function ‪getTypoScriptFrontendController(): TypoScriptFrontendController

    {

        return ‪$GLOBALS['TSFE'];

    }

}