TemplateAnalyzerModuleFunctionController.php

Go to the documentation of this file.

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

class TemplateAnalyzerModuleFunctionController extends \TYPO3\CMS\Backend\Module\AbstractFunctionModule {

    public function init(&$pObj, $conf) {
        parent::init($pObj, $conf);
        $GLOBALS['LANG']->includeLLFile('EXT:tstemplate/Resources/Private/Language/locallang_analyzer.xlf');
        $this->pObj->modMenu_setDefaultList .= ',ts_analyzer_checkLinenum,ts_analyzer_checkSyntax';
    }

    public function modMenu() {
        return array(
            'ts_analyzer_checkSetup' => '1',
            'ts_analyzer_checkConst' => '1',
            'ts_analyzer_checkLinenum' => '1',
            'ts_analyzer_checkComments' => '1',
            'ts_analyzer_checkCrop' => '1',
            'ts_analyzer_checkSyntax' => '1'
        );
    }

    public function initialize_editor($pageId, $template_uid = 0) {
        // Initializes the module. Done in this function because we may need to re-initialize if data is submitted!
        $GLOBALS['tmpl'] = \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance('TYPO3\\CMS\\Core\\TypoScript\\ExtendedTemplateService');
        // Do not log time-performance information
        $GLOBALS['tmpl']->tt_track = 0;
        $GLOBALS['tmpl']->init();
        // Gets the rootLine
        $sys_page = \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance('TYPO3\\CMS\\Frontend\\Page\\PageRepository');
        $GLOBALS['rootLine'] = $sys_page->getRootLine($pageId);
        // This generates the constants/config + hierarchy info for the template.
        $GLOBALS['tmpl']->runThroughTemplates($GLOBALS['rootLine'], $template_uid);
        // Get the row of the first VISIBLE template of the page. whereclause like the frontend.
        $GLOBALS['tplRow'] = $GLOBALS['tmpl']->ext_getFirstTemplate($pageId, $template_uid);
        if (is_array($GLOBALS['tplRow'])) {
            // IF there was a template...
            return 1;
        }
    }

