‪TYPO3CMS  9.5
TYPO3\CMS\Extbase\Configuration\AbstractConfigurationManager Class Reference
Inheritance diagram for TYPO3\CMS\Extbase\Configuration\AbstractConfigurationManager:
TYPO3\CMS\Core\SingletonInterface TYPO3\CMS\Extbase\Configuration\BackendConfigurationManager TYPO3\CMS\Extbase\Configuration\FrontendConfigurationManager

Public Member Functions

 injectObjectManager (\TYPO3\CMS\Extbase\Object\ObjectManagerInterface $objectManager)
 
 injectTypoScriptService (\TYPO3\CMS\Core\TypoScript\TypoScriptService $typoScriptService)
 
 injectEnvironmentService (\TYPO3\CMS\Extbase\Service\EnvironmentService $environmentService)
 
 setContentObject (\TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer $contentObject=null)
 
TYPO3 CMS Frontend ContentObject ContentObjectRenderer null getContentObject ()
 
 setConfiguration (array $configuration=[])
 
array getConfiguration ($extensionName=null, $pluginName=null)
 
string getDefaultBackendStoragePid ()
 
array getTypoScriptSetup ()
 

Public Attributes

const DEFAULT_BACKEND_STORAGE_PID = 0
 

Protected Member Functions

array getExtbaseConfiguration ()
 
 overrideSwitchableControllerActions (array &$frameworkConfiguration, array $switchableControllerActions)
 
array getContextSpecificFrameworkConfiguration (array $frameworkConfiguration)
 
array getPluginConfiguration ($extensionName, $pluginName=null)
 
array getSwitchableControllerActions ($extensionName, $pluginName)
 
string getRecursiveStoragePids ($storagePid, $recursionDepth=0)
 

Protected Attributes

array $configuration = array( )
 
TYPO3 CMS Frontend ContentObject ContentObjectRenderer $contentObject
 
TYPO3 CMS Extbase Object ObjectManagerInterface $objectManager
 
TYPO3 CMS Core TypoScript TypoScriptService $typoScriptService
 
string $extensionName
 
string $pluginName
 
array $configurationCache = array( )
 
TYPO3 CMS Extbase Service EnvironmentService $environmentService
 

Detailed Description

Abstract base class for a general purpose configuration manager

only to be used within Extbase, not part of TYPO3 Core API.

Definition at line 21 of file AbstractConfigurationManager.php.

Member Function Documentation

◆ getConfiguration()

array TYPO3\CMS\Extbase\Configuration\AbstractConfigurationManager::getConfiguration (   $extensionName = null,
  $pluginName = null 
)

Loads the Extbase Framework configuration.

The Extbase framework configuration HAS TO be retrieved using this method, as they are come from different places than the normal settings. Framework configuration is, in contrast to normal settings, needed for the Extbase framework to operate correctly.

Parameters
string$extensionName‪if specified, the configuration for the given extension will be returned (plugin.tx_extensionname)
string$pluginName‪if specified, the configuration for the given plugin will be returned (plugin.tx_extensionname_pluginname)
Returns
‪array the Extbase framework configuration

Definition at line 136 of file AbstractConfigurationManager.php.

References TYPO3\CMS\Extbase\Configuration\AbstractConfigurationManager\$extensionName, $GLOBALS, TYPO3\CMS\Extbase\Configuration\AbstractConfigurationManager\$pluginName, TYPO3\CMS\Extbase\Configuration\AbstractConfigurationManager\getContentObject(), TYPO3\CMS\Extbase\Configuration\AbstractConfigurationManager\getContextSpecificFrameworkConfiguration(), TYPO3\CMS\Extbase\Configuration\AbstractConfigurationManager\getDefaultBackendStoragePid(), TYPO3\CMS\Extbase\Configuration\AbstractConfigurationManager\getExtbaseConfiguration(), TYPO3\CMS\Extbase\Configuration\AbstractConfigurationManager\getPluginConfiguration(), TYPO3\CMS\Extbase\Configuration\AbstractConfigurationManager\getRecursiveStoragePids(), TYPO3\CMS\Extbase\Configuration\AbstractConfigurationManager\getSwitchableControllerActions(), TYPO3\CMS\Core\Utility\ArrayUtility\mergeRecursiveWithOverrule(), TYPO3\CMS\Extbase\Configuration\AbstractConfigurationManager\overrideSwitchableControllerActions(), TYPO3\CMS\Extbase\Utility\FrontendSimulatorUtility\resetFrontendEnvironment(), and TYPO3\CMS\Extbase\Utility\FrontendSimulatorUtility\simulateFrontendEnvironment().

