TYPO3\CMS\Reports\Report\Status\Status Class Reference

Inheritance diagram for TYPO3\CMS\Reports\Report\Status\Status:

Public Member Functions
	__construct (protected readonly BackendViewFactory $backendViewFactory, protected readonly StatusRegistry $statusRegistry)
string	getReport (ServerRequestInterface $request=null)
	getIdentifier ()
	getTitle ()
	getDescription ()
	getIconIdentifier ()
ReportStatus[][]	getSystemStatus (ServerRequestInterface $request=null)
ReportStatus[][]	getDetailedSystemStatus ()
int	getHighestSeverity (array $statusCollection)
‪Public Member Functions inherited from ‪TYPO3\CMS\Reports\ReportInterface
	getReport ()

Protected Member Functions
string	renderStatus (ServerRequestInterface $request, array $statusCollection)
array	sortStatusProviders (array $statusCollection)
array	sortStatuses (array $statusCollection)
	getLanguageService ()

Detailed Description

The status report

Definition at line 33 of file Status.php.

Constructor & Destructor Documentation

__construct()

TYPO3\CMS\Reports\Report\Status\Status::__construct	(	protected readonly BackendViewFactory	$backendViewFactory,
		protected readonly StatusRegistry	$statusRegistry
	)

Constructor for class tx_reports_report_Status

Definition at line 38 of file Status.php.

References TYPO3\CMS\Reports\Report\Status\Status\getLanguageService().

Member Function Documentation

getDescription()

TYPO3\CMS\Reports\Report\Status\Status::getDescription

(

)

Returns description of the report

Implements TYPO3\CMS\Reports\ReportInterface.

Definition at line 70 of file Status.php.

getDetailedSystemStatus()

ReportStatus [][] TYPO3\CMS\Reports\Report\Status\Status::getDetailedSystemStatus

(

)

Runs through all status providers and returns all statuses collected, which are detailed.

Returns

‪ReportStatus[][]

Definition at line 107 of file Status.php.

getHighestSeverity()

int TYPO3\CMS\Reports\Report\Status\Status::getHighestSeverity

(

array

$statusCollection

)

Determines the highest severity from the given statuses.

Parameters

array

$statusCollection

‪An array of \TYPO3\CMS\Reports\Status objects.

Returns

‪int The highest severity found from the statuses.

Definition at line 126 of file Status.php.

Referenced by TYPO3\CMS\Reports\Report\Status\Status\getReport().

getIconIdentifier()

TYPO3\CMS\Reports\Report\Status\Status::getIconIdentifier

(

)

Returns the identifier of the icon used for the report

Implements TYPO3\CMS\Reports\ReportInterface.

Definition at line 75 of file Status.php.

getIdentifier()

TYPO3\CMS\Reports\Report\Status\Status::getIdentifier

(

)

Returns unique identifier of the report

Implements TYPO3\CMS\Reports\ReportInterface.

Definition at line 60 of file Status.php.

getLanguageService()

TYPO3\CMS\Reports\Report\Status\Status::getLanguageService ( )

protected

Definition at line 240 of file Status.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Reports\Report\Status\Status\__construct(), and TYPO3\CMS\Reports\Report\Status\Status\sortStatusProviders().

getReport()

string TYPO3\CMS\Reports\Report\Status\Status::getReport

(

ServerRequestInterface

$request = null

)

Takes care of creating / rendering the status report

Parameters

ServerRequestInterface | null

$request

‪the currently handled request

Returns

‪string The status report as HTML

Implements TYPO3\CMS\Reports\RequestAwareReportInterface.

Definition at line 52 of file Status.php.

References TYPO3\CMS\Reports\Report\Status\Status\getHighestSeverity(), TYPO3\CMS\Reports\Report\Status\Status\getSystemStatus(), and TYPO3\CMS\Reports\Report\Status\Status\renderStatus().

getSystemStatus()

ReportStatus [][] TYPO3\CMS\Reports\Report\Status\Status::getSystemStatus

(

ServerRequestInterface

$request = null

)

Runs through all status providers and returns all statuses collected.

Parameters

ServerRequestInterface | null

$request

Returns

‪ReportStatus[][]

Definition at line 86 of file Status.php.

Referenced by TYPO3\CMS\Reports\Report\Status\Status\getReport().

getTitle()

TYPO3\CMS\Reports\Report\Status\Status::getTitle

(

)

Returns title of the report

Implements TYPO3\CMS\Reports\ReportInterface.

Definition at line 65 of file Status.php.

renderStatus()

string TYPO3\CMS\Reports\Report\Status\Status::renderStatus ( ServerRequestInterface  $request, array  $statusCollection  )

protected

Renders the system's status

Parameters

ServerRequestInterface	$request	‪Incoming request
array	$statusCollection	‪An array of statuses as returned by the available status providers

Returns

‪string The system status as an HTML table

Definition at line 151 of file Status.php.

References TYPO3\CMS\Reports\Report\Status\Status\sortStatuses(), and TYPO3\CMS\Reports\Report\Status\Status\sortStatusProviders().

Referenced by TYPO3\CMS\Reports\Report\Status\Status\getReport().

sortStatuses()

array TYPO3\CMS\Reports\Report\Status\Status::sortStatuses ( array  $statusCollection )

protected

Sorts the statuses by severity

Parameters

array

$statusCollection

‪A collection of statuses per provider

Returns

‪array The collection of statuses sorted by severity

Definition at line 218 of file Status.php.

Referenced by TYPO3\CMS\Reports\Report\Status\Status\renderStatus().

sortStatusProviders()

array TYPO3\CMS\Reports\Report\Status\Status::sortStatusProviders ( array  $statusCollection )

protected

Sorts the status providers (alphabetically and puts primary status providers at the beginning)

Parameters

array

$statusCollection

‪A collection of statuses (with providers)

Returns

‪array The collection of statuses sorted by provider (beginning with provider "_install")

Definition at line 180 of file Status.php.

References TYPO3\CMS\Reports\Report\Status\Status\getLanguageService().

Referenced by TYPO3\CMS\Reports\Report\Status\Status\renderStatus().