ModifyInfoModuleContentEvent
FinalYes
Listeners to this Event will be able to modify the header and footer content of the info module
Table of Contents
Methods
- __construct() : mixed
- addFooterContent() : void
- Add additional content to the footer
- addHeaderContent() : void
- Add additional content to the header
- getCurrentModule() : ModuleInterface
- getFooterContent() : string
- getHeaderContent() : string
- getModuleTemplate() : ModuleTemplate
- getRequest() : ServerRequestInterface
- hasAccess() : bool
- Whether the current user has access to the main content of the info module.
- setFooterContent() : void
- Set content for the footer. Can also be used to e.g. reorder existing content.
- setHeaderContent() : void
- Set content for the header. Can also be used to e.g. reorder existing content.
Methods
__construct()
public
__construct(bool $access, ServerRequestInterface $request, ModuleInterface $currentModule, ModuleTemplate $moduleTemplate) : mixed
Parameters
- $access : bool
- $request : ServerRequestInterface
- $currentModule : ModuleInterface
- $moduleTemplate : ModuleTemplate
addFooterContent()
Add additional content to the footer
public
addFooterContent(string $content) : void
Parameters
- $content : string
addHeaderContent()
Add additional content to the header
public
addHeaderContent(string $content) : void
Parameters
- $content : string
getCurrentModule()
public
getCurrentModule() : ModuleInterface
Return values
ModuleInterfacegetFooterContent()
public
getFooterContent() : string
Return values
stringgetHeaderContent()
public
getHeaderContent() : string
Return values
stringgetModuleTemplate()
public
getModuleTemplate() : ModuleTemplate
Return values
ModuleTemplategetRequest()
public
getRequest() : ServerRequestInterface
Return values
ServerRequestInterfacehasAccess()
Whether the current user has access to the main content of the info module.
public
hasAccess() : bool
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.
Return values
boolsetFooterContent()
Set content for the footer. Can also be used to e.g. reorder existing content.
public
setFooterContent(string $content) : void
IMPORTANT: This overwrites existing content from previous listeners!
Parameters
- $content : string
setHeaderContent()
Set content for the header. Can also be used to e.g. reorder existing content.
public
setHeaderContent(string $content) : void
IMPORTANT: This overwrites existing content from previous listeners!
Parameters
- $content : string