9.5/_template_analyzer_module_function_controller_8php_source.html

<?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\Utility\BackendUtility;

use ‪TYPO3\CMS\Core\Compatibility\PublicMethodDeprecationTrait;

use ‪TYPO3\CMS\Core\Compatibility\PublicPropertyDeprecationTrait;

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

use ‪TYPO3\CMS\Core\TypoScript\ExtendedTemplateService;

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

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

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


class ‪TemplateAnalyzerModuleFunctionController

{

    use ‪PublicPropertyDeprecationTrait;

    use ‪PublicMethodDeprecationTrait;


    private ‪$deprecatedPublicProperties = [

        'pObj' => 'Using TemplateAnalyzerModuleFunctionController::$pObj is deprecated and will not be possible anymore in TYPO3 v10.0.',

        'function_key' => 'Using TemplateAnalyzerModuleFunctionController::$function_key is deprecated, property will be removed in TYPO3 v10.0.',

        'extClassConf' => 'Using TemplateAnalyzerModuleFunctionController::$extClassConf is deprecated, property will be removed in TYPO3 v10.0.',

        'localLangFile' => 'Using TemplateAnalyzerModuleFunctionController::$localLangFile is deprecated, property will be removed in TYPO3 v10.0.',

    ];


    private ‪$deprecatedPublicMethods = [

        'initialize_editor' => 'Using TemplateAnalyzerModuleFunctionController::initialize_editor() is deprecated and will not be possible anymore in TYPO3 v10.0.',

        'modMenu' => 'Using TemplateAnalyzerModuleFunctionController::modMenu() is deprecated and will not be possible anymore in TYPO3 v10.0.',

        'handleExternalFunctionValue' => 'Using TemplateAnalyzerModuleFunctionController::handleExternalFunctionValue() is deprecated, method will be removed in TYPO3 v10.0.',

    ];


    protected ‪$pObj;


    protected ‪$localLanguageFilePath;


    protected ‪$templateRow;


    protected ‪$templateService;


    protected ‪$id;


    protected ‪$localLangFile = '';


    protected ‪$extClassConf;


    protected ‪$function_key = '';


    public function ‪init(‪$pObj)

    {

        $this->pObj = ‪$pObj;

        // Local lang:

        if (!empty($this->localLangFile)) {

            // @deprecated since TYPO3 v9, will be removed in TYPO3 v10.0.

            $this->‪getLanguageService()->‪includeLLFile($this->localLangFile);

        }

        // Setting MOD_MENU items as we need them for logging:

        $this->pObj->MOD_MENU = array_merge($this->pObj->MOD_MENU, $this->modMenu());

        $this->localLanguageFilePath = 'EXT:tstemplate/Resources/Private/Language/locallang_analyzer.xlf';

        $this->pObj->modMenu_setDefaultList .= ',ts_analyzer_checkLinenum,ts_analyzer_checkSyntax';

        $this->id = (int)GeneralUtility::_GP('id');

    }


    protected function ‪modMenu()

    {

        return [

            'ts_analyzer_checkSetup' => '1',

            'ts_analyzer_checkConst' => '1',

            'ts_analyzer_checkLinenum' => '1',

            'ts_analyzer_checkComments' => '1',

            'ts_analyzer_checkCrop' => '1',

            'ts_analyzer_checkSyntax' => '1'

        ];

    }


    protected function ‪initialize_editor($pageId, $templateUid = 0)

    {

        // Initializes the module. Done in this function because we may need to re-initialize if data is submitted!

        $this->templateService = GeneralUtility::makeInstance(ExtendedTemplateService::class);


        // Gets the rootLine

        $rootlineUtility = GeneralUtility::makeInstance(RootlineUtility::class, $pageId);

        $rootLine = $rootlineUtility->get();


        // This generates the constants/config + hierarchy info for the template.

        $this->templateService->runThroughTemplates($rootLine, $templateUid);


        // Get the row of the first VISIBLE template of the page. whereclause like the frontend.

        $this->templateRow = $this->templateService->ext_getFirstTemplate($pageId, $templateUid);

        return is_array($this->templateRow);

    }


    public function ‪main()