Referenced by TYPO3\CMS\Extbase\Tests\Unit\Configuration\AbstractConfigurationManagerTest\switchableControllerActionsAreNotOverriddenIfPluginNameIsSpecified(), TYPO3\CMS\Extbase\Tests\Unit\Configuration\AbstractConfigurationManagerTest\switchableControllerActionsAreOverriddenIfPluginNameIsNotSpecified(), and TYPO3\CMS\Extbase\Tests\Unit\Configuration\AbstractConfigurationManagerTest\switchableControllerActionsAreOverriddenIfSpecifiedPluginIsTheCurrentPlugin().

◆ getContentObject()

TYPO3 CMS Frontend ContentObject ContentObjectRenderer null TYPO3\CMS\Extbase\Configuration\AbstractConfigurationManager::getContentObject ( )

◆ getContextSpecificFrameworkConfiguration()

array TYPO3\CMS\Extbase\Configuration\AbstractConfigurationManager::getContextSpecificFrameworkConfiguration ( array  $frameworkConfiguration)
abstractprotected

The context specific configuration returned by this method will override the framework configuration which was obtained from TypoScript. This can be used f.e. to override the storagePid with the value set inside the Plugin Instance.

WARNING: Make sure this method ALWAYS returns an array!

Parameters
array$frameworkConfiguration‪The framework configuration until now
Returns
‪array context specific configuration which will override the configuration obtained by TypoScript

Reimplemented in TYPO3\CMS\Extbase\Configuration\BackendConfigurationManager, and TYPO3\CMS\Extbase\Configuration\FrontendConfigurationManager.

Referenced by TYPO3\CMS\Extbase\Configuration\AbstractConfigurationManager\getConfiguration().

◆ getDefaultBackendStoragePid()

string TYPO3\CMS\Extbase\Configuration\AbstractConfigurationManager::getDefaultBackendStoragePid ( )

◆ getExtbaseConfiguration()

array TYPO3\CMS\Extbase\Configuration\AbstractConfigurationManager::getExtbaseConfiguration ( )
protected

Returns the TypoScript configuration found in config.tx_extbase

Returns
‪array

Definition at line 205 of file AbstractConfigurationManager.php.

References TYPO3\CMS\Extbase\Configuration\AbstractConfigurationManager\getTypoScriptSetup().

Referenced by TYPO3\CMS\Extbase\Configuration\AbstractConfigurationManager\getConfiguration().

◆ getPluginConfiguration()

array TYPO3\CMS\Extbase\Configuration\AbstractConfigurationManager::getPluginConfiguration (   $extensionName,
  $pluginName = null 
)
abstractprotected

Returns the TypoScript configuration found in plugin.tx_yourextension_yourplugin / module.tx_yourextension_yourmodule merged with the global configuration of your extension from plugin.tx_yourextension / module.tx_yourextension

Parameters
string$extensionName
string$pluginName‪in FE mode this is the specified plugin name, in BE mode this is the full module signature
Returns
‪array

Reimplemented in TYPO3\CMS\Extbase\Configuration\BackendConfigurationManager, and TYPO3\CMS\Extbase\Configuration\FrontendConfigurationManager.

Referenced by TYPO3\CMS\Extbase\Configuration\AbstractConfigurationManager\getConfiguration().

◆ getRecursiveStoragePids()

string TYPO3\CMS\Extbase\Configuration\AbstractConfigurationManager::getRecursiveStoragePids (   $storagePid,
  $recursionDepth = 0 
)
abstractprotected

The implementation of the methods to return a list of storagePid that are below a certain storage pid.

Parameters
string$storagePid‪Storage PID to start at; multiple PIDs possible as comma-separated list
int$recursionDepth‪Maximum number of levels to search, 0 to disable recursive lookup
Returns
‪string storage PIDs

Reimplemented in TYPO3\CMS\Extbase\Configuration\BackendConfigurationManager, and TYPO3\CMS\Extbase\Configuration\FrontendConfigurationManager.

Referenced by TYPO3\CMS\Extbase\Configuration\AbstractConfigurationManager\getConfiguration().

◆ getSwitchableControllerActions()

