‪TYPO3CMS  10.4
TYPO3\CMS\Form\Mvc\Configuration\ConfigurationManager Class Reference
Inheritance diagram for TYPO3\CMS\Form\Mvc\Configuration\ConfigurationManager:
TYPO3\CMS\Extbase\Configuration\ConfigurationManager TYPO3\CMS\Form\Mvc\Configuration\ConfigurationManagerInterface TYPO3\CMS\Extbase\Configuration\ConfigurationManagerInterface TYPO3\CMS\Extbase\Configuration\ConfigurationManagerInterface TYPO3\CMS\Core\SingletonInterface TYPO3\CMS\Core\SingletonInterface

Public Member Functions

 injectYamlSource (YamlSource $yamlSource)
 
array getConfiguration (string $configurationType, string $extensionName=null, string $pluginName=null)
 
- ‪Public Member Functions inherited from ‪TYPO3\CMS\Extbase\Configuration\ConfigurationManager
 __construct (ObjectManagerInterface $objectManager, EnvironmentService $environmentService)
 
 setContentObject (ContentObjectRenderer $contentObject)
 
TYPO3 CMS Frontend ContentObject ContentObjectRenderer null getContentObject ()
 
 setConfiguration (array $configuration=[])
 
bool isFeatureEnabled (string $featureName)
 
- ‪Public Member Functions inherited from ‪TYPO3\CMS\Extbase\Configuration\ConfigurationManagerInterface
array getConfiguration (string $configurationType, ?string $extensionName=null, ?string $pluginName=null)
 

Protected Member Functions

array getConfigurationFromYamlFile (string $extensionName)
 
array overrideConfigurationByTypoScript (array $yamlSettings, string $extensionName)
 
TYPO3 CMS Core Cache Frontend FrontendInterface getCacheFrontend ()
 
string getConfigurationCacheKey (string $cacheKeySuffix)
 
mixed getYamlSettingsFromCache (string $cacheKeySuffix)
 
 setYamlSettingsIntoCache (string $cacheKeySuffix, array $yamlSettings)
 
array getTypoScriptSettings (string $extensionName)
 
- ‪Protected Member Functions inherited from ‪TYPO3\CMS\Extbase\Configuration\ConfigurationManager
 initializeConcreteConfigurationManager ()
 

Protected Attributes

TYPO3 CMS Core Cache Frontend FrontendInterface $cache
 
TYPO3 CMS Form Mvc Configuration YamlSource $yamlSource
 
- ‪Protected Attributes inherited from ‪TYPO3\CMS\Extbase\Configuration\ConfigurationManager
TYPO3 CMS Extbase Object ObjectManagerInterface $objectManager
 
TYPO3 CMS Extbase Configuration AbstractConfigurationManager $concreteConfigurationManager
 
TYPO3 CMS Extbase Service EnvironmentService $environmentService
 

Additional Inherited Members

- ‪Public Attributes inherited from ‪TYPO3\CMS\Extbase\Configuration\ConfigurationManagerInterface
const CONFIGURATION_TYPE_FRAMEWORK = 'Framework'
 
const CONFIGURATION_TYPE_SETTINGS = 'Settings'
 
const CONFIGURATION_TYPE_FULL_TYPOSCRIPT = 'FullTypoScript'
 
- ‪Public Attributes inherited from ‪TYPO3\CMS\Form\Mvc\Configuration\ConfigurationManagerInterface
const CONFIGURATION_TYPE_YAML_SETTINGS = 'YamlSettings'
 

Detailed Description

Extend the ExtbaseConfigurationManager to read YAML configurations.

Scope: frontend / backend

Definition at line 33 of file ConfigurationManager.php.

Member Function Documentation

◆ getCacheFrontend()

TYPO3 CMS Core Cache Frontend FrontendInterface TYPO3\CMS\Form\Mvc\Configuration\ConfigurationManager::getCacheFrontend ( )
protected

◆ getConfiguration()

array TYPO3\CMS\Form\Mvc\Configuration\ConfigurationManager::getConfiguration ( string  $configurationType,
string  $extensionName = null,
string  $pluginName = null 
)
Parameters
string$configurationType‪The kind of configuration to fetch - must be one of the CONFIGURATION_TYPE_* constants
string$extensionName‪if specified, the configuration for the given extension will be returned.
string$pluginName‪if specified, the configuration for the given plugin will be returned.
Returns
‪array The configuration

