TYPO3\CMS\Reports\Controller\ReportController Class Reference

Inheritance diagram for TYPO3\CMS\Reports\Controller\ReportController:

Public Member Functions
	__construct ()
ResponseInterface	handleRequest (ServerRequestInterface $request)
‪Public Member Functions inherited from ‪TYPO3\CMS\Core\Compatibility\PublicMethodDeprecationTrait
mixed	__call (string $methodName, array $arguments)

Protected Member Functions
	initializeView (string $templateName)
	indexAction ()
ResponseInterface null	detailAction (ServerRequestInterface $request)
	generateMenu (ServerRequestInterface $request)
	generateButtons ()
	saveState (string $extension='', string $report='')
	resetState ()
BackendUserAuthentication	getBackendUser ()
LanguageService	getLanguageService ()

Protected Attributes
ModuleTemplate	$moduleTemplate
ViewInterface	$view
string	$shortcutName

Private Attributes
array	$deprecatedPublicMethods

Detailed Description

Reports controller

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

Definition at line 36 of file ReportController.php.

Constructor & Destructor Documentation

__construct()

TYPO3\CMS\Reports\Controller\ReportController::__construct

(

)

Instantiate the report controller

Definition at line 65 of file ReportController.php.

Member Function Documentation

detailAction()

ResponseInterface null TYPO3\CMS\Reports\Controller\ReportController::detailAction ( ServerRequestInterface  $request )

protected

Display a single report

Parameters

ServerRequestInterface

$request

Returns

‪ResponseInterface|null

Definition at line 150 of file ReportController.php.

References $GLOBALS, TYPO3\CMS\Reports\Controller\ReportController\resetState(), and TYPO3\CMS\Reports\Controller\ReportController\saveState().

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

generateButtons()

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

protected

Gets all buttons for the docHeader

Definition at line 233 of file ReportController.php.

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

generateMenu()

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

protected

Generates the menu

Parameters

ServerRequestInterface

$request

Definition at line 192 of file ReportController.php.

References $GLOBALS, and TYPO3\CMS\Reports\Controller\ReportController\getLanguageService().

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

getBackendUser()

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

protected

Returns

‪BackendUserAuthentication

Definition at line 271 of file ReportController.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Reports\Controller\ReportController\resetState(), and TYPO3\CMS\Reports\Controller\ReportController\saveState().

getLanguageService()

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

protected

Returns

‪LanguageService

Definition at line 279 of file ReportController.php.

References $GLOBALS.

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

handleRequest()

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

(

ServerRequestInterface

$request

)

Injects the request object for the current request, and renders correct action

Parameters

ServerRequestInterface

$request

‪the current request

Returns

‪ResponseInterface the response with the content

Definition at line 76 of file ReportController.php.

References $GLOBALS, TYPO3\CMS\Reports\Controller\ReportController\detailAction(), TYPO3\CMS\Reports\Controller\ReportController\generateButtons(), TYPO3\CMS\Reports\Controller\ReportController\generateMenu(), TYPO3\CMS\Reports\Controller\ReportController\indexAction(), and TYPO3\CMS\Reports\Controller\ReportController\initializeView().

indexAction()

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

protected

Overview

Definition at line 138 of file ReportController.php.

References $GLOBALS, and TYPO3\CMS\Reports\Controller\ReportController\saveState().

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

initializeView()

TYPO3\CMS\Reports\Controller\ReportController::initializeView ( string  $templateName )

protected

Parameters

string

$templateName

Definition at line 125 of file ReportController.php.

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

resetState()

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

protected

Reset state in user settings

Definition at line 262 of file ReportController.php.

References TYPO3\CMS\Reports\Controller\ReportController\getBackendUser(), and TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\writeUC().

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

saveState()

TYPO3\CMS\Reports\Controller\ReportController::saveState ( string  $extension = '', string  $report = ''  )

protected

Save the selected report

Parameters

string	$extension	‪Extension name
string	$report	‪Report name

Definition at line 250 of file ReportController.php.

References TYPO3\CMS\Reports\Controller\ReportController\getBackendUser(), and TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\writeUC().

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

Member Data Documentation

$deprecatedPublicMethods

array TYPO3\CMS\Reports\Controller\ReportController::$deprecatedPublicMethods

private

Initial value:

= array( 
        'indexAction' => 'Using ReportController::indexAction() is deprecated and will not be possible anymore in TYPO3 v10.0.',
        'detailAction' => 'Using ReportController::detailAction() is deprecated and will not be possible anymore in TYPO3 v10.0.',
     )

Definition at line 41 of file ReportController.php.

$moduleTemplate

ModuleTemplate TYPO3\CMS\Reports\Controller\ReportController::$moduleTemplate

protected

ModuleTemplate object

Definition at line 50 of file ReportController.php.

$shortcutName

string TYPO3\CMS\Reports\Controller\ReportController::$shortcutName

protected

Module name for the shortcut

Definition at line 60 of file ReportController.php.

$view

ViewInterface TYPO3\CMS\Reports\Controller\ReportController::$view

protected

Definition at line 54 of file ReportController.php.