ConfigurationUtility.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\Extensionmanager\Utility;

/*
 * 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\Core\TypoScript\ConfigurationForm;

class ConfigurationUtility implements \TYPO3\CMS\Core\SingletonInterface
{
    protected $objectManager;

    public function injectObjectManager(\TYPO3\CMS\Extbase\Object\ObjectManager $objectManager)
    {
        $this->objectManager = $objectManager;
    }

    public function saveDefaultConfiguration($extensionKey)
    {
        $currentConfiguration = $this->getCurrentConfiguration($extensionKey);
        $nestedConfiguration = $this->convertValuedToNestedConfiguration($currentConfiguration);
        $this->writeConfiguration($nestedConfiguration, $extensionKey);
    }

    public function writeConfiguration(array $configuration = [], $extensionKey)
    {
        $configurationManager = $this->objectManager->get(\TYPO3\CMS\Core\Configuration\ConfigurationManager::class);
        $configurationManager->setLocalConfigurationValueByPath('EXT/extConf/' . $extensionKey, serialize($configuration));
    }

    public function getCurrentConfiguration($extensionKey)
    {
        $mergedConfiguration = $this->getDefaultConfigurationFromExtConfTemplateAsValuedArray($extensionKey);
        $currentExtensionConfig = unserialize($GLOBALS['TYPO3_CONF_VARS']['EXT']['extConf'][$extensionKey]);
        $currentExtensionConfig = is_array($currentExtensionConfig) ? $currentExtensionConfig : [];
        $currentExtensionConfig = $this->convertNestedToValuedConfiguration($currentExtensionConfig);
        \TYPO3\CMS\Core\Utility\ArrayUtility::mergeRecursiveWithOverrule(
            $mergedConfiguration,
            $currentExtensionConfig
        );
        return $mergedConfiguration;
    }

    public function getDefaultConfigurationFromExtConfTemplateAsValuedArray($extensionKey)
    {
        $rawConfigurationString = $this->getDefaultConfigurationRawString($extensionKey);

        $theConstants = [];

        if ((string)$rawConfigurationString !== '') {
            $extensionPathInformation = $this->getExtensionPathInformation($extensionKey);

            $tsStyleConfig = $this->objectManager->get(ConfigurationForm::class);
            $tsStyleConfig->doNotSortCategoriesBeforeMakingForm = true;

            $theConstants = $tsStyleConfig->ext_initTSstyleConfig(
                $rawConfigurationString,
                $extensionPathInformation['siteRelPath'],
                PATH_site . $extensionPathInformation['siteRelPath']
            );

            // Loop through configuration items, see if it is assigned to a sub category
            // and add the sub category label to the item property if so.
            foreach ($theConstants as $configurationOptionName => $configurationOption) {
                if (
                    array_key_exists('subcat_name', $configurationOption)
                    && isset($tsStyleConfig->subCategories[$configurationOption['subcat_name']])
                    && isset($tsStyleConfig->subCategories[$configurationOption['subcat_name']][0])
                ) {
                    $theConstants[$configurationOptionName]['subcat_label'] = $tsStyleConfig->subCategories[$configurationOption['subcat_name']][0];
                }
            }

            // Set up the additional descriptions
            if (isset($tsStyleConfig->setup['constants']['TSConstantEditor.'])) {
                foreach ($tsStyleConfig->setup['constants']['TSConstantEditor.'] as $category => $highlights) {
                    $theConstants['__meta__'][rtrim($category, '.')]['highlightText'] = $highlights['description'];
                    foreach ($highlights as $highlightNumber => $value) {
                        if (rtrim($category, '.') == $theConstants[$value]['cat']) {
                            $theConstants[$value]['highlight'] = $highlightNumber;
                        }
                    }
                }
            }
        }

        return $theConstants;
    }

    protected function getExtensionPathInformation($extensionKey)
    {
        return $GLOBALS['TYPO3_LOADED_EXT'][$extensionKey];
    }

    protected function getDefaultConfigurationRawString($extensionKey)
    {
        $rawString = '';
        $extConfTemplateFileLocation = \TYPO3\CMS\Core\Utility\GeneralUtility::getFileAbsFileName(
            'EXT:' . $extensionKey . '/ext_conf_template.txt',
            false
        );
        if (file_exists($extConfTemplateFileLocation)) {
            $rawString = file_get_contents($extConfTemplateFileLocation);
        }
        return $rawString;
    }

    public function convertValuedToNestedConfiguration(array $valuedConfiguration)
    {
        $nestedConfiguration = [];
        foreach ($valuedConfiguration as $name => $section) {
            $path = str_replace('.', './', $name);
            $nestedConfiguration = \TYPO3\CMS\Core\Utility\ArrayUtility::setValueByPath($nestedConfiguration, $path, $section['value'], '/');
        }
        return $nestedConfiguration;
    }

    public function convertNestedToValuedConfiguration(array $nestedConfiguration)
    {
        $flatExtensionConfig = \TYPO3\CMS\Core\Utility\ArrayUtility::flatten($nestedConfiguration);
        $valuedCurrentExtensionConfig = [];
        foreach ($flatExtensionConfig as $key => $value) {
            $valuedCurrentExtensionConfig[$key]['value'] = $value;
        }
        return $valuedCurrentExtensionConfig;
    }
}