Reimplemented from TYPO3\CMS\Extbase\Configuration\ConfigurationManager.

Definition at line 60 of file ConfigurationManager.php.

References TYPO3\CMS\Form\Mvc\Configuration\ConfigurationManagerInterface\CONFIGURATION_TYPE_YAML_SETTINGS, and TYPO3\CMS\Form\Mvc\Configuration\ConfigurationManager\getConfigurationFromYamlFile().

◆ getConfigurationCacheKey()

string TYPO3\CMS\Form\Mvc\Configuration\ConfigurationManager::getConfigurationCacheKey ( string  $cacheKeySuffix)
protected

◆ getConfigurationFromYamlFile()

array TYPO3\CMS\Form\Mvc\Configuration\ConfigurationManager::getConfigurationFromYamlFile ( string  $extensionName)
protected

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

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
string$extensionName
Returns
‪array
Exceptions
ExtensionNameRequiredException

Definition at line 88 of file ConfigurationManager.php.

References TYPO3\CMS\Form\Mvc\Configuration\InheritancesResolverService\create(), TYPO3\CMS\Form\Mvc\Configuration\InheritancesResolverService\getResolvedConfiguration(), TYPO3\CMS\Form\Mvc\Configuration\ConfigurationManager\getTypoScriptSettings(), TYPO3\CMS\Form\Mvc\Configuration\ConfigurationManager\getYamlSettingsFromCache(), TYPO3\CMS\Form\Mvc\Configuration\ConfigurationManager\overrideConfigurationByTypoScript(), TYPO3\CMS\Core\Utility\ArrayUtility\removeNullValuesRecursive(), TYPO3\CMS\Form\Mvc\Configuration\ConfigurationManager\setYamlSettingsIntoCache(), TYPO3\CMS\Core\Utility\ArrayUtility\sortArrayWithIntegerKeys(), and TYPO3\CMS\Core\Utility\ArrayUtility\sortArrayWithIntegerKeysRecursive().

Referenced by TYPO3\CMS\Form\Mvc\Configuration\ConfigurationManager\getConfiguration().

◆ getTypoScriptSettings()

array TYPO3\CMS\Form\Mvc\Configuration\ConfigurationManager::getTypoScriptSettings ( string  $extensionName)
protected

◆ getYamlSettingsFromCache()

mixed TYPO3\CMS\Form\Mvc\Configuration\ConfigurationManager::getYamlSettingsFromCache ( string  $cacheKeySuffix)
protected

◆ injectYamlSource()

TYPO3\CMS\Form\Mvc\Configuration\ConfigurationManager::injectYamlSource ( YamlSource  $yamlSource)
Parameters
\TYPO3\CMS\Form\Mvc\Configuration\YamlSource$yamlSource

Definition at line 48 of file ConfigurationManager.php.

References TYPO3\CMS\Form\Mvc\Configuration\ConfigurationManager\$yamlSource.

◆ overrideConfigurationByTypoScript()

array TYPO3\CMS\Form\Mvc\Configuration\ConfigurationManager::overrideConfigurationByTypoScript ( array  $yamlSettings,
string  $extensionName 
)
protected
Parameters
array$yamlSettings
string$extensionName
Returns
‪array

Definition at line 129 of file ConfigurationManager.php.

References TYPO3\CMS\Core\Utility\ArrayUtility\mergeRecursiveWithOverrule().

Referenced by TYPO3\CMS\Form\Mvc\Configuration\ConfigurationManager\getConfigurationFromYamlFile().

◆ setYamlSettingsIntoCache()

TYPO3\CMS\Form\Mvc\Configuration\ConfigurationManager::setYamlSettingsIntoCache ( string  $cacheKeySuffix,
array  $yamlSettings 
)
protected

Member Data Documentation

◆ $cache

TYPO3 CMS Core Cache Frontend FrontendInterface TYPO3\CMS\Form\Mvc\Configuration\ConfigurationManager::$cache
protected

◆ $yamlSource

TYPO3 CMS Form Mvc Configuration YamlSource TYPO3\CMS\Form\Mvc\Configuration\ConfigurationManager::$yamlSource
protected