SystemInformationToolbarItem implements ToolbarItemInterface, RequestAwareToolbarItemInterface
Render system information toolbar item and drop-down.
Provides some events for other extensions to add information.
Attributes
- #[Autoconfigure]
- $public: true
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
- $highestSeverity : InformationStatus
- $severityBadgeClass : string
- $systemInformation : array<string|int, mixed>
- $systemMessages : array<string|int, mixed>
- $systemMessageTotalCount : int
Methods
- __construct() : mixed
- addSystemInformation() : void
- Add a system information.
- addSystemMessage() : void
- Add a system message.
- checkAccess() : bool
- Checks whether the user has access to this toolbar item.
- getAdditionalAttributes() : array<string|int, mixed>
- No additional attributes needed.
- getDropDown() : string
- Render drop-down
- getIndex() : int
- Position relative to others
- getItem() : string
- Render system information dropdown.
- hasDropDown() : bool
- This item has a drop-down.
- setRequest() : void
- addApplicationContext() : void
- addComposerMode() : void
- Adds the information if the Composer mode is enabled or disabled to the displayed system information
- addDatabase() : void
- addDebugger() : void
- addGitRevision() : void
- Gets the current GIT revision and branch
- addOperatingSystem() : void
- Gets the system kernel and version
- addPhpVersion() : void
- addTypo3Version() : void
- addWebServer() : void
- collectInformation() : void
- Collect the information for the drop-down.
- getBackendUserAuthentication() : BackendUserAuthentication
- getLanguageService() : LanguageService
- isFunctionDisabled() : bool
- Check if the given PHP function is disabled in the system.
Properties
$highestSeverity
protected
InformationStatus
$highestSeverity
$severityBadgeClass
protected
string
$severityBadgeClass
= ''
$systemInformation
protected
array<string|int, mixed>
$systemInformation
= []
$systemMessages
protected
array<string|int, mixed>
$systemMessages
= []
$systemMessageTotalCount
protected
int
$systemMessageTotalCount
= 0
Methods
__construct()
public
__construct(EventDispatcherInterface $eventDispatcher, Typo3Version $typo3Version, BackendViewFactory $backendViewFactory) : mixed
Parameters
- $eventDispatcher : EventDispatcherInterface
- $typo3Version : Typo3Version
- $backendViewFactory : BackendViewFactory
addSystemInformation()
Add a system information.
public
addSystemInformation(string $title, string $value, string $iconIdentifier[, string|InformationStatus $status = InformationStatus::NOTICE ]) : void
This is a callback method for signal receivers.
Parameters
- $title : string
-
The title of this system information, typically a LLL:EXT:... label string
- $value : string
-
The associated value
- $iconIdentifier : string
-
The icon identifier
- $status : string|InformationStatus = InformationStatus::NOTICE
-
The status of this system information
addSystemMessage()
Add a system message.
public
addSystemMessage(string $text[, string|InformationStatus $status = InformationStatus::OK ][, int $count = 0 ][, string $module = '' ][, string $params = '' ]) : void
This is a callback method for signal receivers.
Parameters
- $text : string
-
The text to be displayed
- $status : string|InformationStatus = InformationStatus::OK
-
The status of this system message
- $count : int = 0
-
Will be added to the total count
- $module : string = ''
-
The associated module
- $params : string = ''
-
Query string with additional parameters
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 needed.
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 system information dropdown.
public
getItem() : string
Return values
string —Toolbar item HTML
hasDropDown()
This item has a drop-down.
public
hasDropDown() : bool
Return values
boolsetRequest()
public
setRequest(ServerRequestInterface $request) : void
Parameters
- $request : ServerRequestInterface
addApplicationContext()
protected
addApplicationContext() : void
addComposerMode()
Adds the information if the Composer mode is enabled or disabled to the displayed system information
protected
addComposerMode() : void
addDatabase()
protected
addDatabase() : void
addDebugger()
protected
addDebugger() : void
addGitRevision()
Gets the current GIT revision and branch
protected
addGitRevision() : void
addOperatingSystem()
Gets the system kernel and version
protected
addOperatingSystem() : void
addPhpVersion()
protected
addPhpVersion() : void
addTypo3Version()
protected
addTypo3Version() : void
addWebServer()
protected
addWebServer() : void
collectInformation()
Collect the information for the drop-down.
protected
collectInformation() : void
getBackendUserAuthentication()
protected
getBackendUserAuthentication() : BackendUserAuthentication
Return values
BackendUserAuthenticationgetLanguageService()
protected
getLanguageService() : LanguageService
Return values
LanguageServiceisFunctionDisabled()
Check if the given PHP function is disabled in the system.
protected
isFunctionDisabled(string $functionName) : bool
Parameters
- $functionName : string