HelpToolbarItem

class \TYPO3\CMS\Backend\Backend\ToolbarItems\HelpToolbarItem

Implements
ToolbarItemInterface, RequestAwareToolbarItemInterface

Help toolbar item - The question mark icon in toolbar

Table of Contents

Interfaces

ToolbarItemInterface
Interface for classes which extend the backend by adding items to the top toolbar
RequestAwareToolbarItemInterface
Interface for toolbar items that need the ServerRequestInterface Request.

Properties

$helpModule  : MenuModule|null

Methods

__construct()  : mixed
checkAccess()  : bool
Users see this if a module is available
getAdditionalAttributes()  : array
No additional attributes needed.
getDropDown()  : string
Render drop down
getIndex()  : int
Position relative to others
getItem()  : string
Render help icon
hasDropDown()  : bool
This item has a drop-down
setRequest()  : void
getBackendUser()  : BackendUserAuthentication

Properties

Methods

checkAccess()

Users see this if a module is available

public checkAccess() : bool

Return values

bool —

TRUE if user has access, FALSE if not

getAdditionalAttributes()

No additional attributes needed.

public getAdditionalAttributes() : array

Return values

array —

List item HTML attributes

getDropDown()

Render drop down

public getDropDown() : string

Return values

string —

Drop down HTML

getIndex()

Position relative to others

public getIndex() : int

Return values

int —

0 .. 100

getItem()

Render help icon

public getItem() : string

Return values

string —

Toolbar item HTML

hasDropDown()

This item has a drop-down

public hasDropDown() : bool

Return values

bool

setRequest()

public setRequest(ServerRequestInterface $request) : void

Parameters

$request : ServerRequestInterface
On this page