array TYPO3\CMS\Extbase\Configuration\AbstractConfigurationManager::getSwitchableControllerActions (   $extensionName,
  $pluginName 
)
abstractprotected

Returns the configured controller/action pairs of the specified plugin/module in the format array( 'Controller1' => array('action1', 'action2'), 'Controller2' => array('action3', 'action4') )

Parameters
string$extensionName
string$pluginName‪in FE mode this is the specified plugin name, in BE mode this is the full module signature
Returns
‪array

Reimplemented in TYPO3\CMS\Extbase\Configuration\BackendConfigurationManager, and TYPO3\CMS\Extbase\Configuration\FrontendConfigurationManager.

Referenced by TYPO3\CMS\Extbase\Configuration\AbstractConfigurationManager\getConfiguration().

◆ getTypoScriptSetup()

array TYPO3\CMS\Extbase\Configuration\AbstractConfigurationManager::getTypoScriptSetup ( )
abstract

◆ injectEnvironmentService()

TYPO3\CMS\Extbase\Configuration\AbstractConfigurationManager::injectEnvironmentService ( \TYPO3\CMS\Extbase\Service\EnvironmentService  $environmentService)
Parameters
\TYPO3\CMS\Extbase\Service\EnvironmentService$environmentService

Definition at line 87 of file AbstractConfigurationManager.php.

References TYPO3\CMS\Extbase\Configuration\AbstractConfigurationManager\$environmentService.

◆ injectObjectManager()

TYPO3\CMS\Extbase\Configuration\AbstractConfigurationManager::injectObjectManager ( \TYPO3\CMS\Extbase\Object\ObjectManagerInterface  $objectManager)
Parameters
\TYPO3\CMS\Extbase\Object\ObjectManagerInterface$objectManager

Definition at line 71 of file AbstractConfigurationManager.php.

References TYPO3\CMS\Extbase\Configuration\AbstractConfigurationManager\$objectManager.

◆ injectTypoScriptService()

TYPO3\CMS\Extbase\Configuration\AbstractConfigurationManager::injectTypoScriptService ( \TYPO3\CMS\Core\TypoScript\TypoScriptService  $typoScriptService)
Parameters
\TYPO3\CMS\Core\TypoScript\TypoScriptService$typoScriptService

Definition at line 79 of file AbstractConfigurationManager.php.

References TYPO3\CMS\Extbase\Configuration\AbstractConfigurationManager\$typoScriptService.

◆ overrideSwitchableControllerActions()

TYPO3\CMS\Extbase\Configuration\AbstractConfigurationManager::overrideSwitchableControllerActions ( array &  $frameworkConfiguration,
array  $switchableControllerActions 
)
protected

◆ setConfiguration()

TYPO3\CMS\Extbase\Configuration\AbstractConfigurationManager::setConfiguration ( array  $configuration = [])

◆ setContentObject()

TYPO3\CMS\Extbase\Configuration\AbstractConfigurationManager::setContentObject ( \TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer  $contentObject = null)
Parameters
\TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer$contentObject

Definition at line 95 of file AbstractConfigurationManager.php.

References TYPO3\CMS\Extbase\Configuration\AbstractConfigurationManager\$contentObject.

Member Data Documentation

◆ $configuration

array TYPO3\CMS\Extbase\Configuration\AbstractConfigurationManager::$configuration = array( )
protected

◆ $configurationCache

array TYPO3\CMS\Extbase\Configuration\AbstractConfigurationManager::$configurationCache = array( )
protected

1st level configuration cache

Definition at line 62 of file AbstractConfigurationManager.php.

◆ $contentObject

TYPO3 CMS Frontend ContentObject ContentObjectRenderer TYPO3\CMS\Extbase\Configuration\AbstractConfigurationManager::$contentObject
protected

◆ $environmentService

TYPO3 CMS Extbase Service EnvironmentService TYPO3\CMS\Extbase\Configuration\AbstractConfigurationManager::$environmentService
protected

◆ $extensionName

◆ $objectManager

TYPO3 CMS Extbase Object ObjectManagerInterface TYPO3\CMS\Extbase\Configuration\AbstractConfigurationManager::$objectManager
protected

◆ $pluginName

◆ $typoScriptService

TYPO3 CMS Core TypoScript TypoScriptService TYPO3\CMS\Extbase\Configuration\AbstractConfigurationManager::$typoScriptService
protected

◆ DEFAULT_BACKEND_STORAGE_PID