OpendocsToolbarItem implements ToolbarItemInterface, RequestAwareToolbarItemInterface

Main functionality to render a list of all open documents in the top bar of the Backend.

Internal

This class is a specific hook implementation and is not part of the TYPO3's Core 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
Checks whether the user has access to this toolbar item.
getAdditionalAttributes()  : array<string|int, mixed>
No additional attributes
getDropDown()  : string
Render drop-down.
getIndex()  : int
Position relative to others
getItem()  : string
Render toolbar icon via Fluid
hasDropDown()  : bool
This item has a drop-down.
setRequest()  : void
updateNumberOfOpenDocsHook()  : void
Called as a hook in \TYPO3\CMS\Backend\Utility\BackendUtility::getUpdateSignalCode, calls a JS function to change the number of opened documents.
getBackendUser()  : BackendUserAuthentication
getMenuEntries()  : array<string|int, mixed>
Get menu entries for all eligible records.
getMenuEntry()  : array<string|int, mixed>
Returns the data for a recent or open document

Methods

checkAccess()

Checks whether the user has access to this toolbar item.

public checkAccess() : bool
Return values
bool —

TRUE if user has access, FALSE if not

getAdditionalAttributes()

No additional attributes

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

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 toolbar icon via Fluid

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

updateNumberOfOpenDocsHook()

Called as a hook in \TYPO3\CMS\Backend\Utility\BackendUtility::getUpdateSignalCode, calls a JS function to change the number of opened documents.

public updateNumberOfOpenDocsHook(array<string|int, mixed> &$params) : void
Parameters
$params : array<string|int, mixed>

getMenuEntries()

Get menu entries for all eligible records.

protected getMenuEntries(array<string|int, mixed> $documents) : array<string|int, mixed>
Parameters
$documents : array<string|int, mixed>
Return values
array<string|int, mixed>

getMenuEntry()

Returns the data for a recent or open document

protected getMenuEntry(array<string|int, mixed> $document, string $identifier) : array<string|int, mixed>
Parameters
$document : array<string|int, mixed>
$identifier : string
Return values
array<string|int, mixed> —

The data of a recent or closed document, or empty array if no record was found (e.g. deleted)


        

        
    




    

    

                            

            

                            
    

        On this page

        
    


            

                    

        

    

        

            
Search results