OpendocsToolbarItem implements ToolbarItemInterface
Main functionality to render a list of all open documents in the top bar of the TYPO3 Backend
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
Properties
Methods
- __construct() : mixed
- Set up dependencies
- 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 via Fluid
- getIndex() : int
- Position relative to others
- getItem() : string
- Render toolbar icon via Fluid
- hasDropDown() : bool
- This item has a drop down
- updateNumberOfOpenDocsHook() : mixed
- Called as a hook in \TYPO3\CMS\Backend\Utility\BackendUtility::getUpdateSignalCode, calls a JS function to change the number of opened documents
- getBackendUser() : BackendUserAuthentication
- getFluidTemplateObject() : StandaloneView
- Returns a new standalone view, shorthand function
- 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
Properties
$documentService
protected
OpenDocumentService
$documentService
Methods
__construct()
Set up dependencies
public
__construct([OpenDocumentService|null $documentService = null ]) : mixed
Parameters
- $documentService : OpenDocumentService|null = null
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 of attributes
getDropDown()
Render drop down via Fluid
public
getDropDown() : string
Return values
string —HTML
getIndex()
Position relative to others
public
getIndex() : int
Return values
intgetItem()
Render toolbar icon via Fluid
public
getItem() : string
Return values
string —HTML
hasDropDown()
This item has a drop down
public
hasDropDown() : bool
Return values
boolupdateNumberOfOpenDocsHook()
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) : mixed
Parameters
- $params : array<string|int, mixed>
getBackendUser()
protected
getBackendUser() : BackendUserAuthentication
Return values
BackendUserAuthenticationgetFluidTemplateObject()
Returns a new standalone view, shorthand function
protected
getFluidTemplateObject(string $filename) : StandaloneView
Parameters
- $filename : string
-
Which templateFile should be used.
Return values
StandaloneViewgetMenuEntries()
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)