Status implements RequestAwareReportInterface
The status report
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() : 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() : 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
- Sorts the statuses by severity
- sortStatusProviders() : array
- 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() : Status[][]
Return values
Status[][]getHighestSeverity()
Determines the highest severity from the given statuses.
public
getHighestSeverity(array $statusCollection) : int
Parameters
- $statusCollection : array
-
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 ]) : Status[][]
Parameters
- $request : ServerRequestInterface|null = null
Return values
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 $statusCollection) : string
Parameters
- $request : ServerRequestInterface
-
Incoming request
- $statusCollection : array
-
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 $statusCollection) : array
Parameters
- $statusCollection : array
-
A collection of statuses per provider
Return values
array —The collection of statuses sorted by severity
sortStatusProviders()
Sorts the status providers (alphabetically and puts primary status providers at the beginning)
protected
sortStatusProviders(array $statusCollection) : array
Parameters
- $statusCollection : array
-
A collection of statuses (with providers)
Return values
array —The collection of statuses sorted by provider (beginning with provider "_install")