TYPO3\CMS\Backend\Controller\HelpController Class Reference

Public Member Functions
	__construct ()
ResponseInterface	handleRequest (ServerRequestInterface $request)
	indexAction ()
	allAction ()
	detailAction (ServerRequestInterface $request)

Public Attributes
const	FULL = 0
const	TOC_ONLY = 1

Protected Member Functions
	initializeView (string $templateName)
	registerDocheaderButtons (ServerRequestInterface $request)
BackendUserAuthentication	getBackendUser ()
LanguageService	getLanguageService ()

Protected Attributes
const	ALLOWED_ACTIONS = ['index', 'all', 'detail']
TableManualRepository	$tableManualRepository
ModuleTemplate	$moduleTemplate
ViewInterface	$view

Detailed Description

Main "CSH help" module controller

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

Definition at line 37 of file HelpController.php.

Constructor & Destructor Documentation

__construct()

TYPO3\CMS\Backend\Controller\HelpController::__construct

(

)

Instantiate the report controller

Definition at line 62 of file HelpController.php.

Member Function Documentation

allAction()

TYPO3\CMS\Backend\Controller\HelpController::allAction

(

)

Show the table of contents and all manuals

Definition at line 130 of file HelpController.php.

detailAction()

TYPO3\CMS\Backend\Controller\HelpController::detailAction

(

ServerRequestInterface

$request

)

Show a single manual

Parameters

ServerRequestInterface

$request

Definition at line 140 of file HelpController.php.

getBackendUser()

BackendUserAuthentication TYPO3\CMS\Backend\Controller\HelpController::getBackendUser ( )

protected

Returns the currently logged in BE user

Returns

‪BackendUserAuthentication

Definition at line 189 of file HelpController.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Backend\Controller\HelpController\registerDocheaderButtons().

getLanguageService()

LanguageService TYPO3\CMS\Backend\Controller\HelpController::getLanguageService ( )

protected

Returns the LanguageService

Returns

‪LanguageService

Definition at line 199 of file HelpController.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Backend\Controller\HelpController\registerDocheaderButtons().

handleRequest()

ResponseInterface TYPO3\CMS\Backend\Controller\HelpController::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 74 of file HelpController.php.

References TYPO3\CMS\Backend\Controller\HelpController\initializeView(), and TYPO3\CMS\Backend\Controller\HelpController\registerDocheaderButtons().

indexAction()

TYPO3\CMS\Backend\Controller\HelpController::indexAction

(

)

Show table of contents

Definition at line 122 of file HelpController.php.

initializeView()

TYPO3\CMS\Backend\Controller\HelpController::initializeView ( string  $templateName )

protected

Parameters

string

$templateName

Definition at line 108 of file HelpController.php.

References TYPO3\CMS\Backend\Utility\BackendUtility\TYPO3_copyRightNotice().

Referenced by TYPO3\CMS\Backend\Controller\HelpController\handleRequest().

registerDocheaderButtons()

TYPO3\CMS\Backend\Controller\HelpController::registerDocheaderButtons ( ServerRequestInterface  $request )

protected

Registers the Icons into the docheader

Parameters

ServerRequestInterface

$request

Definition at line 162 of file HelpController.php.

References TYPO3\CMS\Backend\Controller\HelpController\getBackendUser(), TYPO3\CMS\Backend\Controller\HelpController\getLanguageService(), and TYPO3\CMS\Core\Imaging\Icon\SIZE_SMALL.

Referenced by TYPO3\CMS\Backend\Controller\HelpController\handleRequest().

Member Data Documentation

$moduleTemplate

ModuleTemplate TYPO3\CMS\Backend\Controller\HelpController::$moduleTemplate

protected

Definition at line 55 of file HelpController.php.

$tableManualRepository

TableManualRepository TYPO3\CMS\Backend\Controller\HelpController::$tableManualRepository

protected

Definition at line 53 of file HelpController.php.

$view

ViewInterface TYPO3\CMS\Backend\Controller\HelpController::$view

protected

Definition at line 57 of file HelpController.php.

ALLOWED_ACTIONS

const TYPO3\CMS\Backend\Controller\HelpController::ALLOWED_ACTIONS = ['index', 'all', 'detail']

protected

Definition at line 39 of file HelpController.php.

FULL

const TYPO3\CMS\Backend\Controller\HelpController::FULL = 0

Section identifiers

Definition at line 44 of file HelpController.php.

TOC_ONLY

const TYPO3\CMS\Backend\Controller\HelpController::TOC_ONLY = 1

Show only Table of contents

Definition at line 49 of file HelpController.php.

Referenced by TYPO3\CMS\Backend\Domain\Repository\TableManualRepository\getSections().