ConfigurationService implements SingletonInterface
Admin Panel Service Class for Configuration Handling
Scope: User TSConfig + Backend User UC
Table of Contents
Interfaces
- SingletonInterface
- "empty" interface for singletons (marker interface pattern)
Methods
- getConfigurationOption() : string
- Helper method to return configuration options Checks User TSConfig overrides and current backend user session
- getMainConfiguration() : array
- Get MainConfiguration (User TSConfig admPanel)
- saveConfiguration() : void
- Save admin panel configuration to backend user UC triggers onSubmit method of modules to enable each module to enhance the save action
- getBackendUser() : BackendUserAuthentication|FrontendBackendUserAuthentication
- Returns the current BE user.
- triggerOnSubmitActors() : void
Methods
getConfigurationOption()
Helper method to return configuration options Checks User TSConfig overrides and current backend user session
public
getConfigurationOption(string $identifier, string $option) : string
Parameters
- $identifier : string
- $option : string
Return values
stringgetMainConfiguration()
Get MainConfiguration (User TSConfig admPanel)
public
getMainConfiguration() : array
Return values
arraysaveConfiguration()
Save admin panel configuration to backend user UC triggers onSubmit method of modules to enable each module to enhance the save action
public
saveConfiguration(ModuleInterface[] $modules, ServerRequestInterface $request) : void
Parameters
- $modules : ModuleInterface[]
- $request : ServerRequestInterface
getBackendUser()
Returns the current BE user.
protected
getBackendUser() : BackendUserAuthentication|FrontendBackendUserAuthentication
Return values
BackendUserAuthentication|FrontendBackendUserAuthenticationtriggerOnSubmitActors()
protected
triggerOnSubmitActors(array $modules, ServerRequestInterface $request, array $configurationToSave) : void
Parameters
- $modules : array
- $request : ServerRequestInterface
- $configurationToSave : array