[TASK] Clean up code of available services report
authorFrancois Suter <francois@typo3.org>
Fri, 21 Oct 2011 13:17:05 +0000 (15:17 +0200)
committerFrancois Suter <francois@typo3.org>
Fri, 21 Oct 2011 13:20:25 +0000 (15:20 +0200)
The code of the available services report contains a number of
incomplete phpDoc blocks plus some small variables initialization
errors. This should be corrected before further work.

Change-Id: I02470e4daecfb8dd15e9477f33ba4023e0340c08
Resolves: #31174
Releases: 4.6
Reviewed-on: http://review.typo3.org/6170
Reviewed-by: Francois Suter
Tested-by: Francois Suter
typo3/sysext/sv/reports/class.tx_sv_reports_serviceslist.php

index f5c3cc3..d9860f8 100644 (file)
@@ -43,7 +43,7 @@ class tx_sv_reports_ServicesList implements tx_reports_Report {
        /**
         * Constructor for class tx_sv_reports_ServicesList
         *
-        * @param       tx_reports_Module       Back-reference to the calling reports module
+        * @param tx_reports_Module $reportsModule Back-reference to the calling reports module
         */
        public function __construct(tx_reports_Module $reportsModule) {
                $this->reportsModule = $reportsModule;
@@ -78,7 +78,7 @@ class tx_sv_reports_ServicesList implements tx_reports_Report {
         * @return      string  The help content for this module.
         */
        protected function renderHelp() {
-               $help .= '<p class="help">'
+               $help = '<p class="help">'
                        . $GLOBALS['LANG']->getLL('report_explanation')
                        . '</p>';
                $help .= '<p class="help">'
@@ -107,8 +107,9 @@ class tx_sv_reports_ServicesList implements tx_reports_Report {
        /**
         * Renders the services list for a single service type.
         *
-        * @param       string  $serviceType the service type to render the installed services list for.
-        * @return      string  Service list as HTML for one service type.
+        * @param string $serviceType The service type to render the installed services list for
+        * @param array $services List of services for the given type
+        * @return string Service list as HTML for one service type
         */
        protected function renderServiceTypeList($serviceType, $services) {
                $header = '<h4>' . sprintf(
@@ -116,7 +117,7 @@ class tx_sv_reports_ServicesList implements tx_reports_Report {
                        $serviceType
                ) . '</h4>';
 
-               $serviceList .= '
+               $serviceList = '
                <table cellspacing="1" cellpadding="2" border="0" class="tx_sv_reportlist services">
                        <tr class="t3-row-header">
                                <td style="width: 35%">' . $GLOBALS['LANG']->getLL('service') . '</td>
@@ -142,7 +143,7 @@ class tx_sv_reports_ServicesList implements tx_reports_Report {
        /**
         * Renders a single service's row.
         *
-        * @param       string  $sericeKey The service key to access the service.
+        * @param       string  $serviceKey The service key to access the service.
         * @param       array   $serviceInformation registration information of the service.
         * @return      string  HTML row for the service.
         */
@@ -266,10 +267,10 @@ class tx_sv_reports_ServicesList implements tx_reports_Report {
         * Utility method used to sort services according to their priority and
         * quality.
         *
-        * @param       array           First service to compare
-        * @param       array           Second service to compare
+        * @param array $a First service to compare
+        * @param array $b Second service to compare
         *
-        * @return      integer         1, 0 or -1 if a is smaller, equal or greater than b, respectively
+        * @return integer 1, 0 or -1 if a is smaller, equal or greater than b, respectively
         */
        protected function sortServices(array $a, array $b) {
                $result = 0;