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

Public Member Functions

 __construct (ObjectManagerInterface $objectManager, TypoScriptService $typoScriptService, EnvironmentService $environmentService, FlexFormService $flexFormService)
 
array getTypoScriptSetup ()
 
- ‪Public Member Functions inherited from ‪TYPO3\CMS\Extbase\Configuration\AbstractConfigurationManager
 __construct (ObjectManagerInterface $objectManager, TypoScriptService $typoScriptService, EnvironmentService $environmentService)
 
 setContentObject (ContentObjectRenderer $contentObject)
 
TYPO3 CMS Frontend ContentObject ContentObjectRenderer null getContentObject ()
 
 setConfiguration (array $configuration=[])
 
array getConfiguration (?string $extensionName=null, ?string $pluginName=null)
 
int getDefaultBackendStoragePid ()
 

Protected Member Functions

array getPluginConfiguration (string $extensionName, string $pluginName=null)
 
array getControllerConfiguration (string $extensionName, string $pluginName)
 
array getContextSpecificFrameworkConfiguration (array $frameworkConfiguration)
 
array overrideStoragePidIfStartingPointIsSet (array $frameworkConfiguration)
 
array overrideConfigurationFromPlugin (array $frameworkConfiguration)
 
array overrideConfigurationFromFlexForm (array $frameworkConfiguration)
 
array mergeConfigurationIntoFrameworkConfiguration (array $frameworkConfiguration, array $configuration, string $configurationPartName)
 
array overrideControllerConfigurationWithSwitchableControllerActionsFromFlexForm (array $frameworkConfiguration, array $flexFormConfiguration)
 
array int[] getRecursiveStoragePids (array $storagePids, int $recursionDepth=0)
 
- ‪Protected Member Functions inherited from ‪TYPO3\CMS\Extbase\Configuration\AbstractConfigurationManager
array getExtbaseConfiguration ()
 
 overrideControllerConfigurationWithSwitchableControllerActions (array &$frameworkConfiguration, array $switchableControllerActions)
 

Protected Attributes

TYPO3 CMS Core Service FlexFormService $flexFormService
 
- ‪Protected Attributes inherited from ‪TYPO3\CMS\Extbase\Configuration\AbstractConfigurationManager
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
 

Additional Inherited Members

- ‪Public Attributes inherited from ‪TYPO3\CMS\Extbase\Configuration\AbstractConfigurationManager
const DEFAULT_BACKEND_STORAGE_PID = 0
 

Detailed Description

A general purpose configuration manager used in frontend mode.

Should NOT be singleton, as a new configuration manager is needed per plugin.

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

Definition at line 34 of file FrontendConfigurationManager.php.

Constructor & Destructor Documentation

◆ __construct()

TYPO3\CMS\Extbase\Configuration\FrontendConfigurationManager::__construct ( ObjectManagerInterface  $objectManager,
TypoScriptService  $typoScriptService,
EnvironmentService  $environmentService,
FlexFormService  $flexFormService 
)
Parameters
\TYPO3\CMS\Extbase\Object\ObjectManagerInterface$objectManager
\TYPO3\CMS\Core\TypoScript\TypoScriptService$typoScriptService
\TYPO3\CMS\Extbase\Service\EnvironmentService$environmentService
\TYPO3\CMS\Core\Service\FlexFormService$flexFormService

Definition at line 46 of file FrontendConfigurationManager.php.

References TYPO3\CMS\Extbase\Configuration\AbstractConfigurationManager\$environmentService, TYPO3\CMS\Extbase\Configuration\FrontendConfigurationManager\$flexFormService, TYPO3\CMS\Extbase\Configuration\AbstractConfigurationManager\$objectManager, and TYPO3\CMS\Extbase\Configuration\AbstractConfigurationManager\$typoScriptService.

Member Function Documentation

◆ getContextSpecificFrameworkConfiguration()

array TYPO3\CMS\Extbase\Configuration\FrontendConfigurationManager::getContextSpecificFrameworkConfiguration ( array  $frameworkConfiguration)
protected

