[TASK] Clean up phpDoc comments in typo3/
authorWouter Wolters <typo3@wouterwolters.nl>
Tue, 12 Jun 2012 18:56:03 +0000 (20:56 +0200)
committerChristian Kuhn <lolli@schwarzbu.ch>
Thu, 14 Jun 2012 21:02:36 +0000 (23:02 +0200)
Clean up phpDoc comments for the following classes:

* typo3/show_item.php
* typo3/show_rechis.php
* typo3/tce_db.php
* typo3/tce_file.php
* typo3/template.php
* typo3/thumbs.php
* typo3/wizard_add.php

Clean up provides:

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

Change-Id: I2c15c4aef382389d4f4105dd352ca48bcaa80a95
Resolves: #37975
Releases: 6.0
Reviewed-on: http://review.typo3.org/12005
Reviewed-by: Oliver Klee
Reviewed-by: Christian Kuhn
Tested-by: Christian Kuhn
typo3/show_item.php
typo3/show_rechis.php
typo3/tce_db.php
typo3/tce_file.php
typo3/template.php
typo3/thumbs.php
typo3/wizard_add.php

index 9381591..1560c45 100644 (file)
@@ -29,7 +29,7 @@
  *
  * Revised for TYPO3 3.7 May/2004 by Kasper Skårhøj
  *
- * @author     Kasper Skårhøj <kasperYYYY@typo3.com>
+ * @author Kasper Skårhøj <kasperYYYY@typo3.com>
  */
 
 
@@ -37,21 +37,10 @@ $GLOBALS['BACK_PATH'] = '';
 require_once('init.php');
 require_once('template.php');
 
-
-
-
-
-
-
-
-
-
-
-
 /**
  * Extension of transfer data class
  *
- * @author     Kasper Skårhøj <kasperYYYY@typo3.com>
+ * @author Kasper Skårhøj <kasperYYYY@typo3.com>
  * @package TYPO3
  * @subpackage core
  */
