Fab\Vidi\Module\ModulePreferences

Complexity

Total Complexity

24

Size/Duplication

Total Lines	221
Duplicated Lines	3.62 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes

0

12 Methods

Rating	Name	Duplication	Size	Complexity
A	get()	0	14	4
A	isLoaded()	0	4	1
A	getAll()	0	9	2
A	getSignature()	0	5	1
A	load()	0	11	1
A	save()	0	27	3
A	fetchPreferencesFromDatabase()	0	16	2
A	fetchGlobalPreferencesFromTypoScript()	0	14	3
A	fetchExtraPreferencesFromTypoScript()	0	18	4
A	getSettings()	8	8	1
A	getDataService()	0	4	1
A	getModuleLoader()	0	4	1

<?php
namespace Fab\Vidi\Module;

/*
 * This file is part of the Fab/Vidi project under GPLv2 or later.
 *
 * For the full copyright and license information, please read the
 * LICENSE.md file that was distributed with this source code.
 */

use Fab\Vidi\Service\DataService;
use TYPO3\CMS\Core\SingletonInterface;
use TYPO3\CMS\Core\Utility\GeneralUtility;

/**
 * Class used to retrieve module preferences.
 */
class ModulePreferences implements SingletonInterface
{

    /**
     * @var array
     */
    protected $preferences;

    /**
     * @var string
     */
    protected $tableName = 'tx_vidi_preference';

    /**
     * @param string $key
     * @param string $dataType
     * @return mixed
     */
    public function get($key, $dataType = '')
    {

        if (empty($dataType)) {
            $dataType = $this->getModuleLoader()->getDataType();
        }

        if (!$this->isLoaded($dataType)) {
            $this->load($dataType);
        }

        $value = empty($this->preferences[$dataType][$key]) ? null : $this->preferences[$dataType][$key];
        return $value;
    }

    /**
     * Tell whether the module is loaded.
     *
     * @param string $dataType
     * @return bool
     */
    public function isLoaded($dataType)
    {
        return !empty($this->preferences[$dataType]);
    }

    /**
     * @param string $dataType
     * @return array
     */
    public function getAll($dataType = '')
    {

        if (empty($dataType)) {
            $dataType = $this->getModuleLoader()->getDataType();
        }
        $this->load($dataType);
        return $this->preferences[$dataType];
    }

    /**
     * Get the md5 signature of the preferences.
     *
     * @param string $dataType
     * @return bool
     */
    public function getSignature($dataType = '')
    {
        $preferences = $this->getAll($dataType);
        return md5(serialize($preferences));
    }

    /**
     * Load preferences.
     *
     * @param string $dataType
     * @return void
     */
    public function load($dataType)
    {

        // Fetch preferences from different sources and overlay them
        $databasePreferences = $this->fetchPreferencesFromDatabase($dataType);
        $generalPreferences = $this->fetchGlobalPreferencesFromTypoScript();
        $specificPreferences = $this->fetchExtraPreferencesFromTypoScript($dataType);

        $preferences = array_merge($generalPreferences, $specificPreferences, $databasePreferences);
        $this->preferences[$dataType] = $preferences;
    }

    /**
     * Save preferences
     *
     * @param array $preferences
     * @return void
     */
    public function save($preferences)
    {
        $configurableParts = ConfigurablePart::getParts();

        $dataType = $this->getModuleLoader()->getDataType();
        $this->getDataService()->delete(
            $this->tableName,
            [
                'data_type' => $dataType
            ]
        );

        $sanitizedPreferences = [];
        foreach ($preferences as $key => $value) {
            if (in_array($key, $configurableParts)) {
                $sanitizedPreferences[$key] = $value;
            }
        }

        $this->getDataService()->insert(
            $this->tableName,
            [
                'data_type' => $dataType,
                'preferences' => serialize($sanitizedPreferences),
            ]
        );
    }

    /**
     * @param $dataType
     * @return array
     */
    public function fetchPreferencesFromDatabase($dataType)
    {
        $preferences = [];
        $record = $this->getDataService()->getRecord(
            $this->tableName,
            [
                'data_type' => $dataType
            ]
        );

        if (!empty($record)) {
            $preferences = unserialize($record['preferences']);
        }

        return $preferences;
    }

    /**
     * Returns the module settings.
     *
     * @return array
     */
    protected function fetchGlobalPreferencesFromTypoScript()
    {
        $settings = $this->getSettings();

        $configurableParts = ConfigurablePart::getParts();
        $preferences = [];
        foreach ($settings as $key => $value) {
            if (in_array($key, $configurableParts)) {
                $preferences[$key] = $value;
            }
        }

        return $preferences;
    }

    /**
     * Returns the module settings.
     *
     * @param string $dataType
     * @return array
     */
    protected function fetchExtraPreferencesFromTypoScript($dataType)
    {
        $generalSettings = $this->getSettings();

        $preferences = [];
        if (isset($generalSettings[$dataType . '.'])) {
            $settings = $generalSettings[$dataType . '.'];

            $configurableParts = ConfigurablePart::getParts();
            foreach ($settings as $key => $value) {
                if (in_array($key, $configurableParts)) {
                    $preferences[$key] = $value;
                }
            }
        }

        return $preferences;
    }

    /**
     * Returns the module settings.
     *
     * @return array
     */
    protected function getSettings()

This method seems to be duplicated in your project.

    {
        /** @var \TYPO3\CMS\Extbase\Configuration\BackendConfigurationManager $backendConfigurationManager */
        $objectManager = GeneralUtility::makeInstance(\TYPO3\CMS\Extbase\Object\ObjectManager::class);
        $backendConfigurationManager = $objectManager->get(\TYPO3\CMS\Extbase\Configuration\BackendConfigurationManager::class);
        $configuration = $backendConfigurationManager->getTypoScriptSetup();
        return $configuration['module.']['tx_vidi.']['settings.'];
    }

    /**
     * @return object|DataService
     */
    protected function getDataService(): DataService
    {
        return GeneralUtility::makeInstance(DataService::class);
    }

    /**
     * Get the Vidi Module Loader.
     *
     * @return \Fab\Vidi\Module\ModuleLoader|object
     */
    protected function getModuleLoader()
    {
        return GeneralUtility::makeInstance(\Fab\Vidi\Module\ModuleLoader::class);
    }

}