Get context specific framework configuration.

  • ‪Overrides storage PID with setting "Startingpoint"
  • ‪merge flexForm configuration, if needed
Parameters
array$frameworkConfiguration‪The framework configuration to modify
Returns
‪array the modified framework configuration

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

Definition at line 122 of file FrontendConfigurationManager.php.

References TYPO3\CMS\Extbase\Configuration\FrontendConfigurationManager\overrideConfigurationFromFlexForm(), TYPO3\CMS\Extbase\Configuration\FrontendConfigurationManager\overrideConfigurationFromPlugin(), and TYPO3\CMS\Extbase\Configuration\FrontendConfigurationManager\overrideStoragePidIfStartingPointIsSet().

◆ getControllerConfiguration()

array TYPO3\CMS\Extbase\Configuration\FrontendConfigurationManager::getControllerConfiguration ( string  $extensionName,
string  $pluginName 
)
protected

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

Parameters
string$extensionName
string$pluginName
Returns
‪array

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

Definition at line 105 of file FrontendConfigurationManager.php.

References TYPO3\CMS\Extbase\Configuration\AbstractConfigurationManager\$extensionName, $GLOBALS, and TYPO3\CMS\Extbase\Configuration\AbstractConfigurationManager\$pluginName.

◆ getPluginConfiguration()

array TYPO3\CMS\Extbase\Configuration\FrontendConfigurationManager::getPluginConfiguration ( string  $extensionName,
string  $pluginName = null 
)
protected

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

Parameters
string$extensionName
string$pluginName
Returns
‪array

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

Definition at line 75 of file FrontendConfigurationManager.php.

References TYPO3\CMS\Extbase\Configuration\AbstractConfigurationManager\$extensionName, TYPO3\CMS\Extbase\Configuration\AbstractConfigurationManager\$pluginName, TYPO3\CMS\Extbase\Configuration\FrontendConfigurationManager\getTypoScriptSetup(), and TYPO3\CMS\Core\Utility\ArrayUtility\mergeRecursiveWithOverrule().

◆ getRecursiveStoragePids()

array int [] TYPO3\CMS\Extbase\Configuration\FrontendConfigurationManager::getRecursiveStoragePids ( array  $storagePids,
int  $recursionDepth = 0 
)
protected

Returns a comma separated list of storagePid that are below a certain storage pid.

Parameters
array | int[]$storagePids‪Storage PIDs to start at; multiple PIDs possible as comma-separated list
int$recursionDepth‪Maximum number of levels to search, 0 to disable recursive lookup
Returns
‪array|int[] storage PIDs

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

Definition at line 269 of file FrontendConfigurationManager.php.

