ConfigurationManager extends ConfigurationManager implements ConfigurationManagerInterface

Extend the ExtbaseConfigurationManager to read YAML configurations.

Scope: frontend / backend

Internal

Table of Contents

Interfaces

ConfigurationManagerInterface
Scope: frontend / backend

Properties

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

Methods

__construct()  : mixed
getConfiguration()  : array<string|int, mixed>
Returns the specified configuration.
injectYamlSource()  : mixed
setConfiguration()  : void
Sets the specified raw configuration coming from the outside.
setRequest()  : void
Set the current request. The ConfigurationManager needs this to determine which concrete ConfigurationManager (BE / FE) has to be created, and the concrete ConfigurationManager need this to access current site and similar.
getCacheFrontend()  : FrontendInterface
getConfigurationCacheKey()  : string
getConfigurationFromYamlFile()  : array<string|int, mixed>
Load and parse YAML files which are configured within the TypoScript path plugin.tx_extensionkey.settings.yamlConfigurations
getTypoScriptSettings()  : array<string|int, mixed>
getYamlSettingsFromCache()  : mixed
initializeConcreteConfigurationManager()  : void
overrideConfigurationByTypoScript()  : array<string|int, mixed>
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<string|int, mixed>
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<string|int, mixed> —

The configuration

setConfiguration()

Sets the specified raw configuration coming from the outside.

public setConfiguration([array<string|int, mixed> $configuration = [] ]) : void

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

Parameters
$configuration : array<string|int, mixed> = []

The new configuration

Internal

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

setRequest()

Set the current request. The ConfigurationManager needs this to determine which concrete ConfigurationManager (BE / FE) has to be created, and the concrete ConfigurationManager need this to access current site and similar.

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<string|int, mixed>

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<string|int, mixed>

getTypoScriptSettings()

protected getTypoScriptSettings(string $extensionName) : array<string|int, mixed>
Parameters
$extensionName : string
Return values
array<string|int, mixed>

getYamlSettingsFromCache()

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

initializeConcreteConfigurationManager()

protected initializeConcreteConfigurationManager() : void

overrideConfigurationByTypoScript()

protected overrideConfigurationByTypoScript(array<string|int, mixed> $yamlSettings, string $extensionName) : array<string|int, mixed>
Parameters
$yamlSettings : array<string|int, mixed>
$extensionName : string
Return values
array<string|int, mixed>

setYamlSettingsIntoCache()

protected setYamlSettingsIntoCache(string $cacheKeySuffix, array<string|int, mixed> $yamlSettings) : mixed
Parameters
$cacheKeySuffix : string
$yamlSettings : array<string|int, mixed> 

        

        
    




    

    

                            

            

                            
    

        On this page

        
    


            

                    

        

    

        

            
Search results