TYPO3\CMS\Sv\Report\ServicesListReport Class Reference

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

Public Member Functions
	__construct (\TYPO3\CMS\Reports\Controller\ReportController $reportsModule)
	getReport ()

Protected Member Functions
	renderHelp ()
	renderServicesList ()
	renderServiceTypeList ($serviceType, $services)
	renderServiceRow ($serviceKey, $serviceInformation)
	renderExecutablesSearchPathList ()
	getInstalledServices ()
	sortServices (array $a, array $b)

Protected Attributes
	$reportsModule

Detailed Description

This file is part of the TYPO3 CMS project.

It is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License, either version 2 of the License, or any later version.

For the full copyright and license information, please read the LICENSE.txt file that was distributed with this source code.

The TYPO3 project - inspiring people to share! This class provides a report displaying a list of all installed services Code inspired by EXT:dam/lib/class.tx_dam_svlist.php by René Fritz

Author

Francois Suter franc.nosp@m.ois@.nosp@m.typo3.nosp@m..org

Definition at line 22 of file ServicesListReport.php.

Constructor & Destructor Documentation

__construct()

TYPO3\CMS\Sv\Report\ServicesListReport::__construct

(

\TYPO3\CMS\Reports\Controller\ReportController

$reportsModule

)

Constructor for class tx_sv_reports_ServicesList

Parameters

tx_reports_Module

$reportsModule

Back-reference to the calling reports module

Definition at line 36 of file ServicesListReport.php.

References $GLOBALS, and TYPO3\CMS\Sv\Report\ServicesListReport\$reportsModule.

Member Function Documentation

getInstalledServices()

TYPO3\CMS\Sv\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 203 of file ServicesListReport.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Sv\Report\ServicesListReport\renderServicesList().

getReport()

TYPO3\CMS\Sv\Report\ServicesListReport::getReport

(

)

This method renders the report

Returns

string The status report as HTML

Implements TYPO3\CMS\Reports\ReportInterface.

Definition at line 46 of file ServicesListReport.php.

References TYPO3\CMS\Sv\Report\ServicesListReport\renderExecutablesSearchPathList(), TYPO3\CMS\Sv\Report\ServicesListReport\renderHelp(), and TYPO3\CMS\Sv\Report\ServicesListReport\renderServicesList().

renderExecutablesSearchPathList()

TYPO3\CMS\Sv\Report\ServicesListReport::renderExecutablesSearchPathList ( )

protected

This method assembles a list of all defined executables search paths

Returns

string HTML to display

Definition at line 155 of file ServicesListReport.php.

References $GLOBALS, TYPO3\CMS\Core\Utility\GeneralUtility\fixWindowsFilePath(), and TYPO3\CMS\Core\Utility\CommandUtility\getPaths().

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

renderHelp()

TYPO3\CMS\Sv\Report\ServicesListReport::renderHelp ( )

protected

Renders the help comments at the top of the module.

Returns

string The help content for this module.

Definition at line 59 of file ServicesListReport.php.

References $GLOBALS.

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

renderServiceRow()

TYPO3\CMS\Sv\Report\ServicesListReport::renderServiceRow (   $serviceKey,   $serviceInformation  )

protected

Renders a single service's row.

Parameters

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

Returns

string HTML row for the service.

Definition at line 115 of file ServicesListReport.php.

References $GLOBALS, and TYPO3\CMS\Core\Utility\ExtensionManagementUtility\findServiceByKey().

Referenced by TYPO3\CMS\Sv\Report\ServicesListReport\renderServiceTypeList().

renderServicesList()

TYPO3\CMS\Sv\Report\ServicesListReport::renderServicesList ( )

protected

This method assembles a list of all installed services

Returns

string HTML to display

Definition at line 70 of file ServicesListReport.php.

References TYPO3\CMS\Sv\Report\ServicesListReport\getInstalledServices(), and TYPO3\CMS\Sv\Report\ServicesListReport\renderServiceTypeList().

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

renderServiceTypeList()

TYPO3\CMS\Sv\Report\ServicesListReport::renderServiceTypeList (   $serviceType,   $services  )

protected

Renders 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

string Service list as HTML for one service type

Definition at line 86 of file ServicesListReport.php.

References $GLOBALS, and TYPO3\CMS\Sv\Report\ServicesListReport\renderServiceRow().

Referenced by TYPO3\CMS\Sv\Report\ServicesListReport\renderServicesList().

sortServices()

TYPO3\CMS\Sv\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

integer 1, 0 or -1 if a is smaller, equal or greater than b, respectively

Definition at line 224 of file ServicesListReport.php.

References $result.

Member Data Documentation

$reportsModule

TYPO3\CMS\Sv\Report\ServicesListReport::$reportsModule

protected

Definition at line 29 of file ServicesListReport.php.

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