ConfigurationController.php

Go to the documentation of this file.

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

/*
 * 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\Backend\Template\Components\ButtonBar;
use TYPO3\CMS\Backend\View\BackendTemplateView;
use TYPO3\CMS\Core\Imaging\Icon;
use TYPO3\CMS\Extbase\Mvc\View\ViewInterface;
use TYPO3\CMS\Extensionmanager\Domain\Model\Extension;
use TYPO3\CMS\Extensionmanager\Exception\ExtensionManagerException;

class ConfigurationController extends AbstractModuleController
{
    protected $configurationItemRepository;

    protected $extensionRepository;

    public function injectConfigurationItemRepository(\TYPO3\CMS\Extensionmanager\Domain\Repository\ConfigurationItemRepository $configurationItemRepository)
    {
        $this->configurationItemRepository = $configurationItemRepository;
    }

    public function injectExtensionRepository(\TYPO3\CMS\Extensionmanager\Domain\Repository\ExtensionRepository $extensionRepository)
    {
        $this->extensionRepository = $extensionRepository;
    }

    protected function initializeView(ViewInterface $view)
    {
        if ($view instanceof BackendTemplateView) {
            parent::initializeView($view);
            $this->generateMenu();
            $this->registerDocheaderButtons();
        }
    }

    public function showConfigurationFormAction(array $extension)
    {
        if (!isset($extension['key'])) {
            throw new ExtensionManagerException('Extension key not found.', 1359206803);
        }
        $extKey = $extension['key'];
        $configuration = $this->configurationItemRepository->findByExtensionKey($extKey);
        if ($configuration) {
            $this->view
                ->assign('configuration', $configuration)
                ->assign('extension', $extension);
        } else {
            $extension = $this->extensionRepository->findOneByCurrentVersionByExtensionKey($extKey);
            // Extension has no configuration and is a distribution
            if ($extension->getCategory() === Extension::DISTRIBUTION_CATEGORY) {
                $this->redirect('welcome', 'Distribution', null, ['extension' => $extension->getUid()]);
            }
            throw new ExtensionManagerException('The extension ' . $extKey . ' has no configuration.');
        }
    }

    public function saveAction(array $config, $extensionKey)
    {
        $this->saveConfiguration($config, $extensionKey);
        $extension = $this->extensionRepository->findOneByCurrentVersionByExtensionKey($extensionKey);
        // Different handling for distribution installation
        if ($extension instanceof Extension &&
            $extension->getCategory() === Extension::DISTRIBUTION_CATEGORY
        ) {
            $this->redirect('welcome', 'Distribution', null, ['extension' => $extension->getUid()]);
        } else {
            $this->redirect('showConfigurationForm', null, null, ['extension' => ['key' => $extensionKey]]);
        }
    }

    public function saveAndCloseAction(array $config, $extensionKey)
    {
        $this->saveConfiguration($config, $extensionKey);
        $this->redirect('index', 'List');
    }

    protected function emitAfterExtensionConfigurationWriteSignal($extensionKey, array $newConfiguration)
    {
        $this->signalSlotDispatcher->dispatch(__CLASS__, 'afterExtensionConfigurationWrite', [$extensionKey, $newConfiguration, $this]);
    }

    protected function saveConfiguration(array $config, $extensionKey)
    {
        $configurationUtility = $this->objectManager->get(\TYPO3\CMS\Extensionmanager\Utility\ConfigurationUtility::class);
        $newConfiguration = $configurationUtility->getCurrentConfiguration($extensionKey);
        \TYPO3\CMS\Core\Utility\ArrayUtility::mergeRecursiveWithOverrule($newConfiguration, $config);
        $configurationUtility->writeConfiguration(
            $configurationUtility->convertValuedToNestedConfiguration($newConfiguration),
            $extensionKey
        );
        $this->emitAfterExtensionConfigurationWriteSignal($extensionKey, $newConfiguration);
    }

    protected function registerDocheaderButtons()
    {
        $moduleTemplate = $this->view->getModuleTemplate();
        $lang = $this->getLanguageService();

        $buttonBar = $moduleTemplate->getDocHeaderComponent()->getButtonBar();

        $uriBuilder = $this->controllerContext->getUriBuilder();
        $uri = $uriBuilder->reset()->uriFor('index', [], 'List');

        $icon = $this->view->getModuleTemplate()->getIconFactory()->getIcon('actions-view-go-back', Icon::SIZE_SMALL);
        $goBackButton = $buttonBar->makeLinkButton()
            ->setHref($uri)
            ->setTitle($this->translate('extConfTemplate.backToList'))
            ->setIcon($icon);
        $buttonBar->addButton($goBackButton, ButtonBar::BUTTON_POSITION_LEFT);

        $saveSplitButton = $buttonBar->makeSplitButton();
        // SAVE button:
        $saveButton = $buttonBar->makeInputButton()
            ->setName('_savedok')
            ->setValue('1')
            ->setTitle($lang->sL('LLL:EXT:lang/locallang_core.xlf:rm.saveDoc'))
            ->setForm('configurationform')
            ->setIcon($moduleTemplate->getIconFactory()->getIcon('actions-document-save', Icon::SIZE_SMALL));
        $saveSplitButton->addItem($saveButton, true);

        // SAVE / CLOSE
        $saveAndCloseButton = $buttonBar->makeInputButton()
            ->setName('_saveandclosedok')
            ->setClasses('t3js-save-close')
            ->setValue('1')
            ->setTitle($lang->sL('LLL:EXT:lang/locallang_core.xlf:rm.saveCloseDoc'))
            ->setForm('configurationform')
            ->setIcon($moduleTemplate->getIconFactory()->getIcon(
                'actions-document-save-close',
                Icon::SIZE_SMALL
            ));
        $saveSplitButton->addItem($saveAndCloseButton);
        $buttonBar->addButton($saveSplitButton, ButtonBar::BUTTON_POSITION_LEFT, 2);
    }

    protected function getLanguageService()
    {
        return $GLOBALS['LANG'];
    }
}