Cleanup #12492: Reports: Made some CGL improvements and added missing SVN markers
authorFrancois Suter <francois.suter@typo3.org>
Wed, 25 Nov 2009 12:16:38 +0000 (12:16 +0000)
committerFrancois Suter <francois.suter@typo3.org>
Wed, 25 Nov 2009 12:16:38 +0000 (12:16 +0000)
git-svn-id: https://svn.typo3.org/TYPO3v4/Core/trunk@6531 709f56b5-9817-0410-a4d7-c38de5d9e867

ChangeLog
typo3/sysext/install/report/class.tx_install_report_installstatus.php
typo3/sysext/reports/interfaces/interface.tx_reports_report.php
typo3/sysext/reports/interfaces/interface.tx_reports_statusprovider.php
typo3/sysext/reports/mod/index.php
typo3/sysext/reports/reports/class.tx_reports_reports_status.php
typo3/sysext/reports/reports/status/class.tx_reports_reports_status_configurationstatus.php
typo3/sysext/reports/reports/status/class.tx_reports_reports_status_securitystatus.php
typo3/sysext/reports/reports/status/class.tx_reports_reports_status_status.php
typo3/sysext/reports/reports/status/class.tx_reports_reports_status_systemstatus.php
typo3/sysext/reports/reports/status/class.tx_reports_reports_status_typo3status.php

index f88abae..2d14960 100755 (executable)
--- a/ChangeLog
+++ b/ChangeLog
@@ -11,6 +11,7 @@
 
        * Fixed bug #12547: Removed wrong default binary search paths for Windows
        * Feature #12491: Reports: Allow multiple providers for each status collection
+       * Cleanup #12492: Reports: Made some CGL improvements and added missing SVN markers
 
 2009-11-25  Oliver Hader  <oliver@typo3.org>
 
