ApacheSolrForTypo3\Solr\System\Configuration\ConfigurationManager

Complexity

Total Complexity

22

Size/Duplication

Total Lines	183
Duplicated Lines	0 %

Test Coverage

Coverage

88.46%

Importance

Changes	1
Bugs	0	Features	0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	injectEventDispatcher()	0	3	1
A	reset()	0	3	1
A	getTypoScriptConfigurationInstance()	0	8	1
B	getTypoScriptConfiguration()	0	39	10
A	getTypoScriptConfigurationByPageAndLanguage()	0	8	1
A	getExtensionConfiguration()	0	3	1
A	getSiteConfiguration()	0	8	2
A	getGlobalConfiguration()	0	3	1
A	getUnifiedConfiguration()	0	19	4

<?php
namespace ApacheSolrForTypo3\Solr\System\Configuration;

/*
 * 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 ApacheSolrForTypo3\Solr\Event\UnifiedConfigurationEvent;
use Psr\EventDispatcher\EventDispatcherInterface;
use TYPO3\CMS\Core\SingletonInterface;
use TYPO3\CMS\Core\Utility\GeneralUtility;

/**
 * Configuration manager old the configuration instance.
 * Singleton
 *
 * @author Timo Schmidt <timo.schmidt@dkd.de>
 * @copyright (c) 2010-2016 Timo Schmidt <timo.schmidt@dkd.de
 */
class ConfigurationManager implements SingletonInterface
{
    /**
     * @var EventDispatcherInterface
     */
    protected $eventDispatcher;

    /**
     * TypoScript Configurations
     *
     * @var TypoScriptConfiguration|UnifiedConfiguration[]
     */
    protected $typoScriptConfigurations = [];

    /**
     * @param EventDispatcherInterface $eventDispatcher
     */
    public function injectEventDispatcher(EventDispatcherInterface $eventDispatcher)
    {
        $this->eventDispatcher = $eventDispatcher;
    }

    /**
     * Resets the state of the configuration manager.
     *
     * @return void
     */
    public function reset()
    {
        $this->typoScriptConfigurations = [];
    }

    /**
     * Build a unified configuration in order to have all configuration settings in one place
     *
     * @param int $pageUid
     * @param int $languageUid
     * @return UnifiedConfiguration
     */
    public function getUnifiedConfiguration(int $pageUid = 0, int $languageUid = 0): UnifiedConfiguration
    {
        if ($pageUid === 0 && !empty($GLOBALS['TSFE']->id)) {
            $pageUid = (int)$GLOBALS['TSFE']->id;
        }

        $hash = md5(UnifiedConfiguration::class . '-' . $pageUid . '-' . $languageUid);
        if (isset($this->typoScriptConfigurations[$hash])) {
            return $this->typoScriptConfigurations[$hash];
        }

        $unifiedConfiguration = new UnifiedConfiguration($pageUid, $languageUid);
        // Requires TYPO3 10 LTS
        $event = new UnifiedConfigurationEvent($unifiedConfiguration);
        $this->eventDispatcher->dispatch($event);

        $this->typoScriptConfigurations[$hash] = $unifiedConfiguration;

        return $unifiedConfiguration;
    }

    /**
     * Returns instance of the global configuration
     *
     * @return GlobalConfiguration
     */
    public function getGlobalConfiguration(): GlobalConfiguration
    {
        return new GlobalConfiguration();
    }

    /**
     * Returns instance of the global configuration
     *
     * @return ExtensionConfiguration
     */
    public function getExtensionConfiguration(): ExtensionConfiguration
    {
        return new ExtensionConfiguration();
    }

    /**
     * Returns the site configuration by given page uid and language
     *
     * @param int $pageUid
     * @param int $languageUid
     * @return SiteConfiguration
     */
    public function getSiteConfiguration(int $pageUid = 0, int $languageUid = 0): SiteConfiguration
    {
        $hash = md5(SiteConfiguration::class . '-' . $pageUid . '-' . $languageUid);
        if (!isset($this->typoScriptConfigurations[$hash])) {
            $this->typoScriptConfigurations[$hash] = new SiteConfiguration($pageUid, $languageUid);
        }

        return $this->typoScriptConfigurations[$hash];
    }

    /**
     * Returns the TypoScript configuration by given page and language uid.
     *
     * @see ConfigurationManager:getTypoScriptConfiguration
     *
     * @param int $pageUid
     * @param int $languageUid
     * @return TypoScriptConfiguration
     */
    public function getTypoScriptConfigurationByPageAndLanguage(
        int $pageUid,
        int $languageUid = 0
    ): TypoScriptConfiguration {
        return $this->getTypoScriptConfiguration(
            null,
            $pageUid,
            $languageUid
        );
    }

    /**
     * Retrieves the TypoScriptConfiguration object from an configuration array, pageId, languageId and TypoScript
     * path that is used in in the current context.
     *
     * @param array $configurationArray
     * @param int $contextPageId
     * @param int $contextLanguageId
     * @param string $contextTypoScriptPath
     * @return TypoScriptConfiguration
     */
    public function getTypoScriptConfiguration(
        array $configurationArray = null,
        $contextPageId = null,
        $contextLanguageId = 0,
        $contextTypoScriptPath = ''
    ) {
        if ($configurationArray == null) {
            if (isset($this->typoScriptConfigurations['default'])) {
                $configurationArray = $this->typoScriptConfigurations['default'];
            } else {
                if (!empty($GLOBALS['TSFE']->tmpl->setup) && is_array($GLOBALS['TSFE']->tmpl->setup)) {
                    $configurationArray = $GLOBALS['TSFE']->tmpl->setup;
                    $this->typoScriptConfigurations['default'] = $configurationArray;
                }
            }
        }

        if (!is_array($configurationArray)) {
            $configurationArray = [];
        }

        if (!isset($configurationArray['plugin.']['tx_solr.'])) {
            $configurationArray['plugin.']['tx_solr.'] = [];
        }

        if ($contextPageId === null && !empty($GLOBALS['TSFE']->id)) {
            $contextPageId = $GLOBALS['TSFE']->id;
        }

        $hash = md5(serialize($configurationArray)) . '-' . $contextPageId . '-' . $contextLanguageId . '-' . $contextTypoScriptPath;
        if (isset($this->typoScriptConfigurations[$hash])) {
            return $this->typoScriptConfigurations[$hash];
        }

        $this->typoScriptConfigurations[$hash] = $this->getTypoScriptConfigurationInstance(
            $configurationArray,
            (int)$contextPageId
        );
        return $this->typoScriptConfigurations[$hash];
    }

    /**
     * This method is used to build the TypoScriptConfiguration.
     *
     * @param array $configurationArray
     * @param int $contextPageId
     * @return TypoScriptConfiguration
     */
    protected function getTypoScriptConfigurationInstance(
        array $configurationArray = null,
        int $contextPageId = 0
    ): TypoScriptConfiguration {
        return GeneralUtility::makeInstance(
            TypoScriptConfiguration::class,
            /** @scrutinizer ignore-type */ $configurationArray,
            /** @scrutinizer ignore-type */ (int)$contextPageId
        );
    }
}