BackendModuleController

Backend module controller to the Install Tool. Sets an Install Tool session marked as "initialized by a valid system administrator backend user" and redirects to the Install Tool entry point.

This is a classic backend module that does not interfere with other code within the Install Tool, it can be seen as a facade around Install Tool just to embed the Install Tool in backend.

Internal

This class is a specific controller implementation and is not considered part of the Public TYPO3 API.

Table of Contents

Constants

ALLOWED_ACTIONS  = ['maintenance', 'settings', 'upgrade', 'environment']
FLAG_CONFIRMATION_REQUEST  = 1
FLAG_INSTALL_TOOL_PASSWORD  = 2

Properties

$moduleTemplateFactory  : ModuleTemplateFactory
$sessionService  : SessionService
$uriBuilder  : UriBuilder

Methods

__construct()  : mixed
backendUserConfirmationAction()  : ResponseInterface
Shows and handles backend user session confirmation ("sudo mode") for accessing a particular Install Tool controller (as given in `$targetController`).
environmentAction()  : ResponseInterface
Initialize session and redirect to "environment"
maintenanceAction()  : ResponseInterface
Initialize session and redirect to "maintenance"
settingsAction()  : ResponseInterface
Initialize session and redirect to "settings"
upgradeAction()  : ResponseInterface
Initialize session and redirect to "upgrade"
getAuthServices()  : Generator<int, object>
Initializes authentication services to be used in a foreach loop
getBackendUser()  : BackendUserAuthentication
getBackendUserConfirmationRedirect()  : ResponseInterface|null
Creates redirect response to backend user confirmation (if required).
getBackendUserConfirmationUri()  : Uri
getSessionService()  : SessionService
Install Tool modified sessions meta-data (handler, storage, name) which conflicts with existing session that for instance.
setAuthorizedAndRedirect()  : ResponseInterface
Starts / updates the session and redirects to the Install Tool with given action.
verifyBackendUserPassword()  : bool
Verifies that provided password is actually correct for current backend user by stepping through authentication chain in `$GLOBALS['BE_USER]`.
verifyInstallToolPassword()  : bool
Verifies that provided password matches Install Tool password.

Constants

ALLOWED_ACTIONS

protected mixed ALLOWED_ACTIONS = ['maintenance', 'settings', 'upgrade', 'environment']

FLAG_CONFIRMATION_REQUEST

protected mixed FLAG_CONFIRMATION_REQUEST = 1

FLAG_INSTALL_TOOL_PASSWORD

protected mixed FLAG_INSTALL_TOOL_PASSWORD = 2

Properties

Methods

backendUserConfirmationAction()

Shows and handles backend user session confirmation ("sudo mode") for accessing a particular Install Tool controller (as given in `$targetController`).

public backendUserConfirmationAction(ServerRequestInterface $request) : ResponseInterface
Parameters
$request : ServerRequestInterface
Return values
ResponseInterface

environmentAction()

Initialize session and redirect to "environment"

public environmentAction() : ResponseInterface
Return values
ResponseInterface

maintenanceAction()

Initialize session and redirect to "maintenance"

public maintenanceAction() : ResponseInterface
Return values
ResponseInterface

settingsAction()

Initialize session and redirect to "settings"

public settingsAction() : ResponseInterface
Return values
ResponseInterface

upgradeAction()

Initialize session and redirect to "upgrade"

public upgradeAction() : ResponseInterface
Return values
ResponseInterface

getAuthServices()

Initializes authentication services to be used in a foreach loop

protected getAuthServices(BackendUserAuthentication $backendUser, array<string|int, mixed> $loginData, array<string|int, mixed> $authInfo) : Generator<int, object>
Parameters
$backendUser : BackendUserAuthentication
$loginData : array<string|int, mixed>
$authInfo : array<string|int, mixed>
Return values
Generator<int, object>

getBackendUserConfirmationRedirect()

Creates redirect response to backend user confirmation (if required).

protected getBackendUserConfirmationRedirect(string $targetController) : ResponseInterface|null
Parameters
$targetController : string
Return values
ResponseInterface|null

getBackendUserConfirmationUri()

protected getBackendUserConfirmationUri(array<string|int, mixed> $parameters) : Uri
Parameters
$parameters : array<string|int, mixed>
Return values
Uri

getSessionService()

Install Tool modified sessions meta-data (handler, storage, name) which conflicts with existing session that for instance.

protected getSessionService() : SessionService
Return values
SessionService

setAuthorizedAndRedirect()

Starts / updates the session and redirects to the Install Tool with given action.

protected setAuthorizedAndRedirect(string $controller) : ResponseInterface
Parameters
$controller : string
Return values
ResponseInterface

verifyBackendUserPassword()

Verifies that provided password is actually correct for current backend user by stepping through authentication chain in `$GLOBALS['BE_USER]`.

protected verifyBackendUserPassword(ServerRequestInterface $request) : bool
Parameters
$request : ServerRequestInterface
Return values
bool

verifyInstallToolPassword()

Verifies that provided password matches Install Tool password.

protected verifyInstallToolPassword(ServerRequestInterface $request) : bool
Parameters
$request : ServerRequestInterface
Return values
bool 

        

        
    




    

    

                            

            

                            
    

        On this page

        
    


            

                    

        

    

        

            
Search results