TYPO3\CMS\Reports\Report\ServicesListReport Class Reference

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

Public Member Functions
	__construct (ReportController $reportsModule)
string	getReport ()

Protected Member Functions
array	getServicesList ()
array	getServiceTypeList ($serviceType, $services)
array	getServiceRow ($serviceKey, $serviceInformation)
array	getExecutablesSearchPathList ()
array	getInstalledServices ()
int	sortServices (array $a, array $b)
TYPO3 CMS Core Localization LanguageService	getLanguageService ()

Protected Attributes
ReportController	$reportsModule

Private Member Functions
array	getServicePathStatus ($isValid)

Detailed Description

This class provides a report displaying a list of all installed services

Definition at line 29 of file ServicesListReport.php.

Constructor & Destructor Documentation

__construct()

TYPO3\CMS\Reports\Report\ServicesListReport::__construct

(

ReportController

$reportsModule

)

Constructor

Parameters

ReportController

$reportsModule

‪Back-reference to the calling reports module

Definition at line 40 of file ServicesListReport.php.

References TYPO3\CMS\Reports\Report\ServicesListReport\$reportsModule, and TYPO3\CMS\Reports\Report\ServicesListReport\getLanguageService().

Member Function Documentation

getExecutablesSearchPathList()

array TYPO3\CMS\Reports\Report\ServicesListReport::getExecutablesSearchPathList ( )

protected

This method assembles a list of all defined executables search paths

Returns

‪array data to display

Definition at line 140 of file ServicesListReport.php.

References TYPO3\CMS\Core\Utility\CommandUtility\getPaths(), and TYPO3\CMS\Reports\Report\ServicesListReport\getServicePathStatus().

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

getInstalledServices()

array TYPO3\CMS\Reports\Report\ServicesListReport::getInstalledServices ( )

protected

This method filters the $T3_SERVICES global array to return a relevant, ordered list of installed services.

Every installed service appears twice in $T3_SERVICES: once as a service key for a given service type, and once a service type all by itself The list of services to display must avoid these duplicates

Furthermore, inside each service type, installed services must be ordered by priority and quality

Returns

‪array List of filtered and ordered services

Definition at line 170 of file ServicesListReport.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Reports\Report\ServicesListReport\getServicesList().

getLanguageService()

TYPO3 CMS Core Localization LanguageService TYPO3\CMS\Reports\Report\ServicesListReport::getLanguageService ( )

protected

Returns LanguageService

Returns

‪\TYPO3\CMS\Core\Localization\LanguageService

Definition at line 235 of file ServicesListReport.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Reports\Report\ServicesListReport\__construct(), TYPO3\CMS\Reports\Report\ServicesListReport\getServiceRow(), and TYPO3\CMS\Reports\Report\ServicesListReport\getServiceTypeList().

getReport()

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

(

)

This method renders the report

Returns

‪string The status report as HTML

Implements TYPO3\CMS\Reports\ReportInterface.

Definition at line 51 of file ServicesListReport.php.

References TYPO3\CMS\Reports\Report\ServicesListReport\getExecutablesSearchPathList(), and TYPO3\CMS\Reports\Report\ServicesListReport\getServicesList().

getServicePathStatus()

array TYPO3\CMS\Reports\Report\ServicesListReport::getServicePathStatus (   $isValid )

private

Method to check if the service in path is available

Parameters

bool | string

$isValid

Returns

‪array

Definition at line 215 of file ServicesListReport.php.

Referenced by TYPO3\CMS\Reports\Report\ServicesListReport\getExecutablesSearchPathList().

getServiceRow()

array TYPO3\CMS\Reports\Report\ServicesListReport::getServiceRow (   $serviceKey,   $serviceInformation  )

protected

Get data of a single service's row.

Parameters

string	$serviceKey	‪The service key to access the service.
array	$serviceInformation	‪registration information of the service.

Returns

‪array data for one row for the service.

Definition at line 111 of file ServicesListReport.php.

References TYPO3\CMS\Core\Utility\ExtensionManagementUtility\findServiceByKey(), and TYPO3\CMS\Reports\Report\ServicesListReport\getLanguageService().

Referenced by TYPO3\CMS\Reports\Report\ServicesListReport\getServiceTypeList().

getServicesList()

array TYPO3\CMS\Reports\Report\ServicesListReport::getServicesList ( )

protected

This method assembles a list of all installed services

Returns

‪array with data to display

Definition at line 73 of file ServicesListReport.php.

References TYPO3\CMS\Reports\Report\ServicesListReport\getInstalledServices(), and TYPO3\CMS\Reports\Report\ServicesListReport\getServiceTypeList().

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

getServiceTypeList()

array TYPO3\CMS\Reports\Report\ServicesListReport::getServiceTypeList (   $serviceType,   $services  )

protected

Get the services list for a single service type.

Parameters

string	$serviceType	‪The service type to render the installed services list for
array	$services	‪List of services for the given type

Returns

‪array Service list as array for one service type

Definition at line 90 of file ServicesListReport.php.

References TYPO3\CMS\Reports\Report\ServicesListReport\getLanguageService(), and TYPO3\CMS\Reports\Report\ServicesListReport\getServiceRow().

Referenced by TYPO3\CMS\Reports\Report\ServicesListReport\getServicesList().

sortServices()

int TYPO3\CMS\Reports\Report\ServicesListReport::sortServices ( array  $a, array  $b  )

protected

Utility method used to sort services according to their priority and quality.

Parameters

array	$a	‪First service to compare
array	$b	‪Second service to compare

Returns

‪int 1, 0 or -1 if $a is smaller, equal or greater than $b, respectively

Definition at line 192 of file ServicesListReport.php.

Member Data Documentation

$reportsModule

ReportController TYPO3\CMS\Reports\Report\ServicesListReport::$reportsModule

protected

Definition at line 33 of file ServicesListReport.php.

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