TYPO3\CMS\Reports\Controller\ReportController Class Reference

Public Member Functions
	__construct (protected readonly UriBuilder $uriBuilder, protected readonly ModuleTemplateFactory $moduleTemplateFactory, protected readonly IconRegistry $iconRegistry, protected readonly ReportRegistry $reportRegistry)
	handleRequest (ServerRequestInterface $request)

Protected Member Functions
	indexAction (ServerRequestInterface $request)
	detailAction (ServerRequestInterface $request, string $report)
	addMainMenu (ModuleTemplate $view, string $activeReportIdentifier='')
	addShortcutButton (ModuleTemplate $view, string $title, array $arguments)
	updateBackendUserUc (string $action, string $report='')
	getBackendUser ()
	getLanguageService ()

Detailed Description

The "Reports" backend module.

This class is a specific Backend controller implementation and is not considered part of the Public TYPO3 API.

Definition at line 38 of file ReportController.php.

Constructor & Destructor Documentation

__construct()

TYPO3\CMS\Reports\Controller\ReportController::__construct	(	protected readonly UriBuilder	$uriBuilder,
		protected readonly ModuleTemplateFactory	$moduleTemplateFactory,
		protected readonly IconRegistry	$iconRegistry,
		protected readonly ReportRegistry	$reportRegistry
	)

Definition at line 40 of file ReportController.php.

Member Function Documentation

addMainMenu()

TYPO3\CMS\Reports\Controller\ReportController::addMainMenu ( ModuleTemplate  $view, string  $activeReportIdentifier = ''  )

protected

Definition at line 136 of file ReportController.php.

References TYPO3\CMS\Backend\Template\ModuleTemplate\getDocHeaderComponent(), and TYPO3\CMS\Reports\Controller\ReportController\getLanguageService().

Referenced by TYPO3\CMS\Reports\Controller\ReportController\detailAction(), and TYPO3\CMS\Reports\Controller\ReportController\indexAction().

addShortcutButton()

TYPO3\CMS\Reports\Controller\ReportController::addShortcutButton ( ModuleTemplate  $view, string  $title, array  $arguments  )

protected

Definition at line 165 of file ReportController.php.

References TYPO3\CMS\Backend\Template\ModuleTemplate\getDocHeaderComponent().

Referenced by TYPO3\CMS\Reports\Controller\ReportController\detailAction(), and TYPO3\CMS\Reports\Controller\ReportController\indexAction().

detailAction()

TYPO3\CMS\Reports\Controller\ReportController::detailAction ( ServerRequestInterface  $request, string  $report  )

protected

Render a single report.

Definition at line 107 of file ReportController.php.

References TYPO3\CMS\Reports\Controller\ReportController\addMainMenu(), TYPO3\CMS\Reports\Controller\ReportController\addShortcutButton(), TYPO3\CMS\Reports\Controller\ReportController\getLanguageService(), and TYPO3\CMS\Reports\RequestAwareReportInterface\getReport().

Referenced by TYPO3\CMS\Reports\Controller\ReportController\handleRequest().

getBackendUser()

TYPO3\CMS\Reports\Controller\ReportController::getBackendUser ( )

protected

Definition at line 188 of file ReportController.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Reports\Controller\ReportController\handleRequest(), and TYPO3\CMS\Reports\Controller\ReportController\updateBackendUserUc().

getLanguageService()

TYPO3\CMS\Reports\Controller\ReportController::getLanguageService ( )

protected

Definition at line 193 of file ReportController.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Reports\Controller\ReportController\addMainMenu(), TYPO3\CMS\Reports\Controller\ReportController\detailAction(), and TYPO3\CMS\Reports\Controller\ReportController\indexAction().

handleRequest()

TYPO3\CMS\Reports\Controller\ReportController::handleRequest

(

ServerRequestInterface

$request

)

Main dispatcher.

Definition at line 50 of file ReportController.php.

References TYPO3\CMS\Reports\Controller\ReportController\detailAction(), TYPO3\CMS\Reports\Controller\ReportController\getBackendUser(), TYPO3\CMS\Reports\Controller\ReportController\indexAction(), and TYPO3\CMS\Reports\Controller\ReportController\updateBackendUserUc().

indexAction()

TYPO3\CMS\Reports\Controller\ReportController::indexAction ( ServerRequestInterface  $request )

protected

Render index "overview".

Definition at line 83 of file ReportController.php.

References TYPO3\CMS\Reports\Controller\ReportController\addMainMenu(), TYPO3\CMS\Reports\Controller\ReportController\addShortcutButton(), and TYPO3\CMS\Reports\Controller\ReportController\getLanguageService().

Referenced by TYPO3\CMS\Reports\Controller\ReportController\handleRequest().

updateBackendUserUc()

TYPO3\CMS\Reports\Controller\ReportController::updateBackendUserUc ( string  $action, string  $report = ''  )

protected

Save selected action / extension / report combination to user uc to render this again on next module call.

Definition at line 178 of file ReportController.php.

References TYPO3\CMS\Reports\Controller\ReportController\getBackendUser().

Referenced by TYPO3\CMS\Reports\Controller\ReportController\handleRequest().