    {

        // Initializes the module. Done in this function because we may need to re-initialize if data is submitted!

        // Checking for more than one template an if, set a menu...


        $assigns = [];

        $template_uid = 0;

        $assigns['manyTemplatesMenu'] = $this->pObj->templateMenu();

        $assigns['LLPrefix'] = 'LLL:' . $this->localLanguageFilePath . ':';

        if ($assigns['manyTemplatesMenu']) {

            $template_uid = $this->pObj->MOD_SETTINGS['templatesOnPage'];

        }


        $assigns['existTemplate'] = $this->‪initialize_editor($this->id, $template_uid);

        if ($assigns['existTemplate']) {

            $assigns['siteTitle'] = trim($this->templateRow['sitetitle']);

            $assigns['templateRecord'] = ‪$this->templateRow;

            $assigns['linkWrappedTemplateTitle'] = $this->pObj->linkWrapTemplateTitle($this->templateRow['title']);

        }


        $this->templateService->clearList_const_temp = array_flip($this->templateService->clearList_const);

        $this->templateService->clearList_setup_temp = array_flip($this->templateService->clearList_setup);

        $pointer = count($this->templateService->hierarchyInfo);

        $hierarchyInfo = $this->templateService->ext_process_hierarchyInfo([], $pointer);

        $assigns['hierarchy'] = implode('', array_reverse($this->templateService->ext_getTemplateHierarchyArr(

            $hierarchyInfo,

            '',

            [],

            1

        )));


        $urlParameters = [

            'id' => ‪$this->id,

            'template' => 'all'

        ];

        $uriBuilder = GeneralUtility::makeInstance(\‪TYPO3\CMS\Backend\Routing\UriBuilder::class);

        $assigns['moduleLink'] = (string)$uriBuilder->buildUriFromRoute('web_ts', $urlParameters);


        $assigns['template'] = $template = GeneralUtility::_GET('template');

        $addParams = $template ? '&template=' . $template : '';

        $assigns['checkboxes'] = [

            'ts_analyzer_checkLinenum' => [

                'id' => 'checkTs_analyzer_checkLinenum',

                'll' => 'lineNumbers'

            ],

            'ts_analyzer_checkSyntax' => [

                'id' => 'checkTs_analyzer_checkSyntax',

                'll' => 'syntaxHighlight'

            ]

        ];


        if (!$this->pObj->MOD_SETTINGS['ts_analyzer_checkSyntax']) {

            $assigns['checkboxes']['ts_analyzer_checkComments'] = [

                'id' => 'checkTs_analyzer_checkComments',

                'll' => 'comments'

            ];

            $assigns['checkboxes']['ts_analyzer_checkCrop'] = [

                'id' => 'checkTs_analyzer_checkCrop',

                'll' => 'cropLines'

            ];

        }


        foreach ($assigns['checkboxes'] as $key => $conf) {

            $assigns['checkboxes'][$key]['label'] = ‪BackendUtility::getFuncCheck(

                $this->id,

                'SET[' . $key . ']',

                $this->pObj->MOD_SETTINGS[$key],

                '',

                $addParams,

                'id="' . $conf['id'] . '"'

            );

        }


        if ($template) {

            $this->templateService->ext_lineNumberOffset = 0;

            $this->templateService->ext_lineNumberOffset_mode = 'const';

            $assigns['constants'] = [];

            foreach ($this->templateService->constants as $key => $val) {

                $currentTemplateId = $this->templateService->hierarchyInfo[$key]['templateID'];

                if ($currentTemplateId == $template || $template === 'all') {

                    $assigns['constants'][] = [

                        'title' => $this->templateService->hierarchyInfo[$key]['title'],

                        'content' => $this->templateService->ext_outputTS(

                            [$val],

                            $this->pObj->MOD_SETTINGS['ts_analyzer_checkLinenum'],

                            $this->pObj->MOD_SETTINGS['ts_analyzer_checkComments'],

                            $this->pObj->MOD_SETTINGS['ts_analyzer_checkCrop'],

                            $this->pObj->MOD_SETTINGS['ts_analyzer_checkSyntax'],

                            0

                        )

                    ];

                    if ($template !== 'all') {

                        break;

                    }

                }

                $this->templateService->ext_lineNumberOffset += count(explode(LF, $val)) + 1;

            }


            // Output Setup

            $this->templateService->ext_lineNumberOffset = 0;

            $this->templateService->ext_lineNumberOffset_mode = 'setup';

            $assigns['setups'] = [];

            foreach ($this->templateService->config as $key => $val) {

                $currentTemplateId = $this->templateService->hierarchyInfo[$key]['templateID'];

                if ($currentTemplateId == $template || $template === 'all') {

                    $assigns['setups'][] = [

                        'title' => $this->templateService->hierarchyInfo[$key]['title'],

                        'content' => $this->templateService->ext_outputTS(

                            [$val],

                            $this->pObj->MOD_SETTINGS['ts_analyzer_checkLinenum'],

                            $this->pObj->MOD_SETTINGS['ts_analyzer_checkComments'],

                            $this->pObj->MOD_SETTINGS['ts_analyzer_checkCrop'],

                            $this->pObj->MOD_SETTINGS['ts_analyzer_checkSyntax'],

                            0

                        )

                    ];

                    if ($template !== 'all') {

                        break;

                    }

                }

                $this->templateService->ext_lineNumberOffset += count(explode(LF, $val)) + 1;

            }

        }


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

        $view->setTemplatePathAndFilename(GeneralUtility::getFileAbsFileName(

            'EXT:tstemplate/Resources/Private/Templates/TemplateAnalyzerModuleFunction.html'

        ));

        $view->assignMultiple($assigns);


        return $view->render();

    }


    protected function ‪handleExternalFunctionValue()

    {

        // Must clean first to make sure the correct key is set...

        $this->pObj->MOD_SETTINGS = ‪BackendUtility::getModuleData($this->pObj->MOD_MENU, GeneralUtility::_GP('SET'), 'web_ts');

        if ($this->function_key) {

            $this->extClassConf = $this->pObj->getExternalItemConfig('web_ts', $this->function_key, $this->pObj->MOD_SETTINGS[$this->function_key]);

        }

    }


    protected function ‪getLanguageService(): ‪LanguageService

    {

        return ‪$GLOBALS['LANG'];

    }

}