AbstractMfaController
AbstractYes
Abstract class for mfa controllers (configuration and authentication)
This class is a specific Backend controller implementation and is not considered part of the Public TYPO3 API.
Table of Contents
Properties
- $allowedActions : array<string|int, mixed>
 - $allowedProviders : array<string|int, mixed>
 - $mfaProviderRegistry : MfaProviderRegistry
 - $mfaRequired : bool
 - $mfaTsConfig : array<string|int, mixed>
 - $moduleTemplate : ModuleTemplate|null
 - $moduleTemplateFactory : ModuleTemplateFactory
 - $uriBuilder : UriBuilder
 
Methods
- __construct() : mixed
 - handleRequest() : ResponseInterface
 - Main action for handling the request and returning the response
 - getBackendUser() : BackendUserAuthentication
 - getLanguageService() : LanguageService
 - getRecommendedProvider() : MfaProviderManifestInterface|null
 - Get the recommended provider
 - initializeMfaConfiguration() : void
 - Initialize MFA configuration based on TSconfig and global configuration
 - isActionAllowed() : bool
 - isProviderAllowed() : bool
 - isValidIdentifier() : bool
 
Properties
$allowedActions
        protected
            array<string|int, mixed>
    $allowedActions
     = []
    
    
    
    
    
$allowedProviders
        protected
            array<string|int, mixed>
    $allowedProviders
    
    
    
    
    
    
$mfaProviderRegistry
        protected
            MfaProviderRegistry
    $mfaProviderRegistry
    
    
    
    
    
    
$mfaRequired
        protected
            bool
    $mfaRequired
    
    
    
    
    
    
$mfaTsConfig
        protected
            array<string|int, mixed>
    $mfaTsConfig
    
    
    
    
    
    
$moduleTemplate
        protected
            ModuleTemplate|null
    $moduleTemplate
    
    
    
    
    
    
$moduleTemplateFactory
        protected
            ModuleTemplateFactory
    $moduleTemplateFactory
    
    
    
    
    
    
$uriBuilder
        protected
            UriBuilder
    $uriBuilder
    
    
    
    
    
    
Methods
__construct()
    public
                    __construct(UriBuilder $uriBuilder, MfaProviderRegistry $mfaProviderRegistry, ModuleTemplateFactory $moduleTemplateFactory) : mixed
    Parameters
- $uriBuilder : UriBuilder
 - $mfaProviderRegistry : MfaProviderRegistry
 - $moduleTemplateFactory : ModuleTemplateFactory
 
handleRequest()
Main action for handling the request and returning the response
    public
    abstract                handleRequest(ServerRequestInterface $request) : ResponseInterface
    Parameters
- $request : ServerRequestInterface
 
Return values
ResponseInterfacegetBackendUser()
    protected
                    getBackendUser() : BackendUserAuthentication
    Return values
BackendUserAuthenticationgetLanguageService()
    protected
                    getLanguageService() : LanguageService
    Return values
LanguageServicegetRecommendedProvider()
Get the recommended provider
    protected
                    getRecommendedProvider() : MfaProviderManifestInterface|null
    Return values
MfaProviderManifestInterface|nullinitializeMfaConfiguration()
Initialize MFA configuration based on TSconfig and global configuration
    protected
                    initializeMfaConfiguration() : void
    isActionAllowed()
    protected
                    isActionAllowed(string $action) : bool
    Parameters
- $action : string
 
Return values
boolisProviderAllowed()
    protected
                    isProviderAllowed(string $identifier) : bool
    Parameters
- $identifier : string
 
Return values
boolisValidIdentifier()
    protected
                    isValidIdentifier(string $identifier) : bool
    Parameters
- $identifier : string