Your IP : 216.73.217.13
<?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\Extbase\Configuration;
use Psr\Container\ContainerInterface;
use Psr\Http\Message\ServerRequestInterface;
use TYPO3\CMS\Core\Http\ApplicationType;
use TYPO3\CMS\Extbase\Configuration\Exception\InvalidConfigurationTypeException;
use TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer;
/**
* A configuration manager following the strategy pattern. It hides the concrete
* implementation of the configuration manager and provides a unified access point.
*
* @internal only to be used within Extbase, not part of TYPO3 Core API.
*/
class ConfigurationManager implements ConfigurationManagerInterface
{
private ContainerInterface $container;
/**
* @todo: Make nullable and private(?) in v13.
*/
protected FrontendConfigurationManager|BackendConfigurationManager $concreteConfigurationManager;
private ?ServerRequestInterface $request = null;
public function __construct(ContainerInterface $container)
{
$this->container = $container;
$this->initializeConcreteConfigurationManager();
}
protected function initializeConcreteConfigurationManager(): void
{
// @todo: Move into getConfiguration() in v13.
// This will allow getting rid of $GLOBALS['TYPO3_REQUEST'] here, and the
// concrete ConfigurationManager is created "late" in getConfiguration().
// Check $this->concreteConfigurationManager for null. If null, fetch request from
// $this->request() (and *maybe* check TYPO3_REQUEST as b/w layer, better not), if still
// null, fall back to BackendConfigurationManager.
// Background: People tend to inject ConfigurationManager into non-extbase bootstrapped
// classes since the getConfiguration() API is so convenient. If request has not been set
// via setRequest(), this *may* indicate a CLI call. Extbase in general needs requests for
// controllers, but we *may* want to allow getting ConfigurationManager injected as
// "standalone" feature in CLI as well? OTOH, we could avoid this, when the TypoScript
// factories have been refactored far enough to be easily usable. If so, the request
// properties should be made non-nullable.
if (($GLOBALS['TYPO3_REQUEST'] ?? null) instanceof ServerRequestInterface
&& ApplicationType::fromRequest($GLOBALS['TYPO3_REQUEST'])->isFrontend()
) {
$this->concreteConfigurationManager = $this->container->get(FrontendConfigurationManager::class);
} else {
$this->concreteConfigurationManager = $this->container->get(BackendConfigurationManager::class);
}
}
/**
* @internal
*/
public function setRequest(ServerRequestInterface $request): void
{
$this->request = $request;
// @todo: Move to getConfiguration() together with "late" creation of $this->concreteConfigurationManager
$this->concreteConfigurationManager->setRequest($this->request);
}
/**
* @deprecated since v12. Remove in v13.
*/
public function setContentObject(ContentObjectRenderer $contentObject): void
{
$this->concreteConfigurationManager->setContentObject($contentObject);
}
/**
* @deprecated since v12. Remove in v13.
*/
public function getContentObject(): ?ContentObjectRenderer
{
trigger_error(
'ConfigurationManager->getContentObject() is deprecated since TYPO3 v12.4 and will be removed in v13.0.' .
' Fetch the current content object from request attribute "currentContentObject" instead',
E_USER_DEPRECATED
);
return $this->concreteConfigurationManager->getContentObject();
}
/**
* Sets the specified raw configuration coming from the outside.
* Note that this is a low level method and only makes sense to be used by Extbase internally.
*
* @param array $configuration The new configuration
* @internal Set by extbase bootstrap internally. Must be called *after* setRequest() has been called.
*/
public function setConfiguration(array $configuration = []): void
{
// @todo: If really needed in v13 and if it can't be refactored out, park
// state in a property and $this->concreteConfigurationManager->setConfiguration()
// after concreteConfigurationManager has been created in getConfiguration().
$this->concreteConfigurationManager->setConfiguration($configuration);
}
/**
* Returns the specified configuration.
* The actual configuration will be merged from different sources in a defined order.
*
* You can get the following types of configuration invoking:
* CONFIGURATION_TYPE_SETTINGS: Extbase settings
* CONFIGURATION_TYPE_FRAMEWORK: the current module/plugin settings
* CONFIGURATION_TYPE_FULL_TYPOSCRIPT: a raw TS array
*
* Note that this is a low level method and only makes sense to be used by Extbase internally.
*
* @param string $configurationType The kind of configuration to fetch - must be one of the CONFIGURATION_TYPE_* constants
* @param string|null $extensionName if specified, the configuration for the given extension will be returned.
* @param string|null $pluginName if specified, the configuration for the given plugin will be returned.
* @throws Exception\InvalidConfigurationTypeException
* @return array The configuration
*/
public function getConfiguration(string $configurationType, string $extensionName = null, string $pluginName = null): array
{
switch ($configurationType) {
case self::CONFIGURATION_TYPE_SETTINGS:
$configuration = $this->concreteConfigurationManager->getConfiguration($extensionName, $pluginName);
return $configuration['settings'] ?? [];
case self::CONFIGURATION_TYPE_FRAMEWORK:
return $this->concreteConfigurationManager->getConfiguration($extensionName, $pluginName);
case self::CONFIGURATION_TYPE_FULL_TYPOSCRIPT:
return $this->concreteConfigurationManager->getTypoScriptSetup();
default:
throw new InvalidConfigurationTypeException('Invalid configuration type "' . $configurationType . '"', 1206031879);
}
}
/**
* Returns TRUE if a certain feature, identified by $featureName
* should be activated, FALSE for backwards-compatible behavior.
*
* This is an INTERNAL API used throughout Extbase and Fluid for providing backwards-compatibility.
* Do not use it in your custom code!
*
* @internal
* @deprecated since TYPO3 v12, will be removed in TYPO3 v13. Remove together with other extbase feature toggle related code.
*/
public function isFeatureEnabled(string $featureName): bool
{
$configuration = $this->getConfiguration(self::CONFIGURATION_TYPE_FRAMEWORK);
return (bool)(isset($configuration['features'][$featureName]) && $configuration['features'][$featureName]);
}
}