HelpController

class \TYPO3\CMS\Backend\Controller\HelpController

Main "CSH help" module controller

Table of Contents

Constants

FULL  : mixed = 0
Section identifiers
TOC_ONLY  : mixed = 1
Show only Table of contents
ALLOWED_ACTIONS  : mixed = ['index', 'all', 'detail']

Properties

$iconFactory  : IconFactory
$moduleTemplate  : ModuleTemplate
$moduleTemplateFactory  : ModuleTemplateFactory
$tableManualRepository  : TableManualRepository
$typo3Information  : Typo3Information
$uriBuilder  : UriBuilder
$view  : ViewInterface

Methods

__construct()  : mixed
allAction()  : mixed
Show the table of contents and all manuals
detailAction()  : mixed
Show a single manual
handleDetailPopup()  : ResponseInterface
handleRequest()  : ResponseInterface
Injects the request object for the current request, and renders correct action
indexAction()  : mixed
Show table of contents
getBackendUser()  : BackendUserAuthentication
Returns the currently logged in BE user
getLanguageService()  : LanguageService
Returns the LanguageService
getManuals()  : array
getShortcutTitle()  : string
Returns the shortcut title for the current page
initializeView()  : mixed
registerDocHeaderButtons()  : mixed
Registers the Icons into the docheader

Constants

FULL

Section identifiers

public mixed FULL = 0

TOC_ONLY

Show only Table of contents

public mixed TOC_ONLY = 1

ALLOWED_ACTIONS

protected mixed ALLOWED_ACTIONS = ['index', 'all', 'detail']

Properties

Methods

allAction()

Show the table of contents and all manuals

public allAction() : mixed

detailAction()

Show a single manual

public detailAction(ServerRequestInterface $request) : mixed

Parameters

$request : ServerRequestInterface

handleDetailPopup()

public handleDetailPopup(ServerRequestInterface $request) : ResponseInterface

Parameters

$request : ServerRequestInterface

Return values

ResponseInterface

handleRequest()

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

public handleRequest(ServerRequestInterface $request[, bool $addBackButton = true ]) : ResponseInterface

Parameters

$request : ServerRequestInterface

the current request

$addBackButton : bool = true

Return values

ResponseInterface —

the response with the content

indexAction()

Show table of contents

public indexAction() : mixed

getManuals()

protected getManuals(ServerRequestInterface $request) : array

Parameters

$request : ServerRequestInterface

Return values

array

getShortcutTitle()

Returns the shortcut title for the current page

protected getShortcutTitle(ServerRequestInterface $request) : string

Parameters

$request : ServerRequestInterface

Return values

string

initializeView()

protected initializeView(string $templateName) : mixed

Parameters

$templateName : string

registerDocHeaderButtons()

Registers the Icons into the docheader

protected registerDocHeaderButtons(ServerRequestInterface $request[, bool $addBackButton = true ]) : mixed

Parameters

$request : ServerRequestInterface
$addBackButton : bool = true
On this page