StatusService
Service for collecting and processing system status information
This is not part of the public API and may change at any time
Attributes
- #[Autoconfigure]
- $public: true
Table of Contents
Properties
Methods
- __construct() : mixed
- collectAndStoreSystemStatus() : void
- Collects system status and stores the highest severity in the registry.
- getDetailedSystemStatus() : array<string|int, array<string|int, Status>>
- Runs through all status providers and returns all statuses collected, which are detailed.
- getHighestSeverity() : int
- Determines the highest severity from the given statuses.
- getSystemStatus() : array<string|int, array<string|int, Status>>
- Runs through all status providers and returns all statuses collected.
- sortStatuses() : array<int, Status>
- Sorts the statuses by severity
- sortStatusProviders() : array<string, array<string, Status>>
- Sorts the status providers (alphabetically and puts primary status providers at the beginning)
- getLanguageService() : LanguageService
Properties
$registry
protected
Registry
$registry
$statusRegistry
protected
StatusRegistry
$statusRegistry
Methods
__construct()
public
__construct(StatusRegistry $statusRegistry, Registry $registry) : mixed
Parameters
- $statusRegistry : StatusRegistry
- $registry : Registry
collectAndStoreSystemStatus()
Collects system status and stores the highest severity in the registry.
public
collectAndStoreSystemStatus([ServerRequestInterface|null $request = null ]) : void
This is useful for displaying warnings at login or in the backend.
Parameters
- $request : ServerRequestInterface|null = null
getDetailedSystemStatus()
Runs through all status providers and returns all statuses collected, which are detailed.
public
getDetailedSystemStatus() : array<string|int, array<string|int, Status>>
Return values
array<string|int, array<string|int, Status>>getHighestSeverity()
Determines the highest severity from the given statuses.
public
getHighestSeverity(array<string, array<string, Status>> $statusCollection) : int
Parameters
- $statusCollection : array<string, array<string, Status>>
-
An array of Status objects.
Return values
int —The highest severity found from the statuses.
getSystemStatus()
Runs through all status providers and returns all statuses collected.
public
getSystemStatus([ServerRequestInterface|null $request = null ]) : array<string|int, array<string|int, Status>>
Parameters
- $request : ServerRequestInterface|null = null
Return values
array<string|int, array<string|int, Status>>sortStatuses()
Sorts the statuses by severity
public
sortStatuses(array<string, Status> $statusCollection) : array<int, Status>
Parameters
- $statusCollection : array<string, Status>
-
A collection of statuses per provider
Return values
array<int, Status> —The collection of statuses sorted by severity
sortStatusProviders()
Sorts the status providers (alphabetically and puts primary status providers at the beginning)
public
sortStatusProviders(array<string, array<string, Status>> $statusCollection) : array<string, array<string, Status>>
Parameters
- $statusCollection : array<string, array<string, Status>>
-
A collection of statuses (with providers)
Return values
array<string, array<string, Status>> —The collection of statuses sorted by provider
getLanguageService()
protected
getLanguageService() : LanguageService