Maintenance implements MiddlewareInterface

Default middleware for all requests inside the TYPO3 Install Tool, which does a simple hardcoded dispatching to a controller based on the get/post variable.

Internal

This class is only meant to be used within EXT:install and is not part of the TYPO3 Core API.

Table of Contents

Interfaces

MiddlewareInterface

Properties

$configurationManager  : ConfigurationManager
$container  : ContainerInterface
$controllers  : array<string|int, mixed>
$formProtectionFactory  : FormProtectionFactory
$packageManager  : FailsafePackageManager
$passwordHashFactory  : PasswordHashFactory
$sessionService  : SessionService

Methods

__construct()  : mixed
process()  : ResponseInterface
Handles an Install Tool request for normal operations
canHandleRequest()  : bool
This request handler is only accessible when basic system integrity constraints are fulfilled.
checkEnableInstallToolFile()  : bool
Checks if ENABLE_INSTALL_TOOL exists.
checkIfEssentialConfigurationExists()  : bool
Check if system/settings.php exists (PackageStates is optional)
checkSessionLifetime()  : bool
Check if session expired.
checkSessionToken()  : bool
Use form protection API to find out if protected POST forms are ok.
enforceReferrer()  : ResponseInterface|null
Evaluates HTTP `Referer` header (which is denied by client to be a custom value) - attempts to ensure the value is given using a HTML client refresh.

Properties

$container read-only

protected ContainerInterface $container

$controllers

protected array<string|int, mixed> $controllers = ['icon' => \TYPO3\CMS\Install\Controller\IconController::class, 'layout' => \TYPO3\CMS\Install\Controller\LayoutController::class, 'login' => \TYPO3\CMS\Install\Controller\LoginController::class, 'maintenance' => \TYPO3\CMS\Install\Controller\MaintenanceController::class, 'settings' => \TYPO3\CMS\Install\Controller\SettingsController::class, 'upgrade' => \TYPO3\CMS\Install\Controller\UpgradeController::class, 'environment' => \TYPO3\CMS\Install\Controller\EnvironmentController::class]

List of valid controllers

Methods

__construct()

public __construct(FailsafePackageManager $packageManager, ConfigurationManager $configurationManager, PasswordHashFactory $passwordHashFactory, ContainerInterface $container, FormProtectionFactory $formProtectionFactory, SessionService $sessionService) : mixed
Parameters
$packageManager : FailsafePackageManager
$configurationManager : ConfigurationManager
$passwordHashFactory : PasswordHashFactory
$container : ContainerInterface
$formProtectionFactory : FormProtectionFactory
$sessionService : SessionService

process()

Handles an Install Tool request for normal operations

public process(ServerRequestInterface $request, RequestHandlerInterface $handler) : ResponseInterface
Parameters
$request : ServerRequestInterface
$handler : RequestHandlerInterface
Return values
ResponseInterface

canHandleRequest()

This request handler is only accessible when basic system integrity constraints are fulfilled.

protected canHandleRequest() : bool
Return values
bool

checkEnableInstallToolFile()

Checks if ENABLE_INSTALL_TOOL exists.

protected checkEnableInstallToolFile() : bool
Return values
bool

checkIfEssentialConfigurationExists()

Check if system/settings.php exists (PackageStates is optional)

protected checkIfEssentialConfigurationExists() : bool
Return values
bool —

TRUE when the essential configuration is available, otherwise FALSE

checkSessionLifetime()

Check if session expired.

protected checkSessionLifetime(ServerRequestInterface $request) : bool

If the session has expired, the login form is displayed.

Parameters
$request : ServerRequestInterface
Return values
bool —

True if session lifetime is OK

checkSessionToken()

Use form protection API to find out if protected POST forms are ok.

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

enforceReferrer()

Evaluates HTTP `Referer` header (which is denied by client to be a custom value) - attempts to ensure the value is given using a HTML client refresh.

protected enforceReferrer(ServerRequestInterface $request) : ResponseInterface|null

see: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Referer

Parameters
$request : ServerRequestInterface
Return values
ResponseInterface|null 

        

        
    




    

    

                            

            

                            
    

        On this page

        
    


            

                    

        

    

        

            
Search results