TYPO3\CMS\Adminpanel\ModuleApi\RequestEnricherInterface Interface Reference

Inheritance diagram for TYPO3\CMS\Adminpanel\ModuleApi\RequestEnricherInterface:

Public Member Functions
Psr Http Message ServerRequestInterface	enrich (ServerRequestInterface $request)

Detailed Description

Adminpanel interface to denote that a module has tasks to perform on initialization of the request and may enrich said request

Modules that need to set data / options early in the rendering process to be able to collect data, should implement this interface - for example the log module uses the initialization to register the admin panel log collection early in the rendering process.

Modules that manipulate the request based on their configuration should also implement this interface.

Initialize is called in the PSR-15 middleware stack through admin panel initialisation via the AdminPanel MainController.

See also

‪\TYPO3\CMS\Adminpanel\Middleware\AdminPanelInitiator::process()

‪\TYPO3\CMS\Adminpanel\Controller\MainController::initialize()

Definition at line 36 of file RequestEnricherInterface.php.

Member Function Documentation

enrich()

Psr Http Message ServerRequestInterface TYPO3\CMS\Adminpanel\ModuleApi\RequestEnricherInterface::enrich

(

ServerRequestInterface

$request

)

Initialize the module - runs in the TYPO3 middleware stack at an early point may manipulate the current request

Parameters

ServerRequestInterface

$request

Returns

‪\Psr\Http\Message\ServerRequestInterface

Implemented in TYPO3\CMS\Adminpanel\Modules\Debug\Log, TYPO3\CMS\Adminpanel\Tests\Unit\Fixtures\MainModuleFixture, TYPO3\CMS\Adminpanel\Modules\CacheModule, TYPO3\CMS\Adminpanel\Modules\PreviewModule, and TYPO3\CMS\Adminpanel\Modules\TsDebug\TypoScriptWaterfall.