ConfigurationService.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
/*
 * 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!
 */
 
namespace ‪TYPO3\CMS\Adminpanel\Service;
 
use Psr\Http\Message\ServerRequestInterface;
use ‪TYPO3\CMS\Adminpanel\ModuleApi\ConfigurableInterface;
use ‪TYPO3\CMS\Adminpanel\ModuleApi\OnSubmitActorInterface;
use ‪TYPO3\CMS\Adminpanel\ModuleApi\SubmoduleProviderInterface;
use ‪TYPO3\CMS\Backend\FrontendBackendUserAuthentication;
use ‪TYPO3\CMS\Core\Authentication\BackendUserAuthentication;
use ‪TYPO3\CMS\Core\SingletonInterface;
 
class ‪ConfigurationService implements ‪SingletonInterface
{
    public function ‪getMainConfiguration(): array
    {
        return $this->‪getBackendUser()->‪getTSConfig()['admPanel.'] ?? [];
    }
 
    public function ‪getConfigurationOption(string $identifier, string $option): string
    {
        if ($identifier === '' || $option === '') {
            throw new \InvalidArgumentException('Identifier and option may not be empty', 1532861423);
        }
 
        $returnValue = $this->‪getMainConfiguration()['override.'][$identifier . '.'][$option] ?? $this->‪getBackendUser()->uc['AdminPanel'][$identifier . '_' . $option] ?? '';
 
        return (string)$returnValue;
    }
 
    public function ‪saveConfiguration(array $modules, ServerRequestInterface $request): void
    {
        $configurationToSave = $request->getParsedBody()['TSFE_ADMIN_PANEL'] ?? [];
        $beUser = $this->‪getBackendUser();
        $this->‪triggerOnSubmitActors($modules, $request, $configurationToSave);
 
        $existingConfiguration = $beUser->uc['AdminPanel'] ?? [];
        $existingConfiguration = is_array($existingConfiguration) ? $existingConfiguration : [];
 
        // Settings
        $beUser->uc['AdminPanel'] = array_merge($existingConfiguration, $configurationToSave);
        unset($beUser->uc['AdminPanel']['action']);
        // Saving
        $beUser->writeUC();
    }
 
    protected function ‪getBackendUser(): ‪BackendUserAuthentication
    {
        return ‪$GLOBALS['BE_USER'];
    }
 
    protected function ‪triggerOnSubmitActors(
        array $modules,
        ServerRequestInterface $request,
        $configurationToSave
    ): void {
        foreach ($modules as $module) {
            if (
                $module instanceof ‪OnSubmitActorInterface
                && (
                    ($module instanceof ‪ConfigurableInterface && $module->‪isEnabled())
                    || !($module instanceof ‪ConfigurableInterface)
                )
            ) {
                $module->onSubmit($configurationToSave, $request);
            }
            if ($module instanceof ‪SubmoduleProviderInterface) {
                $this->‪triggerOnSubmitActors($module->getSubModules(), $request, $configurationToSave);
            }
        }
    }
}