[TASK] Clean up phpDoc comments in typo3/sysext/
authorWouter Wolters <typo3@wouterwolters.nl>
Fri, 22 Jun 2012 16:52:16 +0000 (18:52 +0200)
committerChristian Kuhn <lolli@schwarzbu.ch>
Fri, 22 Jun 2012 17:52:31 +0000 (19:52 +0200)
Clean up phpDoc comments for the following classes:

* typo3/sysext/recordlist/ext_tables.php
* typo3/sysext/recordlist/mod1/index.php
* typo3/sysext/reports/ext_localconf.php
* typo3/sysext/reports/ext_tables.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
* typo3/sysext/reports/reports/status/
class.tx_reports_reports_status_warningmessagepostprocessor.php
* typo3/sysext/reports/tasks/
class.tx_reports_tasks_systemstatusupdatetask.php
* typo3/sysext/reports/tasks/
class.tx_reports_tasks_systemstatusupdatetasknotificationemailfield.php

Clean up provides:

* Provide correct parameter names in phpDoc
* Provide correct data types in phpDoc
* CGLify phpDoc (remove tabs)

Change-Id: I75f6fe74dd2e70c2f327729eaffbc0da8d4518c4
Resolves: #38315
Releases: 6.0
Reviewed-on: http://review.typo3.org/12297
Reviewed-by: Christian Kuhn
Tested-by: Christian Kuhn
16 files changed:
typo3/sysext/recordlist/ext_tables.php
typo3/sysext/recordlist/mod1/index.php
typo3/sysext/reports/ext_localconf.php
typo3/sysext/reports/ext_tables.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
typo3/sysext/reports/reports/status/class.tx_reports_reports_status_warningmessagepostprocessor.php
typo3/sysext/reports/tasks/class.tx_reports_tasks_systemstatusupdatetask.php
typo3/sysext/reports/tasks/class.tx_reports_tasks_systemstatusupdatetasknotificationemailfield.php

index 1d55bdc..25fe21a 100644 (file)
@@ -1,6 +1,6 @@
 <?php
