UserToolbarItem implements ToolbarItemInterface, RequestAwareToolbarItemInterface

User toolbar item and drop-down.

Internal

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

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.

Methods

__construct()  : mixed
checkAccess()  : bool
Item is always enabled.
getAdditionalAttributes()  : array<string|int, mixed>
Returns an additional class if user is in "switch user" mode.
getDropDown()  : string
Render drop-down content.
getIndex()  : int
Position relative to others.
getItem()  : string
Render username and an icon.
hasDropDown()  : bool
This item has a drop-down.
setRequest()  : void
getBackendUser()  : BackendUserAuthentication
getColorSchemes()  : array<string|int, mixed>
getColorSchemeSwitchEnabled()  : bool
getLanguageService()  : LanguageService

Methods

checkAccess()

Item is always enabled.

public checkAccess() : bool
Return values
bool —

TRUE if user has access, FALSE if not

getAdditionalAttributes()

Returns an additional class if user is in "switch user" mode.

public getAdditionalAttributes() : array<string|int, mixed>
Return values
array<string|int, mixed> —

List item HTML attributes

getDropDown()

Render drop-down content.

public getDropDown() : string
Return values
string —

Drop down HTML

getIndex()

Position relative to others.

public getIndex() : int
Return values
int —

0 .. 100

getItem()

Render username and an 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

getColorSchemes()

protected getColorSchemes() : array<string|int, mixed>
Return values
array<string|int, mixed>

getColorSchemeSwitchEnabled()

protected getColorSchemeSwitchEnabled() : bool
Return values
bool 

        

        
    




    

    

                            

            

                            
    

        On this page

        
    


            

                    

        

    

        

            
Search results