[TASK] Clean up phpDoc comments in typo3/sysext/
authorWouter Wolters <typo3@wouterwolters.nl>
Fri, 22 Jun 2012 20:54:44 +0000 (22:54 +0200)
committerChristian Kuhn <lolli@schwarzbu.ch>
Sat, 23 Jun 2012 09:10:08 +0000 (11:10 +0200)
Clean up provides:

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

Change-Id: Ibf7958460bfac740d74bd22a12c7b9a995d1dbbe
Resolves: #38321
Releases: 6.0
Reviewed-on: http://review.typo3.org/12303
Reviewed-by: Christian Kuhn
Tested-by: Christian Kuhn
typo3/sysext/t3skin/ext_localconf.php
typo3/sysext/t3skin/ext_tables.php
typo3/sysext/taskcenter/classes/class.tx_taskcenter_status.php
typo3/sysext/taskcenter/ext_autoload.php
typo3/sysext/taskcenter/ext_tables.php
typo3/sysext/taskcenter/interfaces/interface.tx_taskcenter_task.php
typo3/sysext/taskcenter/task/conf.php
typo3/sysext/taskcenter/task/index.php
typo3/sysext/tsconfig_help/ext_tables.php
typo3/sysext/tsconfig_help/mod1/conf.php
typo3/sysext/tsconfig_help/mod1/index.php

index bba8f70..57b5933 100644 (file)
@@ -1,6 +1,7 @@
 <?php
