‪TYPO3CMS  ‪main
TYPO3\CMS\Info\Controller\Event\ModifyInfoModuleContentEvent Class Reference

Public Member Functions

 __construct (private readonly bool $access, private readonly ServerRequestInterface $request, private readonly ModuleInterface $currentModule, private readonly ModuleTemplate $moduleTemplate,)
 
 hasAccess ()
 
 getRequest ()
 
 getCurrentModule ()
 
 getModuleTemplate ()
 
 setHeaderContent (string $content)
 
 addHeaderContent (string $content)
 
 getHeaderContent ()
 
 setFooterContent (string $content)
 
 addFooterContent (string $content)
 
 getFooterContent ()
 

Private Attributes

string $headerContent = ''
 
string $footerContent = ''
 

Detailed Description

Listeners to this Event will be able to modify the header and footer content of the info module

Definition at line 27 of file ModifyInfoModuleContentEvent.php.

Constructor & Destructor Documentation

◆ __construct()

TYPO3\CMS\Info\Controller\Event\ModifyInfoModuleContentEvent::__construct ( private readonly bool  $access,
private readonly ServerRequestInterface  $request,
private readonly ModuleInterface  $currentModule,
private readonly ModuleTemplate  $moduleTemplate 
)

Definition at line 32 of file ModifyInfoModuleContentEvent.php.

Member Function Documentation

◆ addFooterContent()

TYPO3\CMS\Info\Controller\Event\ModifyInfoModuleContentEvent::addFooterContent ( string  $content)

Add additional content to the footer

Definition at line 99 of file ModifyInfoModuleContentEvent.php.

Referenced by TYPO3\CMS\SysNote\Provider\InfoModuleProvider\__invoke().

◆ addHeaderContent()

TYPO3\CMS\Info\Controller\Event\ModifyInfoModuleContentEvent::addHeaderContent ( string  $content)

Add additional content to the header

Definition at line 77 of file ModifyInfoModuleContentEvent.php.

Referenced by TYPO3\CMS\SysNote\Provider\InfoModuleProvider\__invoke().

◆ getCurrentModule()

TYPO3\CMS\Info\Controller\Event\ModifyInfoModuleContentEvent::getCurrentModule ( )

◆ getFooterContent()

TYPO3\CMS\Info\Controller\Event\ModifyInfoModuleContentEvent::getFooterContent ( )

◆ getHeaderContent()

TYPO3\CMS\Info\Controller\Event\ModifyInfoModuleContentEvent::getHeaderContent ( )

◆ getModuleTemplate()

TYPO3\CMS\Info\Controller\Event\ModifyInfoModuleContentEvent::getModuleTemplate ( )

Definition at line 60 of file ModifyInfoModuleContentEvent.php.

◆ getRequest()

TYPO3\CMS\Info\Controller\Event\ModifyInfoModuleContentEvent::getRequest ( )

◆ hasAccess()

TYPO3\CMS\Info\Controller\Event\ModifyInfoModuleContentEvent::hasAccess ( )

Whether the current user has access to the main content of the info module. IMPORTANT: This is only for informational purposes. Listeners can therefore decide on their own if their content should be added to the module even if the user does not have access to the main module content.

Definition at line 45 of file ModifyInfoModuleContentEvent.php.

Referenced by TYPO3\CMS\SysNote\Provider\InfoModuleProvider\__invoke().

◆ setFooterContent()

TYPO3\CMS\Info\Controller\Event\ModifyInfoModuleContentEvent::setFooterContent ( string  $content)

Set content for the footer. Can also be used to e.g. reorder existing content. IMPORTANT: This overwrites existing content from previous listeners!

Definition at line 91 of file ModifyInfoModuleContentEvent.php.

◆ setHeaderContent()

TYPO3\CMS\Info\Controller\Event\ModifyInfoModuleContentEvent::setHeaderContent ( string  $content)

Set content for the header. Can also be used to e.g. reorder existing content. IMPORTANT: This overwrites existing content from previous listeners!

Definition at line 69 of file ModifyInfoModuleContentEvent.php.

Member Data Documentation

◆ $footerContent

string TYPO3\CMS\Info\Controller\Event\ModifyInfoModuleContentEvent::$footerContent = ''
private

◆ $headerContent

string TYPO3\CMS\Info\Controller\Event\ModifyInfoModuleContentEvent::$headerContent = ''
private