Status implements RequestAwareReportInterface
The status report
Attributes
- #[Autoconfigure]
- $public: true
Table of Contents
Interfaces
- RequestAwareReportInterface
- Interface for classes which provide a report using information from the current request
Properties
Methods
- __construct() : mixed
- Constructor for class tx_reports_report_Status
- getDescription() : string
- Returns description of the report
- 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.
- getIconIdentifier() : string
- Returns the identifier of the icon used for the report
- getIdentifier() : string
- Returns unique identifier of the report
- getReport() : string
- Takes care of creating / rendering the status report
- getSystemStatus() : array<string|int, array<string|int, Status>>
- Runs through all status providers and returns all statuses collected.
- getTitle() : string
- Returns title of the report
- getLanguageService() : LanguageService
- renderStatus() : string
- Renders the system's status
- sortStatuses() : array<string|int, mixed>
- Sorts the statuses by severity
- sortStatusProviders() : array<string|int, mixed>
- Sorts the status providers (alphabetically and puts primary status providers at the beginning)
Properties
$backendViewFactory read-only
protected
BackendViewFactory
$backendViewFactory
$statusRegistry read-only
protected
StatusRegistry
$statusRegistry
Methods
__construct()
Constructor for class tx_reports_report_Status
public
__construct(BackendViewFactory $backendViewFactory, StatusRegistry $statusRegistry) : mixed
Parameters
- $backendViewFactory : BackendViewFactory
- $statusRegistry : StatusRegistry
getDescription()
Returns description of the report
public
getDescription() : string
Return values
stringgetDetailedSystemStatus()
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|int, mixed> $statusCollection) : int
Parameters
- $statusCollection : array<string|int, mixed>
-
An array of \TYPO3\CMS\Reports\Status objects.
Return values
int —The highest severity found from the statuses.
getIconIdentifier()
Returns the identifier of the icon used for the report
public
getIconIdentifier() : string
Return values
stringgetIdentifier()
Returns unique identifier of the report
public
getIdentifier() : string
Return values
stringgetReport()
Takes care of creating / rendering the status report
public
getReport([ServerRequestInterface|null $request = null ]) : string
Parameters
- $request : ServerRequestInterface|null = null
-
the currently handled request
Return values
string —The status report as HTML
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>>getTitle()
Returns title of the report
public
getTitle() : string
Return values
stringgetLanguageService()
protected
getLanguageService() : LanguageService
Return values
LanguageServicerenderStatus()
Renders the system's status
protected
renderStatus(ServerRequestInterface $request, array<string|int, mixed> $statusCollection) : string
Parameters
- $request : ServerRequestInterface
-
Incoming request
- $statusCollection : array<string|int, mixed>
-
An array of statuses as returned by the available status providers
Return values
string —The system status as an HTML table
sortStatuses()
Sorts the statuses by severity
protected
sortStatuses(array<string|int, mixed> $statusCollection) : array<string|int, mixed>
Parameters
- $statusCollection : array<string|int, mixed>
-
A collection of statuses per provider
Return values
array<string|int, mixed> —The collection of statuses sorted by severity
sortStatusProviders()
Sorts the status providers (alphabetically and puts primary status providers at the beginning)
protected
sortStatusProviders(array<string|int, mixed> $statusCollection) : array<string|int, mixed>
Parameters
- $statusCollection : array<string|int, mixed>
-
A collection of statuses (with providers)
Return values
array<string|int, mixed> —The collection of statuses sorted by provider (beginning with provider "_install")