-if (!defined ('TYPO3_MODE')) {
-       die ('Access denied.');
+if (!defined('TYPO3_MODE')) {
+       die('Access denied.');
 }
 
 if (TYPO3_MODE === 'BE') {
index d3a56d3..42970ae 100644 (file)
  * Revised for TYPO3 3.6 November/2003 by Kasper Skårhøj
  * XHTML compliant
  *
- * @author     Kasper Skårhøj <kasperYYYY@typo3.com>
+ * @author Kasper Skårhøj <kasperYYYY@typo3.com>
  */
 
-
 $LANG->includeLLFile('EXT:lang/locallang_mod_web_list.xml');
 $BE_USER->modAccess($MCONF, 1);
 t3lib_BEfunc::lockRecords();
 
-
-
-
-
-
-
-
 /**
  * Script Class for the Web > List module; rendering the listing of records on a page
  *
- * @author     Kasper Skårhøj <kasperYYYY@typo3.com>
+ * @author Kasper Skårhøj <kasperYYYY@typo3.com>
  * @package TYPO3
  * @subpackage core
  */
 class SC_db_list {
 
                // Internal, GPvars:
-       var $id;                                        // Page Id for which to make the listing
-       var $pointer;                           // Pointer - for browsing list of records.
-       var $imagemode;                         // Thumbnails or not
-       var $table;                                     // Which table to make extended listing for
-       var $search_field;                      // Search-fields
-       var $search_levels;                     // Search-levels
-       var $showLimit;                         // Show-limit
-       var $returnUrl;                         // Return URL
-
-       var $clear_cache;                       // Clear-cache flag - if set, clears page cache for current id.
-       var $cmd;                                       // Command: Eg. "delete" or "setCB" (for TCEmain / clipboard operations)
-       var $cmd_table;                         // Table on which the cmd-action is performed.
+               // Page Id for which to make the listing
+       var $id;
+               // Pointer - for browsing list of records.
+       var $pointer;
+               // Thumbnails or not
+       var $imagemode;
+               // Which table to make extended listing for
+       var $table;
+               // Search-fields
+       var $search_field;
+               // Search-levels
+       var $search_levels;
+               // Show-limit
+       var $showLimit;
+               // Return URL
+       var $returnUrl;
+               // Clear-cache flag - if set, clears page cache for current id.
+       var $clear_cache;
+               // Command: Eg. "delete" or "setCB" (for TCEmain / clipboard operations)
+       var $cmd;
+               // Table on which the cmd-action is performed.
+       var $cmd_table;
 
                // Internal, static:
-       var $perms_clause;                      // Page select perms clause
-       var $modTSconfig;                       // Module TSconfig
-       var $pageinfo;                          // Current ids page record
+               // Page select perms clause
+       var $perms_clause;
+               // Module TSconfig
+       var $modTSconfig;
+               // Current ids page record
+       var $pageinfo;
 
        /**
         * Document template object
@@ -85,20 +90,23 @@ class SC_db_list {
         * @var template
         */
        var $doc;
-
-       var $MCONF=array();                     // Module configuration
-       var $MOD_MENU=array();          // Menu configuration
-       var $MOD_SETTINGS=array();      // Module settings (session variable)
-       var $include_once=array();      // Array, where files to include is accumulated in the init() function
+               // Module configuration
+       var $MCONF = array();
+               // Menu configuration
+       var $MOD_MENU = array();
+               // Module settings (session variable)
+       var $MOD_SETTINGS = array();
+               // Array, where files to include is accumulated in the init() function
+       var $include_once = array();
 
                // Internal, dynamic:
-       var $content;                           // Module output accumulation
-
+               // Module output accumulation
+       var $content;
 
        /**
         * Initializing the module
         *
-        * @return      void
+        * @return void
         */
        function init() {
 
@@ -127,7 +135,7 @@ class SC_db_list {
        /**
         * Initialize function menu array
         *
-        * @return      void
+        * @return void
         */
        function menuConfig() {
 
@@ -148,13 +156,13 @@ class SC_db_list {
        /**
         * Clears page cache for the current id, $this->id
         *
-        * @return      void
+        * @return void
         */
        function clearCache() {
                if ($this->clear_cache) {
                        $tce = t3lib_div::makeInstance('t3lib_TCEmain');
-                       $tce->stripslashes_values=0;
-                       $tce->start(Array(), Array());
+                       $tce->stripslashes_values = 0;
+                       $tce->start(array(), array());
                        $tce->clear_cacheCmd($this->id);
                }
        }
@@ -162,7 +170,7 @@ class SC_db_list {
        /**
         * Main function, starting the rendering of the list.
         *
-        * @return      void
+        * @return void
         */
        function main() {
                        // Start document template object:
@@ -222,25 +230,35 @@ class SC_db_list {
                $dblist->modTSconfig = $this->modTSconfig;
 
                        // Clipboard is initialized:
-               $dblist->clipObj = t3lib_div::makeInstance('t3lib_clipboard');          // Start clipboard
-               $dblist->clipObj->initializeClipboard();        // Initialize - reads the clipboard content from the user session
+                       // Start clipboard
+               $dblist->clipObj = t3lib_div::makeInstance('t3lib_clipboard');
+                       // Initialize - reads the clipboard content from the user session
+               $dblist->clipObj->initializeClipboard();
 
                        // Clipboard actions are handled:
-               $CB = t3lib_div::_GET('CB');    // CB is the clipboard command array
-               if ($this->cmd=='setCB') {
-                               // CBH is all the fields selected for the clipboard, CBC is the checkbox fields which were checked. By merging we get a full array of checked/unchecked elements
+                       // CB is the clipboard command array
+               $CB = t3lib_div::_GET('CB');
+               if ($this->cmd == 'setCB') {
+                               // CBH is all the fields selected for the clipboard, CBC is the checkbox fields which were checked.
+                               // By merging we get a full array of checked/unchecked elements
                                // This is set to the 'el' array of the CB after being parsed so only the table in question is registered.
                        $CB['el'] = $dblist->clipObj->cleanUpCBC(array_merge((array)t3lib_div::_POST('CBH'), (array)t3lib_div::_POST('CBC')), $this->cmd_table);
                }
-               if (!$this->MOD_SETTINGS['clipBoard'])  $CB['setP']='normal';   // If the clipboard is NOT shown, set the pad to 'normal'.
-               $dblist->clipObj->setCmd($CB);          // Execute commands.
-               $dblist->clipObj->cleanCurrent();       // Clean up pad
-               $dblist->clipObj->endClipboard();       // Save the clipboard content
+               if (!$this->MOD_SETTINGS['clipBoard']) {
+                               // If the clipboard is NOT shown, set the pad to 'normal'.
+                       $CB['setP'] = 'normal';
+               }
+                       // Execute commands.
+               $dblist->clipObj->setCmd($CB);
+                       // Clean up pad
+               $dblist->clipObj->cleanCurrent();
+                       // Save the clipboard content
+               $dblist->clipObj->endClipboard();
 
                        // This flag will prevent the clipboard panel in being shown.
                        // It is set, if the clickmenu-layer is active AND the extended view is not enabled.
                $dblist->dontShowClipControlPanels = $GLOBALS['CLIENT']['FORMSTYLE'] && !$this->MOD_SETTINGS['bigControlPanel']
-                       && $dblist->clipObj->current=='normal'
+                       && $dblist->clipObj->current == 'normal'
                        && !$this->modTSconfig['properties']['showClipControlPanelsDespiteOfCMlayers'];
 
 
@@ -250,16 +268,16 @@ class SC_db_list {
 
                                // Deleting records...:
                                // Has not to do with the clipboard but is simply the delete action. The clipboard object is used to clean up the submitted entries to only the selected table.
-                       if ($this->cmd=='delete') {
+                       if ($this->cmd == 'delete') {
                                $items = $dblist->clipObj->cleanUpCBC(t3lib_div::_POST('CBC'), $this->cmd_table, 1);
                                if (count($items)) {
-                                       $cmd=array();
+                                       $cmd = array();
                                        foreach ($items as $iK => $value) {
                                                $iKParts = explode('|', $iK);
                                                $cmd[$iKParts[0]][$iKParts[1]]['delete']=1;
                                        }
                                        $tce = t3lib_div::makeInstance('t3lib_TCEmain');
-                                       $tce->stripslashes_values=0;
+                                       $tce->stripslashes_values = 0;
                                        $tce->start(array(), $cmd);
                                        $tce->process_cmdmap();
 
@@ -346,9 +364,9 @@ class SC_db_list {
 
                        // Begin to compile the whole page, starting out with page header:
                $this->body = $this->doc->header($this->pageinfo['title']);
-               $this->body.= '<form action="'.htmlspecialchars($dblist->listURL()).'" method="post" name="dblistForm">';
-               $this->body.= $dblist->HTMLcode;
-               $this->body.= '<input type="hidden" name="cmd_table" /><input type="hidden" name="cmd" /></form>';
+               $this->body .= '<form action="'.htmlspecialchars($dblist->listURL()).'" method="post" name="dblistForm">';
+               $this->body .= $dblist->HTMLcode;
+               $this->body .= '<input type="hidden" name="cmd_table" /><input type="hidden" name="cmd" /></form>';
 
                        // If a listing was produced, create the page footer with search form etc:
                if ($dblist->HTMLcode) {
@@ -466,19 +484,21 @@ class SC_db_list {
        /**
         * Outputting the accumulated content to screen
         *
-        * @return      void
+        * @return void
         */
        function printContent() {
                echo $this->content;
        }
 }
 
-// Make instance:
+       // Make instance:
 $SOBE = t3lib_div::makeInstance('SC_db_list');
 $SOBE->init();
 
 // Include files?
-foreach($SOBE->include_once as $INC_FILE)      include_once($INC_FILE);
+foreach ($SOBE->include_once as $INC_FILE) {
+       include_once($INC_FILE);
+}
 
 $SOBE->clearCache();
 $SOBE->main();
index 8449664..6436c70 100644 (file)
@@ -1,7 +1,7 @@
 <?php
 
-if (!defined ('TYPO3_MODE')) {
-       die ('Access denied.');
+if (!defined('TYPO3_MODE')) {
+       die('Access denied.');
 }
 
 $GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['scheduler']['tasks']['tx_reports_tasks_SystemStatusUpdateTask'] = array(
index 757f61d..8f7c967 100644 (file)
@@ -1,6 +1,6 @@
 <?php
-if (!defined ('TYPO3_MODE')) {
-       die ('Access denied.');
+if (!defined('TYPO3_MODE')) {
+       die('Access denied.');
 }
 
 if (TYPO3_MODE == 'BE') {
@@ -26,7 +26,6 @@ if (TYPO3_MODE == 'BE') {
        $GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['reports']['tx_reports']['status']['providers']['system'][] = 'tx_reports_reports_status_SystemStatus';
        $GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['reports']['tx_reports']['status']['providers']['security'][] = 'tx_reports_reports_status_SecurityStatus';
        $GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['reports']['tx_reports']['status']['providers']['configuration'][] = 'tx_reports_reports_status_ConfigurationStatus';
-
 }
 
 ?>
\ No newline at end of file
index 203fa5a..a8a9bc7 100644 (file)
 *  This copyright notice MUST APPEAR in all copies of the script!
 ***************************************************************/
 
-
 /**
  * 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
  */
 interface tx_reports_Report {
 
        /**
-        * returns the content for a report
+        * Returns the content for a report
         *
-        * @return      string  A reports rendered HTML
+        * @return string A reports rendered HTML
         */
        public function getReport();
 }
index e70f579..5f86d50 100644 (file)
 *  This copyright notice MUST APPEAR in all copies of the script!
 ***************************************************************/
 
-
 /**
  * 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
  */
 interface tx_reports_StatusProvider {
 
        /**
-        * returns the staus of an extension or (sub)system
+        * Returns the staus of an extension or (sub)system
         *
-        * @return      array   An array of tx_reports_reports_status_Status objects
+        * @return array An array of tx_reports_reports_status_Status objects
         */
        public function getStatus();
 }
index 71fddfd..a37575c 100644 (file)
 *  This copyright notice MUST APPEAR in all copies of the script!
 ***************************************************************/
 
-
 $LANG->includeLLFile('EXT:reports/mod/locallang.xml');
        // This checks permissions and exits if the users has no permission for entry.
 $BE_USER->modAccess($MCONF, 1);
 
-
 /**
  * Module 'Reports' for the 'reports' extension.
  *
- * @author             Ingo Renner <ingo@typo3.org>
- * @package            TYPO3
- * @subpackage tx_reports
+ * @author Ingo Renner <ingo@typo3.org>
+ * @package TYPO3
+ * @subpackage tx_reports
  */
 class tx_reports_Module extends t3lib_SCbase {
 
@@ -42,12 +40,12 @@ class tx_reports_Module extends t3lib_SCbase {
        /**
         * Initializes the Module
         *
-        * @return      void
+        * @return void
         */
        public function __construct() {
                parent::init();
 
-                       // initialize document
+                       // Initialize document
                $this->doc = t3lib_div::makeInstance('template');
                $this->doc->setModuleTemplate(
                        t3lib_extMgm::extPath('reports') . 'mod/mod_template.html'
@@ -62,11 +60,11 @@ class tx_reports_Module extends t3lib_SCbase {
        /**
         * Adds items to the ->MOD_MENU array. Used for the function menu selector.
         *
-        * @return      void
+        * @return void
         */
        public function menuConfig() {
                $reportsMenuItems = array();
-               $this->MOD_MENU   = array('function' => array());
+               $this->MOD_MENU = array('function' => array());
 
                foreach ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['reports'] as $extKey => $reports) {
                        foreach ($reports as $reportName => $report) {
@@ -91,7 +89,7 @@ class tx_reports_Module extends t3lib_SCbase {
         * Creates the module's content. In this case it rather acts as a kind of #
         * dispatcher redirecting requests to specific reports.
         *
-        * @return      void
+        * @return void
         */
        public function main() {
                $docHeaderButtons = $this->getButtons();
@@ -122,7 +120,7 @@ class tx_reports_Module extends t3lib_SCbase {
                } else {
                                // If no access or if ID == 0
                        $docHeaderButtons['save'] = '';
-                       $this->content.=$this->doc->spacer(10);
+                       $this->content .= $this->doc->spacer(10);
                }
 
                        // compile document
@@ -148,7 +146,7 @@ class tx_reports_Module extends t3lib_SCbase {
        /**
         * Prints out the module's HTML
         *
-        * @return      void
+        * @return void
         */
        public function printContent() {
                echo $this->content;
@@ -157,7 +155,7 @@ class tx_reports_Module extends t3lib_SCbase {
        /**
         * Generates the module content by calling the selected report
         *
-        * @return      void
+        * @return void
         */
        protected function renderModuleContent() {
                $this->content .= $this->doc->header($GLOBALS['LANG']->getLL('title'));
@@ -190,7 +188,7 @@ class tx_reports_Module extends t3lib_SCbase {
        /**
         * Shows an overview list of available reports.
         *
-        * @return      string  list of available reports
+        * @return string List of available reports
         */
        protected function indexAction() {
                $defaultIcon = t3lib_extMgm::extRelPath('reports') . 'mod/moduleicon.gif';
@@ -235,7 +233,7 @@ class tx_reports_Module extends t3lib_SCbase {
         * Create the panel of buttons for submitting the form or otherwise
         * perform operations.
         *
-        * @return      array   all available buttons as an assoc. array
+        * @return array All available buttons as an assoc. array
         */
        protected function getButtons() {
                $buttons = array(
@@ -255,7 +253,7 @@ class tx_reports_Module extends t3lib_SCbase {
        }
 }
 
-// Make instance:
+       // Make instance:
 $SOBE = t3lib_div::makeInstance('tx_reports_Module');
 
 // Include files?
index 80f393a..ef89afa 100644 (file)
 *  This copyright notice MUST APPEAR in all copies of the script!
 ***************************************************************/
 
-
 /**
  * The status report
  *
- * @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 implements tx_reports_Report {
 
+       /**
+        * @var array
+        */
        protected $statusProviders = array();
 
        /**
@@ -46,7 +48,7 @@ class tx_reports_reports_Status implements tx_reports_Report {
        /**
         * Takes care of creating / rendering the status report
         *
-        * @return      string  The status report as HTML
+        * @return string The status report as HTML
         */
        public function getReport() {
                $content = '';
@@ -54,7 +56,7 @@ class tx_reports_reports_Status implements tx_reports_Report {
                $status = $this->getSystemStatus();
                $highestSeverity = $this->getHighestSeverity($status);
 
-                       // updating the registry
+                       // Updating the registry
                $registry = t3lib_div::makeInstance('t3lib_Registry');
                $registry->set('tx_reports', 'status.highestSeverity', $highestSeverity);
 
@@ -67,7 +69,7 @@ class tx_reports_reports_Status implements tx_reports_Report {
 
        /**
         * Gets all registered status providers and creates instances of them.
-        *
+        * @return void
         */
        protected function getStatusProviders() {
                foreach ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['reports']['tx_reports']['status']['providers'] as $key => $statusProvidersList) {
@@ -86,7 +88,7 @@ class tx_reports_reports_Status implements tx_reports_Report {
        /**
         * Runs through all status providers and returns all statuses collected.
         *
-        * @return      array   An array of tx_reports_reports_status_Status objects
+        * @return array An array of tx_reports_reports_status_Status objects
         */
        public function getSystemStatus() {
                $status = array();
@@ -106,8 +108,8 @@ class tx_reports_reports_Status implements tx_reports_Report {
        /**
         * Determines the highest severity from the given statuses.
         *
-        * @param       array   An array of tx_reports_reports_status_Status objects.
-        * @return      integer The highest severity found from the statuses.
+        * @param array $statusCollection An array of tx_reports_reports_status_Status objects.
+        * @return integer The highest severity found from the statuses.
         */
        public function getHighestSeverity(array $statusCollection) {
                $highestSeverity = tx_reports_reports_status_Status::NOTICE;
@@ -118,7 +120,7 @@ class tx_reports_reports_Status implements tx_reports_Report {
                                        $highestSeverity = $status->getSeverity();
                                }
 
-                                       // reached the highest severity level, no need to go on
+                                       // Reached the highest severity level, no need to go on
                                if ($highestSeverity == tx_reports_reports_status_Status::ERROR) {
                                        break;
                                }
@@ -131,12 +133,12 @@ class tx_reports_reports_Status implements tx_reports_Report {
        /**
         * Renders the system's status
         *
-        * @param       array   An array of statuses as returned by the available status providers
-        * @return      string  The system status as an HTML table
+        * @param array $statusCollection An array of statuses as returned by the available status providers
+        * @return string The system status as an HTML table
         */
        protected function renderStatus(array $statusCollection) {
 
-               // TODO refactor into separate methods, status list and single status
+                       // TODO refactor into separate methods, status list and single status
 
                $content = '';
                $template = '
@@ -150,7 +152,7 @@ class tx_reports_reports_Status implements tx_reports_Report {
 
                $statuses = $this->sortStatusProviders($statusCollection);
 
-               foreach($statuses as $provider => $providerStatus) {
+               foreach ($statuses as $provider => $providerStatus) {
                        $providerState = $this->sortStatuses($providerStatus);
 
                        $id = str_replace(' ', '-', $provider);
@@ -190,8 +192,8 @@ class tx_reports_reports_Status implements tx_reports_Report {
        /**
         * Sorts the status providers (alphabetically and puts primary status providers at the beginning)
         *
-        * @param       array   A collection of statuses (with providers)
-        * @return      array   The collection of statuses sorted by provider (beginning with provider "_install")
+        * @param array $statusCollection A collection of statuses (with providers)
+        * @return array The collection of statuses sorted by provider (beginning with provider "_install")
         */
        protected function sortStatusProviders(array $statusCollection) {
                        // Extract the primary status collections, i.e. the status groups
@@ -238,8 +240,8 @@ class tx_reports_reports_Status implements tx_reports_Report {
        /**
         * Sorts the statuses by severity
         *
-        * @param       array   A collection of statuses per provider
-        * @return      array   The collection of statuses sorted by severity
+        * @param array $statusCollection A collection of statuses per provider
+        * @return array The collection of statuses sorted by severity
         */
        protected function sortStatuses(array $statusCollection) {
                $statuses  = array();
@@ -256,7 +258,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
+                       // Making sure that the core version information is always on the top
                if (is_object($header)) {
                        array_unshift($statuses, $header);
                }
index 95b22c0..ed544f7 100644 (file)
 *  This copyright notice MUST APPEAR in all copies of the script!
 ***************************************************************/
 
-
 /**
  * Performs some checks about the install tool protection status
  *
- * @author             Ingo Renner <ingo@typo3.org>
- * @package            TYPO3
- * @subpackage reports
+ * @author Ingo Renner <ingo@typo3.org>
+ * @package TYPO3
+ * @subpackag reports
  */
 class tx_reports_reports_status_ConfigurationStatus implements tx_reports_StatusProvider {
 
-               // 10 MB
+       /**
+        * 10MB
+        *
+        * @var integer
+        */
        protected $deprecationLogFileSizeWarningThreshold = 10485760;
-               // 100 MB
+
+       /**
+        * 100MB
+        *
+        * @var integer
+        */
        protected $deprecationLogFileSizeErrorThreshold   = 104857600;
 
        /**
@@ -47,7 +55,7 @@ class tx_reports_reports_status_ConfigurationStatus implements tx_reports_Status
        /**
         * Determines the Install Tool's status, mainly concerning its protection.
         *
-        * @return      array   List of statuses
+        * @return array List of statuses
         * @see typo3/sysext/reports/interfaces/tx_reports_StatusProvider::getStatus()
         */
        public function getStatus() {
@@ -74,7 +82,7 @@ class tx_reports_reports_status_ConfigurationStatus implements tx_reports_Status
        /**
         * Checks if sys_refindex is empty.
         *
-        * @return      tx_reports_reports_status_Status        An tx_reports_reports_status_Status object representing whether the reference index is empty or not
+        * @return tx_reports_reports_status_Status An tx_reports_reports_status_Status object representing whether the reference index is empty or not
         */
        protected function getReferenceIndexStatus() {
                $value    = $GLOBALS['LANG']->getLL('status_ok');
@@ -105,7 +113,7 @@ class tx_reports_reports_status_ConfigurationStatus implements tx_reports_Status
        /**
         * Checks if PHP safe_mode is enabled.
         *
-        * @return      tx_reports_reports_status_Status        A tx_reports_reports_status_Status object representing whether the safe_mode is enabled or not
+        * @return tx_reports_reports_status_Status A tx_reports_reports_status_Status object representing whether the safe_mode is enabled or not
         */
        protected function getPhpSafeModeStatus() {
                $value    = $GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_common.xml:disabled');
@@ -126,7 +134,7 @@ class tx_reports_reports_status_ConfigurationStatus implements tx_reports_Status
        /**
         * Checks if PHP magic_quotes_gpc is enabled.
         *
-        * @return      tx_reports_reports_status_Status        A tx_reports_reports_status_Status object representing whether the magic_quote_gpc is enabled or not
+        * @return tx_reports_reports_status_Status A tx_reports_reports_status_Status object representing whether the magic_quote_gpc is enabled or not
         */
        protected function getPhpMagicQuotesGpcStatus() {
                $value    = $GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_common.xml:disabled');
@@ -147,7 +155,7 @@ class tx_reports_reports_status_ConfigurationStatus implements tx_reports_Status
        /**
         * Checks whether memcached is configured, if that's the case we asume it's also used.
         *
-        * @return      boolean TRUE if memcached is used, FALSE otherwise.
+        * @return boolean TRUE if memcached is used, FALSE otherwise.
         */
        protected function isMemcachedUsed() {
                $memcachedUsed = FALSE;
@@ -163,7 +171,7 @@ class tx_reports_reports_status_ConfigurationStatus implements tx_reports_Status
        /**
         * Gets the configured memcached server connections.
         *
-        * @return      array   An array of configured memcached server connections.
+        * @return array An array of configured memcached server connections.
         */
        protected function getConfiguredMemcachedServers() {
                $memcachedServers = array();
@@ -187,7 +195,7 @@ class tx_reports_reports_status_ConfigurationStatus implements tx_reports_Status
        /**
         * Checks whether TYPO3 can connect to the configured memcached servers.
         *
-        * @return      tx_reports_reports_status_Status        An tx_reports_reports_status_Status object representing whether TYPO3 can connect to the configured memcached servers
+        * @return tx_reports_reports_status_Status An tx_reports_reports_status_Status object representing whether TYPO3 can connect to the configured memcached servers
         */
        protected function getMemcachedConnectionStatus() {
                $value    = $GLOBALS['LANG']->getLL('status_ok');
@@ -244,7 +252,7 @@ class tx_reports_reports_status_ConfigurationStatus implements tx_reports_Status
         * Provides status information on the deprecation log, whether it's enabled
         * and if so whether certain limits in file size are reached.
         *
-        * @return      tx_reports_reports_status_Status        The deprecation log status.
+        * @return tx_reports_reports_status_Status The deprecation log status.
         */
        protected function getDeprecationLogStatus() {
                $title    = $GLOBALS['LANG']->getLL('status_configuration_DeprecationLog');
@@ -294,7 +302,7 @@ class tx_reports_reports_status_ConfigurationStatus implements tx_reports_Status
         * Creates a link to the deprecation log file with the absolute path as the
         * link text.
         *
-        * @return      string  Link to the deprecation log file
+        * @return string Link to the deprecation log file
         */
        protected function getDeprecationLogFileLink() {
                $logFile = t3lib_div::getDeprecationLogFileName();
index d96d638..c80c067 100644 (file)
@@ -22,7 +22,6 @@
 *  This copyright notice MUST APPEAR in all copies of the script!
 ***************************************************************/
 
-
 /**
  * Performs several checks about the system's health
  *
@@ -77,7 +76,7 @@ class tx_reports_reports_status_SecurityStatus implements tx_reports_StatusProvi
                                // Check against salted password
                        if (t3lib_extMgm::isLoaded('saltedpasswords')) {
                                if (tx_saltedpasswords_div::isUsageEnabled('BE')) {
-                                               /** @var $saltingObject tx_saltedpasswords_salts */
+                                       /** @var $saltingObject tx_saltedpasswords_salts */
                                        $saltingObject = tx_saltedpasswords_salts_factory::getSaltingInstance($row['password']);
                                        if (is_object($saltingObject)) {
                                                if ($saltingObject->checkPassword('password', $row['password'])) {
index 88ed39e..ffbea3b 100644 (file)
@@ -26,9 +26,9 @@
 /**
  * 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
  */
 class tx_reports_reports_status_Status {
 
@@ -38,18 +38,33 @@ class tx_reports_reports_status_Status {
        const WARNING = 1;
        const ERROR   = 2;
 
+       /**
+        * @var string
+        */
        protected $title;
+
+       /**
+        * @var string
+        */
        protected $value;
+
+       /**
+        * @var string
+        */
        protected $message;
+
+       /**
+        * @var integer
+        */
        protected $severity;
 
        /**
         * constructor for class tx_reports_report_status_Status
         *
-        * @param       string  the status' title
-        * @param       string  the status' value
-        * @param       string  an optional message further describing the status
-        * @param       integer a severity level, one of
+        * @param string $title The status' title
+        * @param string $value The status' value
+        * @param string $message An optional message further describing the status
+        * @param integer $severity A severity level, one of
         */
        public function __construct($title, $value, $message = '', $severity = self::OK) {
                $this->title    = (string) $title;
@@ -63,36 +78,36 @@ class tx_reports_reports_status_Status {
        }
 
        /**
-        * gets the status' title
+        * Gets the status' title
         *
-        * @return      string
+        * @return string
         */
        public function getTitle() {
                return $this->title;
        }
 
        /**
-        * gets the status' value
+        * Gets the status' value
         *
-        * @return      string
+        * @return string
         */
        public function getValue() {
                return $this->value;
        }
 
        /**
-        * gets the status' message (if any)
+        * Gets the status' message (if any)
         *
-        * @return      string
+        * @return string
         */
        public function getMessage() {
                return $this->message;
        }
 
        /**
-        * gets the status' severity
+        * Gets the status' severity
         *
-        * @return      integer
+        * @return integer
         */
        public function getSeverity() {
                return $this->severity;
@@ -101,7 +116,7 @@ class tx_reports_reports_status_Status {
        /**
         * Creates a string representation of a status.
         *
-        * @return      string  String representation of this status.
+        * @return string String representation of this status.
         */
        public function __toString() {
                $severity = array(
@@ -112,7 +127,7 @@ class tx_reports_reports_status_Status {
                        self::ERROR   => 'ERR',
                );
 
-                       // max length 80 characters
+                       // Max length 80 characters
                $stringRepresentation =
                        str_pad('[' . $severity[$this->severity] . ']', 7) .
                        str_pad($this->title, 40) . ' - ' .
index 6855efd..83f7406 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 {
 
-               // PHP modules which are required. Can be changed by hook in getMissingPhpModules()
+       /**
+        * PHP modules which are required. Can be changed by hook in getMissingPhpModules()
+        *
+        * @var array
+        */
        protected $requiredPhpModules = array(
                'fileinfo', 'filter', 'gd', 'json', 'mysql', 'pcre', 'session', 'SPL', 'standard', 'openssl', 'xml', 'zlib', 'soap'
        );
@@ -40,7 +44,7 @@ class tx_reports_reports_status_SystemStatus implements tx_reports_StatusProvide
        /**
         * Determines the Install Tool's status, mainly concerning its protection.
         *
-        * @return      array   List of statuses
+        * @return array List of statuses
         * @see typo3/sysext/reports/interfaces/tx_reports_StatusProvider::getStatus()
         */
        public function getStatus() {
@@ -58,11 +62,10 @@ class tx_reports_reports_status_SystemStatus implements tx_reports_StatusProvide
                return $statuses;
        }
 
-
        /**
         * Checks the current PHP version against a minimum required version.
         *
-        * @return      tx_reports_reports_status_Status        A status of whether a minimum PHP version requirment is met
+        * @return tx_reports_reports_status_Status A status of whether a minimum PHP version requirment is met
         */
        protected function getPhpStatus() {
                $message  = '';
@@ -84,7 +87,7 @@ class tx_reports_reports_status_SystemStatus implements tx_reports_StatusProvide
        /**
         * Checks the current memory limit against a minimum required version.
         *
-        * @return      tx_reports_reports_status_Status        A status of whether a minimum memory limit requirment is met
+        * @return tx_reports_reports_status_Status A status of whether a minimum memory limit requirment is met
         */
        protected function getPhpMemoryLimitStatus() {
                $memoryLimit = ini_get('memory_limit');
@@ -124,7 +127,7 @@ class tx_reports_reports_status_SystemStatus implements tx_reports_StatusProvide
        /**
         * Executes commands like clearing the memory status flag
         *
-        * @return      void
+        * @return void
         */
        protected function executeAdminCommand() {
                $command = t3lib_div::_GET('adminCmd');
@@ -178,9 +181,9 @@ class tx_reports_reports_status_SystemStatus implements tx_reports_StatusProvide
        }
 
        /**
-        * checks whether register globals is on or off.
+        * Checks whether register globals is on or off.
         *
-        * @return      tx_reports_reports_status_Status        A status of whether register globals is on or off
+        * @return tx_reports_reports_status_Status A status of whether register globals is on or off
         */
        protected function getPhpRegisterGlobalsStatus() {
                $value    = $GLOBALS['LANG']->getLL('status_disabled');
@@ -189,7 +192,7 @@ class tx_reports_reports_status_SystemStatus implements tx_reports_StatusProvide
 
                $registerGlobals = trim(ini_get('register_globals'));
 
-                       // can't reliably check for 'on', therefore checking for the oposite 'off', '', or 0
+                       // Can't reliably check for 'on', therefore checking for the opposite 'off', '', or 0
                if (!empty($registerGlobals) && strtolower($registerGlobals) != 'off') {
                        $registerGlobalsHighlight = '<em>register_globals</em>';
                        $phpManualLink .= '<a href="http://php.net/configuration.changes">' . $GLOBALS['LANG']->getLL('status_phpRegisterGlobalsHowToChange') . '</a>';
@@ -209,7 +212,7 @@ class tx_reports_reports_status_SystemStatus implements tx_reports_StatusProvide
        /**
         * Reports the webserver TYPO3 is running on.
         *
-        * @return      tx_reports_reports_status_Status        The server software as a status
+        * @return tx_reports_reports_status_Status The server software as a status
         */
        protected function getWebserverStatus() {
                return t3lib_div::makeInstance('tx_reports_reports_status_Status',
index 1862ea5..b4b5427 100644 (file)
 *  This copyright notice MUST APPEAR in all copies of the script!
 ***************************************************************/
 
-
 /**
  * Performs basic checks about the TYPO3 install
  *
- * @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_Typo3Status implements tx_reports_StatusProvider {
 
        /**
         * Returns the status for this report
         *
-        * @return      array   List of statuses
+        * @return array List of statuses
         * @see typo3/sysext/reports/interfaces/tx_reports_StatusProvider::getStatus()
         */
        public function getStatus() {
@@ -50,7 +49,7 @@ class tx_reports_reports_status_Typo3Status implements tx_reports_StatusProvider
        /**
         * Simply gets the current TYPO3 version.
         *
-        * @return      tx_reports_reports_status_Status
+        * @return tx_reports_reports_status_Status
         */
        protected function getTypo3VersionStatus() {
                return t3lib_div::makeInstance(
index 61f3d8c..9262764 100644 (file)
 *  This copyright notice MUST APPEAR in all copies of the script!
 ***************************************************************/
 
-
 /**
  * Post processes the warning messages found in about modules.
  *
- * @author     Ingo Renner <ingo@typo3.org>
+ * @author Ingo Renner <ingo@typo3.org>
  * @package TYPO3
  * @subpackage reports
  */
@@ -38,11 +37,11 @@ class tx_reports_reports_status_WarningMessagePostProcessor {
         * properly or the status report has been checked manually and we take over
         * control over the system warning messages.
         *
-        * @param       array   An array of messages related to already found issues.
+        * @param array $warningMessages An array of messages related to already found issues.
         */
        public function displayWarningMessages_postProcess(array &$warningMessages) {
 
-                       // get highest severity
+                       // Get highest severity
                $registry = t3lib_div::makeInstance('t3lib_Registry');
                $highestSeverity = $registry->get(
                        'tx_reports',
@@ -51,7 +50,7 @@ class tx_reports_reports_status_WarningMessagePostProcessor {
                );
 
                if (!is_null($highestSeverity)) {
-                               // status update has run, so taking over control over the core messages
+                               // Status update has run, so taking over control over the core messages
                        unset(
                                $warningMessages['install_password'],
                                $warningMessages['backend_admin'],
@@ -65,7 +64,7 @@ class tx_reports_reports_status_WarningMessagePostProcessor {
                        );
 
                        if ($highestSeverity > tx_reports_reports_status_Status::OK) {
-                                       // display a message that there's something wrong and that
+                                       // Display a message that there's something wrong and that
                                        // the admin should take a look at the detailed status report
                                $GLOBALS['LANG']->includeLLFile('EXT:reports/reports/locallang.xml');
 
index 161df95..b487338 100644 (file)
 *  This copyright notice MUST APPEAR in all copies of the script!
 ***************************************************************/
 
-
 /**
  * A task that should be run regularly to determine the system's status.
  *
- * @author     Ingo Renner <ingo@typo3.org>
+ * @author Ingo Renner <ingo@typo3.org>
  * @package TYPO3
  * @subpackage reports
  */
@@ -36,7 +35,7 @@ class tx_reports_tasks_SystemStatusUpdateTask extends tx_scheduler_Task {
         * Email address to send email notification to in case we find problems with
         * the system.
         *
-        * @var string
+        * @var string
         */
        protected $notificationEmail = NULL;
 
@@ -66,7 +65,7 @@ class tx_reports_tasks_SystemStatusUpdateTask extends tx_scheduler_Task {
        /**
         * Gets the notification email address.
         *
-        * @return      string  Notification email address.
+        * @return string Notification email address.
         */
        public function getNotificationEmail() {
                return $this->notificationEmail;
@@ -75,7 +74,7 @@ class tx_reports_tasks_SystemStatusUpdateTask extends tx_scheduler_Task {
        /**
         * Sets the notification email address.
         *
-        * @param       string  $notificationEmail Notification email address.
+        * @param string $notificationEmail Notification email address.
         */
        public function setNotificationEmail($notificationEmail) {
                $this->notificationEmail = $notificationEmail;
@@ -84,7 +83,7 @@ class tx_reports_tasks_SystemStatusUpdateTask extends tx_scheduler_Task {
        /**
         * Sends a notification email, reporting system issues.
         *
-        * @param       array   $systemStatus Array of statuses
+        * @param array $systemStatus Array of statuses
         */
        protected function sendNotificationEmail(array $systemStatus) {
                $systemIssues = array();
index 5fd4e8f..259e91c 100644 (file)
 *  This copyright notice MUST APPEAR in all copies of the script!
 ***************************************************************/
 
-
 /**
  * Additional field to set the notification email address(es) for system health
  * issue notifications.
  *
- * @author     Ingo Renner <ingo@typo3.org>
- * @package    TYPO3
- * @subpackage reports
+ * @author Ingo Renner <ingo@typo3.org>
+ * @package TYPO3
+ * @subpackage reports
  */
 class tx_reports_tasks_SystemStatusUpdateTaskNotificationEmailField implements tx_scheduler_AdditionalFieldProvider {
 
-
        /**
         * Additional fields
         *
-        * @var array
+        * @var array
         */
        protected $fields = array('notificationEmail');
 
        /**
         * Field prefix.
         *
-        * @var string
+        * @var string
         */
        protected $fieldPrefix = 'SystemStatusUpdate';
 
        /**
         * Gets additional fields to render in the form to add/edit a task
         *
-        * @param       array   $taskInfo Values of the fields from the add/edit task form
-        * @param       tx_scheduler_Task       $task The task object being eddited. Null when adding a task!
-        * @param       tx_scheduler_Module     $schedulerModule Reference to the scheduler backend module
-        * @return      array   A two dimensional array, array('Identifier' => array('fieldId' => array('code' => '', 'label' => '', 'cshKey' => '', 'cshLabel' => ''))
+        * @param array $taskInfo Values of the fields from the add/edit task form
+        * @param tx_scheduler_Task $task The task object being eddited. Null when adding a task!
+        * @param tx_scheduler_Module $schedulerModule Reference to the scheduler backend module
+        * @return array A two dimensional array, array('Identifier' => array('fieldId' => array('code' => '', 'label' => '', 'cshKey' => '', 'cshLabel' => ''))
         */
        public function getAdditionalFields(array &$taskInfo, $task, tx_scheduler_Module $schedulerModule) {
                $fields = array('notificationEmail');
@@ -86,9 +84,9 @@ class tx_reports_tasks_SystemStatusUpdateTaskNotificationEmailField implements t
        /**
         * Validates the additional fields' values
         *
-        * @param       array   $submittedData An array containing the data submitted by the add/edit task form
-        * @param       tx_scheduler_Module     $schedulerModule Reference to the scheduler backend module
-        * @return      boolean TRUE if validation was ok (or selected class is not relevant), FALSE otherwise
+        * @param array $submittedData An array containing the data submitted by the add/edit task form
+        * @param tx_scheduler_Module $schedulerModule Reference to the scheduler backend module
+        * @return boolean TRUE if validation was ok (or selected class is not relevant), FALSE otherwise
         */
        public function validateAdditionalFields(array &$submittedData, tx_scheduler_Module $schedulerModule) {
                $validInput = TRUE;
@@ -111,9 +109,9 @@ class tx_reports_tasks_SystemStatusUpdateTaskNotificationEmailField implements t
        /**
         * Takes care of saving the additional fields' values in the task's object
         *
-        * @param       array   $submittedData An array containing the data submitted by the add/edit task form
-        * @param       tx_scheduler_Task       $task Reference to the scheduler backend module
-        * @return      void
+        * @param array $submittedData An array containing the data submitted by the add/edit task form
+        * @param tx_scheduler_Task $task Reference to the scheduler backend module
+        * @return void
         */
        public function saveAdditionalFields(array $submittedData, tx_scheduler_Task $task) {
 
@@ -130,8 +128,8 @@ class tx_reports_tasks_SystemStatusUpdateTaskNotificationEmailField implements t
        /**
         * Constructs the full field name which can be used in HTML markup.
         *
-        * @param       string  $fieldName A raw field name
-        * @return      string Field name ready to use in HTML markup
+        * @param string $fieldName A raw field name
+        * @return string Field name ready to use in HTML markup
         */
        protected function getFullFieldName($fieldName) {
                return $this->fieldPrefix . ucfirst($fieldName);