ConfigurationManager extends ConfigurationManager implements ConfigurationManagerInterface

Extend the ExtbaseConfigurationManager to read YAML configurations.

Scope: frontend / backend

Internal

Table of Contents

Interfaces

ConfigurationManagerInterface
Class ConfigurationManagerInterface

Properties

$cache  : FrontendInterface
$concreteConfigurationManager  : FrontendConfigurationManager|BackendConfigurationManager
$yamlSource  : YamlSource

Methods

__construct()  : mixed
getConfiguration()  : array
Returns the specified configuration.
getContentObject()  : ContentObjectRenderer|null
injectYamlSource()  : mixed
isFeatureEnabled()  : bool
Returns TRUE if a certain feature, identified by $featureName should be activated, FALSE for backwards-compatible behavior.
setConfiguration()  : void
Sets the specified raw configuration coming from the outside.
setContentObject()  : void
setRequest()  : void
getCacheFrontend()  : FrontendInterface
getConfigurationCacheKey()  : string
getConfigurationFromYamlFile()  : array
Load and parse YAML files which are configured within the TypoScript path plugin.tx_extensionkey.settings.yamlConfigurations
getTypoScriptSettings()  : array
getYamlSettingsFromCache()  : mixed
initializeConcreteConfigurationManager()  : void
overrideConfigurationByTypoScript()  : array
setYamlSettingsIntoCache()  : mixed

Properties

Methods

__construct()

public __construct(ContainerInterface $container) : mixed
Parameters
$container : ContainerInterface

getConfiguration()

Returns the specified configuration.

public getConfiguration(string $configurationType[, string $extensionName = null ][, string $pluginName = null ]) : array
Parameters
$configurationType : string

The kind of configuration to fetch - must be one of the CONFIGURATION_TYPE_* constants

$extensionName : string = null

if specified, the configuration for the given extension will be returned.

$pluginName : string = null

if specified, the configuration for the given plugin will be returned.

Internal
Return values
array —

The configuration

isFeatureEnabled()

Returns TRUE if a certain feature, identified by $featureName should be activated, FALSE for backwards-compatible behavior.

public isFeatureEnabled(string $featureName) : bool
Deprecated

since TYPO3 v12, will be removed in TYPO3 v13. Remove together with other extbase feature toggle related code.

This is an INTERNAL API used throughout Extbase and Fluid for providing backwards-compatibility. Do not use it in your custom code!

Parameters
$featureName : string
Internal
Return values
bool

setConfiguration()

Sets the specified raw configuration coming from the outside.

public setConfiguration([array $configuration = [] ]) : void

Note that this is a low level method and only makes sense to be used by Extbase internally.

Parameters
$configuration : array = []

The new configuration

Internal

Set by extbase bootstrap internally. Must be called after setRequest() has been called.

setRequest()

public setRequest(ServerRequestInterface $request) : void
Parameters
$request : ServerRequestInterface
Internal

getConfigurationCacheKey()

protected getConfigurationCacheKey(string $cacheKeySuffix) : string
Parameters
$cacheKeySuffix : string
Return values
string

getConfigurationFromYamlFile()

Load and parse YAML files which are configured within the TypoScript path plugin.tx_extensionkey.settings.yamlConfigurations

protected getConfigurationFromYamlFile(string $extensionName) : array

The following steps will be done:

  • Convert each singe YAML file into an array
  • merge this arrays together
  • resolve all declared inheritances
  • remove all keys if their values are NULL
  • return all configuration paths within TYPO3.CMS
  • sort by array keys, if all keys within the current nesting level are numerical keys
  • resolve possible TypoScript settings in FE mode
Parameters
$extensionName : string
Tags
throws
ExtensionNameRequiredException
Return values
array

getTypoScriptSettings()

protected getTypoScriptSettings(string $extensionName) : array
Parameters
$extensionName : string
Return values
array

getYamlSettingsFromCache()

protected getYamlSettingsFromCache(string $cacheKeySuffix) : mixed
Parameters
$cacheKeySuffix : string

initializeConcreteConfigurationManager()

protected initializeConcreteConfigurationManager() : void

overrideConfigurationByTypoScript()

protected overrideConfigurationByTypoScript(array $yamlSettings, string $extensionName) : array
Parameters
$yamlSettings : array
$extensionName : string
Return values
array

setYamlSettingsIntoCache()

protected setYamlSettingsIntoCache(string $cacheKeySuffix, array $yamlSettings) : mixed
Parameters
$cacheKeySuffix : string
$yamlSettings : array
On this page

Search results