ConfigurationForm.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\Core\TypoScript;

class ConfigurationForm extends \TYPO3\CMS\Core\TypoScript\ExtendedTemplateService {

    // Internal
    public $categories = array();

    public $ext_dontCheckIssetValues = 1;

    public $ext_CEformName = 'tsStyleConfigForm';

    public $ext_printAll = 1;

    public $ext_incomingValues = array();

    public function ext_initTSstyleConfig($configTemplate, $pathRel, $pathAbs, $backPath) {
        // Do not log time-performance information
        $this->tt_track = 0;
        $this->constants = array($configTemplate, '');
        // The editable constants are returned in an array.
        $theConstants = $this->generateConfig_constants();
        $this->ext_localGfxPrefix = $pathAbs;
        $this->ext_localWebGfxPrefix = $backPath . $pathRel;
        $this->ext_backPath = $backPath;
        return $theConstants;
    }

    public function ext_setValueArray($theConstants, $valueArray) {
        $temp = $this->flatSetup;
        $this->flatSetup = array();
        $this->flattenSetup($valueArray, '', '');
        $this->objReg = ($this->ext_realValues = $this->flatSetup);
        $this->flatSetup = $temp;
        foreach ($theConstants as $k => $p) {
            if (isset($this->objReg[$k])) {
                $theConstants[$k]['value'] = $this->ext_realValues[$k];
            }
        }
        // Reset the default pool of categories.
        $this->categories = array();
        // The returned constants are sorted in categories, that goes into the $this->categories array
        $this->ext_categorizeEditableConstants($theConstants);
        return $theConstants;
    }

    public function ext_getCategoriesForModMenu() {
        return $this->ext_getCategoryLabelArray();
    }

    public function ext_makeHelpInformationForCategory($cat) {
        return $this->ext_getTSCE_config($cat);
    }

    public function ext_getForm($cat, $theConstants, $script = '', $addFields = '', $extKey = '', $addFormTag = TRUE) {
        $this->ext_makeHelpInformationForCategory($cat);
        $printFields = trim($this->ext_printFields($theConstants, $cat));
        $content = '';
        $content .= \TYPO3\CMS\Core\Utility\GeneralUtility::wrapJS('
            function uFormUrl(aname) {
                document.' . $this->ext_CEformName . '.action = ' . \TYPO3\CMS\Core\Utility\GeneralUtility::quoteJSvalue(\TYPO3\CMS\Core\Utility\GeneralUtility::linkThisScript() . '#') . '+aname;
            }
        ');
        if ($addFormTag) {
            $content .= '<form action="' . htmlspecialchars(($script ?: \TYPO3\CMS\Core\Utility\GeneralUtility::linkThisScript())) . '" name="' . $this->ext_CEformName . '" method="post" enctype="' . $GLOBALS['TYPO3_CONF_VARS']['SYS']['form_enctype'] . '">';
        }
        $content .= $addFields;
        $content .= $printFields;
        $content .= '<input type="submit" name="submit" value="' . $GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_tsfe.xlf:update', TRUE) . '" id="configuration-submit-' . htmlspecialchars($extKey) . '" />';
        $example = $this->ext_displayExample();
        $content .= $example ? '<hr/>' . $example : '';
        return $content;
    }

    public function ext_displayExample() {
        if ($this->helpConfig['imagetag'] || $this->helpConfig['description'] || $this->helpConfig['header']) {
            $out = '<div align="center">' . $this->helpConfig['imagetag'] . '</div><BR>' . ($this->helpConfig['description'] ? implode(explode('//', $this->helpConfig['description']), '<BR>') . '<BR>' : '') . ($this->helpConfig['bulletlist'] ? '<ul><li>' . implode(explode('//', $this->helpConfig['bulletlist']), '<li>') . '</ul>' : '<BR>');
        }
        return $out;
    }

    public function ext_mergeIncomingWithExisting($arr) {
        $parseObj = \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance('TYPO3\\CMS\\Core\\TypoScript\\Parser\\TypoScriptParser');
        $parseObj->parse(implode(LF, $this->ext_incomingValues));
        $arr2 = $parseObj->setup;
        \TYPO3\CMS\Core\Utility\ArrayUtility::mergeRecursiveWithOverrule($arr, $arr2);
        return $arr;
    }

    // Extends:
    public function ext_getKeyImage($key) {
        return '<img' . \TYPO3\CMS\Backend\Utility\IconUtility::skinImg($this->ext_backPath, ('gfx/rednumbers/' . $key . '.gif'), '') . ' hspace="2" align="top" alt="" />';
    }

    public function ext_getTSCE_config_image($imgConf) {
        $iFile = $this->ext_localGfxPrefix . $imgConf;
        $tFile = $this->ext_localWebGfxPrefix . $imgConf;
        $imageInfo = @getImagesize($iFile);
        return '<img src="' . $tFile . '" ' . $imageInfo[3] . '>';
    }

    public function ext_fNandV($params) {
        $fN = 'data[' . $params['name'] . ']';
        $fV = ($params['value'] = isset($this->ext_realValues[$params['name']]) ? $this->ext_realValues[$params['name']] : $params['default_value']);
        $reg = array();
        // Values entered from the constantsedit cannot be constants!
        if (preg_match('/^\\{[\\$][a-zA-Z0-9\\.]*\\}$/', trim($fV), $reg)) {
            $fV = '';
        }
        $fV = htmlspecialchars($fV);
        return array($fN, $fV, $params);
    }

    public function ext_putValueInConf($key, $var) {
        $this->ext_incomingValues[$key] = $key . '=' . $var;
    }

    public function ext_removeValueInConf($key) {

    }

}