ServicesListReport implements ReportInterface
This class provides a report displaying a list of all installed services
Table of Contents
Interfaces
- ReportInterface
- Interface for classes which provide a report.
Properties
Methods
- __construct() : mixed
- Constructor
- getReport() : string
- This method renders the report
- getExecutablesSearchPathList() : array<string|int, mixed>
- This method assembles a list of all defined executables search paths
- getInstalledServices() : array<string|int, mixed>
- This method filters the $T3_SERVICES global array to return a relevant, ordered list of installed services.
- getLanguageService() : LanguageService
- Returns LanguageService
- getServiceRow() : array<string|int, mixed>
- Get data of a single service's row.
- getServicesList() : array<string|int, mixed>
- This method assembles a list of all installed services
- getServiceTypeList() : array<string|int, mixed>
- Get the services list for a single service type.
- sortServices() : int
- Utility method used to sort services according to their priority and quality.
Properties
$reportsModule
protected
ReportController
$reportsModule
Methods
__construct()
Constructor
public
__construct(ReportController $reportsModule) : mixed
Parameters
- $reportsModule : ReportController
-
Back-reference to the calling reports module
getReport()
This method renders the report
public
getReport() : string
Return values
string —The status report as HTML
getExecutablesSearchPathList()
This method assembles a list of all defined executables search paths
protected
getExecutablesSearchPathList() : array<string|int, mixed>
Return values
array<string|int, mixed> —data to display
getInstalledServices()
This method filters the $T3_SERVICES global array to return a relevant, ordered list of installed services.
protected
getInstalledServices() : array<string|int, mixed>
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
Return values
array<string|int, mixed> —List of filtered and ordered services
getLanguageService()
Returns LanguageService
protected
getLanguageService() : LanguageService
Return values
LanguageServicegetServiceRow()
Get data of a single service's row.
protected
getServiceRow(string $serviceKey, array<string|int, mixed> $serviceInformation) : array<string|int, mixed>
Parameters
- $serviceKey : string
-
The service key to access the service.
- $serviceInformation : array<string|int, mixed>
-
registration information of the service.
Return values
array<string|int, mixed> —data for one row for the service.
getServicesList()
This method assembles a list of all installed services
protected
getServicesList() : array<string|int, mixed>
Return values
array<string|int, mixed> —with data to display
getServiceTypeList()
Get the services list for a single service type.
protected
getServiceTypeList(string $serviceType, array<string|int, mixed> $services) : array<string|int, mixed>
Parameters
- $serviceType : string
-
The service type to render the installed services list for
- $services : array<string|int, mixed>
-
List of services for the given type
Return values
array<string|int, mixed> —Service list as array for one service type
sortServices()
Utility method used to sort services according to their priority and quality.
protected
sortServices(array<string|int, mixed> $a, array<string|int, mixed> $b) : int
Parameters
- $a : array<string|int, mixed>
-
First service to compare
- $b : array<string|int, mixed>
-
Second service to compare
Return values
int —1, 0 or -1 if $a is smaller, equal or greater than $b, respectively