    public function main() {
        $theOutput = '';

        // 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...
        $manyTemplatesMenu = $this->pObj->templateMenu();
        $template_uid = 0;
        if ($manyTemplatesMenu) {
            $template_uid = $this->pObj->MOD_SETTINGS['templatesOnPage'];
        }

        // BUGBUG: Should we check if the uset may at all read and write template-records???
        $existTemplate = $this->initialize_editor($this->pObj->id, $template_uid);

        // initialize
        if ($existTemplate) {
            $theOutput .= $this->pObj->doc->section(
                $GLOBALS['LANG']->getLL('currentTemplate', TRUE),
                \TYPO3\CMS\Backend\Utility\IconUtility::getSpriteIconForRecord('sys_template', $GLOBALS['tplRow']) . '<strong>' . $this->pObj->linkWrapTemplateTitle($GLOBALS['tplRow']['title']) . '</strong>' . htmlspecialchars((trim($GLOBALS['tplRow']['sitetitle']) ? ' (' . $GLOBALS['tplRow']['sitetitle'] . ')' : ''))
            );
        }
        if ($manyTemplatesMenu) {
            $theOutput .= $this->pObj->doc->section('', $manyTemplatesMenu);
        }
        $GLOBALS['tmpl']->clearList_const_temp = array_flip($GLOBALS['tmpl']->clearList_const);
        $GLOBALS['tmpl']->clearList_setup_temp = array_flip($GLOBALS['tmpl']->clearList_setup);
        $pointer = count($GLOBALS['tmpl']->hierarchyInfo);
        $hierarchyInfo = $GLOBALS['tmpl']->ext_process_hierarchyInfo(array(), $pointer);
        $head = '<thead><tr>';
        $head .= '<th>' . $GLOBALS['LANG']->getLL('title', TRUE) . '</th>';
        $head .= '<th>' . $GLOBALS['LANG']->getLL('rootlevel', TRUE) . '</th>';
        $head .= '<th>' . $GLOBALS['LANG']->getLL('clearSetup', TRUE) . '</th>';
        $head .= '<th>' . $GLOBALS['LANG']->getLL('clearConstants', TRUE) . '</th>';
        $head .= '<th>' . $GLOBALS['LANG']->getLL('pid', TRUE) . '</th>';
        $head .= '<th>' . $GLOBALS['LANG']->getLL('rootline', TRUE) . '</th>';
        $head .= '<th>' . $GLOBALS['LANG']->getLL('nextLevel', TRUE) . '</th>';
        $head .= '</tr></thead>';
        $hierar = implode(array_reverse($GLOBALS['tmpl']->ext_getTemplateHierarchyArr($hierarchyInfo, '', array(), 1)), '');
        $hierar = '<table class="t3-table" id="ts-analyzer">' . $head . $hierar . '</table>';
        $theOutput .= $this->pObj->doc->spacer(5);
        $theOutput .= $this->pObj->doc->section($GLOBALS['LANG']->getLL('templateHierarchy', TRUE), $hierar, 0, 1);
        $urlParameters = array(
            'id' => $GLOBALS['SOBE']->id,
            'template' => 'all'
        );
        $aHref = \TYPO3\CMS\Backend\Utility\BackendUtility::getModuleUrl('web_ts', $urlParameters);
        $completeLink = '<p><a href="' . htmlspecialchars($aHref) . '" class="t3-button">' . $GLOBALS['LANG']->getLL('viewCompleteTS', TRUE) . '</a></p>';
        $theOutput .= $this->pObj->doc->spacer(5);
        $theOutput .= $this->pObj->doc->section($GLOBALS['LANG']->getLL('completeTS', TRUE), $completeLink, 0, 1);
        $theOutput .= $this->pObj->doc->spacer(15);
        // Output options
        $theOutput .= $this->pObj->doc->section($GLOBALS['LANG']->getLL('displayOptions', TRUE), '', FALSE, TRUE);
        $addParams = \TYPO3\CMS\Core\Utility\GeneralUtility::_GET('template') ? '&template=' . \TYPO3\CMS\Core\Utility\GeneralUtility::_GET('template') : '';
        $theOutput .= '<div class="tst-analyzer-options">' . \TYPO3\CMS\Backend\Utility\BackendUtility::getFuncCheck($this->pObj->id, 'SET[ts_analyzer_checkLinenum]', $this->pObj->MOD_SETTINGS['ts_analyzer_checkLinenum'], '', $addParams, 'id="checkTs_analyzer_checkLinenum"') . '<label for="checkTs_analyzer_checkLinenum">' . $GLOBALS['LANG']->getLL('lineNumbers', TRUE) . '</label> ' . \TYPO3\CMS\Backend\Utility\BackendUtility::getFuncCheck($this->pObj->id, 'SET[ts_analyzer_checkSyntax]', $this->pObj->MOD_SETTINGS['ts_analyzer_checkSyntax'], '', $addParams, 'id="checkTs_analyzer_checkSyntax"') . '<label for="checkTs_analyzer_checkSyntax">' . $GLOBALS['LANG']->getLL('syntaxHighlight', TRUE) . '</label> ' . (!$this->pObj->MOD_SETTINGS['ts_analyzer_checkSyntax'] ? \TYPO3\CMS\Backend\Utility\BackendUtility::getFuncCheck($this->pObj->id, 'SET[ts_analyzer_checkComments]', $this->pObj->MOD_SETTINGS['ts_analyzer_checkComments'], '', $addParams, 'id="checkTs_analyzer_checkComments"') . '<label for="checkTs_analyzer_checkComments">' . $GLOBALS['LANG']->getLL('comments', TRUE) . '</label> ' . \TYPO3\CMS\Backend\Utility\BackendUtility::getFuncCheck($this->pObj->id, 'SET[ts_analyzer_checkCrop]', $this->pObj->MOD_SETTINGS['ts_analyzer_checkCrop'], '', $addParams, 'id="checkTs_analyzer_checkCrop"') . '<label for="checkTs_analyzer_checkCrop">' . $GLOBALS['LANG']->getLL('cropLines', TRUE) . '</label> ' : '') . '</div>';
        $theOutput .= $this->pObj->doc->spacer(25);
        // Output Constants
        if (\TYPO3\CMS\Core\Utility\GeneralUtility::_GET('template')) {
            $theOutput .= $this->pObj->doc->section($GLOBALS['LANG']->getLL('constants', TRUE), '', 0, 1);
            $theOutput .= $this->pObj->doc->sectionEnd();
            $theOutput .= '
                <table class="t3-table ts-typoscript">
            ';
            // Don't know why -2 and not 0... :-) But works.
            $GLOBALS['tmpl']->ext_lineNumberOffset = 0;
            $GLOBALS['tmpl']->ext_lineNumberOffset_mode = 'const';
            foreach ($GLOBALS['tmpl']->constants as $key => $val) {
                $currentTemplateId = $GLOBALS['tmpl']->hierarchyInfo[$key]['templateID'];
                if ($currentTemplateId == \TYPO3\CMS\Core\Utility\GeneralUtility::_GET('template') || \TYPO3\CMS\Core\Utility\GeneralUtility::_GET('template') == 'all') {
                    $theOutput .= '
                        <tr>
                            <td><strong>' . htmlspecialchars($GLOBALS['tmpl']->hierarchyInfo[$key]['title']) . '</strong></td>
                        </tr>
                        <tr>
                            <td>
                                <table border="0" cellpadding="0" cellspacing="0" width="100%"><tr><td nowrap="nowrap">' . $GLOBALS['tmpl']->ext_outputTS(array($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) . '</td></tr></table>
                            </td>
                        </tr>
                    ';
                    if (\TYPO3\CMS\Core\Utility\GeneralUtility::_GET('template') != 'all') {
                        break;
                    }
                }
                $GLOBALS['tmpl']->ext_lineNumberOffset += count(explode(LF, $val)) + 1;
            }
            $theOutput .= '
                </table>
            ';
        }
        // Output setup
        if (\TYPO3\CMS\Core\Utility\GeneralUtility::_GET('template')) {
            $theOutput .= $this->pObj->doc->spacer(15);
            $theOutput .= $this->pObj->doc->section($GLOBALS['LANG']->getLL('setup', TRUE), '', 0, 1);
            $theOutput .= $this->pObj->doc->sectionEnd();
            $theOutput .= '
                <table class="t3-table ts-typoscript">
            ';
            $GLOBALS['tmpl']->ext_lineNumberOffset = 0;
            $GLOBALS['tmpl']->ext_lineNumberOffset_mode = 'setup';
            foreach ($GLOBALS['tmpl']->config as $key => $val) {
                $currentTemplateId = $GLOBALS['tmpl']->hierarchyInfo[$key]['templateID'];
                if ($currentTemplateId == \TYPO3\CMS\Core\Utility\GeneralUtility::_GET('template') || \TYPO3\CMS\Core\Utility\GeneralUtility::_GET('template') == 'all') {
                    $theOutput .= '
                        <tr>
                            <td><strong>' . htmlspecialchars($GLOBALS['tmpl']->hierarchyInfo[$key]['title']) . '</strong></td></tr>
                        <tr>
                            <td><table border="0" cellpadding="0" cellspacing="0" width="100%"><tr><td nowrap="nowrap">' . $GLOBALS['tmpl']->ext_outputTS(array($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) . '</td></tr></table>
                            </td>
                        </tr>
                    ';
                    if (\TYPO3\CMS\Core\Utility\GeneralUtility::_GET('template') != 'all') {
                        break;
                    }
                }
                $GLOBALS['tmpl']->ext_lineNumberOffset += count(explode(LF, $val)) + 1;
            }
            $theOutput .= '
                </table>
            ';
        }
        return $theOutput;
    }

}