index f4798d0..5ef8566 100644 (file)
@@ -29,9 +29,11 @@ require_once(t3lib_extMgm::extPath('install', 'requirements.php'));
 /**
  * Provides an installation status report
  *
- * @author     Ingo Renner <ingo@typo3.org>
- * @package TYPO3
- * @subpackage tx_install
+ * @author             Ingo Renner <ingo@typo3.org>
+ * @package            TYPO3
+ * @subpackage tx_install
+ *
+ * $Id$
  */
 class tx_install_report_InstallStatus implements tx_reports_StatusProvider {
 
@@ -40,6 +42,7 @@ class tx_install_report_InstallStatus implements tx_reports_StatusProvider {
        /**
         * Compiles a collection of system status checks as a status report.
         *
+        * @return      array   List of statuses
         * @see typo3/sysext/reports/interfaces/tx_reports_StatusProvider::getStatus()
         */
        public function getStatus() {
@@ -54,9 +57,9 @@ class tx_install_report_InstallStatus implements tx_reports_StatusProvider {
        }
 
        /**
-        * Checks for several directoris being writable.
+        * Checks for several directories being writable.
         *
-        * @return unknown_type
+        * @return tx_reports_reports_status_Status     An tx_reports_reports_status_Status object indicating the status of the file system
         */
        protected function getFileSystemStatus() {
                $value    = $GLOBALS['LANG']->sL('LLL:EXT:install/report/locallang.xml:status_writable');
index 3c99ac3..df3aaf1 100644 (file)
 /**
  * Interface for classes which provide a report.
  *
- * @author     Ingo Renner <ingo@typo3.org>
- * @package TYPO3
- * @subpackage tx_reports
+ * @author             Ingo Renner <ingo@typo3.org>
+ * @package            TYPO3
+ * @subpackage tx_reports
+ *
+ * $Id$
  */
 interface tx_reports_Report {
 
index 9427275..5465b1a 100644 (file)
 /**
  * Interface for classes which provide a status report entry.
  *
- * @author     Ingo Renner <ingo@typo3.org>
- * @package TYPO3
- * @subpackage tx_reports
+ * @author             Ingo Renner <ingo@typo3.org>
+ * @package            TYPO3
+ * @subpackage tx_reports
+ *
+ * $Id$
  */
 interface tx_reports_StatusProvider {
 
index 711f224..65dfbb9 100644 (file)
 *
 *  This copyright notice MUST APPEAR in all copies of the script!
 ***************************************************************/
-/**
- * [CLASS/FUNCTION INDEX of SCRIPT]
- *
- * Hint: use extdeveval to insert/update function index above.
- */
 
 
 $LANG->includeLLFile('EXT:reports/mod/locallang.xml');
@@ -36,9 +31,11 @@ $BE_USER->modAccess($MCONF, 1);
 /**
  * Module 'Reports' for the 'reports' extension.
  *
- * @author     Ingo Renner <ingo@typo3.org>
- * @package    TYPO3
+ * @author             Ingo Renner <ingo@typo3.org>
+ * @package            TYPO3
  * @subpackage tx_reports
+ *
+ * $Id$
  */
 class tx_reports_Module extends t3lib_SCbase {
 
index 300fa1c..e44a938 100644 (file)
 /**
  * The status report
  *
- * @author     Ingo Renner <ingo@typo3.org>
- * @package TYPO3
- * @subpackage reports
+ * @author             Ingo Renner <ingo@typo3.org>
+ * @package            TYPO3
+ * @subpackage reports
+ *
+ * $Id$
  */
 class tx_reports_reports_Status implements tx_reports_Report {
 
@@ -215,7 +217,7 @@ class tx_reports_reports_Status implements tx_reports_Report {
                array_multisort($sortTitle, SORT_DESC, $statuses);
 
                        // making sure that the core version information is always on the top
-               if(is_object($header)) {
+               if (is_object($header)) {
                        array_unshift($statuses, $header);
                }
                return $statuses;
index 11963b9..09d49bd 100644 (file)
 /**\r
  * Performs some checks about the install tool protection status\r
  *\r
- * @author     Ingo Renner <ingo@typo3.org>\r
- * @package TYPO3\r
- * @subpackage reports\r
+ * @author             Ingo Renner <ingo@typo3.org>\r
+ * @package            TYPO3\r
+ * @subpackage reports\r
+ *\r
+ * $Id$\r
  */\r
 class tx_reports_reports_status_ConfigurationStatus implements tx_reports_StatusProvider {\r
 \r
        /**\r
         * Determines the Install Tool's status, mainly concerning its protection.\r
         *\r
+        * @return      array   List of statuses\r
         * @see typo3/sysext/reports/interfaces/tx_reports_StatusProvider::getStatus()\r
         */\r
        public function getStatus() {\r
                $statuses = array(\r
                        'emptyReferenceIndex' => $this->getReferenceIndexStatus(),\r
-\r
                );\r
 \r
                if ($this->isMemcachedUsed()) {\r
@@ -85,11 +87,11 @@ class tx_reports_reports_status_ConfigurationStatus implements tx_reports_Status
         * @return      boolean True if memcached is used, false otherwise.\r
         */\r
        protected function isMemcachedUsed() {\r
-               $memcachedUsed = false;\r
+               $memcachedUsed = FALSE;\r
 \r
                $memcachedServers = $this->getConfiguredMemcachedServers();\r
                if (count($memcachedServers)) {\r
-                       $memcachedUsed = true;\r
+                       $memcachedUsed = TRUE;\r
                }\r
 \r
                return $memcachedUsed;\r
index 3af76b9..d035fbc 100644 (file)
 /**\r
  * Performs several checks about the system's health\r
  *\r
- * @author     Ingo Renner <ingo@typo3.org>\r
- * @package TYPO3\r
- * @subpackage reports\r
+ * @author             Ingo Renner <ingo@typo3.org>\r
+ * @package            TYPO3\r
+ * @subpackage reports\r
+ *\r
+ * $Id$\r
  */\r
 class tx_reports_reports_status_SecurityStatus implements tx_reports_StatusProvider {\r
 \r
        /**\r
         * Determines the Install Tool's status, mainly concerning its protection.\r
         *\r
+        * @return      array   List of statuses\r
         * @see typo3/sysext/reports/interfaces/tx_reports_StatusProvider::getStatus()\r
         */\r
        public function getStatus() {\r
@@ -175,11 +178,11 @@ class tx_reports_reports_status_SecurityStatus implements tx_reports_StatusProvi
         * @return      boolean True if memcached is used, false otherwise.\r
         */\r
        protected function isMemcachedUsed() {\r
-               $memcachedUsed = false;\r
+               $memcachedUsed = FALSE;\r
 \r
                $memcachedServers = $this->getConfiguredMemcachedServers();\r
                if (count($memcachedServers)) {\r
-                       $memcachedUsed = true;\r
+                       $memcachedUsed = TRUE;\r
                }\r
 \r
                return $memcachedUsed;\r
@@ -194,7 +197,7 @@ class tx_reports_reports_status_SecurityStatus implements tx_reports_StatusProvi
        protected function executeAdminCommand() {\r
                $command = t3lib_div::_GET('adminCmd');\r
 \r
-               switch($command) {\r
+               switch ($command) {\r
                        case 'remove_ENABLE_INSTALL_TOOL':\r
                                unlink(PATH_site . 'typo3conf/ENABLE_INSTALL_TOOL');\r
                        break;\r
index b07e059..4cd2d6b 100644 (file)
 /**
  * A class representing a certain status
  *
- * @author     Ingo Renner <ingo@typo3.org>
- * @package TYPO3
- * @subpackage reports
+ * @author             Ingo Renner <ingo@typo3.org>
+ * @package            TYPO3
+ * @subpackage reports
+ *
+ * $Id$
  */
 class tx_reports_reports_status_Status {
 
index eba6267..d30609f 100644 (file)
 /**
  * Performs several checks about the system's health
  *
- * @author     Ingo Renner <ingo@typo3.org>
- * @package TYPO3
- * @subpackage reports
+ * @author             Ingo Renner <ingo@typo3.org>
+ * @package            TYPO3
+ * @subpackage reports
  */
 class tx_reports_reports_status_SystemStatus implements tx_reports_StatusProvider {
 
        /**
         * Determines the Install Tool's status, mainly concerning its protection.
         *
+        * @return      array   List of statuses
         * @see typo3/sysext/reports/interfaces/tx_reports_StatusProvider::getStatus()
         */
        public function getStatus() {
index bdc8d67..a0cf786 100644 (file)
  * @author             Ingo Renner <ingo@typo3.org>\r
  * @package            TYPO3\r
  * @subpackage reports\r
+ *\r
+ * $Id$\r
  */\r
 class tx_reports_reports_status_Typo3Status implements tx_reports_StatusProvider {\r
 \r
        /**\r
         * Returns the status for this report\r
         *\r
+        * @return      array   List of statuses\r
         * @see typo3/sysext/reports/interfaces/tx_reports_StatusProvider::getStatus()\r
         */\r
        public function getStatus() {\r
                $statuses = array(\r
                        'Typo3Version' => $this->getTypo3VersionStatus(),\r
-\r
                );\r
 \r
                return $statuses;\r