TYPO3  7.6
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
FrontendConfigurationManager Class Reference
Inheritance diagram for FrontendConfigurationManager:
AbstractConfigurationManager SingletonInterface

Public Member Functions

 injectFlexFormService (\TYPO3\CMS\Extbase\Service\FlexFormService $flexFormService)
 
 getTypoScriptSetup ()
 
- Public Member Functions inherited from AbstractConfigurationManager
 injectObjectManager (\TYPO3\CMS\Extbase\Object\ObjectManagerInterface $objectManager)
 
 injectTypoScriptService (\TYPO3\CMS\Extbase\Service\TypoScriptService $typoScriptService)
 
 injectEnvironmentService (\TYPO3\CMS\Extbase\Service\EnvironmentService $environmentService)
 
 setContentObject (\TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer $contentObject=null)
 
 getContentObject ()
 
 setConfiguration (array $configuration=array())
 
 getConfiguration ($extensionName=null, $pluginName=null)
 
 getDefaultBackendStoragePid ()
 
 getTypoScriptSetup ()
 

Protected Member Functions

 getPluginConfiguration ($extensionName, $pluginName=null)
 
 getSwitchableControllerActions ($extensionName, $pluginName)
 
 getContextSpecificFrameworkConfiguration (array $frameworkConfiguration)
 
 overrideStoragePidIfStartingPointIsSet (array $frameworkConfiguration)
 
 overrideConfigurationFromPlugin (array $frameworkConfiguration)
 
 overrideConfigurationFromFlexForm (array $frameworkConfiguration)
 
 mergeConfigurationIntoFrameworkConfiguration (array $frameworkConfiguration, array $configuration, $configurationPartName)
 
 overrideSwitchableControllerActionsFromFlexForm (array $frameworkConfiguration, array $flexFormConfiguration)
 
 getRecursiveStoragePids ($storagePid, $recursionDepth=0)
 
- Protected Member Functions inherited from AbstractConfigurationManager
 getExtbaseConfiguration ()
 
 overrideSwitchableControllerActions (array &$frameworkConfiguration, array $switchableControllerActions)
 
 getContextSpecificFrameworkConfiguration (array $frameworkConfiguration)
 
 getPluginConfiguration ($extensionName, $pluginName=null)
 
 getSwitchableControllerActions ($extensionName, $pluginName)
 
 getRecursiveStoragePids ($storagePid, $recursionDepth=0)
 

Protected Attributes

 $flexFormService
 
- Protected Attributes inherited from AbstractConfigurationManager
 $configuration = array()
 
 $contentObject
 
 $objectManager
 
 $typoScriptService
 
 $extensionName
 
 $pluginName
 
 $configurationCache = array()
 
 $environmentService
 

Additional Inherited Members

- Public Attributes inherited from 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.

Definition at line 22 of file FrontendConfigurationManager.php.

Member Function Documentation

getContextSpecificFrameworkConfiguration ( array  $frameworkConfiguration)
protected

Get context specific framework configuration.

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

Definition at line 102 of file FrontendConfigurationManager.php.

References FrontendConfigurationManager\overrideConfigurationFromFlexForm(), FrontendConfigurationManager\overrideConfigurationFromPlugin(), and FrontendConfigurationManager\overrideStoragePidIfStartingPointIsSet().

getPluginConfiguration (   $extensionName,
  $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

Definition at line 55 of file FrontendConfigurationManager.php.

References AbstractConfigurationManager\$extensionName, AbstractConfigurationManager\$pluginName, and FrontendConfigurationManager\getTypoScriptSetup().

getRecursiveStoragePids (   $storagePid,
  $recursionDepth = 0 
)
protected

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

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

Definition at line 243 of file FrontendConfigurationManager.php.

References AbstractConfigurationManager\getContentObject().

getSwitchableControllerActions (   $extensionName,
  $pluginName 
)
protected

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

Parameters
string$extensionName
string$pluginName
Returns
array

Definition at line 85 of file FrontendConfigurationManager.php.

References AbstractConfigurationManager\$extensionName, $GLOBALS, and AbstractConfigurationManager\$pluginName.

getTypoScriptSetup ( )

Returns TypoScript Setup array from current Environment.

Returns
array the raw TypoScript setup

Definition at line 42 of file FrontendConfigurationManager.php.

References $GLOBALS.

Referenced by FrontendConfigurationManager\getPluginConfiguration(), and FrontendConfigurationManager\overrideConfigurationFromPlugin().

injectFlexFormService ( \TYPO3\CMS\Extbase\Service\FlexFormService  $flexFormService)
Parameters
\TYPO3\CMS\Extbase\Service\FlexFormService$flexFormService

Definition at line 32 of file FrontendConfigurationManager.php.

References FrontendConfigurationManager\$flexFormService.

mergeConfigurationIntoFrameworkConfiguration ( array  $frameworkConfiguration,
array  $configuration,
  $configurationPartName 
)
protected

Merge a configuration into the framework configuration.

Parameters
array$frameworkConfigurationthe framework configuration to merge the data on
array$configurationThe configuration
string$configurationPartNameThe name of the configuration part which should be merged.
Returns
array the processed framework configuration

Definition at line 194 of file FrontendConfigurationManager.php.

Referenced by FrontendConfigurationManager\overrideConfigurationFromFlexForm(), and FrontendConfigurationManager\overrideConfigurationFromPlugin().

overrideConfigurationFromFlexForm ( array  $frameworkConfiguration)
protected

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

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

Definition at line 167 of file FrontendConfigurationManager.php.

References FrontendConfigurationManager\mergeConfigurationIntoFrameworkConfiguration(), and FrontendConfigurationManager\overrideSwitchableControllerActionsFromFlexForm().

Referenced by FrontendConfigurationManager\getContextSpecificFrameworkConfiguration().

overrideConfigurationFromPlugin ( array  $frameworkConfiguration)
protected

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

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

Definition at line 146 of file FrontendConfigurationManager.php.

References FrontendConfigurationManager\getTypoScriptSetup(), and FrontendConfigurationManager\mergeConfigurationIntoFrameworkConfiguration().

Referenced by FrontendConfigurationManager\getContextSpecificFrameworkConfiguration().

overrideStoragePidIfStartingPointIsSet ( array  $frameworkConfiguration)
protected

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

Parameters
array$frameworkConfigurationthe framework configurations
Returns
array the framework configuration with overriden storagePid

Definition at line 117 of file FrontendConfigurationManager.php.

References $list.

Referenced by FrontendConfigurationManager\getContextSpecificFrameworkConfiguration().

overrideSwitchableControllerActionsFromFlexForm ( array  $frameworkConfiguration,
array  $flexFormConfiguration 
)
protected

Overrides the switchable controller actions from the flexForm.

Parameters
array$frameworkConfigurationThe original framework configuration
array$flexFormConfigurationThe full flexForm configuration
Exceptions
Exception\ParseErrorException
Returns
array the modified framework configuration, if needed

Definition at line 214 of file FrontendConfigurationManager.php.

References AbstractConfigurationManager\overrideSwitchableControllerActions().

Referenced by FrontendConfigurationManager\overrideConfigurationFromFlexForm().

Member Data Documentation

$flexFormService
protected