9.5/adminpanel_2_classes_2_module_api_2_abstract_module_8php_source.html

<?php

declare(strict_types = 1);


namespace ‪TYPO3\CMS\Adminpanel\ModuleApi;


/*

 * 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\Adminpanel\Service\ConfigurationService;

use ‪TYPO3\CMS\Backend\FrontendBackendUserAuthentication;

use ‪TYPO3\CMS\Core\Authentication\BackendUserAuthentication;

use ‪TYPO3\CMS\Core\Localization\LanguageService;

use ‪TYPO3\CMS\Core\Utility\GeneralUtility;


abstract class ‪AbstractModule implements ‪ModuleInterface, ‪ConfigurableInterface, ‪SubmoduleProviderInterface

{


    protected ‪$subModules = [];


    protected ‪$mainConfiguration;


    protected ‪$configurationService;


    public function ‪__construct()

    {

        $this->configurationService = GeneralUtility::makeInstance(ConfigurationService::class);

        $this->mainConfiguration = $this->configurationService->getMainConfiguration();

    }


    public function ‪isEnabled(): bool

    {

        $identifier = $this->‪getIdentifier();

        $result = $this->‪isEnabledViaTsConfig();

        if ($this->mainConfiguration['override.'][$identifier] ?? false) {

            $result = (bool)$this->mainConfiguration['override.'][$identifier];

        }

        return $result;

    }


    public function ‪setSubModules(array ‪$subModules): void

    {

        $this->subModules = ‪$subModules;

    }


    public function ‪getSubModules(): array

    {

        return ‪$this->subModules;

    }


    public function ‪hasSubmoduleSettings(): bool

    {

        $hasSettings = false;

        foreach ($this->subModules as $subModule) {

            if ($subModule instanceof ‪ModuleSettingsProviderInterface) {

                $hasSettings = true;

                break;

            }

            if ($subModule instanceof ‪SubmoduleProviderInterface) {

                $hasSettings = $subModule->hasSubmoduleSettings();

            }

        }

        return $hasSettings;

    }


    protected function ‪getBackendUser(): ‪BackendUserAuthentication

    {

        return ‪$GLOBALS['BE_USER'];

    }


    protected function ‪getLanguageService(): ‪LanguageService

    {

        return ‪$GLOBALS['LANG'];

    }


    protected function ‪isEnabledViaTsConfig(): bool

    {

        $result = false;

        $identifier = $this->‪getIdentifier();

        if (!empty($this->mainConfiguration['enable.']['all'])) {

            $result = true;

        } elseif (!empty($this->mainConfiguration['enable.'][$identifier])) {

            $result = true;

        }

        return $result;

    }

}