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

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

Public Member Functions
	__construct ()
string	getReport (ServerRequestInterface $request=null)
TYPO3 CMS Reports Status[]	getSystemStatus (ServerRequestInterface $request=null)
TYPO3 CMS Reports Status[]	getDetailedSystemStatus ()
int	getHighestSeverity (array $statusCollection)
‪Public Member Functions inherited from ‪TYPO3\CMS\Reports\ReportInterface
string	getReport ()

Protected Member Functions
	getStatusProviders ()
string	renderStatus (array $statusCollection)
array	sortStatusProviders (array $statusCollection)
array	sortStatuses (array $statusCollection)
LanguageService	getLanguageService ()

Protected Attributes
StatusProviderInterface[][]	$statusProviders = array( )

Detailed Description

The status report

Definition at line 31 of file Status.php.

Constructor & Destructor Documentation

__construct()

TYPO3\CMS\Reports\Report\Status\Status::__construct

(

)

Constructor for class tx_reports_report_Status

Definition at line 40 of file Status.php.

References TYPO3\CMS\Reports\Report\Status\Status\getLanguageService(), TYPO3\CMS\Reports\Report\Status\Status\getStatusProviders(), and TYPO3\CMS\Core\Localization\LanguageService\includeLLFile().

Member Function Documentation

getDetailedSystemStatus()

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

(

)

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

Returns

‪\TYPO3\CMS\Reports\Status[]

Definition at line 108 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 129 of file Status.php.

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

getLanguageService()

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

protected

Returns

‪LanguageService

Definition at line 265 of file Status.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Reports\Report\Status\Status\__construct(), TYPO3\CMS\Reports\Report\Status\Status\getReport(), 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\getLanguageService(), TYPO3\CMS\Core\Localization\LanguageService\getLL(), TYPO3\CMS\Reports\Report\Status\Status\getSystemStatus(), and TYPO3\CMS\Reports\Report\Status\Status\renderStatus().

getStatusProviders()

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

protected

Gets all registered status providers and creates instances of them.

Definition at line 67 of file Status.php.

References $GLOBALS.

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

getSystemStatus()

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

(

ServerRequestInterface

$request = null

)

Runs through all status providers and returns all statuses collected.

Parameters

ServerRequestInterface

$request

Returns

‪\TYPO3\CMS\Reports\Status[]

Definition at line 86 of file Status.php.

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

renderStatus()

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

protected

Renders the system's status

Parameters

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 153 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 240 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 201 of file Status.php.

References TYPO3\CMS\Reports\Report\Status\Status\getLanguageService(), TYPO3\CMS\Core\Localization\LanguageService\getLL(), and TYPO3\CMS\Core\Localization\LanguageService\sL().

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

Member Data Documentation

$statusProviders

StatusProviderInterface [][] TYPO3\CMS\Reports\Report\Status\Status::$statusProviders = array( )

protected

Definition at line 35 of file Status.php.