ReportController
The "Reports" backend module.
This class is a specific Backend controller implementation and is not considered part of the Public TYPO3 API.
Attributes
- #[AsController]
Table of Contents
Properties
- $iconRegistry : IconRegistry
- $moduleTemplateFactory : ModuleTemplateFactory
- $reportRegistry : ReportRegistry
- $uriBuilder : UriBuilder
Methods
- __construct() : mixed
- handleRequest() : ResponseInterface
- Main dispatcher.
- addMainMenu() : void
- addShortcutButton() : void
- detailAction() : ResponseInterface
- Render a single report.
- getBackendUser() : BackendUserAuthentication
- getLanguageService() : LanguageService
- indexAction() : ResponseInterface
- Render index "overview".
- updateBackendUserUc() : void
- Save selected action / extension / report combination to user uc to render this again on next module call.
Properties
$iconRegistry read-only
protected
IconRegistry
$iconRegistry
$moduleTemplateFactory read-only
protected
ModuleTemplateFactory
$moduleTemplateFactory
$reportRegistry read-only
protected
ReportRegistry
$reportRegistry
$uriBuilder read-only
protected
UriBuilder
$uriBuilder
Methods
__construct()
public
__construct(UriBuilder $uriBuilder, ModuleTemplateFactory $moduleTemplateFactory, IconRegistry $iconRegistry, ReportRegistry $reportRegistry) : mixed
Parameters
- $uriBuilder : UriBuilder
- $moduleTemplateFactory : ModuleTemplateFactory
- $iconRegistry : IconRegistry
- $reportRegistry : ReportRegistry
handleRequest()
Main dispatcher.
public
handleRequest(ServerRequestInterface $request) : ResponseInterface
Parameters
- $request : ServerRequestInterface
Return values
ResponseInterfaceaddMainMenu()
protected
addMainMenu(ModuleTemplate $view[, string $activeReportIdentifier = '' ]) : void
Parameters
- $view : ModuleTemplate
- $activeReportIdentifier : string = ''
addShortcutButton()
protected
addShortcutButton(ModuleTemplate $view, string $title, array<string|int, mixed> $arguments) : void
Parameters
- $view : ModuleTemplate
- $title : string
- $arguments : array<string|int, mixed>
detailAction()
Render a single report.
protected
detailAction(ServerRequestInterface $request, string $report) : ResponseInterface
Parameters
- $request : ServerRequestInterface
- $report : string
Return values
ResponseInterfacegetBackendUser()
protected
getBackendUser() : BackendUserAuthentication
Return values
BackendUserAuthenticationgetLanguageService()
protected
getLanguageService() : LanguageService
Return values
LanguageServiceindexAction()
Render index "overview".
protected
indexAction(ServerRequestInterface $request) : ResponseInterface
Parameters
- $request : ServerRequestInterface
Return values
ResponseInterfaceupdateBackendUserUc()
Save selected action / extension / report combination to user uc to render this again on next module call.
protected
updateBackendUserUc(string $action[, string $report = '' ]) : void
Parameters
- $action : string
- $report : string = ''