References TYPO3\CMS\Extbase\Configuration\AbstractConfigurationManager\getContentObject(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getTreeList(), and TYPO3\CMS\Core\Utility\GeneralUtility\intExplode().

◆ getTypoScriptSetup()

array TYPO3\CMS\Extbase\Configuration\FrontendConfigurationManager::getTypoScriptSetup ( )

◆ mergeConfigurationIntoFrameworkConfiguration()

array TYPO3\CMS\Extbase\Configuration\FrontendConfigurationManager::mergeConfigurationIntoFrameworkConfiguration ( array  $frameworkConfiguration,
array  $configuration,
string  $configurationPartName 
)
protected

Merge a configuration into the framework configuration.

Parameters
array$frameworkConfiguration‪the framework configuration to merge the data on
array$configuration‪The configuration
string$configurationPartName‪The name of the configuration part which should be merged.
Returns
‪array the processed framework configuration

Definition at line 218 of file FrontendConfigurationManager.php.

References TYPO3\CMS\Extbase\Configuration\AbstractConfigurationManager\$configuration, and TYPO3\CMS\Core\Utility\ArrayUtility\mergeRecursiveWithOverrule().

Referenced by TYPO3\CMS\Extbase\Configuration\FrontendConfigurationManager\overrideConfigurationFromFlexForm(), and TYPO3\CMS\Extbase\Configuration\FrontendConfigurationManager\overrideConfigurationFromPlugin().

◆ overrideConfigurationFromFlexForm()

array TYPO3\CMS\Extbase\Configuration\FrontendConfigurationManager::overrideConfigurationFromFlexForm ( array  $frameworkConfiguration)
protected

Overrides configuration settings from flexForms. This merges the whole flexForm data, and overrides the controller configuration with possibly configured switchable controller actions.

Parameters
array$frameworkConfiguration‪the framework configuration
Returns
‪array the framework configuration with overridden data from flexForm

Definition at line 191 of file FrontendConfigurationManager.php.

References TYPO3\CMS\Extbase\Configuration\FrontendConfigurationManager\mergeConfigurationIntoFrameworkConfiguration(), and TYPO3\CMS\Extbase\Configuration\FrontendConfigurationManager\overrideControllerConfigurationWithSwitchableControllerActionsFromFlexForm().

Referenced by TYPO3\CMS\Extbase\Configuration\FrontendConfigurationManager\getContextSpecificFrameworkConfiguration().

◆ overrideConfigurationFromPlugin()

array TYPO3\CMS\Extbase\Configuration\FrontendConfigurationManager::overrideConfigurationFromPlugin ( array  $frameworkConfiguration)
protected

Overrides configuration settings from the plugin typoscript (plugin.tx_myext_pi1.)

Parameters
array$frameworkConfiguration‪the framework configuration
Returns
‪array the framework configuration with overridden data from typoscript

Definition at line 169 of file FrontendConfigurationManager.php.

References TYPO3\CMS\Extbase\Configuration\FrontendConfigurationManager\getTypoScriptSetup(), and TYPO3\CMS\Extbase\Configuration\FrontendConfigurationManager\mergeConfigurationIntoFrameworkConfiguration().

Referenced by TYPO3\CMS\Extbase\Configuration\FrontendConfigurationManager\getContextSpecificFrameworkConfiguration().

◆ overrideControllerConfigurationWithSwitchableControllerActionsFromFlexForm()

array TYPO3\CMS\Extbase\Configuration\FrontendConfigurationManager::overrideControllerConfigurationWithSwitchableControllerActionsFromFlexForm ( array  $frameworkConfiguration,
array  $flexFormConfiguration 
)
protected

Overrides the controller configuration with possibly registered switchable controller actions of the flex form configuration.

Parameters
array$frameworkConfiguration‪The original framework configuration
array$flexFormConfiguration‪The full flexForm configuration
Exceptions
Exception

Definition at line 240 of file FrontendConfigurationManager.php.

References TYPO3\CMS\Extbase\Configuration\AbstractConfigurationManager\overrideControllerConfigurationWithSwitchableControllerActions(), and TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

Referenced by TYPO3\CMS\Extbase\Configuration\FrontendConfigurationManager\overrideConfigurationFromFlexForm().

◆ overrideStoragePidIfStartingPointIsSet()

array TYPO3\CMS\Extbase\Configuration\FrontendConfigurationManager::overrideStoragePidIfStartingPointIsSet ( array  $frameworkConfiguration)
protected

Overrides the storage PID settings, in case the "Startingpoint" settings is set in the plugin configuration.

Parameters
array$frameworkConfiguration‪the framework configurations
Returns
‪array the framework configuration with overridden storagePid

Definition at line 137 of file FrontendConfigurationManager.php.

References TYPO3\CMS\Core\Utility\ArrayUtility\mergeRecursiveWithOverrule(), and TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

Referenced by TYPO3\CMS\Extbase\Configuration\FrontendConfigurationManager\getContextSpecificFrameworkConfiguration().

Member Data Documentation

◆ $flexFormService

TYPO3 CMS Core Service FlexFormService TYPO3\CMS\Extbase\Configuration\FrontendConfigurationManager::$flexFormService
protected