@@ -66,11 +55,11 @@ class transferData extends t3lib_transferData       {
        /**
         * Register item function.
         *
-        * @param       string          Table name
-        * @param       integer         Record uid
-        * @param       string          Field name
-        * @param       string          Content string.
-        * @return      void
+        * @param string $table Table name
+        * @param integer $id Record uid
+        * @param string $field Field name
+        * @param string $content Content string.
+        * @return void
         */
        function regItem($table, $id, $field, $content) {
                t3lib_div::loadTCA($table);
@@ -94,39 +83,38 @@ class transferData extends t3lib_transferData       {
        }
 }
 
-
-
-
-
-
-
-
-
-
-
 /**
  * Script Class for showing information about an item.
  *
- * @author     Kasper Skårhøj <kasperYYYY@typo3.com>
+ * @author Kasper Skårhøj <kasperYYYY@typo3.com>
  * @package TYPO3
  * @subpackage core
  */
 class SC_show_item {
 
                // GET vars:
-       var $table;                     // Record table (or filename)
-       var $uid;                       // Record uid  (or '' when filename)
+               // Record table (or filename)
+       var $table;
+               // Record uid  (or '' when filename)
+       var $uid;
 
                // Internal, static:
-       var $perms_clause;      // Page select clause
-       var $access;            // If TRUE, access to element is granted
-       var $type;                      // Which type of element: "file" or "db"
-       var $doc;                       // Document Template Object
+               // Page select clause
+       var $perms_clause;
+               // If TRUE, access to element is granted
+       var $access;
+               // Which type of element: "file" or "db"
+       var $type;
+               // Document Template Object
+       var $doc;
 
                // Internal, dynamic:
-       var $content;           // Content Accumulation
-       var $pageinfo;          // For type "db": Set to page record of the parent page of the item set (if type="db")
-       var $row;                       // For type "db": The database record row.
+               // Content Accumulation
+       var $content;
+               // For type "db": Set to page record of the parent page of the item set (if type="db")
+       var $pageinfo;
+               // For type "db": The database record row.
+       var $row;
 
        /**
         * The fileObject if present
@@ -146,7 +134,7 @@ class SC_show_item {
         * Initialization of the class
         * Will determine if table/uid GET vars are database record or a file and if the user has access to view information about the item.
         *
-        * @return      void
+        * @return void
         */
        function init() {
                        // Setting input variables.
@@ -155,8 +143,10 @@ class SC_show_item {
 
                        // Initialize:
                $this->perms_clause = $GLOBALS['BE_USER']->getPagePermsClause(1);
-               $this->access = FALSE;  // Set to TRUE if there is access to the record / file.
-               $this->type = '';       // Sets the type, "db" or "file". If blank, nothing can be shown.
+                       // Set to TRUE if there is access to the record / file.
+               $this->access = FALSE;
+                       // Sets the type, "db" or "file". If blank, nothing can be shown.
+               $this->type = '';
 
                        // Checking if the $table value is really a table and if the user has access to it.
                if (isset($GLOBALS['TCA'][$this->table])) {
@@ -210,15 +200,15 @@ class SC_show_item {
                $this->doc->backPath = $GLOBALS['BACK_PATH'];
 
                        // Starting the page by creating page header stuff:
-               $this->content.=$this->doc->startPage($GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.xml:show_item.php.viewItem'));
-               $this->content.='<h3 class="t3-row-header">' . $GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.xml:show_item.php.viewItem') . '</h3>';
-               $this->content.=$this->doc->spacer(5);
+               $this->content .= $this->doc->startPage($GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.xml:show_item.php.viewItem'));
+               $this->content .= '<h3 class="t3-row-header">' . $GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.xml:show_item.php.viewItem') . '</h3>';
+               $this->content .= $this->doc->spacer(5);
        }
 
        /**
         * Main function. Will generate the information to display for the item set internally.
         *
-        * @return      void
+        * @return void
         */
        function main() {
 
@@ -240,8 +230,8 @@ class SC_show_item {
                                }
                        }
 
-                               // if type was not rendered use default rendering functions
-                       if(!$typeRendered) {
+                               // If type was not rendered use default rendering functions
+                       if (!$typeRendered) {
                                        // Branch out based on type:
                                switch ($this->type) {
                                        case 'db':
@@ -277,7 +267,7 @@ class SC_show_item {
                $this->content.= $this->doc->section('', $code);
 
                        // Initialize variables:
-               $tableRows = Array();
+               $tableRows = array();
                $i = 0;
 
                        // Traverse the list of fields to display for the record:
@@ -301,19 +291,19 @@ class SC_show_item {
                                        <table border="0" cellpadding="0" cellspacing="0" id="typo3-showitem" class="t3-table-info">
                                                '.implode('', $tableRows).'
                                        </table>';
-               $this->content.=$this->doc->section('', $tableCode);
+               $this->content .= $this->doc->section('', $tableCode);
 
                        // Add path and table information in the bottom:
                $code = '';
                $code .= $GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.xml:labels.path') . ': ' . t3lib_div::fixed_lgd_cs($this->pageinfo['_thePath'], -48) . '<br />';
                $code .= $GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.xml:labels.table') . ': ' . $GLOBALS['LANG']->sL($GLOBALS['TCA'][$this->table]['ctrl']['title']) . ' (' . $this->table . ') - UID: ' . $this->uid . '<br />';
-               $this->content.= $this->doc->section('', $code);
+               $this->content .= $this->doc->section('', $code);
 
                        // References:
-               $this->content.= $this->doc->section($GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.xml:show_item.php.referencesToThisItem'), $this->makeRef($this->table, $this->row['uid']));
+               $this->content .= $this->doc->section($GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.xml:show_item.php.referencesToThisItem'), $this->makeRef($this->table, $this->row['uid']));
 
                        // References:
-               $this->content.= $this->doc->section($GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.xml:show_item.php.referencesFromThisItem'), $this->makeRefFrom($this->table, $this->row['uid']));
+               $this->content .= $this->doc->section($GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.xml:show_item.php.referencesFromThisItem'), $this->makeRefFrom($this->table, $this->row['uid']));
        }
 
        /**
@@ -362,7 +352,7 @@ class SC_show_item {
                        $this->content .= $this->doc->section('', $thumb);
                }
 
-                                       // Initialize variables:
+                       // Initialize variables:
                $tableRows = array();
                $i = 0;
 
@@ -382,7 +372,7 @@ class SC_show_item {
                        }
                }
 
-                                       // Create table from the information:
+                       // Create table from the information:
                $tableCode = '
                                        <table border="0" cellpadding="0" cellspacing="0" id="typo3-showitem" class="t3-table-info">
                                                ' . implode('', $tableRows) . '
@@ -465,7 +455,7 @@ class SC_show_item {
                                '<td>' . $GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.xml:show_item.php.sorting') . '</td>' .
                                '</tr>';
                }
-               foreach($rows as $row) {
+               foreach ($rows as $row) {
                        if($table === '_FILE') {
                                $row = $this->mapFileReferenceOnRefIndex($row);
                        }
@@ -509,8 +499,8 @@ class SC_show_item {
        /**
         * Make reference display (what this elements points to)
         *
-        * @param $table string Table name
-        * @param $ref string Filename or uid
+        * @param string $table Table name
+        * @param string $ref Filename or uid
         * @return string HTML
         */
        function makeRefFrom($table, $ref) {
@@ -536,7 +526,7 @@ class SC_show_item {
                                '<td>' . $GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.xml:show_item.php.refString') . '</td>' .
                                '</tr>';
                }
-               foreach($rows as $row) {
+               foreach ($rows as $row) {
                        $infoData[] = '<tr class="bgColor4">' .
                                '<td>' . htmlspecialchars($this->getFieldName($table, $row['field'])) . '</td>' .
                                '<td>' . htmlspecialchars($row['flexpointer']) . '</td>' .
@@ -554,10 +544,10 @@ class SC_show_item {
        }
 }
 
-// Make instance:
+       // Make instance:
 $SOBE = t3lib_div::makeInstance('SC_show_item');
 $SOBE->init();
 $SOBE->main();
 $SOBE->printContent();
 
-?>
\ No newline at end of file
+?>
index 843067d..cf2fa75 100644 (file)
@@ -24,6 +24,7 @@
 *
 *  This copyright notice MUST APPEAR in all copies of the script!
 ***************************************************************/
+
 /**
  * Shows information about a database or file item
  *
  * @author     Kasper Skårhøj <kasperYYYY@typo3.com>
  */
 
-$BACK_PATH='';
-require ($BACK_PATH.'init.php');
-require ($BACK_PATH.'template.php');
+$BACK_PATH = '';
+require($BACK_PATH.'init.php');
+require($BACK_PATH.'template.php');
 $LANG->includeLLFile('EXT:lang/locallang_show_rechis.xml');
-require_once ('class.show_rechis.inc');
+require_once('class.show_rechis.inc');
 
 /**
  * Script Class for showing the history module of TYPO3s backend
  *
- * @author     Kasper Skårhøj <kasperYYYY@typo3.com>
+ * @author Kasper Skårhøj <kasperYYYY@typo3.com>
  * @package TYPO3
  * @subpackage core
  * @see class.show_rechis.inc
@@ -62,7 +63,7 @@ class SC_show_rechis {
        /**
         * Initialize the module output
         *
-        * @return      void
+        * @return void
         */
        function init() {
 
@@ -78,7 +79,7 @@ class SC_show_rechis {
        /**
         * Generate module output
         *
-        * @return      void
+        * @return void
         */
        function main() {
 
@@ -101,7 +102,7 @@ class SC_show_rechis {
        /**
         * Outputting the accumulated content to screen
         *
-        * @return      void
+        * @return void
         */
        function printContent() {
                $this->content .= $this->doc->endPage();
@@ -112,7 +113,7 @@ class SC_show_rechis {
        /**
         * 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(
@@ -134,7 +135,7 @@ class SC_show_rechis {
        }
 }
 
-// Make instance:
+       // Make instance:
 $SOBE = t3lib_div::makeInstance('SC_show_rechis');
 $SOBE->init();
 $SOBE->main();
index 052a1f3..5550630 100644 (file)
@@ -24,6 +24,7 @@
 *
 *  This copyright notice MUST APPEAR in all copies of the script!
 ***************************************************************/
+
 /**
  * TCE gateway (TYPO3 Core Engine) for database handling
  * This script is a gateway for POST forms to class.t3lib_TCEmain that manipulates all information in the database!!
  *
  * Revised for TYPO3 3.6 July/2003 by Kasper Skårhøj
  *
- * @author     Kasper Skårhøj <kasperYYYY@typo3.com>
+ * @author Kasper Skårhøj <kasperYYYY@typo3.com>
  */
 
-
-require ('init.php');
-require ('template.php');
-
-
-
-
-
-
-
-
-
-
+require('init.php');
+require('template.php');
 
 /**
  * Script Class, creating object of t3lib_TCEmain and sending the posted data to the object.
@@ -54,27 +44,39 @@ require ('template.php');
  * Is not used by alt_doc.php though (main form rendering script) - that uses the same class (TCEmain) but makes its own initialization (to save the redirect request).
  * For all other cases than alt_doc.php it is recommended to use this script for submitting your editing forms - but the best solution in any case would probably be to link your application to alt_doc.php, that will give you easy form-rendering as well.
  *
- * @author     Kasper Skårhøj <kasperYYYY@typo3.com>
+ * @author Kasper Skårhøj <kasperYYYY@typo3.com>
  * @package TYPO3
  * @subpackage core
  */
 class SC_tce_db {
 
                // Internal, static: GPvar
-       var $flags;                     // Array. Accepts options to be set in TCE object. Currently it supports "reverseOrder" (boolean).
-       var $data;                      // Data array on the form [tablename][uid][fieldname] = value
-       var $cmd;                       // Command array on the form [tablename][uid][command] = value. This array may get additional data set internally based on clipboard commands send in CB var!
-       var $mirror;            // Array passed to ->setMirror.
-       var $cacheCmd;          // Cache command sent to ->clear_cacheCmd
-       var $redirect;          // Redirect URL. Script will redirect to this location after performing operations (unless errors has occured)
-       var $prErr;                     // Boolean. If set, errors will be printed on screen instead of redirection. Should always be used, otherwise you will see no errors if they happen.
-       var $CB;                        // Clipboard command array. May trigger changes in "cmd"
-       var $vC;                        // Verification code
-       var $uPT;                       // Boolean. Update Page Tree Trigger. If set and the manipulated records are pages then the update page tree signal will be set.
-       var $generalComment;    // String, general comment (for raising stages of workspace versions)
+               // Array. Accepts options to be set in TCE object. Currently it supports "reverseOrder" (boolean).
+       var $flags;
+               // Data array on the form [tablename][uid][fieldname] = value
+       var $data;
+               // Command array on the form [tablename][uid][command] = value. This array may get additional data set internally based on clipboard commands send in CB var!
+       var $cmd;
+               // Array passed to ->setMirror.
+       var $mirror;
+               // Cache command sent to ->clear_cacheCmd
+       var $cacheCmd;
+               // Redirect URL. Script will redirect to this location after performing operations (unless errors has occured)
+       var $redirect;
+               // Boolean. If set, errors will be printed on screen instead of redirection. Should always be used, otherwise you will see no errors if they happen.
+       var $prErr;
+               // Clipboard command array. May trigger changes in "cmd"
+       var $CB;
+               // Verification code
+       var $vC;
+               // Boolean. Update Page Tree Trigger. If set and the manipulated records are pages then the update page tree signal will be set.
+       var $uPT;
+               // String, general comment (for raising stages of workspace versions)
+       var $generalComment;
 
                // Internal, dynamic:
-       var $include_once=array();              // Files to include after init() function is called:
+               // Files to include after init() function is called:
+       var $include_once = array();
 
        /**
         * TYPO3 Core Engine
@@ -83,13 +85,10 @@ class SC_tce_db {
         */
        var $tce;
 
-
-
-
        /**
         * Initialization of the class
         *
-        * @return      void
+        * @return void
         */
        function init() {
 
@@ -109,12 +108,13 @@ class SC_tce_db {
 
                        // Creating TCEmain object
                $this->tce = t3lib_div::makeInstance('t3lib_TCEmain');
-               $this->tce->stripslashes_values=0;
+               $this->tce->stripslashes_values = 0;
                $this->tce->generalComment = $this->generalComment;
 
                        // Configuring based on user prefs.
                if ($GLOBALS['BE_USER']->uc['recursiveDelete']) {
-                       $this->tce->deleteTree = 1;     // TRUE if the delete Recursive flag is set.
+                               // TRUE if the delete Recursive flag is set.
+                       $this->tce->deleteTree = 1;
                }
                if ($GLOBALS['BE_USER']->uc['copyLevels']) {
                                // Set to number of page-levels to copy.
@@ -143,7 +143,7 @@ class SC_tce_db {
        /**
         * Clipboard pasting and deleting.
         *
-        * @return      void
+        * @return void
         */
        function initClipboard() {
                if (is_array($this->CB)) {
@@ -163,16 +163,18 @@ class SC_tce_db {
        /**
         * Executing the posted actions ...
         *
-        * @return      void
+        * @return void
         */
        function main() {
 
                        // LOAD TCEmain with data and cmd arrays:
                $this->tce->start($this->data, $this->cmd);
-               if (is_array($this->mirror))    {$this->tce->setMirror($this->mirror);}
+               if (is_array($this->mirror)) {
+                       $this->tce->setMirror($this->mirror);
+               }
 
                        // Checking referer / executing
-               $refInfo=parse_url(t3lib_div::getIndpEnv('HTTP_REFERER'));
+               $refInfo = parse_url(t3lib_div::getIndpEnv('HTTP_REFERER'));
                $httpHost = t3lib_div::getIndpEnv('TYPO3_HOST_ONLY');
                if ($httpHost != $refInfo['host'] && $this->vC != $GLOBALS['BE_USER']->veriCode() && !$GLOBALS['TYPO3_CONF_VARS']['SYS']['doNotCheckReferer']) {
                        $this->tce->log('', 0, 0, 0, 1, 'Referer host "%s" and server host "%s" did not match and veriCode was not valid either!', 1, array($refInfo['host'], $httpHost));
@@ -198,7 +200,7 @@ class SC_tce_db {
         * Redirecting the user after the processing has been done.
         * Might also display error messages directly, if any.
         *
-        * @return      void
+        * @return void
         */
        function finish() {
                        // Prints errors, if...
@@ -212,12 +214,14 @@ class SC_tce_db {
        }
 }
 
-// Make instance:
+       // Make instance:
 $SOBE = t3lib_div::makeInstance('SC_tce_db');
 $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);
+}
 
 $formprotection = t3lib_formprotection_Factory::get();
 
index d8a966c..5fd325b 100644 (file)
@@ -24,6 +24,7 @@
 *
 *  This copyright notice MUST APPEAR in all copies of the script!
 ***************************************************************/
+
 /**
  * Gateway for TCE (TYPO3 Core Engine) file-handling through POST forms.
  * This script serves as the fileadministration part of the TYPO3 Core Engine.
  *
  * Revised for TYPO3 3.6 July/2003 by Kasper Skårhøj
  *
- * @author     Kasper Skårhøj <kasperYYYY@typo3.com>
+ * @author Kasper Skårhøj <kasperYYYY@typo3.com>
  */
 
 require_once('init.php');
 require_once('classes/class.typo3_tcefile.php');
 
-// Make instance:
+       // Make instance:
 $SOBE = t3lib_div::makeInstance('TYPO3_tcefile');
 $SOBE->init();
 $SOBE->main();
index f9d67b3..4389936 100644 (file)
 *
 *  This copyright notice MUST APPEAR in all copies of the script!
 ***************************************************************/
+
 /**
  * Contains class with layout/output function for TYPO3 Backend Scripts
  *
  * Revised for TYPO3 3.6 2/2003 by Kasper Skårhøj
  * XHTML-trans compliant
  *
- * @author     Kasper Skårhøj <kasperYYYY@typo3.com>
+ * @author Kasper Skårhøj <kasperYYYY@typo3.com>
  */
 
-
-
-if (!defined('TYPO3_MODE'))    die("Can't include this file directly.");
-
+if (!defined('TYPO3_MODE')) {
+       die('Can\'t include this file directly.');
+}
 
 /**
  * TYPO3 Backend Template Class
@@ -60,41 +60,70 @@ if (!defined('TYPO3_MODE')) die("Can't include this file directly.");
 class template {
 
                // Vars you typically might want to/should set from outside after making instance of this class:
-       var $backPath = '';                             // 'backPath' pointing back to the PATH_typo3
-       var $form='';                                   // This can be set to the HTML-code for a formtag. Useful when you need a form to span the whole page; Inserted exactly after the body-tag.
-       var $JScodeLibArray = array();          // Similar to $JScode (see below) but used as an associative array to prevent double inclusion of JS code. This is used to include certain external Javascript libraries before the inline JS code. <script>-Tags are not wrapped around automatically
-       var $JScode='';                                 // Additional header code (eg. a JavaScript section) could be accommulated in this var. It will be directly outputted in the header.
-       var $extJScode = '';                            // Additional header code for ExtJS. It will be included in document header and inserted in a Ext.onReady(function()
-       var $JScodeArray = array();             // Similar to $JScode but for use as array with associative keys to prevent double inclusion of JS code. a <script> tag is automatically wrapped around.
-       var $postCode='';                               // Additional 'page-end' code could be accommulated in this var. It will be outputted at the end of page before </body> and some other internal page-end code.
-       var $docType = '';                              // Doc-type used in the header. Default is xhtml_trans. You can also set it to 'html_3', 'xhtml_strict' or 'xhtml_frames'.
-       var $moduleTemplate = '';               // HTML template with markers for module
-       protected $moduleTemplateFilename = ''; // the base file (not overlaid by TBE_STYLES) for the current module, useful for hooks when finding out which modules is rendered currently
+               // 'backPath' pointing back to the PATH_typo3
+       var $backPath = '';
+               // This can be set to the HTML-code for a formtag. Useful when you need a form to span the whole page; Inserted exactly after the body-tag.
+       var $form = '';
+               // Similar to $JScode (see below) but used as an associative array to prevent double inclusion of JS code. This is used to include certain external Javascript libraries before the inline JS code. <script>-Tags are not wrapped around automatically
+       var $JScodeLibArray = array();
+               // Additional header code (eg. a JavaScript section) could be accommulated in this var. It will be directly outputted in the header.
+       var $JScode = '';
+               // Additional header code for ExtJS. It will be included in document header and inserted in a Ext.onReady(function()
+       var $extJScode = '';
+               // Similar to $JScode but for use as array with associative keys to prevent double inclusion of JS code. a <script> tag is automatically wrapped around.
+       var $JScodeArray = array();
+               // Additional 'page-end' code could be accommulated in this var. It will be outputted at the end of page before </body> and some other internal page-end code.
+       var $postCode = '';
+               // Doc-type used in the header. Default is xhtml_trans. You can also set it to 'html_3', 'xhtml_strict' or 'xhtml_frames'.
+       var $docType = '';
+               // HTML template with markers for module
+       var $moduleTemplate = '';
+               // the base file (not overlaid by TBE_STYLES) for the current module, useful for hooks when finding out which modules is rendered currently
+       protected $moduleTemplateFilename = '';
 
                // Other vars you can change, but less frequently used:
-       var $scriptID='';                               // Script ID.
-       var $bodyTagId='';                              // Id which can be set for the body tag. Default value is based on script ID
-       var $bodyTagAdditions='';               // You can add additional attributes to the body-tag through this variable.
-       var $inDocStyles='';                    // Additional CSS styles which will be added to the <style> section in the header
-       var $inDocStylesArray=array();          // Like $inDocStyles but for use as array with associative keys to prevent double inclusion of css code
-       var $form_rowsToStylewidth = 9.58;      // Multiplication factor for formWidth() input size (default is 48* this value).
-       var $form_largeComp = 1.33;             // Compensation for large documents (used in class.t3lib_tceforms.php)
-       var $endJS=1;                                   // If set, then a JavaScript section will be outputted in the bottom of page which will try and update the top.busy session expiry object.
+               // Script ID.
+       var $scriptID = '';
+               // Id which can be set for the body tag. Default value is based on script ID
+       var $bodyTagId = '';
+               // You can add additional attributes to the body-tag through this variable.
+       var $bodyTagAdditions = '';
+               // Additional CSS styles which will be added to the <style> section in the header
+       var $inDocStyles = '';
+               // Like $inDocStyles but for use as array with associative keys to prevent double inclusion of css code
+       var $inDocStylesArray = array();
+               // Multiplication factor for formWidth() input size (default is 48* this value).
+       var $form_rowsToStylewidth = 9.58;
+               // Compensation for large documents (used in class.t3lib_tceforms.php)
+       var $form_largeComp = 1.33;
+               // If set, then a JavaScript section will be outputted in the bottom of page which will try and update the top.busy session expiry object.
+       var $endJS = 1;
 
                // TYPO3 Colorscheme.
                // If you want to change this, please do so through a skin using the global var $GLOBALS['TBE_STYLES']
-       var $bgColor = '#F7F3EF';               // Light background color
-       var $bgColor2 = '#9BA1A8';              // Steel-blue
-       var $bgColor3 = '#F6F2E6';              // dok.color
-       var $bgColor4 = '#D9D5C9';              // light tablerow background, brownish
-       var $bgColor5 = '#ABBBB4';              // light tablerow background, greenish
-       var $bgColor6 = '#E7DBA8';              // light tablerow background, yellowish, for section headers. Light.
+               // Light background color
+       var $bgColor = '#F7F3EF';
+               // Steel-blue
+       var $bgColor2 = '#9BA1A8';
+               // dok.color
+       var $bgColor3 = '#F6F2E6';
+               // light tablerow background, brownish
+       var $bgColor4 = '#D9D5C9';
+               // light tablerow background, greenish
+       var $bgColor5 = '#ABBBB4';
+               // light tablerow background, yellowish, for section headers. Light.
+       var $bgColor6 = '#E7DBA8';
        var $hoverColor = '#254D7B';
-       var $styleSheetFile = '';       // Filename of stylesheet (relative to PATH_typo3)
-       var $styleSheetFile2 = '';              // Filename of stylesheet #2 - linked to right after the $this->styleSheetFile script (relative to PATH_typo3)
-       var $styleSheetFile_post = '';  // Filename of a post-stylesheet - included right after all inline styles.
-       var $backGroundImage = '';              // Background image of page (relative to PATH_typo3)
-       var $inDocStyles_TBEstyle = ''; // Inline css styling set from TBE_STYLES array
+               // Filename of stylesheet (relative to PATH_typo3)
+       var $styleSheetFile = '';
+               // Filename of stylesheet #2 - linked to right after the $this->styleSheetFile script (relative to PATH_typo3)
+       var $styleSheetFile2 = '';
+               // Filename of a post-stylesheet - included right after all inline styles.
+       var $styleSheetFile_post = '';
+               // Background image of page (relative to PATH_typo3)
+       var $backGroundImage = '';
+               // Inline css styling set from TBE_STYLES array
+       var $inDocStyles_TBEstyle = '';
 
        /**
         * Whether to use the X-UA-Compatible meta tag
@@ -116,7 +145,7 @@ class template {
                'generatedSprites' => '../typo3temp/sprites/',
        );
 
-               // include these CSS directories from skins by default
+               // Include these CSS directories from skins by default
        protected $stylesheetsSkins = array(
                'structure' => 'stylesheets/structure/',
                'visual' => 'stylesheets/visual/',
@@ -131,13 +160,16 @@ class template {
        );
 
                // DEV:
-       var $parseTimeFlag = 0;                 // Will output the parsetime of the scripts in milliseconds (for admin-users). Set this to FALSE when releasing TYPO3. Only for dev.
+               // Will output the parsetime of the scripts in milliseconds (for admin-users). Set this to FALSE when releasing TYPO3. Only for dev.
+       var $parseTimeFlag = 0;
 
                // INTERNAL
-       var $charset = 'utf-8';                 // Default charset. see function initCharset()
-
-       var $sectionFlag=0;                             // Internal: Indicates if a <div>-output section is open
-       var $divClass = '';                             // (Default) Class for wrapping <DIV>-tag of page. Is set in class extensions.
+               // Default charset. see function initCharset()
+       var $charset = 'utf-8';
+               // Internal: Indicates if a <div>-output section is open
+       var $sectionFlag = 0;
+               // (Default) Class for wrapping <DIV>-tag of page. Is set in class extensions.
+       var $divClass = '';
 
        var $pageHeaderBlock = '';
        var $endOfPageJsBlock = '';
@@ -148,7 +180,8 @@ class template {
         * @var t3lib_PageRenderer
         */
        protected $pageRenderer;
-       protected $pageHeaderFooterTemplateFile = '';   // alternative template file
+               // Alternative template file
+       protected $pageHeaderFooterTemplateFile = '';
 
        protected $extDirectStateProvider = FALSE;
 
@@ -179,16 +212,20 @@ class template {
                        $this->scriptID = preg_replace('/^.*\/(sysext|ext)\//', 'ext/', substr(PATH_thisScript, strlen(PATH_site)));
                }
                if (TYPO3_mainDir!='typo3/' && substr($this->scriptID, 0, strlen(TYPO3_mainDir)) == TYPO3_mainDir) {
-                       $this->scriptID = 'typo3/'.substr($this->scriptID, strlen(TYPO3_mainDir));      // This fixes if TYPO3_mainDir has been changed so the script ids are STILL "typo3/..."
+                               // This fixes if TYPO3_mainDir has been changed so the script ids are STILL "typo3/..."
+                       $this->scriptID = 'typo3/'.substr($this->scriptID, strlen(TYPO3_mainDir));
                }
 
                $this->bodyTagId = preg_replace('/[^A-Za-z0-9-]/', '-', $this->scriptID);
 
                        // Individual configuration per script? If so, make a recursive merge of the arrays:
                if (is_array($GLOBALS['TBE_STYLES']['scriptIDindex'][$this->scriptID])) {
-                       $ovr = $GLOBALS['TBE_STYLES']['scriptIDindex'][$this->scriptID];                // Make copy
-                       $GLOBALS['TBE_STYLES'] = t3lib_div::array_merge_recursive_overrule($GLOBALS['TBE_STYLES'], $ovr);               // merge styles.
-                       unset($GLOBALS['TBE_STYLES']['scriptIDindex'][$this->scriptID]);        // Have to unset - otherwise the second instantiation will do it again!
+                               // Make copy
+                       $ovr = $GLOBALS['TBE_STYLES']['scriptIDindex'][$this->scriptID];
+                               // merge styles.
+                       $GLOBALS['TBE_STYLES'] = t3lib_div::array_merge_recursive_overrule($GLOBALS['TBE_STYLES'], $ovr);
+                               // Have to unset - otherwise the second instantiation will do it again!
+                       unset($GLOBALS['TBE_STYLES']['scriptIDindex'][$this->scriptID]);
                }
 
                        // Color scheme:
@@ -232,7 +269,7 @@ class template {
                        $this->pageRenderer->enableCompressCss();
                        $this->pageRenderer->enableCompressJavascript();
 
-                               // add all JavaScript files defined in $this->jsFiles to the PageRenderer
+                               // Add all JavaScript files defined in $this->jsFiles to the PageRenderer
                        foreach ($this->jsFiles as $file) {
                                $this->pageRenderer->addJsFile($GLOBALS['BACK_PATH'] . $file);
                        }
@@ -243,8 +280,6 @@ class template {
                return $this->pageRenderer;
        }
 
-
-
        /**
         * Sets inclusion of StateProvider
         *
@@ -254,14 +289,6 @@ class template {
                $this->extDirectStateProvider = TRUE;
        }
 
-
-
-
-
-
-
-
-
        /*****************************************
         *
         * EVALUATION FUNCTIONS
@@ -344,7 +371,7 @@ class template {
         * Use this to test if click-menus (context sensitive menus) can and should be displayed in the backend.
         *
         * @return boolean
-        * @deprecated since TYPO3 4.7, will be removed in TYPO3 4.9 - This function makes no sense anymore
+        * @deprecated since TYPO3 4.7, will be removed in TYPO3 6.1 - This function makes no sense anymore
         */
        function isCMlayers() {
                t3lib_div::logDeprecatedFunction();
@@ -450,7 +477,7 @@ class template {
                $GET = t3lib_div::_GET();
                $storeArray = array_merge(
                        t3lib_div::compileSelectedGetVarsFromArray($gvList, $GET),
-                       array('SET'=>t3lib_div::compileSelectedGetVarsFromArray($setList, (array)$GLOBALS['SOBE']->MOD_SETTINGS))
+                       array('SET' => t3lib_div::compileSelectedGetVarsFromArray($setList, (array)$GLOBALS['SOBE']->MOD_SETTINGS))
                );
                $storeUrl = t3lib_div::implodeArrayForUrl('', $storeArray);
                return $storeUrl;
@@ -469,7 +496,8 @@ class template {
         */
        function formWidth($size = 48, $textarea = FALSE, $styleOverride = '') {
                $wAttrib = $textarea?'cols':'size';
-               if (!$GLOBALS['CLIENT']['FORMSTYLE'])   {       // If not setting the width by style-attribute
+                       // If not setting the width by style-attribute
+               if (!$GLOBALS['CLIENT']['FORMSTYLE']) {
                        $retVal = ' '.$wAttrib.'="'.$size.'"';
                } else {        // Setting width by style-attribute. 'cols' MUST be avoided with NN6+
                        $pixels = ceil($size*$this->form_rowsToStylewidth);
@@ -494,8 +522,8 @@ class template {
        function formWidthText($size = 48, $styleOverride = '', $wrap = '') {
                $wTags = $this->formWidth($size, 1, $styleOverride);
                        // Netscape 6+/Mozilla seems to have this ODD problem where there WILL ALWAYS be wrapping with the cols-attribute set and NEVER without the col-attribute...
-               if (strtolower(trim($wrap))!='off' && $GLOBALS['CLIENT']['BROWSER']=='net' && $GLOBALS['CLIENT']['VERSION']>=5) {
-                       $wTags.=' cols="'.$size.'"';
+               if (strtolower(trim($wrap)) != 'off' && $GLOBALS['CLIENT']['BROWSER']=='net' && $GLOBALS['CLIENT']['VERSION'] >= 5) {
+                       $wTags .= ' cols="'.$size.'"';
                }
                return $wTags;
        }
@@ -566,17 +594,6 @@ class template {
                $this->useCompatibilityTag = (bool) $useCompatibilityTag;
        }
 
-
-
-
-
-
-
-
-
-
-
-
        /*****************************************
         *
         *      PAGE BUILDING FUNCTIONS.
@@ -619,7 +636,7 @@ class template {
 
                        // Send HTTP header for selected charset. Added by Robert Lemke 23.10.2003
                $this->initCharset();
-               header ('Content-Type:text/html;charset='.$this->charset);
+               header('Content-Type:text/html;charset='.$this->charset);
 
                        // Standard HTML tag
                $htmlTag = '<html xmlns="http://www.w3.org/1999/xhtml">';
@@ -628,7 +645,7 @@ class template {
                        case 'html_3':
                                $headerStart = '<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">';
                                $htmlTag = '<html>';
-                               // disable rendering of XHTML tags
+                                       // Disable rendering of XHTML tags
                                $this->getPageRenderer()->setRenderXhtml(FALSE);
                                break;
                        case 'xhtml_strict':
@@ -651,20 +668,20 @@ class template {
                                        // The fallthrough is intended as HTML5, as this is the default for the BE since TYPO3 4.5
                                $headerStart = '<!DOCTYPE html>' . LF;
                                $htmlTag = '<html>';
-                               // disable rendering of XHTML tags
+                                       // Disable rendering of XHTML tags
                                $this->getPageRenderer()->setRenderXhtml(FALSE);
                                break;
                }
 
                $this->pageRenderer->setHtmlTag($htmlTag);
 
-               // This loads the tabulator-in-textarea feature. It automatically modifies
-               // every textarea which is found.
+                       // This loads the tabulator-in-textarea feature. It automatically modifies
+                       // every textarea which is found.
                if (!$GLOBALS['BE_USER']->uc['disableTabInTextarea']) {
                        $this->loadJavascriptLib('tab.js');
                }
 
-                       // include the JS for the Context Sensitive Help
+                       // Include the JS for the Context Sensitive Help
                if ($includeCsh) {
                        $this->loadCshJavascript();
                }
@@ -710,7 +727,7 @@ class template {
                        $this->pageRenderer->addJsFile($this->backPath . '../t3lib/js/extjs/ExtDirect.StateProvider.js');
                }
 
-                       // add jsCode for overriding the console with a debug panel connection
+                       // Add jsCode for overriding the console with a debug panel connection
                $this->pageRenderer->addJsInlineCode(
                        'consoleOverrideWithDebugPanel',
                        'if (typeof top.Ext === "object") {
@@ -771,10 +788,10 @@ class template {
 
                $this->endOfPageJsBlock = $this->pageRenderer->render(t3lib_PageRenderer::PART_FOOTER);
 
-               if ($this->docType=='xhtml_frames') {
+               if ($this->docType == 'xhtml_frames') {
                        return $str;
                } else
-                       $str.=$this->docBodyTagBegin().
+                       $str .= $this->docBodyTagBegin().
                                ($this->divClass ?
 '
 
@@ -799,7 +816,7 @@ class template {
                                $this->parseTime().
                                ($this->form?'
 </form>':'');
-                       // if something is in buffer like debug, put it to end of page
+                       // If something is in buffer like debug, put it to end of page
                if (ob_get_contents()) {
                        $str .= ob_get_clean();
                        if (!headers_sent()) {
@@ -866,8 +883,8 @@ class template {
         * @return string HTML content
         * @see icons(), sectionHeader()
         */
-       function section($label, $text, $nostrtoupper = FALSE, $sH = FALSE, $type=0, $allowHTMLinHeader = FALSE) {
-               $str='';
+       function section($label, $text, $nostrtoupper = FALSE, $sH = FALSE, $type = 0, $allowHTMLinHeader = FALSE) {
+               $str = '';
 
                        // Setting header
                if ($label) {
@@ -875,7 +892,7 @@ class template {
                        $str.=$this->sectionHeader($this->icons($type).$label, $sH, $nostrtoupper ? '' : ' class="uppercase"');
                }
                        // Setting content
-               $str.='
+               $str .= '
 
        <!-- Section content -->
 '.$text;
@@ -892,7 +909,7 @@ class template {
         */
        function divider($dist) {
                $dist = intval($dist);
-               $str='
+               $str = '
 
        <!-- DIVIDER -->
        <hr style="margin-top: '.$dist.'px; margin-bottom: '.$dist.'px;" />
@@ -907,7 +924,7 @@ class template {
         * @return string HTML content
         */
        function spacer($dist) {
-               if ($dist>0) {
+               if ($dist > 0) {
                        return '
 
        <!-- Spacer element -->
@@ -930,7 +947,7 @@ class template {
                if ($addAttrib && substr($addAttrib, 0, 1) !== ' ') {
                        $addAttrib = ' ' . $addAttrib;
                }
-               $str='
+               $str = '
 
        <!-- Section header -->
        <' . $tag . $addAttrib . '>' . $label . '</' . $tag . '>
@@ -1064,12 +1081,12 @@ class template {
         * @return void
         */
        function addStyleSheetDirectory($path) {
-                       // calculation needed, when TYPO3 source is used via a symlink
+                       // Calculation needed, when TYPO3 source is used via a symlink
                        // absolute path to the stylesheets
                $filePath = dirname(t3lib_div::getIndpEnv('SCRIPT_FILENAME')) . '/' . $GLOBALS['BACK_PATH'] . $path;
-                       // clean the path
+                       // Clean the path
                $resolvedPath = t3lib_div::resolveBackPath($filePath);
-                       // read all files in directory and sort them alphabetically
+                       // Read all files in directory and sort them alphabetically
                $files = t3lib_div::getFilesInDir($resolvedPath, 'css', FALSE, 1);
                foreach ($files as $file) {
                        $this->pageRenderer->addCssFile($GLOBALS['BACK_PATH'] . $path . $file, 'stylesheet', 'all');
@@ -1084,12 +1101,12 @@ class template {
         * @return string content with inserted styles
         */
        function insertStylesAndJS($content) {
-                       // insert accumulated CSS
+                       // Insert accumulated CSS
                $this->inDocStylesArray[] = $this->inDocStyles;
                $styles = LF.implode(LF, $this->inDocStylesArray);
                $content = str_replace('/*###POSTCSSMARKER###*/', $styles, $content);
 
-                       // insert accumulated JS
+                       // Insert accumulated JS
                $jscode = $this->JScode.LF.$this->wrapScriptTags(implode(LF, $this->JScodeArray));
                $content = str_replace('<!--###POSTJSMARKER###-->', $jscode, $content);
 
@@ -1104,7 +1121,7 @@ class template {
        public function getSkinStylesheetDirectories() {
                $stylesheetDirectories = array();
 
-                       // add default core stylesheets
+                       // Add default core stylesheets
                foreach ($this->stylesheetsCore as $stylesheetDir) {
                        $stylesheetDirectories[] = $stylesheetDir;
                }
@@ -1116,13 +1133,13 @@ class template {
                        foreach ($GLOBALS['TBE_STYLES']['skins'] as $skinExtKey => $skin) {
                                $skinStylesheetDirs = $this->stylesheetsSkins;
 
-                                       // skins can add custom stylesheetDirectories using
+                                       // Skins can add custom stylesheetDirectories using
                                        // $GLOBALS['TBE_STYLES']['skins'][$_EXTKEY]['stylesheetDirectories']
                                if (is_array($skin['stylesheetDirectories'])) {
                                        $skinStylesheetDirs = array_merge($skinStylesheetDirs, $skin['stylesheetDirectories']);
                                }
 
-                                       // add all registered directories
+                                       // Add all registered directories
                                foreach ($skinStylesheetDirs as $stylesheetDir) {
                                                // for EXT:myskin/stylesheets/ syntax
                                        if (substr($stylesheetDir, 0, 4) === 'EXT:') {
@@ -1131,7 +1148,7 @@ class template {
                                                        $stylesheetDirectories[] = t3lib_extMgm::extRelPath($extKey) . $path;
                                                }
                                        } else {
-                                               // for relative paths
+                                                       // For relative paths
                                                $stylesheetDirectories[] = t3lib_extMgm::extRelPath($skinExtKey) . $stylesheetDir;
                                        }
                                }
@@ -1174,12 +1191,6 @@ class template {
                return '<meta http-equiv="X-UA-Compatible" content="' . $content . '" />';
        }
 
-
-
-
-
-
-
        /*****************************************
         *
         * OTHER ELEMENTS
@@ -1187,7 +1198,6 @@ class template {
         *
         ******************************************/
 
-
        /**
         * Returns an image-tag with an 18x16 icon of the following types:
         *
@@ -1236,7 +1246,7 @@ class template {
        }
 
        /**
-        * dimmed-fontwrap. Returns the string wrapped in a <span>-tag defining the color to be gray/dimmed
+        * Dimmed-fontwrap. Returns the string wrapped in a <span>-tag defining the color to be gray/dimmed
         *
         * @param string $string Input string
         * @return string Output string
@@ -1279,15 +1289,15 @@ class template {
         * @return string Output string
         */
        function wrapScriptTags($string, $linebreak = TRUE) {
-               if(trim($string)) {
+               if (trim($string)) {
                                // <script wrapped in nl?
                        $cr = $linebreak? LF : '';
 
-                               // remove nl from the beginning
+                               // Remove nl from the beginning
                        $string = preg_replace ('/^\n+/', '', $string);
-                               // re-ident to one tab using the first line as reference
+                               // Re-ident to one tab using the first line as reference
                        $match = array();
-                       if(preg_match('/^(\t+)/', $string, $match)) {
+                       if (preg_match('/^(\t+)/', $string, $match)) {
                                $string = str_replace($match[1], TAB, $string);
                        }
                        $string = $cr.'<script type="text/javascript">
@@ -1364,23 +1374,23 @@ class template {
        function menuTable($arr1, $arr2 = array(), $arr3 = array()) {
                $rows = max(array(count($arr1), count($arr2), count($arr3)));
 
-               $menu='
+               $menu = '
                <table border="0" cellpadding="0" cellspacing="0" id="typo3-tablemenu">';
-               for($a=0;$a<$rows;$a++) {
-                       $menu.='<tr>';
-                       $cls=array();
-                       $valign='middle';
-                       $cls[]='<td valign="'.$valign.'">'.$arr1[$a][0].'</td><td>'.$arr1[$a][1].'</td>';
+               for ($a = 0; $a < $rows; $a++) {
+                       $menu .= '<tr>';
+                       $cls = array();
+                       $valign = 'middle';
+                       $cls[] = '<td valign="'.$valign.'">'.$arr1[$a][0].'</td><td>'.$arr1[$a][1].'</td>';
                        if (count($arr2)) {
-                               $cls[]='<td valign="'.$valign.'">'.$arr2[$a][0].'</td><td>'.$arr2[$a][1].'</td>';
+                               $cls[] = '<td valign="'.$valign.'">'.$arr2[$a][0].'</td><td>'.$arr2[$a][1].'</td>';
                                if (count($arr3)) {
-                                       $cls[]='<td valign="'.$valign.'">'.$arr3[$a][0].'</td><td>'.$arr3[$a][1].'</td>';
+                                       $cls[] = '<td valign="'.$valign.'">'.$arr3[$a][0].'</td><td>'.$arr3[$a][1].'</td>';
                                }
                        }
-                       $menu.=implode($cls, '<td>&nbsp;&nbsp;</td>');
-                       $menu.='</tr>';
+                       $menu .= implode($cls, '<td>&nbsp;&nbsp;</td>');
+                       $menu .= '</tr>';
                }
-               $menu.='
+               $menu .= '
                </table>
                ';
                return $menu;
@@ -1416,8 +1426,6 @@ class template {
                $this->pageRenderer->addJsFile($this->backPath . $lib);
        }
 
-
-
        /**
         * Includes the necessary Javascript function for the clickmenu (context sensitive menus) in the document
         * @return void
@@ -1443,7 +1451,7 @@ class template {
                $this->loadJavascriptLib('js/common.js');
                $this->loadJavascriptLib('js/tree.js');
 
-                       // setting prefs for drag & drop
+                       // Setting prefs for drag & drop
                $this->JScodeArray['dragdrop'] = '
                        DragDrop.changeURL = "'.$this->backPath.'alt_clickmenu.php";
                        DragDrop.backPath  = "'.t3lib_div::shortMD5(''.'|'.$GLOBALS['TYPO3_CONF_VARS']['SYS']['encryptionKey']).'";
@@ -1488,7 +1496,7 @@ class template {
                        if (!$script) {$script=basename(PATH_thisScript);}
 
                        $menuDef = array();
-                       foreach($menuItems as $value => $label) {
+                       foreach ($menuItems as $value => $label) {
                                $menuDef[$value]['isActive'] = !strcmp($currentValue, $value);
                                $menuDef[$value]['label'] = t3lib_div::deHSCentities(htmlspecialchars($label));
                                $menuDef[$value]['url'] = $script . '?' . $mainParams . $addparams . '&' . $elementName . '=' . $value;
@@ -1507,10 +1515,10 @@ class template {
         * @access private
         */
        function getTabMenuRaw($menuItems) {
-               $content='';
+               $content = '';
 
                if (is_array($menuItems)) {
-                       $options='';
+                       $options = '';
 
                        $count = count($menuItems);
                        $widthLeft = 1;
@@ -1523,7 +1531,7 @@ class template {
                        $widthAct = $widthNo + $addToAct;
                        $widthRight = 100 - ($widthLeft + ($count*$widthNo) + $addToAct);
 
-                       foreach($menuItems as $id => $def) {
+                       foreach ($menuItems as $id => $def) {
                                $isActive = $def['isActive'];
                                $class = $isActive ? 'tabact' : 'tab';
                                $width = $isActive ? $widthAct : $widthNo;
@@ -1568,7 +1576,7 @@ class template {
         * @return string JavaScript section for the HTML header.
         */
        public function getDynTabMenu($menuItems, $identString, $toggle = 0, $foldout = FALSE, $noWrap = TRUE, $fullWidth = FALSE, $defaultTabIndex = 1, $dividers2tabs = 2) {
-                       // load the static code, if not already done with the function below
+                       // Load the static code, if not already done with the function below
                $this->loadJavascriptLib('js/tabmenu.js');
 
                $content = '';
@@ -1583,10 +1591,10 @@ class template {
                        $noWrap = $noWrap ? ' nowrap="nowrap"' : '';
 
                                // Traverse menu items
-                       $c=0;
-                       $tabRows=0;
+                       $c = 0;
+                       $tabRows = 0;
                        $titleLenCount = 0;
-                       foreach($menuItems as $index => $def) {
+                       foreach ($menuItems as $index => $def) {
                                        // Need to add one so checking for first index in JavaScript
                                        // is different than if it is not set at all.
                                $index += 1;
@@ -1664,8 +1672,8 @@ class template {
                                        // Tab menu is compiled:
                                if (!$foldout) {
                                        $tabContent = '';
-                                       for($a=0;$a<=$tabRows;$a++) {
-                                               $tabContent.= '
+                                       for($a = 0; $a <= $tabRows; $a++) {
+                                               $tabContent .= '
 
                                        <!-- Tab menu -->
                                        <table cellpadding="0" cellspacing="0" border="0"'.($fullWidth ? ' width="100%"' : '').' class="typo3-dyntabmenu">
@@ -1674,22 +1682,22 @@ class template {
                                                </tr>
                                        </table>';
                                        }
-                                       $content.= '<div class="typo3-dyntabmenu-tabs">'.$tabContent.'</div>';
+                                       $content .= '<div class="typo3-dyntabmenu-tabs">'.$tabContent.'</div>';
                                }
 
                                        // Div layers are added:
-                               $content.= '
+                               $content .= '
                                <!-- Div layers for tab menu: -->
                                <div class="typo3-dyntabmenu-divs'.($foldout?'-foldout':'').'">
                                '.implode('', $divs).'</div>';
 
                                        // Java Script section added:
-                               $content.= '
+                               $content .= '
                                <!-- Initialization JavaScript for the menu -->
                                <script type="text/javascript">
                                        DTM_array["'.$id.'"] = new Array();
                                        '.implode('', $JSinit).'
-                                       '.($toggle<=0 ? 'DTM_activate("'.$id.'", top.DTM_currentTabs["'.$id.'"]?top.DTM_currentTabs["'.$id.'"]:'.intval($defaultTabIndex).', 0);' : '').'
+                                       '.($toggle <= 0 ? 'DTM_activate("'.$id.'", top.DTM_currentTabs["'.$id.'"]?top.DTM_currentTabs["'.$id.'"]:'.intval($defaultTabIndex).', 0);' : '').'
                                </script>
 
                                ';
@@ -1801,7 +1809,7 @@ class template {
                        if (!empty($flashMessages)) {
                                $markerArray['FLASHMESSAGES'] = '<div id="typo3-messages">' . $flashMessages . '</div>';
 
-                                       // if there is no dedicated marker for the messages present
+                                       // If there is no dedicated marker for the messages present
                                        // then force them to appear before the content
                                if (strpos($moduleBody, '###FLASHMESSAGES###') === FALSE) {
                                        $moduleBody = str_replace(
@@ -1827,7 +1835,7 @@ class template {
                        }
                }
 
-                       // replacing all markers with the finished markers and return the HTML content
+                       // Replacing all markers with the finished markers and return the HTML content
                return t3lib_parsehtml::substituteMarkerArray($moduleBody, $markerArray, '###|###');
 
        }
@@ -1842,7 +1850,7 @@ class template {
                $markers = array();
                        // Fill buttons for left and right float
                $floats = array('left', 'right');
-               foreach($floats as $key) {
+               foreach ($floats as $key) {
                                // Get the template for each float
                        $buttonTemplate = t3lib_parsehtml::getSubpart($this->moduleTemplate, '###BUTTON_GROUPS_' . strtoupper($key) . '###');
                                // Fill the button markers in this float
@@ -1860,7 +1868,7 @@ class template {
                                        $buttonTemplate = t3lib_parsehtml::substituteSubpart($buttonTemplate, $buttonMarker, trim($buttonGroup));
                                }
                        }
-                               // replace the marker with the template and remove all line breaks (for IE compat)
+                               // Replace the marker with the template and remove all line breaks (for IE compat)
                        $markers['BUTTONLIST_' . strtoupper($key)] = str_replace(LF, '', $buttonTemplate);
                }
 
@@ -1871,7 +1879,7 @@ class template {
                                'markers'       => &$markers,
                                'pObj'          => &$this
                        );
-                       foreach($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['typo3/template.php']['docHeaderButtonsHook'] as $funcRef) {
+                       foreach ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['typo3/template.php']['docHeaderButtonsHook'] as $funcRef) {
                                t3lib_div::callUserFunction($funcRef, $params, $this);
                        }
                }
@@ -1889,7 +1897,7 @@ class template {
                        // Is this a real page
                if (is_array($pageRecord) && $pageRecord['uid']) {
                        $title = substr($pageRecord['_thePathFull'], 0, -1);
-                               // remove current page title
+                               // Remove current page title
                        $pos = strrpos($title, '/');
                        if ($pos !== FALSE) {
                                $title = substr($title, 0, $pos) . '/';
@@ -1922,7 +1930,8 @@ class template {
        protected function getPageInfo($pageRecord) {
 
                                // Add icon with clickmenu, etc:
-               if (is_array($pageRecord) && $pageRecord['uid'])        {       // If there IS a real page
+                               // If there IS a real page
+               if (is_array($pageRecord) && $pageRecord['uid']) {
                        $alttext = t3lib_BEfunc::getRecordIconAltText($pageRecord, 'pages');
                        $iconImg = t3lib_iconWorks::getSpriteIconForRecord('pages', $pageRecord, array('title'=>$alttext));
                                // Make Icon:
@@ -2010,17 +2019,12 @@ class template {
                ';
 
        }
-
-
 }
 
-
-// ******************************
 // Extension classes of the template class.
 // These are meant to provide backend screens with different widths.
 // They still do because of the different class-prefixes used for the <div>-sections
 // but obviously the final width is determined by the stylesheet used.
-// ******************************
 
 /**
  * Extension class for "template" - used for backend pages which are wide. Typically modules taking up all the space in the "content" frame of the backend
@@ -2058,7 +2062,6 @@ class mediumDoc extends template {
        var $divClass = 'typo3-mediumDoc';
 }
 
-
 /**
  * Extension class for "template" - used in the context of frontend editing.
  */
@@ -2088,7 +2091,7 @@ class frontendDoc extends template {
                $this->pageRenderer->setBackPath($this->backPath);
                $this->docStyle();
 
-                       // add applied JS/CSS to $GLOBALS['TSFE']
+                       // Add applied JS/CSS to $GLOBALS['TSFE']
                if ($this->JScode) {
                        $this->pageRenderer->addHeaderData($this->JScode);
                }
@@ -2100,10 +2103,7 @@ class frontendDoc extends template {
        }
 }
 
-// ******************************
-// The template is loaded
-// ******************************
+       // The template is loaded
 $GLOBALS['TBE_TEMPLATE'] = t3lib_div::makeInstance('template');
 
-
 ?>
index 5bd0bce..ddb38bd 100644 (file)
 *
 *  This copyright notice MUST APPEAR in all copies of the script!
 ***************************************************************/
+
 /**
  * Generates a thumbnail and returns an image stream, either GIF/PNG or JPG
  *
- * @author             René Fritz <r.fritz@colorcube.de>
+ * @author René Fritz <r.fritz@colorcube.de>
  */
 
-// *******************************
-// Set error reporting
-// *******************************
+       // Set error reporting
 error_reporting(E_ALL & ~(E_STRICT | E_NOTICE | E_DEPRECATED));
 
 require('init.php');
 
-// ******************
-// include thumbs script
-// ******************
-require (PATH_t3lib . 'thumbs.php');
+       // include thumbs script
+require(PATH_t3lib . 'thumbs.php');
 
 ?>
\ No newline at end of file
index 96b14aa..f1b7dfa 100644 (file)
 *
 *  This copyright notice MUST APPEAR in all copies of the script!
 ***************************************************************/
+
 /**
  * Wizard to add new records to a group/select TCEform formfield
  *
  * Revised for TYPO3 3.6 November/2003 by Kasper Skårhøj
  *
- * @author     Kasper Skårhøj <kasperYYYY@typo3.com>
+ * @author Kasper Skårhøj <kasperYYYY@typo3.com>
  */
 
-
 $BACK_PATH = '';
-require ('init.php');
-require ('template.php');
+require('init.php');
+require('template.php');
 $LANG->includeLLFile('EXT:lang/locallang_wizards.xml');
 
-
-
-
-
-
-
-
-
-
-
-
-
 /**
  * Script Class for adding new items to a group/select field. Performs proper redirection as needed.
  *
- * @author     Kasper Skårhøj <kasperYYYY@typo3.com>
+ * @author Kasper Skårhøj <kasperYYYY@typo3.com>
  * @package TYPO3
  * @subpackage core
  */
 class SC_wizard_add {
 
                // Internal, dynamic:
-       var $content;                           // Content accumulation for the module.
-       var $include_once=array();      // List of files to include.
-
-       var $processDataFlag=0;         // If set, the TCEmain class is loaded and used to add the returning ID to the parent record.
+               // Content accumulation for the module.
+       var $content;
+               // List of files to include.
+       var $include_once = array();
+               // If set, the TCEmain class is loaded and used to add the returning ID to the parent record.
+       var $processDataFlag = 0;
 
                // Internal, static:
-       var $pid;                                       // Create new record -pid (pos/neg). If blank, return immediately
-       var $table;                                     // The parent table we are working on.
-       var $id;                                        // Loaded with the created id of a record when TCEforms (alt_doc.php) returns ...
+               // Create new record -pid (pos/neg). If blank, return immediately
+       var $pid;
+               // The parent table we are working on.
+       var $table;
+               // Loaded with the created id of a record when TCEforms (alt_doc.php) returns ...
+       var $id;
 
                // Internal, static: GPvars
-       var $P;                                         // Wizard parameters, coming from TCEforms linking to the wizard.
-       var $returnEditConf;            // Information coming back from alt_doc.php script, telling what the table/id was of the newly created record.
-
-
-
-
-
-
-
+               // Wizard parameters, coming from TCEforms linking to the wizard.
+       var $P;
+               // Information coming back from alt_doc.php script, telling what the table/id was of the newly created record.
+       var $returnEditConf;
 
        /**
         * Initialization of the class.
         *
-        * @return      void
+        * @return void
         */
        function init() {
 
@@ -102,7 +90,7 @@ class SC_wizard_add {
                $TSconfig = t3lib_BEfunc::getTCEFORM_TSconfig($this->P['table'], is_array($origRow)?$origRow:array('pid'=>$this->P['pid']));
 
                        // Set [params][pid]
-               if (substr($this->P['params']['pid'], 0, 3)=='###' && substr($this->P['params']['pid'], -3)=='###') {
+               if (substr($this->P['params']['pid'], 0, 3) == '###' && substr($this->P['params']['pid'], -3)=='###') {
                        $this->pid = intval($TSconfig['_'.substr($this->P['params']['pid'], 3, -3)]);
                } else $this->pid = intval($this->P['params']['pid']);
 
@@ -112,7 +100,8 @@ class SC_wizard_add {
                }
 
                        // Else proceed:
-               if ($this->returnEditConf)      {       // If a new id has returned from a newly created record...
+                       // If a new id has returned from a newly created record...
+               if ($this->returnEditConf) {
                        $eC = unserialize($this->returnEditConf);
                        if (is_array($eC[$this->table]) && t3lib_utility_Math::canBeInterpretedAsInteger($this->P['uid'])) {
 
@@ -124,13 +113,14 @@ class SC_wizard_add {
                                        // ... and if everything seems OK we will register some classes for inclusion and instruct the object to perform processing later.
                                if ($this->P['params']['setValue'] && $cmd=='edit' && $this->id && $this->P['table'] && $this->P['field'] && $this->P['uid']) {
 
-                                       if ($LiveRec=t3lib_BEfunc::getLiveVersionOfRecord($this->table, $this->id, 'uid'))      { $this->id=$LiveRec['uid'];}
-
+                                       if ($LiveRec = t3lib_BEfunc::getLiveVersionOfRecord($this->table, $this->id, 'uid')) {
+                                               $this->id=$LiveRec['uid'];
+                                       }
 
-                                       $this->include_once[]=PATH_t3lib.'class.t3lib_loaddbgroup.php';
-                                       $this->include_once[]=PATH_t3lib.'class.t3lib_transferdata.php';
-                                       $this->include_once[]=PATH_t3lib.'class.t3lib_tcemain.php';
-                                       $this->processDataFlag=1;
+                                       $this->include_once[] = PATH_t3lib.'class.t3lib_loaddbgroup.php';
+                                       $this->include_once[] = PATH_t3lib.'class.t3lib_transferdata.php';
+                                       $this->include_once[] = PATH_t3lib.'class.t3lib_tcemain.php';
+                                       $this->processDataFlag = 1;
                                }
                        }
                }
@@ -140,7 +130,7 @@ class SC_wizard_add {
         * Main function
         * Will issue a location-header, redirecting either BACK or to a new alt_doc.php instance...
         *
-        * @return      void
+        * @return void
         */
        function main() {
 
@@ -149,20 +139,22 @@ class SC_wizard_add {
 
                                        // Preparing the data of the parent record...:
                                $trData = t3lib_div::makeInstance('t3lib_transferData');
-                               $trData->fetchRecord($this->P['table'], $this->P['uid'], '');   // 'new'
+                                       // 'new'
+                               $trData->fetchRecord($this->P['table'], $this->P['uid'], '');
                                $current = reset($trData->regTableItems_data);
 
                                        // If that record was found (should absolutely be...), then init TCEmain and set, prepend or append the record
                                if (is_array($current)) {
                                        $tce = t3lib_div::makeInstance('t3lib_TCEmain');
-                                       $tce->stripslashes_values=0;
+                                       $tce->stripslashes_values = 0;
                                        $data = array();
                                        $addEl = $this->table.'_'.$this->id;
 
                                                // Setting the new field data:
-                                       if ($this->P['flexFormPath'])   {       // If the field is a flexform field, work with the XML structure instead:
-
-                                               $currentFlexFormData = t3lib_div::xml2array($current[$this->P['field']]); // Current value of flexform path:
+                                               // If the field is a flexform field, work with the XML structure instead:
+                                       if ($this->P['flexFormPath']) {
+                                                       // Current value of flexform path:
+                                               $currentFlexFormData = t3lib_div::xml2array($current[$this->P['field']]);
                                                $flexToolObj = t3lib_div::makeInstance('t3lib_flexformtools');
                                                $curValueOfFlexform = $flexToolObj->getArrayValueByPath($this->P['flexFormPath'], $currentFlexFormData);
                                                $insertValue = '';
@@ -213,12 +205,14 @@ class SC_wizard_add {
        }
 }
 
-// Make instance:
+       // Make instance:
 $SOBE = t3lib_div::makeInstance('SC_wizard_add');
 $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();