-if (!defined ('TYPO3_MODE'))   die ('Access denied.');
-
+if (!defined('TYPO3_MODE')) {
+       die('Access denied.');
+}
 
 t3lib_extMgm::addPageTSConfig('
        RTE.default.skin = EXT:'.$_EXTKEY.'/rtehtmlarea/htmlarea.css
index dd07b13..9dd3609 100644 (file)
@@ -1,10 +1,12 @@
 <?php
-if (!defined ('TYPO3_MODE'))   die ('Access denied.');
+if (!defined('TYPO3_MODE')) {
+       die('Access denied.');
+}
 
 if (TYPO3_MODE == 'BE' || (TYPO3_MODE == 'FE' && isset($GLOBALS['BE_USER']))) {
        global $TBE_STYLES;
 
-               // register as a skin
+               // Register as a skin
        $TBE_STYLES['skins'][$_EXTKEY] = array(
                'name' => 't3skin',
        );
@@ -78,9 +80,12 @@ if (TYPO3_MODE == 'BE' || (TYPO3_MODE == 'FE' && isset($GLOBALS['BE_USER']))) {
        $temp_eP = t3lib_extMgm::extRelPath($_EXTKEY);
 
                // Alternative dimensions for frameset sizes:
-       $TBE_STYLES['dims']['leftMenuFrameW'] = 190;            // Left menu frame width
-       $TBE_STYLES['dims']['topFrameH']      = 42;                     // Top frame height
-       $TBE_STYLES['dims']['navFrameWidth']  = 280;            // Default navigation frame width
+               // Left menu frame width
+       $TBE_STYLES['dims']['leftMenuFrameW'] = 190;
+               // Top frame height
+       $TBE_STYLES['dims']['topFrameH']      = 42;
+               // Default navigation frame width
+       $TBE_STYLES['dims']['navFrameWidth']  = 280;
 
                // Setting roll-over background color for click menus:
                // Notice, this line uses the the 'scriptIDindex' feature to override another value in this array (namely $TBE_STYLES['mainColors']['bgColor5']), for a specific script "typo3/alt_clickmenu.php"
@@ -180,7 +185,7 @@ if (TYPO3_MODE == 'BE' || (TYPO3_MODE == 'FE' && isset($GLOBALS['BE_USER']))) {
                // extJS theme
        $TBE_STYLES['extJS']['theme'] =  $temp_eP . 'extjs/xtheme-t3skin.css';
 
-       // Adding HTML template for login screen
+               // Adding HTML template for login screen
        $TBE_STYLES['htmlTemplates']['templates/login.html'] = 'sysext/t3skin/templates/login.html';
 
        $GLOBALS['TBE_STYLES']['stylesheets']['admPanel'] = t3lib_extMgm::siteRelPath('t3skin') . 'stylesheets/standalone/admin_panel.css';
@@ -194,7 +199,6 @@ if (TYPO3_MODE == 'BE' || (TYPO3_MODE == 'FE' && isset($GLOBALS['BE_USER']))) {
                );
        }
        unset($flagNames, $flagName);
-
 }
 
 ?>
\ No newline at end of file
index df48133..3307dac 100644 (file)
 *  This copyright notice MUST APPEAR in all copies of the script!
 ***************************************************************/
 
-
 /**
  * Status of tasks
  *
- * @author             Georg Ringer <typo3@ringerge.org>
- * @package            TYPO3
- * @subpackage taskcenter
- *
+ * @author Georg Ringer <typo3@ringerge.org>
+ * @package TYPO3
+ * @subpackage taskcenter
  */
 class tx_taskcenter_status {
 
        /**
         * Saves the section toggle state of tasks in the backend user's uc
         *
-        * @param       array           array of parameters from the AJAX interface, currently unused
-        * @param       TYPO3AJAX       object of type TYPO3AJAX
-        * @return      void
+        * @param array $params Array of parameters from the AJAX interface, currently unused
+        * @param TYPO3AJAX $ajaxObj Object of type TYPO3AJAX
+        * @return void
         */
        public function saveCollapseState(array $params, TYPO3AJAX $ajaxObj) {
-                       // remove 'el_' in the beginning which is needed for the saveSortingState()
+                       // Remove 'el_' in the beginning which is needed for the saveSortingState()
                $item   = substr(htmlspecialchars(t3lib_div::_POST('item')), 3);
                $state  = (bool)t3lib_div::_POST('state');
 
@@ -49,18 +47,17 @@ class tx_taskcenter_status {
                $GLOBALS['BE_USER']->writeUC();
        }
 
-
        /**
         * Saves the sorting order of tasks in the backend user's uc
         *
-        * @param       array           array of parameters from the AJAX interface, currently unused
-        * @param       TYPO3AJAX       object of type TYPO3AJAX
-        * @return      void
+        * @param array $params Array of parameters from the AJAX interface, currently unused
+        * @param TYPO3AJAX $ajaxObj Object of type TYPO3AJAX
+        * @return void
         */
        public function saveSortingState(array $params, TYPO3AJAX $ajaxObj) {
                $sort = array();
                $items = explode('&', t3lib_div::_POST('data'));
-               foreach($items as $item) {
+               foreach ($items as $item) {
                        $sort[] = substr($item, 12);
                }
 
index 734e5ca..9757cc8 100644 (file)
@@ -1,8 +1,5 @@
 <?php
-/*
- * Register necessary class names with autoloader
- *
- */
+       // Register necessary class names with autoloader
 $extensionPath = t3lib_extMgm::extPath('taskcenter');
 return array (
        'tx_taskcenter_task' => $extensionPath . 'interfaces/interface.tx_taskcenter_task.php'
index 15d94fb..0458908 100755 (executable)
@@ -1,6 +1,6 @@
 <?php
-if (!defined ('TYPO3_MODE')) {
-       die ('Access denied.');
+if (!defined('TYPO3_MODE')) {
+       die('Access denied.');
 }
 
 if (TYPO3_MODE == 'BE') {
index 7b4e491..1afd895 100644 (file)
 *  This copyright notice MUST APPEAR in all copies of the script!
 ***************************************************************/
 
-
 /**
  * Interface for classes which provide a task.
  *
- * @author             Georg Ringer <typo3@ringerge.org
- * @package            TYPO3
- * @subpackage tx_taskcenter
- *
+ * @author Georg Ringer <typo3@ringerge.org
+ * @package TYPO3
+ * @subpackage tx_taskcenter
  */
 interface tx_taskcenter_Task {
 
        /**
-        * returns the content for a task
+        * Returns the content for a task
         *
-        * @return      string  A task rendered HTML
+        * @return string A task rendered HTML
         */
        public function getTask();
 
        /**
-        * returns the overview of a task
+        * Returns the overview of a task
         *
-        * @return      string  A task rendered HTML
+        * @return string A task rendered HTML
         */
        public function getOverview();
 }
index 49eff9a..8792799 100755 (executable)
@@ -1,8 +1,8 @@
 <?php
        $MLANG['default']['tabs_images']['tab'] = 'task.gif';
-       $MLANG['default']['ll_ref']='LLL:EXT:taskcenter/task/locallang_mod.xml';
+       $MLANG['default']['ll_ref'] = 'LLL:EXT:taskcenter/task/locallang_mod.xml';
 
-       $MCONF['script']='_DISPATCH';
-       $MCONF['access']='group,user';
-       $MCONF['name']='user_task';
+       $MCONF['script'] = '_DISPATCH';
+       $MCONF['access'] = 'group,user';
+       $MCONF['name'] = 'user_task';
 ?>
\ No newline at end of file
index bb8e20b..2f1ce9e 100755 (executable)
 *  This copyright notice MUST APPEAR in all copies of the script!
 ***************************************************************/
 
-
 /**
  * This class provides a taskcenter for BE users
  *
- * @author             Georg Ringer <typo3@ringerge.org>
- * @package            TYPO3
- * @subpackage taskcenter
+ * @author Georg Ringer <typo3@ringerge.org>
+ * @package TYPO3
+ * @subpackage taskcenter
  *
  */
 
-
 $LANG->includeLLFile('EXT:taskcenter/task/locallang.xml');
-
-
 $BE_USER->modAccess($MCONF, 1);
 
-
-// ***************************
-// Script Classes
-// ***************************
+       // Script Classes
 class SC_mod_user_task_index extends t3lib_SCbase {
 
        protected $pageinfo;
@@ -49,12 +42,12 @@ class SC_mod_user_task_index 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('taskcenter') . 'res/mod_template.html'
@@ -70,7 +63,7 @@ class SC_mod_user_task_index extends t3lib_SCbase {
        /**
         * Adds items to the ->MOD_MENU array. Used for the function menu selector.
         *
-        * @return      void
+        * @return void
         */
        public function menuConfig() {
                $this->MOD_MENU  = array('mode' => array());
@@ -85,7 +78,7 @@ class SC_mod_user_task_index extends t3lib_SCbase {
         * Creates the module's content. In this case it rather acts as a kind of #
         * dispatcher redirecting requests to specific tasks.
         *
-        * @return      void
+        * @return void
         */
        public function main() {
                $docHeaderButtons = $this->getButtons();
@@ -114,7 +107,7 @@ class SC_mod_user_task_index extends t3lib_SCbase {
                        $this->renderModuleContent();
                }
 
-                       // compile document
+                       // Compile document
                $markers['FUNC_MENU'] = t3lib_BEfunc::getFuncMenu(
                                0,
                                'SET[mode]',
@@ -135,7 +128,7 @@ class SC_mod_user_task_index extends t3lib_SCbase {
        /**
         * Prints out the module's HTML
         *
-        * @return      void
+        * @return void
         */
        public function printContent() {
                echo $this->content;
@@ -144,18 +137,18 @@ class SC_mod_user_task_index extends t3lib_SCbase {
        /**
         * Generates the module content by calling the selected task
         *
-        * @return      void
+        * @return void
         */
        protected function renderModuleContent() {
                $title = $content = $actionContent = '';
                $chosenTask     = (string)$this->MOD_SETTINGS['function'];
 
-                       // render the taskcenter task as default
+                       // Render the taskcenter task as default
                if (empty($chosenTask) || $chosenTask == 'index') {
                        $chosenTask = 'taskcenter.tasks';
                }
 
-                       // remder the task
+                       // Render the task
                list($extKey, $taskClass) = explode('.', $chosenTask, 2);
                $title = $GLOBALS['LANG']->sL($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['taskcenter'][$extKey][$taskClass]['title']);
 
@@ -163,7 +156,7 @@ class SC_mod_user_task_index extends t3lib_SCbase {
                        $taskInstance = t3lib_div::makeInstance($taskClass, $this);
 
                        if ($taskInstance instanceof tx_taskcenter_Task) {
-                                       // check if the task is restricted to admins only
+                                       // Check if the task is restricted to admins only
                                if ($this->checkAccess($extKey, $taskClass)) {
                                        $actionContent .= $taskInstance->getTask();
                                } else {
@@ -176,7 +169,7 @@ class SC_mod_user_task_index extends t3lib_SCbase {
                                        $actionContent .= $flashMessage->render();
                                }
                        } else {
-                                       // error if the task is not an instance of tx_taskcenter_Task
+                                       // Error if the task is not an instance of tx_taskcenter_Task
                                $flashMessage = t3lib_div::makeInstance(
                                        't3lib_FlashMessage',
                                        sprintf($GLOBALS['LANG']->getLL('error_no-instance', TRUE), $taskClass, 'tx_taskcenter_Task'),
@@ -208,7 +201,7 @@ class SC_mod_user_task_index extends t3lib_SCbase {
        /**
         * Generates the information content
         *
-        * @return      void
+        * @return void
         */
        protected function renderInformationContent() {
                $content = $this->description (
@@ -231,9 +224,9 @@ class SC_mod_user_task_index extends t3lib_SCbase {
        /**
         * Render the headline of a task including a title and an optional description.
         *
-        * @param       string          $title: Title
-        * @param       string          $description: Description
-        * @return      string formatted title and description
+        * @param string $title Title
+        * @param string $description Description
+        * @return string formatted title and description
         */
        public function description($title, $description='') {
                if (!empty($description)) {
@@ -255,22 +248,22 @@ class SC_mod_user_task_index extends t3lib_SCbase {
         *      - descriptionHtml:      Description allowing HTML tags which will override the
         *                                                                                      description
         *
-        * @param       array           $items: List of items to be displayed in the definition list.
-        * @param       boolean         $mainMenu: Set it to TRUE to render the main menu
-        * @return      string  definition list
+        * @param array $items List of items to be displayed in the definition list.
+        * @param boolean $mainMenu Set it to TRUE to render the main menu
+        * @return string Fefinition list
         */
        public function renderListMenu($items, $mainMenu = FALSE) {
                $content = $section = '';
                $count = 0;
 
-                       // change the sorting of items to the user's one
+                       // Change the sorting of items to the user's one
                if ($mainMenu) {
                        $this->doc->getPageRenderer()->addJsFile(t3lib_extMgm::extRelPath('taskcenter') . 'res/tasklist.js');
                        $userSorting = unserialize($GLOBALS['BE_USER']->uc['taskcenter']['sorting']);
                        if (is_array($userSorting)) {
                                $newSorting = array();
-                               foreach($userSorting as $item) {
-                                       if(isset($items[$item])) {
+                               foreach ($userSorting as $item) {
+                                       if (isset($items[$item])) {
                                                $newSorting[] = $items[$item];
                                                unset($items[$item]);
                                        }
@@ -280,7 +273,7 @@ class SC_mod_user_task_index extends t3lib_SCbase {
                }
 
                if (is_array($items) && count($items) > 0) {
-                       foreach($items as $item) {
+                       foreach ($items as $item) {
                                $title = htmlspecialchars($item['title']);
 
                                $icon = $additionalClass = $collapsedStyle = '';
@@ -306,7 +299,7 @@ class SC_mod_user_task_index extends t3lib_SCbase {
 
                                $id = $this->getUniqueKey($item['uid']);
 
-                                       // collapsed & expanded menu items
+                                       // Collapsed & expanded menu items
                                if ($mainMenu && isset($GLOBALS['BE_USER']->uc['taskcenter']['states'][$id]) && $GLOBALS['BE_USER']->uc['taskcenter']['states'][$id]) {
                                        $collapsedStyle = 'style="display:none"';
                                        $additionalClass = 'collapsed';
@@ -314,14 +307,14 @@ class SC_mod_user_task_index extends t3lib_SCbase {
                                        $additionalClass = 'expanded';
                                }
 
-                                       // first & last menu item
+                                       // First & last menu item
                                if ($count == 0) {
                                        $additionalClass .= ' first-item';
                                } elseif ($count + 1 === count($items)) {
                                        $additionalClass .= ' last-item';
                                }
 
-                                       // active menu item
+                                       // Active menu item
                                $active = ((string) $this->MOD_SETTINGS['function'] == $item['uid']) ? ' active-task' : '';
 
                                        // Main menu: Render additional syntax to sort tasks
@@ -345,7 +338,6 @@ class SC_mod_user_task_index extends t3lib_SCbase {
                        $navigationId = ($mainMenu) ? 'id="task-list"' : '';
 
                        $content = '<ul ' . $navigationId . ' class="task-list">' . $content . '</ul>';
-
                }
 
                return $content;
@@ -354,14 +346,14 @@ class SC_mod_user_task_index 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() {
                $content = '';
                $tasks = array();
                $icon = t3lib_extMgm::extRelPath('taskcenter') . 'task/task.gif';
 
-                       // render the tasks only if there are any available
+                       // Render the tasks only if there are any available
                if (is_array($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['taskcenter']) && count($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['taskcenter']) > 0) {
                        foreach ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['taskcenter'] as $extKey => $extensionReports) {
                                foreach ($extensionReports as $taskClass => $task) {
@@ -384,7 +376,7 @@ class SC_mod_user_task_index extends t3lib_SCbase {
                                                }
                                        }
 
-                                               // generate an array of all tasks
+                                               // Generate an array of all tasks
                                        $uniqueKey = $this->getUniqueKey($extKey . '.' . $taskClass);
                                        $tasks[$uniqueKey] = array(
                                                'title'                         => $taskTitle,
@@ -415,7 +407,7 @@ class SC_mod_user_task_index 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(
@@ -438,23 +430,23 @@ class SC_mod_user_task_index extends t3lib_SCbase {
         *  - Tasks can be restriced to admins only
         *  - Tasks can be blinded for Users with TsConfig taskcenter.<extensionkey>.<taskName> = 0
         *
-        * @param       string          $extKey: Extension key
-        * @param       string          $taskClass: Name of the task
-        * @return boolean              Access to the task allowed or not
+        * @param string $extKey Extension key
+        * @param string $taskClass Name of the task
+        * @return boolean Access to the task allowed or not
         */
        protected function checkAccess($extKey, $taskClass) {
-                       // check if task is blinded with TsConfig (taskcenter.<extkey>.<taskName>
+                       // Check if task is blinded with TsConfig (taskcenter.<extkey>.<taskName>
                $tsConfig = $GLOBALS['BE_USER']->getTSConfig('taskcenter.' . $extKey . '.' . $taskClass);
                if (isset($tsConfig['value']) && intval($tsConfig['value']) == 0) {
                        return FALSE;
                }
 
-               // admins are always allowed
+                       // Admins are always allowed
                if ($GLOBALS['BE_USER']->isAdmin()) {
                        return TRUE;
                }
 
-                       // check if task is restricted to admins
+                       // Check if task is restricted to admins
                if (intval($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['taskcenter'][$extKey][$taskClass]['admin']) == 1) {
                        return FALSE;
                }
@@ -465,9 +457,9 @@ class SC_mod_user_task_index extends t3lib_SCbase {
        /**
         * Returns HTML code to dislay an url in an iframe at the right side of the taskcenter
         *
-        * @param       string          $url: url to display
-        * @param       int             $max:
-        * @return      string          code that inserts the iframe (HTML)
+        * @param string $url Url to display
+        * @param integer $max
+        * @return string Code that inserts the iframe (HTML)
         */
        public function urlInIframe($url, $max=0) {
                $this->doc->JScodeArray[] =
@@ -487,8 +479,8 @@ class SC_mod_user_task_index extends t3lib_SCbase {
         * Create a unique key from a string which can be used in Prototype's Sortable
         * Therefore '_' are replaced
         *
-        * @param       string          $string: string which is used to generate the identifier
-        * @return      string          modified string
+        * @param string $string string which is used to generate the identifier
+        * @return string Modified string
         */
        protected function getUniqueKey($string) {
                $search         = array('.', '_');
@@ -500,7 +492,7 @@ class SC_mod_user_task_index extends t3lib_SCbase {
        /**
         * This method prepares the link for opening the devlog in a new window
         *
-        * @return      string  Hyperlink with icon and appropriate JavaScript
+        * @return string Hyperlink with icon and appropriate JavaScript
         */
        protected function openInNewWindow() {
                $url = t3lib_div::getIndpEnv('TYPO3_REQUEST_SCRIPT');
index ad59402..bd82354 100644 (file)
@@ -1,8 +1,9 @@
 <?php
-if (!defined ('TYPO3_MODE'))   die ('Access denied.');
+if (!defined('TYPO3_MODE')) {
+       die('Access denied.');
+}
 
 if (TYPO3_MODE == 'BE') {
-
        t3lib_extMgm::addModule('help', 'txtsconfighelpM1', '', t3lib_extMgm::extPath($_EXTKEY).'mod1/');
 }
 ?>
\ No newline at end of file
index da4cf84..e6defa7 100644 (file)
@@ -1,9 +1,9 @@
 <?php
-$MCONF['name']='help_txtsconfighelpM1';
+$MCONF['name'] = 'help_txtsconfighelpM1';
 $MCONF['script'] = '_DISPATCH';
 
-$MCONF['access']='user,group';
+$MCONF['access'] = 'user,group';
 
 $MLANG['default']['tabs_images']['tab'] = 'moduleicon.gif';
-$MLANG['default']['ll_ref']='LLL:EXT:tsconfig_help/mod1/locallang_mod.xml';
+$MLANG['default']['ll_ref'] = 'LLL:EXT:tsconfig_help/mod1/locallang_mod.xml';
 ?>
\ No newline at end of file
index 548e2ae..3272515 100644 (file)
 *  This copyright notice MUST APPEAR in all copies of the script!
 ***************************************************************/
 
-
 $LANG->includeLLFile('EXT:tsconfig_help/mod1/locallang.xml');
-$BE_USER->modAccess($MCONF, 1);        // This checks permissions and exits if the users has no permission for entry.
+       // This checks permissions and exits if the users has no permission for entry.
+$BE_USER->modAccess($MCONF, 1);
 
 /**
  * Module 'TypoScript Help' for the 'tsconfig_help' extension.
  *
- * @author     Stephane Schitter <stephane.schitter@free.fr>
- * @package    TYPO3
- * @subpackage tx_tsconfighelp
+ * @author Stephane Schitter <stephane.schitter@free.fr>
+ * @package TYPO3
+ * @subpackage tx_tsconfighelp
  */
 class tx_tsconfighelp_module1 extends t3lib_SCbase {
        var $pageinfo;
-       var $objStringsPerExtension = array(); // This is used to count how many times the same obj_string appears in each extension manual
-       var $allObjStrings = array(); // This is used to count how many times the same obj_string appears across all extensions
+               // This is used to count how many times the same obj_string appears in each extension manual
+       var $objStringsPerExtension = array();
+               // This is used to count how many times the same obj_string appears across all extensions
+       var $allObjStrings = array();
 
        /**
         * Initializes the Module
-        * @return      void
+        * @return void
         */
        function init() {
                parent::init();
@@ -49,7 +51,7 @@ class tx_tsconfighelp_module1 extends t3lib_SCbase {
        /**
         * Adds items to the ->MOD_MENU array. Used for the function menu selector.
         *
-        * @return      void
+        * @return void
         */
        function menuConfig() {
                $this->MOD_MENU = array(
@@ -68,7 +70,7 @@ class tx_tsconfighelp_module1 extends t3lib_SCbase {
        /**
         * Main function of the module. Write the content to $this->content
         *
-        * @return      void
+        * @return void
         */
        function main() {
                // Access check!
@@ -128,7 +130,7 @@ class tx_tsconfighelp_module1 extends t3lib_SCbase {
        /**
         * Prints out the module HTML
         *
-        * @return      void
+        * @return void
         */
        function printContent() {
                echo $this->content;
@@ -137,7 +139,7 @@ class tx_tsconfighelp_module1 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(
@@ -157,7 +159,7 @@ class tx_tsconfighelp_module1 extends t3lib_SCbase {
        /**
         * Generates the module content
         *
-        * @return      void
+        * @return void
         */
        function moduleContent() {
                switch ((string)$this->MOD_SETTINGS['function']) {
@@ -246,8 +248,6 @@ class tx_tsconfighelp_module1 extends t3lib_SCbase {
                                } else {
                                        $this->content .= '<p>' . $GLOBALS['LANG']->getLL('adminAccessOnly') . '</p><br />';
                                }
-
-
                        break;
                }
        }
@@ -255,12 +255,12 @@ class tx_tsconfighelp_module1 extends t3lib_SCbase {
        /**
         * Returns the contents of a specific file within the ZIP
         *
-        * @return      string  contents
+        * @return string Contents
         */
        function getZIPFileContents($ZIPfile, $filename) {
                if (file_exists($ZIPfile)) {
                                // Unzipping SXW file, getting filelist:
-                       $tempPath = PATH_site.'typo3temp/tx_tsconfighelp_ziptemp/';
+                       $tempPath = PATH_site . 'typo3temp/tx_tsconfighelp_ziptemp/';
                        t3lib_div::mkdir($tempPath);
 
                        $this->unzip($ZIPfile, $tempPath);
@@ -277,16 +277,15 @@ class tx_tsconfighelp_module1 extends t3lib_SCbase {
         * Unzips a zip file in the given path.
         * Uses the Extension Manager unzip functions.
         *
-        *
-        * @param string $file          Full path to zip file
-        * @param string $path          Path to change to before extracting
-        * @return boolean      TRUE on success, FALSE in failure
+        * @param string $file Full path to zip file
+        * @param string $path Path to change to before extracting
+        * @return boolean TRUE on success, FALSE in failure
         */
        function unzip($file, $path) {
-                       // we use the unzip class of the Extension Manager here
+                       // We use the unzip class of the Extension Manager here
                        // TODO: move unzip class to core
                if (!t3lib_extMgm::isLoaded('em')) {
-                               //em is not loaded, so include the unzip class
+                               // Em is not loaded, so include the unzip class
                        t3lib_div::requireOnce(PATH_typo3 . 'sysext/em/classes/tools/class.tx_em_tools_unzip.php');
                }
                $unzip = t3lib_div::makeInstance('tx_em_Tools_Unzip', $file);
@@ -304,8 +303,8 @@ class tx_tsconfighelp_module1 extends t3lib_SCbase {
         * This function assumes the STYLE definitions are not nested. If they are then, then "close" type will need to be used
         * more carefully, and a depth counter will need to be implemented.
         *
-        * @param       array           The XML values array. The XML index is not necessary in this function.
-        * @return      array           Array that contains the different styles with their parent (required to recognise "Table Contents"-type styles), and their style (bold/italic)
+        * @param array $vals The XML values array. The XML index is not necessary in this function.
+        * @return array Array that contains the different styles with their parent (required to recognise "Table Contents"-type styles), and their style (bold/italic)
         */
        function parseStyles($vals) {
                $currentStyleName = '';
@@ -320,13 +319,16 @@ class tx_tsconfighelp_module1 extends t3lib_SCbase {
 
                                                        if (array_key_exists('STYLE:PARENT-STYLE-NAME', $node['attributes'])) {
                                                                $parentStyleName = $node['attributes']['STYLE:PARENT-STYLE-NAME'];
-                                                               $style[$currentStyleName]['parents'][] = $parentStyleName; // keep trace of parents in the style array
+                                                                       // Keep trace of parents in the style array
+                                                               $style[$currentStyleName]['parents'][] = $parentStyleName;
                                                        } else {
-                                                               $parentStyleName = ''; // this style has no parent, therefore clean the variable to avoid side effects with next use of that variable
+                                                                       // This style has no parent, therefore clean the variable to avoid side effects with next use of that variable
+                                                               $parentStyleName = '';
                                                        }
-
-                                                       if (array_key_exists($parentStyleName, $style)) { // the style parent is already documented in the array
-                                                               $style[$currentStyleName] = $style[$parentStyleName]; // inherit parent style
+                                                               // The style parent is already documented in the array
+                                                       if (array_key_exists($parentStyleName, $style)) {
+                                                                       // Inherit parent style
+                                                               $style[$currentStyleName] = $style[$parentStyleName];
                                                        }
                                                break;
                                        }
@@ -360,7 +362,6 @@ class tx_tsconfighelp_module1 extends t3lib_SCbase {
                return $style;
        }
 
-
        /**
         * Checks if the style is a child of a specified parent. This is useful for example to check if a specific style that has
         * a generic name ("P8" for example) is a child of the "Table Contents" style. It would not only inherit its style (bold/
@@ -368,20 +369,20 @@ class tx_tsconfighelp_module1 extends t3lib_SCbase {
         *
         * This function references the global $Styles variables which must have been created previously with parseStyles()
         *
-        * @param       string          Name of the child style that we want to get properties for
-        * @param       string          Name of the parent style that we want to compare the child against
-        * @return      boolean         TRUE if the child and parent are linked together. FALSE otherwise.
+        * @param string $child Name of the child style that we want to get properties for
+        * @param string $parent Name of the parent style that we want to compare the child against
+        * @return boolean TRUE if the child and parent are linked together. FALSE otherwise.
         */
        function isStyleChildOf($child, $parent) {
                global $Styles;
-
-               if (!strcmp($child, $parent))   { // the child is actually the same as the parent. They are obviously linked together
+                       // The child is actually the same as the parent. They are obviously linked together
+               if (!strcmp($child, $parent)) {
                        return TRUE;
                }
 
                if (is_array($Styles[$child])  // the child is a documented style
                        && array_key_exists('parents', $Styles[$child])  // it has some parents
-                       && (array_search($parent, $Styles[$child]['parents']) !== FALSE))       { // and the parent appears amongst its ancestors
+                       && (array_search($parent, $Styles[$child]['parents']) !== FALSE)) { // and the parent appears amongst its ancestors
                        return TRUE;
                }
                return FALSE;
@@ -399,37 +400,40 @@ class tx_tsconfighelp_module1 extends t3lib_SCbase {
         * This function uses the unusual index XML array in addition to the values, this is necessary to find where in the XML
         * tree a TABLE starts once we found where it ends.
         *
-        * @param       array           The XML values array
-        * @param       array           The XML index array
-        * @param       integer         This is a reference to the index in the array where we should be starting the search
-        * @return      array           Array of the table start index and table end index where TS is defined. table start is FALSE if there are no more TS entries in the document (consider it similar to an EOF reached status).
+        * @param array $vals The XML values array
+        * @param array $index The XML index array
+        * @param integer $id This is a reference to the index in the array where we should be starting the search
+        * @return array Array of the table start index and table end index where TS is defined. table start is FALSE if there are no more TS entries in the document (consider it similar to an EOF reached status).
         */
        function nextTSDefinitionTable($vals, $index, &$id) {
-                       // browse the table where we left off last time
+                       // Browse the table where we left off last time
                while ($id < count ($vals)) {
                        $node = $vals[$id];
-                       if (!strcmp($node['type'], 'close') && !strcmp($node['tag'], 'TABLE:TABLE'))    { // check if next entry is a candidate
+                               // check if next entry is a candidate
+                       if (!strcmp($node['type'], 'close') && !strcmp($node['tag'], 'TABLE:TABLE')) {
                                $nextNode = $vals[$id+1];
                                if (!strcmp($nextNode['tag'], 'TEXT:P') && $this->isStyleChildOf($nextNode['attributes']['TEXT:STYLE-NAME'], 'Table Contents')) {
-                                               // we found a good entry
-                                       $closeIndex = array_search($id, $index['TABLE:TABLE']); // find the ID in the list of table items
-
-                                       $tableStart = $index['TABLE:TABLE'][$closeIndex-1]; // find the matching start of the table in the $vals array
+                                               // We found a good entry
+                                               // Find the ID in the list of table items
+                                       $closeIndex = array_search($id, $index['TABLE:TABLE']);
+                                               // Find the matching start of the table in the $vals array
+                                       $tableStart = $index['TABLE:TABLE'][$closeIndex-1];
 
                                        return array($tableStart, $id++);
                                }
                        }
                        $id = $id+1;
                }
-               return array(FALSE, 0); // marks the end of the input, no more table to find. WARNING: needs to be tested with === FALSE
+                       // Marks the end of the input, no more table to find. WARNING: needs to be tested with === FALSE
+               return array(FALSE, 0);
        }
 
        /**
         * Converts an Open Office like style (font-weight:bold for example) into an HTML style (b is for bold). This function uses the global
         * $Styles defined through the parseStyles function
         *
-        * @param       array           an array containing the [attributes][style] items in the OO format
-        * @return      array           an array where the items are all the HTML styles to apply to closely match the input OO-like styles
+        * @param array $node An array containing the [attributes][style] items in the OO format
+        * @return array An array where the items are all the HTML styles to apply to closely match the input OO-like styles
         */
        function styleTags($node) {
                global $Styles;
@@ -451,9 +455,9 @@ class tx_tsconfighelp_module1 extends t3lib_SCbase {
        /**
         * Converts an array containing style strings (for example ['b','i']) into their HTML equivalents
         *
-        * @param       array           an array containing all the style tags
-        * @param       string          either '' or '/' depending on whether the style definition is to open or close the style
-        * @return      string          the sequence of tags to open or close the style, for example <strong><i>
+        * @param array $style An array containing all the style tags
+        * @param string $char Either '' or '/' depending on whether the style definition is to open or close the style
+        * @return string The sequence of tags to open or close the style, for example <strong><i>
         */
        function styleHTML($style, $char) {
                $string = '';
@@ -472,14 +476,15 @@ class tx_tsconfighelp_module1 extends t3lib_SCbase {
         * &nbsp if empty : if the input is empty, we return a &nbsp; string so that in the HTML output something will be       displayed
         * utf8 to entities cleaning : in some SXW docs we can find UTF8 characters that need to be converted to be displayed on screen
         *
-        * @param       string          Text that will need to be transformed according to the HSC and other rules
-        * @return      string          Transformed text that can now be freely serialized or exported to HTML
+        * @param string $text Text that will need to be transformed according to the HSC and other rules
+        * @return string Transformed text that can now be freely serialized or exported to HTML
         */
        function HSCtext($text) {
                global $LANG;
-
-               if (strcmp($text, ''))  { // there is some content in the text field
-                       $cleantext = stripslashes(htmlspecialchars($text, ENT_QUOTES)); // stripslashes required as it could confuse unserialize
+                       // Rhere is some content in the text field
+               if (strcmp($text, '')) {
+                               // Stripslashes required as it could confuse unserialize
+                       $cleantext = stripslashes(htmlspecialchars($text, ENT_QUOTES));
                        return $LANG->csConvObj->utf8_to_entities($cleantext, $LANG->charSet);
                } else { // there is no text, it's empty
                        return '&nbsp;';
@@ -498,37 +503,47 @@ class tx_tsconfighelp_module1 extends t3lib_SCbase {
         *   column_count => number of columns found in table. Usually 4, but for spanned columns, it would be less (1 for example)
         *   is_propertyTable => ??? (almost always equal to 1)
         *
-        * @param       array           This is the input XML data that is to be parsed
-        * @param       integer         The starting ID in the XML array to parse the data from
-        * @param       integer         The ending ID in the XML array to stop parsing data
-        * @return      array           An array with the contents of the different columns extracted from the input data
+        * @param array $vals This is the input XML data that is to be parsed
+        * @param integer $start The starting ID in the XML array to parse the data from
+        * @param integer $end The ending ID in the XML array to stop parsing data
+        * @return array An array with the contents of the different columns extracted from the input data
         */
        function parseTable($vals, $start, $end) {
                $sectionHeader = 0;
                $sectionRow = 0;
                $sectionCell = 0;
                $sectionP = 0;
-
-               $newLineRequired = ''; // this variable will either be empty (no newline required) or '\n' (newline required)
-               $textStyle = array (); // this will be the list of tag styles to apply to the text
+                       // This variable will either be empty (no newline required) or '\n' (newline required)
+               $newLineRequired = '';
+                       // This will be the list of tag styles to apply to the text
+               $textStyle = array ();
 
                $currentRow = 0;
                $currentCell = 0;
 
                $rowID = 0;
-               $cellID = 0;  // also gets reset at every top-level row
-
-               $table = array(); // will contain the results of the function
+                       // Also gets reset at every top-level row
+               $cellID = 0;
+                       // Will contain the results of the function
+               $table = array();
 
                $id = $start;
                while ($id < $end) {
                        $node = $vals[$id];
 
-                       // sanity check
-                       if ($sectionHeader < 0) die ('Malformed XML (header-rows)'.LF);
-                       if ($sectionRow < 0)    die ('Malformed XML (row)'.LF);
-                       if ($sectionCell < 0)   die ('Malformed XML (cell)'.LF);
-                       if ($sectionP < 0)              die ('Malformed XML (P)'.LF);
+                               // Sanity check
+                       if ($sectionHeader < 0) {
+                               die('Malformed XML (header-rows)'.LF);
+                       }
+                       if ($sectionRow < 0) {
+                               die('Malformed XML (row)'.LF);
+                       }
+                       if ($sectionCell < 0) {
+                               die ('Malformed XML (cell)'.LF);
+                       }
+                       if ($sectionP < 0) {
+                               die('Malformed XML (P)'.LF);
+                       }
 
                        switch ($node['type']) {
                                case 'open':
@@ -538,9 +553,11 @@ class tx_tsconfighelp_module1 extends t3lib_SCbase {
                                                break;
 
                                                case 'TABLE:TABLE-ROW':
-                                                       if (!$sectionHeader)    { // skip section header, we only look at the *contents* of the table
+                                                               // Skip section header, we only look at the *contents* of the table
+                                                       if (!$sectionHeader) {
                                                                $sectionRow++;
-                                                               if ($sectionRow == 1)   { // make sure we are within a top-level row
+                                                                       // Make sure we are within a top-level row
+                                                               if ($sectionRow == 1) {
                                                                        $rowID++;
                                                                        $cellID = 0;
                                                                }
@@ -548,20 +565,25 @@ class tx_tsconfighelp_module1 extends t3lib_SCbase {
                                                break;
 
                                                case 'TABLE:TABLE-CELL':
-                                                       if (!$sectionHeader)    { // skip section header, we only look at the *contents* of the table
+                                                               // Skip section header, we only look at the *contents* of the table
+                                                       if (!$sectionHeader) {
                                                                $sectionCell++;
-                                                               if ($sectionCell == 1)  { // make sure we are within a top-level cell
+                                                                       // Make sure we are within a top-level cell
+                                                               if ($sectionCell == 1) {
                                                                        $cellID++;
-                                                                       $newLineRequired = ''; // no newline required after this
+                                                                               // No newline required after this
+                                                                       $newLineRequired = '';
                                                                }
                                                        }
                                                break;
 
                                                case 'TEXT:P':
-                                                       if ($sectionCell)       { // make sure we are in a cell
+                                                               // Make sure we are in a cell
+                                                       if ($sectionCell) {
                                                                $sectionP++;
                                                                $table[$rowID-1][$cellID-1] .= $this->styleHTML($this->styleTags($node), '') . $newLineRequired.$this->HSCtext($node['value']);
-                                                               $newLineRequired = ''; // no newline required after this
+                                                                       // No newline required after this
+                                                               $newLineRequired = '';
                                                                $latestTEXTPopen = $node;
                                                        }
                                                break;
@@ -571,25 +593,29 @@ class tx_tsconfighelp_module1 extends t3lib_SCbase {
                                case 'complete':
                                        switch ($node['tag']) {
                                                case 'TEXT:P':
-                                                       if ($sectionCell)       { // make sure we are in a cell
+                                                               // make sure we are in a cell
+                                                       if ($sectionCell) {
                                                                $table[$rowID-1][$cellID-1] .= $this->styleHTML($this->styleTags($node), '') . $newLineRequired.$this->HSCtext($node['value']).$this->styleHTML($this->styleTags($node), '/');
                                                                $newLineRequired = '<br>'; // after a paragraph, require a new-line
                                                        }
                                                break;
 
                                                case 'TEXT:SPAN':
-                                                       if ($sectionCell)       { // make sure we are in a cell
+                                                               // make sure we are in a cell
+                                                       if ($sectionCell) {
                                                                $table[$rowID-1][$cellID-1] .= $this->styleHTML($this->styleTags($node), '').$newLineRequired.$this->HSCtext($node['value']).$this->styleHTML($this->styleTags($node), '/');
                                                                $newLineRequired = ''; // no newline required after this
                                                        }
                                                break;
 
                                                case 'TEXT:S':
-                                                       if ($sectionCell)       { // make sure we are in a cell
-                                                               for ($i=0; $i<$node['attributes']['TEXT:C']; $i++) {
+                                                               // make sure we are in a cell
+                                                       if ($sectionCell) {
+                                                               for ($i = 0; $i < $node['attributes']['TEXT:C']; $i++) {
                                                                        $table[$rowID-1][$cellID-1] .= '&nbsp;';
                                                                }
-                                                               $newLineRequired = ''; // no newline required after this
+                                                                       // no newline required after this
+                                                               $newLineRequired = '';
                                                        }
                                                break;
                                        }
@@ -598,9 +624,11 @@ class tx_tsconfighelp_module1 extends t3lib_SCbase {
                                case 'cdata':
                                        switch ($node['tag']) {
                                                case 'TEXT:P':
-                                                       if ($sectionCell)       { // make sure we are in a cell
+                                                               // make sure we are in a cell
+                                                       if ($sectionCell) {
                                                                $table[$rowID-1][$cellID-1] .= $this->styleHTML($this->styleTags($node), '') . $newLineRequired.$this->HSCtext($node['value']).$this->styleHTML($this->styleTags($node), '/');
-                                                               $newLineRequired = ''; // no newline required after this
+                                                                       // no newline required after this
+                                                               $newLineRequired = '';
                                                        }
                                                break;
                                        }
@@ -613,20 +641,23 @@ class tx_tsconfighelp_module1 extends t3lib_SCbase {
                                                break;
 
                                                case 'TABLE:TABLE-ROW':
-                                                       if (!$sectionHeader)    { // skip section header, we only look at the *contents* of the table
+                                                               // skip section header, we only look at the *contents* of the table
+                                                       if (!$sectionHeader) {
                                                                $sectionRow--;
                                                        }
                                                break;
 
                                                case 'TABLE:TABLE-CELL':
-                                                       if (!$sectionHeader)    { // skip section header, we only look at the *contents* of the table
+                                                               // skip section header, we only look at the *contents* of the table
+                                                       if (!$sectionHeader) {
                                                                $sectionCell--;
                                                        }
                                                break;
 
                                                case 'TEXT:P':
                                                        $sectionP--;
-                                                       $newLineRequired = '<br>'; // after a paragraph, require a new-line
+                                                               // after a paragraph, require a new-line
+                                                       $newLineRequired = '<br>';
                                                        $table[$rowID-1][$cellID-1] .= $this->styleHTML($this->styleTags($latestTEXTPopen), '/');
                                                break;
                                        }
@@ -640,10 +671,10 @@ class tx_tsconfighelp_module1 extends t3lib_SCbase {
        /**
         * Load the contents of the table into the SQL database
         *
-        * @param       string          Name of the extension to load the documentation for. This is used to make the unique hash in the database
-        * @param       array           Contents of the documentation table
-        * @param       string          Name of the table from the source document (name at the bottom of the table in OpenOffice)
-        * @return      boolean         TRUE on success and FALSE on failure from the INSERT database query
+        * @param string $extension Name of the extension to load the documentation for. This is used to make the unique hash in the database
+        * @param array $table Contents of the documentation table
+        * @param string $tableName Name of the table from the source document (name at the bottom of the table in OpenOffice)
+        * @return boolean TRUE on success and FALSE on failure from the INSERT database query
         */
        function dumpIntoSQL($extension, $table, $tableName) {
                global $uid;
@@ -652,8 +683,10 @@ class tx_tsconfighelp_module1 extends t3lib_SCbase {
                        $tempArray = array();
                        $tempArray['property'] = $row[0];
 
-                       $tempArray['datatype'] = count($row)==2 ? '&nbsp;':$row[1];     // in the case there are only 2 columns, the second one is the description !
-                       $tempArray['description'] = count($row)==2 ? $row[1]:$row[2];  // in the case there are only 2 columns, the second one is the description !
+                               // in the case there are only 2 columns, the second one is the description !
+                       $tempArray['datatype'] = count($row) == 2 ? '&nbsp;':$row[1];
+                               // in the case there are only 2 columns, the second one is the description !
+                       $tempArray['description'] = count($row) == 2 ? $row[1]:$row[2];
                        $tempArray['default'] = $row[3];
                        $tempArray['column_count'] = count($row);
                        $tempArray['is_propertyTable'] = 1;
@@ -683,9 +716,12 @@ class tx_tsconfighelp_module1 extends t3lib_SCbase {
                        $this->allObjStrings[$obj_string] = 0;
                }
                $md5hash = md5($obj_string);
-               $description = ''; // unused
-               $guide = hexdec(substr(md5($extension), 6, 6));  // try to find a way to uniquely identify the source extension and place the identified into the "guide" column
-               $title = ''; // unused
+                       // unused
+               $description = '';
+                       // try to find a way to uniquely identify the source extension and place the identified into the "guide" column
+               $guide = hexdec(substr(md5($extension), 6, 6));
+                       // unused
+               $title = '';
 
                $insertFields = array(
                        'guide' => $guide,
@@ -703,10 +739,10 @@ class tx_tsconfighelp_module1 extends t3lib_SCbase {
         * Purges the existing contents for TypoScript help in the database. This ensures that several runs of the import process will not push
         * duplicate information in the database, but that we clean it first before adding new contents.
         *
-        * @param       string          Name of the extension for which to delete all the data in the database. If empty, all database will be cleaned
-        * @return      void
+        * @param string $extension Name of the extension for which to delete all the data in the database. If empty, all database will be cleaned
+        * @return void
         */
-       function purgeSQLContents($extension='') {
+       function purgeSQLContents($extension = '') {
                $guide = hexdec(substr(md5($extension), 6, 6));
                if ($extension != '') {
                        $GLOBALS['TYPO3_DB']->exec_DELETEquery('static_tsconfig_help', 'guide='.$guide);
@@ -720,20 +756,20 @@ class tx_tsconfighelp_module1 extends t3lib_SCbase {
         * the styles associated with the contents so that later on we can distinguish bold and italic characters for example. It then parses the XML
         * array to find all the TS-like description tables and parses them before loading them into the SQL database.
         *
-        * @param       string          Name of the extension to load manual from
-        * @param       string          Input data from the manual.sxw in a string form. One large string with the whole OO manual document.
-        * @return      integer         Number of individual tables found in the document and loaded into the SQL database
+        * @param string $extension Name of the extension to load manual from
+        * @param string $contents Input data from the manual.sxw in a string form. One large string with the whole OO manual document.
+        * @return integer Number of individual tables found in the document and loaded into the SQL database
         */
        function loadExtensionManual($extension, $contents) {
                global $Styles;
 
-                       // read the contents into an XML array
+                       // Read the contents into an XML array
                $parser = xml_parser_create();
                xml_parse_into_struct($parser, $contents, $vals, $index);
 
                xml_parser_free($parser);
 
-                       // parse styles from the manual for future rendering
+                       // Parse styles from the manual for future rendering
                $Styles = $this->parseStyles($vals);
 
                $id = 0;
@@ -760,12 +796,14 @@ class tx_tsconfighelp_module1 extends t3lib_SCbase {
        }
 }
 
-// Make instance:
+       // Make instance:
 $SOBE = t3lib_div::makeInstance('tx_tsconfighelp_module1');
 $SOBE->init();
 
-// Include files?
-foreach ($SOBE->include_once as $INC_FILE) include_once($INC_FILE);
+       // Include files?
+foreach ($SOBE->include_once as $INC_FILE) {
+       include_once($INC_FILE);
+}
 
 $SOBE->main();
 $SOBE->printContent();