TYPO3\CMS\Backend\Http\BackendModuleRequestHandler Class Reference

Inheritance diagram for TYPO3\CMS\Backend\Http\BackendModuleRequestHandler:

Public Member Functions
	__construct (Bootstrap $bootstrap)
	handleRequest (ServerRequestInterface $request)
	canHandleRequest (ServerRequestInterface $request)
	getPriority ()
Public Member Functions inherited from TYPO3\CMS\Core\Http\RequestHandlerInterface
	handleRequest (\Psr\Http\Message\ServerRequestInterface $request)
	canHandleRequest (\Psr\Http\Message\ServerRequestInterface $request)

Protected Member Functions
	boot ()
	isValidModuleRequest ()
	isDispatchedModule ($moduleName)
	callTraditionalModule ($moduleName)
	getModuleConfiguration ($moduleName)
	getFormProtection ()

Protected Attributes
	$bootstrap
	$moduleRegistry = []
	$backendUserAuthentication
	$request

Detailed Description

Handles the request for backend modules and wizards Juggles with $GLOBALS['TBE_MODULES']

Definition at line 35 of file BackendModuleRequestHandler.php.

Constructor & Destructor Documentation

__construct()

TYPO3\CMS\Backend\Http\BackendModuleRequestHandler::__construct

(

Bootstrap

$bootstrap

)

Constructor handing over the bootstrap and the original request

Parameters

Bootstrap

$bootstrap

Definition at line 63 of file BackendModuleRequestHandler.php.

References TYPO3\CMS\Backend\Http\BackendModuleRequestHandler\$bootstrap.

Member Function Documentation

boot()

TYPO3\CMS\Backend\Http\BackendModuleRequestHandler::boot ( )

protected

Execute TYPO3 bootstrap

Returns

void

Definition at line 109 of file BackendModuleRequestHandler.php.

Referenced by TYPO3\CMS\Backend\Http\BackendModuleRequestHandler\handleRequest().

callTraditionalModule()

TYPO3\CMS\Backend\Http\BackendModuleRequestHandler::callTraditionalModule (   $moduleName )

protected

Calls traditional modules which are identified by having an index.php in their directory and were previously located within the global scope.

Parameters

string

$moduleName

Returns

bool Returns TRUE if the module was executed

Definition at line 230 of file BackendModuleRequestHandler.php.

References $GLOBALS, $MCONF, and TYPO3\CMS\Backend\Http\BackendModuleRequestHandler\getModuleConfiguration().

Referenced by TYPO3\CMS\Backend\Http\BackendModuleRequestHandler\handleRequest().

canHandleRequest()

TYPO3\CMS\Backend\Http\BackendModuleRequestHandler::canHandleRequest

(

ServerRequestInterface

$request

)

This request handler can handle any backend request coming from index.php

Parameters

ServerRequestInterface

$request

Returns

bool

Definition at line 139 of file BackendModuleRequestHandler.php.

getFormProtection()

TYPO3\CMS\Backend\Http\BackendModuleRequestHandler::getFormProtection ( )

protected

Wrapper method for static form protection utility

Returns

Definition at line 283 of file BackendModuleRequestHandler.php.

References TYPO3\CMS\Core\FormProtection\FormProtectionFactory\get().

Referenced by TYPO3\CMS\Backend\Http\BackendModuleRequestHandler\isValidModuleRequest().

getModuleConfiguration()

TYPO3\CMS\Backend\Http\BackendModuleRequestHandler::getModuleConfiguration (   $moduleName )

protected

Returns the module configuration which is provided during module registration

Parameters

string

$moduleName

Returns

array

Exceptions

Definition at line 260 of file BackendModuleRequestHandler.php.

Referenced by TYPO3\CMS\Backend\Http\BackendModuleRequestHandler\callTraditionalModule(), and TYPO3\CMS\Backend\Http\BackendModuleRequestHandler\isDispatchedModule().

getPriority()

TYPO3\CMS\Backend\Http\BackendModuleRequestHandler::getPriority

(

)

Returns the priority - how eager the handler is to actually handle the request.

Returns

int The priority of the request handler.

Implements TYPO3\CMS\Core\Http\RequestHandlerInterface.

Definition at line 273 of file BackendModuleRequestHandler.php.

handleRequest()

TYPO3\CMS\Backend\Http\BackendModuleRequestHandler::handleRequest

(

ServerRequestInterface

$request

)

Handles the request, evaluating the configuration and executes the module accordingly

Parameters

ServerRequestInterface

$request

Returns

NULL|

Exceptions

Exception

Definition at line 75 of file BackendModuleRequestHandler.php.

References $GLOBALS, TYPO3\CMS\Backend\Http\BackendModuleRequestHandler\$request, TYPO3\CMS\Backend\Http\BackendModuleRequestHandler\boot(), TYPO3\CMS\Backend\Http\BackendModuleRequestHandler\callTraditionalModule(), TYPO3\CMS\Backend\Http\BackendModuleRequestHandler\isDispatchedModule(), and TYPO3\CMS\Backend\Http\BackendModuleRequestHandler\isValidModuleRequest().

isDispatchedModule()

TYPO3\CMS\Backend\Http\BackendModuleRequestHandler::isDispatchedModule (   $moduleName )

protected

A dispatched module is used, when no PATH is given. Traditional modules have a module path set.

Parameters

string

$moduleName

Returns

bool

Definition at line 162 of file BackendModuleRequestHandler.php.

References TYPO3\CMS\Backend\Http\BackendModuleRequestHandler\$bootstrap, $GLOBALS, TYPO3\CMS\Core\Utility\MathUtility\canBeInterpretedAsInteger(), TYPO3\CMS\Backend\Http\BackendModuleRequestHandler\getModuleConfiguration(), TYPO3\CMS\Backend\Utility\BackendUtility\getRecord(), TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance(), TYPO3\CMS\Core\Type\Bitmask\Permission\PAGE_SHOW, and TYPO3\CMS\Backend\Utility\BackendUtility\readPageAccess().

Referenced by TYPO3\CMS\Backend\Http\BackendModuleRequestHandler\handleRequest().

isValidModuleRequest()

TYPO3\CMS\Backend\Http\BackendModuleRequestHandler::isValidModuleRequest ( )

protected

Checks if all parameters are met.

Returns

bool

Definition at line 149 of file BackendModuleRequestHandler.php.

References TYPO3\CMS\Backend\Http\BackendModuleRequestHandler\getFormProtection().

Referenced by TYPO3\CMS\Backend\Http\BackendModuleRequestHandler\handleRequest().

Member Data Documentation

$backendUserAuthentication

TYPO3\CMS\Backend\Http\BackendModuleRequestHandler::$backendUserAuthentication

protected

Definition at line 50 of file BackendModuleRequestHandler.php.

$bootstrap

TYPO3\CMS\Backend\Http\BackendModuleRequestHandler::$bootstrap

protected

Definition at line 40 of file BackendModuleRequestHandler.php.

Referenced by TYPO3\CMS\Backend\Http\BackendModuleRequestHandler\__construct(), and TYPO3\CMS\Backend\Http\BackendModuleRequestHandler\isDispatchedModule().

$moduleRegistry

TYPO3\CMS\Backend\Http\BackendModuleRequestHandler::$moduleRegistry = []

protected

Definition at line 45 of file BackendModuleRequestHandler.php.

$request

TYPO3\CMS\Backend\Http\BackendModuleRequestHandler::$request

protected

Definition at line 56 of file BackendModuleRequestHandler.php.

Referenced by TYPO3\CMS\Backend\Http\BackendModuleRequestHandler\handleRequest().