[TASK] Clean up phpDoc comments in t3lib classes
authorWouter Wolters <typo3@wouterwolters.nl>
Tue, 15 May 2012 21:52:49 +0000 (23:52 +0200)
committerChristian Kuhn <lolli@schwarzbu.ch>
Wed, 16 May 2012 07:47:24 +0000 (09:47 +0200)
Clean up phpDoc comments for the following classes:

* t3lib/class.t3lib_install_sql.php
* t3lib/class.t3lib_loaddbgroup.php
* t3lib/class.t3lib_loadmodules.php
* t3lib/class.t3lib_lock.php
* t3lib/class.t3lib_modsettings.php

Clean up provides:

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

Change-Id: I0465b7d41e492ae4746f0649b676eae4ad2a145a
Resolves: #37202
Releases: 6.0
Reviewed-on: http://review.typo3.org/11228
Reviewed-by: Christian Kuhn
Tested-by: Christian Kuhn
t3lib/class.t3lib_install_sql.php
t3lib/class.t3lib_loaddbgroup.php
t3lib/class.t3lib_loadmodules.php
t3lib/class.t3lib_lock.php
t3lib/class.t3lib_modsettings.php

index 43d5272..02640e9 100644 (file)
@@ -26,7 +26,7 @@
  ***************************************************************/
 
 /**
- * Verify TYPO3 DB table structure. ainly used in install tool
+ * Verify TYPO3 DB table structure. Mainly used in install tool
  * compare wizard and extension manager.
  *
  * @author Christian Kuhn <lolli@schwarzbu.ch>
@@ -90,14 +90,16 @@ class t3lib_install_Sql {
 
                foreach ($lines as $value) {
                        if (substr($value, 0, 1) == '#') {
-                               continue; // Ignore comments
+                                       // Ignore comments
+                               continue;
                        }
 
                        if (!strlen($table)) {
                                $parts = t3lib_div::trimExplode(' ', $value, TRUE);
                                if (strtoupper($parts[0]) === 'CREATE' && strtoupper($parts[1]) === 'TABLE') {
                                        $table = str_replace('`', '', $parts[2]);
-                                       if (TYPO3_OS == 'WIN') { // tablenames are always lowercase on windows!
+                                               // tablenames are always lowercase on windows!
+                                       if (TYPO3_OS == 'WIN') {
                                                $table = strtolower($table);
                                        }
                                }
@@ -121,14 +123,18 @@ class t3lib_install_Sql {
                                                $total[$table]['extra']['COLLATE'] = $this->getCollationForCharset($charset);
                                        }
 
-                                       $table = ''; // Remove table marker and start looking for the next "CREATE TABLE" statement
+                                               // Remove table marker and start looking for the next "CREATE TABLE" statement
+                                       $table = '';
                                } else {
-                                       $lineV = preg_replace('/,$/', '', $value); // Strip trailing commas
+                                               // Strip trailing commas
+                                       $lineV = preg_replace('/,$/', '', $value);
                                        $lineV = str_replace('`', '', $lineV);
-                                       $lineV = str_replace('  ', ' ', $lineV); // Remove double blanks
+                                               // Remove double blanks
+                                       $lineV = str_replace('  ', ' ', $lineV);
 
                                        $parts = explode(' ', $lineV, 2);
-                                       if (!preg_match('/(PRIMARY|UNIQUE|FULLTEXT|INDEX|KEY)/', $parts[0])) { // Field definition
+                                               // Field definition
+                                       if (!preg_match('/(PRIMARY|UNIQUE|FULLTEXT|INDEX|KEY)/', $parts[0])) {
 
                                                        // Make sure there is no default value when auto_increment is set
                                                if (stristr($parts[1], 'auto_increment')) {
@@ -179,7 +185,7 @@ class t3lib_install_Sql {
         * Useful if you want to use UTF-8 in the database and needs to extend the field sizes in the database so UTF-8 chars are not discarded. For most charsets available as single byte sets, multiplication with 2 should be enough. For chinese, use 3.
         *
         * @param array $total Total array (from getFieldDefinitions_fileContent())
-        * @return      void
+        * @return void
         * @access private
         * @see getFieldDefinitions_fileContent()
         */
@@ -259,7 +265,8 @@ class t3lib_install_Sql {
                        if (method_exists($GLOBALS['TYPO3_DB'], 'admin_get_charsets')) {
                                $this->character_sets = $GLOBALS['TYPO3_DB']->admin_get_charsets();
                        } else {
-                               $this->character_sets[$charset] = array(); // Add empty element to avoid that the check will be repeated
+                                       // Add empty element to avoid that the check will be repeated
+                               $this->character_sets[$charset] = array();
                        }
                }
 
@@ -287,13 +294,13 @@ class t3lib_install_Sql {
                $tables = $GLOBALS['TYPO3_DB']->admin_get_tables(TYPO3_db);
                foreach ($tables as $tableName => $tableStatus) {
 
-                               // Fields:
+                               // Fields
                        $fieldInformation = $GLOBALS['TYPO3_DB']->admin_get_fields($tableName);
                        foreach ($fieldInformation as $fN => $fieldRow) {
                                $total[$tableName]['fields'][$fN] = $this->assembleFieldDefinition($fieldRow);
                        }
 
-                               // Keys:
+                               // Keys
                        $keyInformation = $GLOBALS['TYPO3_DB']->admin_get_keys($tableName);
 
                        foreach ($keyInformation as $keyRow) {
@@ -364,7 +371,8 @@ class t3lib_install_Sql {
                        foreach ($FDsrc as $table => $info) {
                                if (!strlen($onlyTableList) || t3lib_div::inList($onlyTableList, $table)) {
                                        if (!isset($FDcomp[$table])) {
-                                               $extraArr[$table] = $info; // If the table was not in the FDcomp-array, the result array is loaded with that table.
+                                                       // If the table was not in the FDcomp-array, the result array is loaded with that table.
+                                               $extraArr[$table] = $info;
                                                $extraArr[$table]['whole_table'] = 1;
                                        } else {
                                                $keyTypes = explode(',', 'extra,fields,keys');
@@ -373,7 +381,8 @@ class t3lib_install_Sql {
                                                                foreach ($info[$theKey] as $fieldN => $fieldC) {
                                                                        $fieldN = str_replace('`', '', $fieldN);
                                                                        if ($fieldN == 'COLLATE') {
-                                                                               continue; // TODO: collation support is currently disabled (needs more testing)
+                                                                                       // TODO: collation support is currently disabled (needs more testing)
+                                                                               continue;
                                                                        }
 
                                                                        if (!isset($FDcomp[$table][$theKey][$fieldN])) {
@@ -529,7 +538,7 @@ class t3lib_install_Sql {
                                                                $statement = 'DROP TABLE ' . $table . ';';
                                                                $statements['drop_table'][md5($statement)] = $statement;
                                                        }
-                                                               // count:
+                                                               // Count
                                                        $count = $GLOBALS['TYPO3_DB']->exec_SELECTcountRows('*', $table);
                                                        $statements['tables_count'][md5($statement)] = $count ? 'Records in table: ' . $count : '';
                                                } else {
@@ -537,9 +546,11 @@ class t3lib_install_Sql {
                                                        if ($info['extra']) {
                                                                foreach ($info['extra'] as $k => $v) {
                                                                        if ($k == 'COLLATE' || $k == 'CLEAR') {
-                                                                               continue; // Skip these special statements. TODO: collation support is currently disabled (needs more testing)
+                                                                                       // Skip these special statements. TODO: collation support is currently disabled (needs more testing)
+                                                                               continue;
                                                                        }
-                                                                       $statement .= ' ' . $k . '=' . $v; // Add extra attributes like ENGINE, CHARSET, etc.
+                                                                               // Add extra attributes like ENGINE, CHARSET, etc.
+                                                                       $statement .= ' ' . $k . '=' . $v;
                                                                }
                                                        }
                                                        $statement .= ';';
@@ -600,7 +611,7 @@ class t3lib_install_Sql {
                foreach ($sqlcodeArr as $line => $lineContent) {
                        $is_set = 0;
 
-                               // auto_increment fields cannot have a default value!
+                               // Auto_increment fields cannot have a default value!
                        if (stristr($lineContent, 'auto_increment')) {
                                $lineContent = preg_replace('/ default \'0\'/i', '', $lineContent);
                        }
@@ -640,7 +651,7 @@ class t3lib_install_Sql {
                        if (preg_match('/^create[[:space:]]*table[[:space:]]*[`]?([[:alnum:]_]*)[`]?/i', substr($lineContent, 0, 100), $reg)) {
                                $table = trim($reg[1]);
                                if ($table) {
-                                               // table names are always lowercase on Windows!
+                                               // Table names are always lowercase on Windows!
                                        if (TYPO3_OS == 'WIN') {
                                                $table = strtolower($table);
                                        }
index e3ee530..1d6dec7 100644 (file)
  *
  * Revised for TYPO3 3.6 September/2003 by Kasper Skårhøj
  *
- * @author     Kasper Skårhøj <kasperYYYY@typo3.com>
+ * @author Kasper Skårhøj <kasperYYYY@typo3.com>
  */
 
-
 /**
  * Load database groups (relations)
  * Used to process the relations created by the TCA element types "group" and "select" for database records. Manages MM-relations as well.
  *
- * @author     Kasper Skårhøj <kasperYYYY@typo3.com>
+ * @author Kasper Skårhøj <kasperYYYY@typo3.com>
  * @package TYPO3
  * @subpackage t3lib
  */
 class t3lib_loadDBGroup {
-               // External, static:
-       var $fromTC = 1; // Means that only uid and the label-field is returned
-       var $registerNonTableValues = 0; // If set, values that are not ids in tables are normally discarded. By this options they will be preserved.
+               // External, static
+               // Means that only uid and the label-field is returned
+       var $fromTC = 1;
+               // If set, values that are not ids in tables are normally discarded. By this options they will be preserved.
+       var $registerNonTableValues = 0;
 
                // Internal, dynamic:
-       var $tableArray = Array(); // Contains the table names as keys. The values are the id-values for each table. Should ONLY contain proper table names.
-       var $itemArray = Array(); // Contains items in an numeric array (table/id for each). Tablenames here might be "_NO_TABLE"
-       var $nonTableArray = array(); // Array for NON-table elements
+               // Contains the table names as keys. The values are the id-values for each table. Should ONLY contain proper table names.
+       var $tableArray = array();
+               // Contains items in an numeric array (table/id for each). Tablenames here might be "_NO_TABLE"
+       var $itemArray = array();
+               // Array for NON-table elements
+       var $nonTableArray = array();
        var $additionalWhere = array();
-       var $checkIfDeleted = 1; // deleted-column is added to additionalWhere... if this is set...
-       var $dbPaths = Array();
-       var $firstTable = ''; // Will contain the first table name in the $tablelist (for positive ids)
-       var $secondTable = ''; // Will contain the second table name in the $tablelist (for negative ids)
+               // Deleted-column is added to additionalWhere... if this is set...
+       var $checkIfDeleted = 1;
+       var $dbPaths = array();
+               // Will contain the first table name in the $tablelist (for positive ids)
+       var $firstTable = '';
+               // Will contain the second table name in the $tablelist (for negative ids)
+       var $secondTable = '';
                // private
-       var $MM_is_foreign = 0; // boolean - if 1, uid_local and uid_foreign are switched, and the current table is inserted as tablename - this means you display a foreign relation "from the opposite side"
-       var $MM_oppositeField = ''; // field name at the "local" side of the MM relation
-       var $MM_oppositeTable = ''; // only set if MM_is_foreign is set
-       var $MM_oppositeFieldConf = ''; // only set if MM_is_foreign is set
-       var $MM_isMultiTableRelationship = 0; // is empty by default; if MM_is_foreign is set and there is more than one table allowed (on the "local" side), then it contains the first table (as a fallback)
-       var $currentTable; // current table => Only needed for reverse relations
-       var $undeleteRecord; // if a record should be undeleted (so do not use the $useDeleteClause on t3lib_BEfunc)
-
-
-       var $MM_match_fields = array(); // array of fields value pairs that should match while SELECT and will be written into MM table if $MM_insert_fields is not set
-       var $MM_insert_fields = array(); // array of fields and value pairs used for insert in MM table
-       var $MM_table_where = ''; // extra MM table where
+               // Boolean - if 1, uid_local and uid_foreign are switched, and the current table is inserted as tablename - this means you display a foreign relation "from the opposite side"
+       var $MM_is_foreign = 0;
+               // Field name at the "local" side of the MM relation
+       var $MM_oppositeField = '';
+               // Only set if MM_is_foreign is set
+       var $MM_oppositeTable = '';
+               // Only set if MM_is_foreign is set
+       var $MM_oppositeFieldConf = '';
+               // Is empty by default; if MM_is_foreign is set and there is more than one table allowed (on the "local" side), then it contains the first table (as a fallback)
+       var $MM_isMultiTableRelationship = 0;
+               // Current table => Only needed for reverse relations
+       var $currentTable;
+               // If a record should be undeleted (so do not use the $useDeleteClause on t3lib_BEfunc)
+       var $undeleteRecord;
+
+               // Array of fields value pairs that should match while SELECT and will be written into MM table if $MM_insert_fields is not set
+       var $MM_match_fields = array();
+               // Array of fields and value pairs used for insert in MM table
+       var $MM_insert_fields = array();
+               // Extra MM table where
+       var $MM_table_where = '';
 
        /**
         * @var boolean
@@ -77,13 +93,13 @@ class t3lib_loadDBGroup {
        /**
         * Initialization of the class.
         *
-        * @param       string          List of group/select items
-        * @param       string          Comma list of tables, first table takes priority if no table is set for an entry in the list.
-        * @param       string          Name of a MM table.
-        * @param       integer         Local UID for MM lookup
-        * @param       string          current table name
-        * @param       integer         TCA configuration for current field
-        * @return      void
+        * @param string $itemlist List of group/select items
+        * @param string $tablelist Comma list of tables, first table takes priority if no table is set for an entry in the list.
+        * @param string $MMtable Name of a MM table.
+        * @param integer $MMuid Local UID for MM lookup
+        * @param string $currentTable Current table name
+        * @param integer $conf TCA configuration for current field
+        * @return void
         */
        function start($itemlist, $tablelist, $MMtable = '', $MMuid = 0, $currentTable = '', $conf = array()) {
                        // SECTION: MM reverse relations
@@ -97,12 +113,12 @@ class t3lib_loadDBGroup {
                $this->currentTable = $currentTable;
                if ($this->MM_is_foreign) {
                        $tmp = ($conf['type'] === 'group' ? $conf['allowed'] : $conf['foreign_table']);
-                               // normally, $conf['allowed'] can contain a list of tables, but as we are looking at a MM relation from the foreign side, it only makes sense to allow one one table in $conf['allowed']
+                               // Normally, $conf['allowed'] can contain a list of tables, but as we are looking at a MM relation from the foreign side, it only makes sense to allow one one table in $conf['allowed']
                        $tmp = t3lib_div::trimExplode(',', $tmp);
                        $this->MM_oppositeTable = $tmp[0];
                        unset($tmp);
 
-                               // only add the current table name if there is more than one allowed field
+                               // Only add the current table name if there is more than one allowed field
                        t3lib_div::loadTCA($this->MM_oppositeTable); // We must be sure this has been done at least once before accessing the "columns" part of TCA for a table.
                        $this->MM_oppositeFieldConf = $GLOBALS['TCA'][$this->MM_oppositeTable]['columns'][$this->MM_oppositeField]['config'];
 
@@ -139,12 +155,15 @@ class t3lib_loadDBGroup {
                }
 
                        // Set first and second tables:
-               $this->firstTable = key($this->tableArray); // Is the first table
+                       // Is the first table
+               $this->firstTable = key($this->tableArray);
                next($this->tableArray);
-               $this->secondTable = key($this->tableArray); // If the second table is set and the ID number is less than zero (later) then the record is regarded to come from the second table...
+                       // If the second table is set and the ID number is less than zero (later) then the record is regarded to come from the second table...
+               $this->secondTable = key($this->tableArray);
 
                        // Now, populate the internal itemArray and tableArray arrays:
-               if ($MMtable) { // If MM, then call this function to do that:
+                       // If MM, then call this function to do that:
+               if ($MMtable) {
                        if ($MMuid) {
                                $this->readMM($MMtable, $MMuid);
                        } else { // Revert to readList() for new records in order to load possible default values from $itemlist
@@ -156,7 +175,7 @@ class t3lib_loadDBGroup {
                } else {
                                // If not MM, then explode the itemlist by "," and traverse the list:
                        $this->readList($itemlist);
-                               // do automatic default_sortby, if any
+                               // Do automatic default_sortby, if any
                        if ($conf['foreign_default_sortby']) {
                                $this->sortList($conf['foreign_default_sortby']);
                        }
@@ -176,14 +195,15 @@ class t3lib_loadDBGroup {
        /**
         * Explodes the item list and stores the parts in the internal arrays itemArray and tableArray from MM records.
         *
-        * @param       string          Item list
-        * @return      void
+        * @param string $itemlist Item list
+        * @return void
         */
        function readList($itemlist) {
                if ((string) trim($itemlist) != '') {
                        $tempItemArray = t3lib_div::trimExplode(',', $itemlist); // Changed to trimExplode 31/3 04; HMENU special type "list" didn't work if there were spaces in the list... I suppose this is better overall...
                        foreach ($tempItemArray as $key => $val) {
-                               $isSet = 0; // Will be set to "1" if the entry was a real table/id:
+                                       // Will be set to "1" if the entry was a real table/id:
+                               $isSet = 0;
 
                                        // Extract table name and id. This is un the formular [tablename]_[id] where table name MIGHT contain "_", hence the reversion of the string!
                                $val = strrev($val);
@@ -222,14 +242,14 @@ class t3lib_loadDBGroup {
         * This is only used for automatic sorting of comma separated lists.
         * This function is only relevant for data that is stored in comma separated lists!
         *
-        * @param       string          $sortby: The default_sortby field/command (e.g. 'price DESC')
-        * @return      void
+        * @param string $sortby The default_sortby field/command (e.g. 'price DESC')
+        * @return void
         */
        function sortList($sortby) {
-                       // sort directly without fetching addional data
+                       // Sort directly without fetching addional data
                if ($sortby == 'uid') {
                        usort($this->itemArray, create_function('$a,$b', 'return $a["id"] < $b["id"] ? -1 : 1;'));
-                               // only useful if working on the same table
+                               // Only useful if working on the same table
                } elseif (count($this->tableArray) == 1) {
                        reset($this->tableArray);
                        $table = key($this->tableArray);
@@ -253,28 +273,30 @@ class t3lib_loadDBGroup {
         * Reads the record tablename/id into the internal arrays itemArray and tableArray from MM records.
         * You can call this function after start if you supply no list to start()
         *
-        * @param       string          MM Tablename
-        * @param       integer         Local UID
-        * @return      void
+        * @param string $tableName MM Tablename
+        * @param integer $uid Local UID
+        * @return void
         */
        function readMM($tableName, $uid) {
                $key = 0;
                $additionalWhere = '';
 
-               if ($this->MM_is_foreign) { // in case of a reverse relation
+                       // In case of a reverse relation
+               if ($this->MM_is_foreign) {
                        $uidLocal_field = 'uid_foreign';
                        $uidForeign_field = 'uid_local';
                        $sorting_field = 'sorting_foreign';
 
                        if ($this->MM_isMultiTableRelationship) {
                                $additionalWhere .= ' AND ( tablenames=' . $GLOBALS['TYPO3_DB']->fullQuoteStr($this->currentTable, $tableName);
-                               if ($this->currentTable == $this->MM_isMultiTableRelationship) { // be backwards compatible! When allowing more than one table after having previously allowed only one table, this case applies.
+                                       // Be backwards compatible! When allowing more than one table after having previously allowed only one table, this case applies.
+                               if ($this->currentTable == $this->MM_isMultiTableRelationship) {
                                        $additionalWhere .= ' OR tablenames=\'\'';
                                }
                                $additionalWhere .= ' ) ';
                        }
                        $theTable = $this->MM_oppositeTable;
-               } else { // default
+               } else { // Default
                        $uidLocal_field = 'uid_local';
                        $uidForeign_field = 'uid_foreign';
                        $sorting_field = 'sorting';
@@ -291,8 +313,10 @@ class t3lib_loadDBGroup {
                        // Select all MM relations:
                $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery('*', $tableName, $uidLocal_field . '=' . intval($uid) . $additionalWhere, '', $sorting_field);
                while ($row = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res)) {
-                       if (!$this->MM_is_foreign) { // default
-                               $theTable = $row['tablenames'] ? $row['tablenames'] : $this->firstTable; // If tablesnames columns exists and contain a name, then this value is the table, else it's the firstTable...
+                               // Default
+                       if (!$this->MM_is_foreign) {
+                                       // If tablesnames columns exists and contain a name, then this value is the table, else it's the firstTable...
+                               $theTable = $row['tablenames'] ? $row['tablenames'] : $this->firstTable;
                        }
                        if (($row[$uidForeign_field] || $theTable == 'pages') && $theTable && isset($this->tableArray[$theTable])) {
 
@@ -312,14 +336,15 @@ class t3lib_loadDBGroup {
        /**
         * Writes the internal itemArray to MM table:
         *
-        * @param       string          MM table name
-        * @param       integer         Local UID
-        * @param       boolean         If set, then table names will always be written.
-        * @return      void
+        * @param string $MM_tableName MM table name
+        * @param integer $uid Local UID
+        * @param boolean $prependTableName If set, then table names will always be written.
+        * @return void
         */
        function writeMM($MM_tableName, $uid, $prependTableName = 0) {
 
-               if ($this->MM_is_foreign) { // in case of a reverse relation
+                       // In case of a reverse relation
+               if ($this->MM_is_foreign) {
                        $uidLocal_field = 'uid_foreign';
                        $uidForeign_field = 'uid_local';
                        $sorting_field = 'sorting_foreign';
@@ -332,7 +357,8 @@ class t3lib_loadDBGroup {
                        // If there are tables...
                $tableC = count($this->tableArray);
                if ($tableC) {
-                       $prep = ($tableC > 1 || $prependTableName || $this->MM_isMultiTableRelationship) ? 1 : 0; // boolean: does the field "tablename" need to be filled?
+                               // Boolean: does the field "tablename" need to be filled?
+                       $prep = ($tableC > 1 || $prependTableName || $this->MM_isMultiTableRelationship) ? 1 : 0;
                        $c = 0;
 
                        $additionalWhere_tablenames = '';
@@ -341,7 +367,7 @@ class t3lib_loadDBGroup {
                        }
 
                        $additionalWhere = '';
-                               // add WHERE clause if configured
+                               // Add WHERE clause if configured
                        if ($this->MM_table_where) {
                                $additionalWhere .= LF . str_replace('###THIS_UID###', intval($uid), $this->MM_table_where);
                        }
@@ -359,7 +385,11 @@ class t3lib_loadDBGroup {
                        );
 
                        $oldMMs = array();
-                       $oldMMs_inclUid = array(); // This array is similar to $oldMMs but also holds the uid of the MM-records, if any (configured by MM_hasUidField). If the UID is present it will be used to update sorting and delete MM-records. This is necessary if the "multiple" feature is used for the MM relations. $oldMMs is still needed for the in_array() search used to look if an item from $this->itemArray is in $oldMMs
+                               // This array is similar to $oldMMs but also holds the uid of the MM-records, if any (configured by MM_hasUidField).
+                               // If the UID is present it will be used to update sorting and delete MM-records.
+                               // This is necessary if the "multiple" feature is used for the MM relations.
+                               // $oldMMs is still needed for the in_array() search used to look if an item from $this->itemArray is in $oldMMs
+                       $oldMMs_inclUid = array();
                        while ($row = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res)) {
                                if (!$this->MM_is_foreign && $prep) {
                                        $oldMMs[] = array($row['tablenames'], $row[$uidForeign_field]);
@@ -374,7 +404,8 @@ class t3lib_loadDBGroup {
                                $c++;
 
                                if ($prep || $val['table'] == '_NO_TABLE') {
-                                       if ($this->MM_is_foreign) { // insert current table if needed
+                                               // Insert current table if needed
+                                       if ($this->MM_is_foreign) {
                                                $tablename = $this->currentTable;
                                        } else {
                                                $tablename = $val['table'];
@@ -391,16 +422,18 @@ class t3lib_loadDBGroup {
 
                                if (in_array($item, $oldMMs)) {
                                        $oldMMs_index = array_search($item, $oldMMs);
-
+                                               // In principle, selecting on the UID is all we need to do if a uid field is available since that is unique! But as long as it "doesn't hurt" we just add it to the where clause. It should all match up.
                                        $whereClause = $uidLocal_field . '=' . $uid . ' AND ' . $uidForeign_field . '=' . $val['id'] .
-                                                               ($this->MM_hasUidField ? ' AND uid=' . intval($oldMMs_inclUid[$oldMMs_index][2]) : ''); // In principle, selecting on the UID is all we need to do if a uid field is available since that is unique! But as long as it "doesn't hurt" we just add it to the where clause. It should all match up.
+                                                               ($this->MM_hasUidField ? ' AND uid=' . intval($oldMMs_inclUid[$oldMMs_index][2]) : '');
                                        if ($tablename) {
                                                $whereClause .= ' AND tablenames=' . $GLOBALS['TYPO3_DB']->fullQuoteStr($tablename, $MM_tableName);
                                        }
                                        $GLOBALS['TYPO3_DB']->exec_UPDATEquery($MM_tableName, $whereClause . $additionalWhere, array($sorting_field => $c));
 
-                                       unset($oldMMs[$oldMMs_index]); // remove the item from the $oldMMs array so after this foreach loop only the ones that need to be deleted are in there.
-                                       unset($oldMMs_inclUid[$oldMMs_index]); // remove the item from the $oldMMs array so after this foreach loop only the ones that need to be deleted are in there.
+                                               // Remove the item from the $oldMMs array so after this foreach loop only the ones that need to be deleted are in there.
+                                       unset($oldMMs[$oldMMs_index]);
+                                               // Remove the item from the $oldMMs array so after this foreach loop only the ones that need to be deleted are in there.
+                                       unset($oldMMs_inclUid[$oldMMs_index]);
                                } else {
 
                                        $insertFields = $this->MM_insert_fields;
@@ -424,7 +457,8 @@ class t3lib_loadDBGroup {
                                $removeClauses = array();
                                $updateRefIndex_records = array();
                                foreach ($oldMMs as $oldMM_key => $mmItem) {
-                                       if ($this->MM_hasUidField) { // If UID field is present, of course we need only use that for deleting...:
+                                               // If UID field is present, of course we need only use that for deleting.
+                                       if ($this->MM_hasUidField) {
                                                $removeClauses[] = 'uid=' . intval($oldMMs_inclUid[$oldMM_key][2]);
                                                $elDelete = $oldMMs_inclUid[$oldMM_key];
                                        } else {
@@ -451,7 +485,8 @@ class t3lib_loadDBGroup {
                                }
                        }
 
-                               // Update ref index; In tcemain it is not certain that this will happen because if only the MM field is changed the record itself is not updated and so the ref-index is not either. This could also have been fixed in updateDB in tcemain, however I decided to do it here ...
+                               // Update ref index; In tcemain it is not certain that this will happen because if only the MM field is changed the record itself is not updated and so the ref-index is not either.
+                               // This could also have been fixed in updateDB in tcemain, however I decided to do it here ...
                        $this->updateRefIndex($this->currentTable, $uid);
                }
        }
@@ -460,15 +495,15 @@ class t3lib_loadDBGroup {
         * Remaps MM table elements from one local uid to another
         * Does NOT update the reference index for you, must be called subsequently to do that!
         *
-        * @param       string          MM table name
-        * @param       integer         Local, current UID
-        * @param       integer         Local, new UID
-        * @param       boolean         If set, then table names will always be written.
-        * @return      void
+        * @param string $MM_tableName MM table name
+        * @param integer $uid Local, current UID
+        * @param integer $newUid Local, new UID
+        * @param boolean $prependTableName If set, then table names will always be written.
+        * @return void
         */
        function remapMM($MM_tableName, $uid, $newUid, $prependTableName = 0) {
-
-               if ($this->MM_is_foreign) { // in case of a reverse relation
+                       // In case of a reverse relation
+               if ($this->MM_is_foreign) {
                        $uidLocal_field = 'uid_foreign';
                } else { // default
                        $uidLocal_field = 'uid_local';
@@ -477,7 +512,8 @@ class t3lib_loadDBGroup {
                        // If there are tables...
                $tableC = count($this->tableArray);
                if ($tableC) {
-                       $prep = ($tableC > 1 || $prependTableName || $this->MM_isMultiTableRelationship) ? 1 : 0; // boolean: does the field "tablename" need to be filled?
+                               // Boolean: does the field "tablename" need to be filled?
+                       $prep = ($tableC > 1 || $prependTableName || $this->MM_isMultiTableRelationship) ? 1 : 0;
                        $c = 0;
 
                        $additionalWhere_tablenames = '';
@@ -486,7 +522,7 @@ class t3lib_loadDBGroup {
                        }
 
                        $additionalWhere = '';
-                               // add WHERE clause if configured
+                               // Add WHERE clause if configured
                        if ($this->MM_table_where) {
                                $additionalWhere .= LF . str_replace('###THIS_UID###', intval($uid), $this->MM_table_where);
                        }
@@ -503,9 +539,9 @@ class t3lib_loadDBGroup {
         * Reads items from a foreign_table, that has a foreign_field (uid of the parent record) and
         * stores the parts in the internal array itemArray and tableArray.
         *
-        * @param       integer         $uid: The uid of the parent record (this value is also on the foreign_table in the foreign_field)
-        * @param       array           $conf: TCA configuration for current field
-        * @return      void
+        * @param integer $uid The uid of the parent record (this value is also on the foreign_table in the foreign_field)
+        * @param array $conf TCA configuration for current field
+        * @return void
         */
        function readForeignField($uid, $conf) {
                $key = 0;
@@ -516,17 +552,17 @@ class t3lib_loadDBGroup {
                $useDeleteClause = $this->undeleteRecord ? FALSE : TRUE;
                $foreign_match_fields = is_array($conf['foreign_match_fields']) ? $conf['foreign_match_fields'] : array();
 
-                       // search for $uid in foreign_field, and if we have symmetric relations, do this also on symmetric_field
+                       // Search for $uid in foreign_field, and if we have symmetric relations, do this also on symmetric_field
                if ($conf['symmetric_field']) {
                        $whereClause = '(' . $conf['foreign_field'] . '=' . $uid . ' OR ' . $conf['symmetric_field'] . '=' . $uid . ')';
                } else {
                        $whereClause = $conf['foreign_field'] . '=' . $uid;
                }
-                       // use the deleteClause (e.g. "deleted=0") on this table
+                       // Use the deleteClause (e.g. "deleted=0") on this table
                if ($useDeleteClause) {
                        $whereClause .= t3lib_BEfunc::deleteClause($foreign_table);
                }
-                       // if it's requested to look for the parent uid AND the parent table,
+                       // If it's requested to look for the parent uid AND the parent table,
                        // add an additional SQL-WHERE clause
                if ($foreign_table_field && $this->currentTable) {
                        $whereClause .= ' AND ' . $foreign_table_field . '=' . $GLOBALS['TYPO3_DB']->fullQuoteStr($this->currentTable, $foreign_table);
@@ -543,10 +579,11 @@ class t3lib_loadDBGroup {
                        $whereClause .= t3lib_BEfunc::getWorkspaceWhereClause($foreign_table, $currentRecord['t3ver_wsid']);
                }
 
-                       // get the correct sorting field
-               if ($conf['foreign_sortby']) { // specific manual sortby for data handled by this field
+                       // Get the correct sorting field
+                       // Specific manual sortby for data handled by this field
+               if ($conf['foreign_sortby']) {
                        if ($conf['symmetric_sortby'] && $conf['symmetric_field']) {
-                                       // sorting depends on, from which side of the relation we're looking at it
+                                       // Sorting depends on, from which side of the relation we're looking at it
                                $sortby = '
                                        CASE
                                                WHEN ' . $conf['foreign_field'] . '=' . $uid . '
@@ -554,20 +591,20 @@ class t3lib_loadDBGroup {
                                                ELSE ' . $conf['symmetric_sortby'] . '
                                        END';
                        } else {
-                                       // regular single-side behaviour
+                                       // Regular single-side behaviour
                                $sortby = $conf['foreign_sortby'];
                        }
-               } elseif ($conf['foreign_default_sortby']) { // specific default sortby for data handled by this field
+               } elseif ($conf['foreign_default_sortby']) { // Specific default sortby for data handled by this field
                        $sortby = $conf['foreign_default_sortby'];
-               } elseif ($GLOBALS['TCA'][$foreign_table]['ctrl']['sortby']) { // manual sortby for all table records
+               } elseif ($GLOBALS['TCA'][$foreign_table]['ctrl']['sortby']) { // Manual sortby for all table records
                        $sortby = $GLOBALS['TCA'][$foreign_table]['ctrl']['sortby'];
-               } elseif ($GLOBALS['TCA'][$foreign_table]['ctrl']['default_sortby']) { // default sortby for all table records
+               } elseif ($GLOBALS['TCA'][$foreign_table]['ctrl']['default_sortby']) { // Default sortby for all table records
                        $sortby = $GLOBALS['TCA'][$foreign_table]['ctrl']['default_sortby'];
                }
 
-                       // strip a possible "ORDER BY" in front of the $sortby value
+                       // Strip a possible "ORDER BY" in front of the $sortby value
                $sortby = $GLOBALS['TYPO3_DB']->stripOrderBy($sortby);
-                       // get the rows from storage
+                       // Get the rows from storage
                $rows = $GLOBALS['TYPO3_DB']->exec_SELECTgetRows('uid', $foreign_table, $whereClause, '', $sortby);
 
                if (count($rows)) {
@@ -583,11 +620,11 @@ class t3lib_loadDBGroup {
        /**
         * Write the sorting values to a foreign_table, that has a foreign_field (uid of the parent record)
         *
-        * @param       array           $conf: TCA configuration for current field
-        * @param       integer         $parentUid: The uid of the parent record
-        * @param       boolean         $updateToUid: Whether to update the foreign field with the $parentUid (on Copy)
-        * @param        boolean                $skipSorting: Do not update the sorting columns, this could happen for imported values
-        * @return      void
+        * @param array $conf TCA configuration for current field
+        * @param integer $parentUid The uid of the parent record
+        * @param boolean $updateToUid Whether to update the foreign field with the $parentUid (on Copy)
+        * @param boolean $skipSorting Do not update the sorting columns, this could happen for imported values
+        * @return void
         */
        function writeForeignField($conf, $parentUid, $updateToUid = 0, $skipSorting = FALSE) {
                $c = 0;
@@ -597,9 +634,9 @@ class t3lib_loadDBGroup {
                $foreign_table_field = $conf['foreign_table_field'];
                $foreign_match_fields = is_array($conf['foreign_match_fields']) ? $conf['foreign_match_fields'] : array();
 
-                       // if there are table items and we have a proper $parentUid
+                       // If there are table items and we have a proper $parentUid
                if (t3lib_utility_Math::canBeInterpretedAsInteger($parentUid) && count($this->tableArray)) {
-                               // if updateToUid is not a positive integer, set it to '0', so it will be ignored
+                               // If updateToUid is not a positive integer, set it to '0', so it will be ignored
                        if (!(t3lib_utility_Math::canBeInterpretedAsInteger($updateToUid) && $updateToUid > 0)) {
                                $updateToUid = 0;
                        }
@@ -616,12 +653,12 @@ class t3lib_loadDBGroup {
                                $fields .= ',' . 't3ver_state,t3ver_oid';
                        }
 
-                               // update all items
+                               // Update all items
                        foreach ($this->itemArray as $val) {
                                $uid = $val['id'];
                                $table = $val['table'];
 
-                                       // fetch the current (not overwritten) relation record if we should handle symmetric relations
+                                       // Fetch the current (not overwritten) relation record if we should handle symmetric relations
                                if ($symmetric_field || $considerWorkspaces) {
                                        $row = t3lib_BEfunc::getRecord($table, $uid, $fields, '', FALSE);
                                }
@@ -632,7 +669,7 @@ class t3lib_loadDBGroup {
                                $updateValues = $foreign_match_fields;
                                $workspaceValues = array();
 
-                                       // no update to the uid is requested, so this is the normal behaviour
+                                       // No update to the uid is requested, so this is the normal behaviour
                                        // just update the fields and care about sorting
                                if (!$updateToUid) {
                                                // Always add the pointer to the parent uid
@@ -642,15 +679,16 @@ class t3lib_loadDBGroup {
                                                $updateValues[$foreign_field] = $parentUid;
                                        }
 
-                                               // if it is configured in TCA also to store the parent table in the child record, just do it
+                                               // If it is configured in TCA also to store the parent table in the child record, just do it
                                        if ($foreign_table_field && $this->currentTable) {
                                                $updateValues[$foreign_table_field] = $this->currentTable;
                                        }
 
-                                               // update sorting columns if not to be skipped
+                                               // Update sorting columns if not to be skipped
                                        if (!$skipSorting) {
-                                                       // get the correct sorting field
-                                               if ($conf['foreign_sortby']) { // specific manual sortby for data handled by this field
+                                                       // Get the correct sorting field
+                                                       // Specific manual sortby for data handled by this field
+                                               if ($conf['foreign_sortby']) {
                                                        $sortby = $conf['foreign_sortby'];
                                                } elseif ($GLOBALS['TCA'][$foreign_table]['ctrl']['sortby']) { // manual sortby for all table records
                                                        $sortby = $GLOBALS['TCA'][$foreign_table]['ctrl']['sortby'];
@@ -668,7 +706,7 @@ class t3lib_loadDBGroup {
                                                }
                                        }
 
-                                               // update to a foreign_field/symmetric_field pointer is requested, normally used on record copies
+                                               // Update to a foreign_field/symmetric_field pointer is requested, normally used on record copies
                                                // only update the fields, if the old uid is found somewhere - for select fields, TCEmain is doing this already!
                                } else {
                                        if ($isOnSymmetricSide) {
@@ -696,8 +734,8 @@ class t3lib_loadDBGroup {
        /**
         * After initialization you can extract an array of the elements from the object. Use this function for that.
         *
-        * @param       boolean         If set, then table names will ALWAYS be prepended (unless its a _NO_TABLE value)
-        * @return      array           A numeric array.
+        * @param boolean $prependTableName If set, then table names will ALWAYS be prepended (unless its a _NO_TABLE value)
+        * @return array A numeric array.
         */
        function getValueArray($prependTableName = '') {
                        // INIT:
@@ -722,10 +760,10 @@ class t3lib_loadDBGroup {
        /**
         * Converts id numbers from negative to positive.
         *
-        * @param       array           Array of [table]_[id] pairs.
-        * @param       string          Foreign table (the one used for positive numbers)
-        * @param       string          NEGative foreign table
-        * @return      array           The array with ID integer values, converted to positive for those where the table name was set but did NOT match the positive foreign table.
+        * @param array $valueArray Array of [table]_[id] pairs.
+        * @param string $fTable Foreign table (the one used for positive numbers)
+        * @param string $nfTable Negative foreign table
+        * @return array The array with ID integer values, converted to positive for those where the table name was set but did NOT match the positive foreign table.
         */
        function convertPosNeg($valueArray, $fTable, $nfTable) {
                if (is_array($valueArray) && $fTable) {
@@ -759,13 +797,16 @@ class t3lib_loadDBGroup {
                                        if ($this->fromTC) {
                                                $from = 'uid,pid';
                                                if ($GLOBALS['TCA'][$key]['ctrl']['label']) {
-                                                       $from .= ',' . $GLOBALS['TCA'][$key]['ctrl']['label']; // Titel
+                                                               // Titel
+                                                       $from .= ',' . $GLOBALS['TCA'][$key]['ctrl']['label'];
                                                }
                                                if ($GLOBALS['TCA'][$key]['ctrl']['label_alt']) {
-                                                       $from .= ',' . $GLOBALS['TCA'][$key]['ctrl']['label_alt']; // Alternative Title-Fields
+                                                               // Alternative Title-Fields
+                                                       $from .= ',' . $GLOBALS['TCA'][$key]['ctrl']['label_alt'];
                                                }
                                                if ($GLOBALS['TCA'][$key]['ctrl']['thumbnail']) {
-                                                       $from .= ',' . $GLOBALS['TCA'][$key]['ctrl']['thumbnail']; // Thumbnail
+                                                               // Thumbnail
+                                                       $from .= ',' . $GLOBALS['TCA'][$key]['ctrl']['thumbnail'];
                                                }
                                        }
                                        $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery($from, $key, 'uid IN (' . $itemList . ')' . $this->additionalWhere[$key]);
@@ -781,7 +822,7 @@ class t3lib_loadDBGroup {
        /**
         * Prepare items from itemArray to be transferred to the TCEforms interface (as a comma list)
         *
-        * @return      string
+        * @return string
         * @see t3lib_transferdata::renderRecord()
         */
        function readyForInterface() {
@@ -790,7 +831,8 @@ class t3lib_loadDBGroup {
                }
 
                $output = array();
-               $perms_clause = $GLOBALS['BE_USER']->getPagePermsClause(1); // For use when getting the paths....
+                       // For use when getting the paths
+               $perms_clause = $GLOBALS['BE_USER']->getPagePermsClause(1);
                $titleLen = intval($GLOBALS['BE_USER']->uc['titleLen']);
 
                foreach ($this->itemArray as $key => $val) {
@@ -807,8 +849,8 @@ class t3lib_loadDBGroup {
        /**
         * Counts the items in $this->itemArray and puts this value in an array by default.
         *
-        * @param       boolean         Whether to put the count value in an array
-        * @return      mixed           The plain count as integer or the same inside an array
+        * @param boolean $returnAsArray Whether to put the count value in an array
+        * @return mixed The plain count as integer or the same inside an array
         */
        function countItems($returnAsArray = TRUE) {
                $count = count($this->itemArray);
@@ -823,9 +865,9 @@ class t3lib_loadDBGroup {
         * Should be called any almost any update to a record which could affect references inside the record.
         * (copied from TCEmain)
         *
-        * @param       string          Table name
-        * @param       integer         Record UID
-        * @return      array Information concerning modifications delivered by t3lib_refindex::updateRefIndexTable()
+        * @param string $table Table name
+        * @param integer $id Record UID
+        * @return array Information concerning modifications delivered by t3lib_refindex::updateRefIndexTable()
         */
        function updateRefIndex($table, $id) {
                if ($this->updateReferenceIndex === TRUE) {
@@ -838,10 +880,10 @@ class t3lib_loadDBGroup {
        /**
         * Checks, if we're looking from the "other" side, the symmetric side, to a symmetric relation.
         *
-        * @param       string          $parentUid: The uid of the parent record
-        * @param       array           $parentConf: The TCA configuration of the parent field embedding the child records
-        * @param       array           $childRec: The record row of the child record
-        * @return      boolean         Returns TRUE if looking from the symmetric ("other") side to the relation.
+        * @param string $parentUid The uid of the parent record
+        * @param array $parentConf The TCA configuration of the parent field embedding the child records
+        * @param array $childRec The record row of the child record
+        * @return boolean Returns TRUE if looking from the symmetric ("other") side to the relation.
         */
        function isOnSymmetricSide($parentUid, $parentConf, $childRec) {
                return t3lib_utility_Math::canBeInterpretedAsInteger($childRec['uid']) && $parentConf['symmetric_field'] && $parentUid == $childRec[$parentConf['symmetric_field']]
index 4808807..6f768f0 100644 (file)
  * Modifications by René Fritz, 2001
  * 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>
  * @internal
  */
 
-
 /**
  * Load Backend Interface modules
  *
  *              $this->loadModules = t3lib_div::makeInstance('t3lib_loadModules');
  *              $this->loadModules->load($TBE_MODULES);
  *
- * @author     Kasper Skårhøj <kasperYYYY@typo3.com>
+ * @author Kasper Skårhøj <kasperYYYY@typo3.com>
  * @package TYPO3
  * @subpackage t3lib
  */
 class t3lib_loadModules {
-       var $modules = array(); // After the init() function this array will contain the structure of available modules for the backend user.
-       var $absPathArray = array(); // Array with paths pointing to the location of modules from extensions
+               // After the init() function this array will contain the structure of available modules for the backend user.
+       var $modules = array();
+               // Array with paths pointing to the location of modules from extensions
+       var $absPathArray = array();
 
-       var $modListGroup = array(); // this array will hold the elements that should go into the select-list of modules for groups...
-       var $modListUser = array(); // this array will hold the elements that should go into the select-list of modules for users...
+               // This array will hold the elements that should go into the select-list of modules for groups...
+       var $modListGroup = array();
+               // This array will hold the elements that should go into the select-list of modules for users...
+       var $modListUser = array();
 
        /**
         * The backend user for use internally
@@ -59,7 +62,8 @@ class t3lib_loadModules {
         * @var t3lib_beUserAuth
         */
        var $BE_USER;
-       var $observeWorkspaces = FALSE; // If set TRUE, workspace "permissions" will be observed so non-allowed modules will not be included in the array of modules.
+               // If set TRUE, workspace "permissions" will be observed so non-allowed modules will not be included in the array of modules.
+       var $observeWorkspaces = FALSE;
 
        /**
         * Contains the registered navigation components
@@ -73,9 +77,9 @@ class t3lib_loadModules {
         * The outcome of the load() function will be a $this->modules array populated with the backend module structure available to the BE_USER
         * Further the global var $LANG will have labels and images for the modules loaded in an internal array.
         *
-        * @param       array           $modulesArray should be the global var $TBE_MODULES, $BE_USER can optionally be set to an alternative Backend user object than the global var $BE_USER (which is the currently logged in user)
-        * @param       object          Optional backend user object to use. If not set, the global BE_USER object is used.
-        * @return      void
+        * @param array $modulesArray Should be the global var $TBE_MODULES, $BE_USER can optionally be set to an alternative Backend user object than the global var $BE_USER (which is the currently logged in user)
+        * @param object $BE_USER Optional backend user object to use. If not set, the global BE_USER object is used.
+        * @return void
         */
        function load($modulesArray, $BE_USER = '') {
                        // Setting the backend user for use internally
@@ -87,31 +91,30 @@ class t3lib_loadModules {
 
                /*
 
-                                        $modulesArray might look like this when entering this function.
-                                        Notice the two modules added by extensions - they have a path attached
-
-                                       Array
+                       $modulesArray might look like this when entering this function.
+                       Notice the two modules added by extensions - they have a path attached
+
+                       Array
+                       (
+                               [web] => list,info,perm,func
+                               [file] => list
+                               [user] =>
+                               [tools] => em,install,txphpmyadmin
+                               [help] => about
+                               [_PATHS] => Array
                                        (
-                                               [web] => list,info,perm,func
-                                               [file] => list
-                                               [user] =>
-                                               [tools] => em,install,txphpmyadmin
-                                               [help] => about
-                                               [_PATHS] => Array
-                                                       (
-                                                               [tools_install] => /www/htdocs/typo3/32/coreinstall/typo3/ext/install/mod/
-                                                               [tools_txphpmyadmin] => /www/htdocs/typo3/32/coreinstall/typo3/ext/phpmyadmin/modsub/
-                                                       )
-
+                                               [tools_install] => /www/htdocs/typo3/32/coreinstall/typo3/ext/install/mod/
+                                               [tools_txphpmyadmin] => /www/htdocs/typo3/32/coreinstall/typo3/ext/phpmyadmin/modsub/
                                        )
 
-                                        */
-                       //
+                       )
+                */
+
                $this->absPathArray = $modulesArray['_PATHS'];
                unset($modulesArray['_PATHS']);
-                       // unset the array for calling external backend module dispatchers in typo3/mod.php
+                       // Unset the array for calling external backend module dispatchers in typo3/mod.php
                unset($modulesArray['_dispatcher']);
-                       // unset the array for calling backend modules based on external backend module dispatchers in typo3/mod.php
+                       // Unset the array for calling backend modules based on external backend module dispatchers in typo3/mod.php
                unset($modulesArray['_configuration']);
 
                $this->navigationComponents = $modulesArray['_navigationComponents'];
@@ -119,26 +122,27 @@ class t3lib_loadModules {
 
                $theMods = $this->parseModulesArray($modulesArray);
 
-               /*
-                          Originally modules were found in typo3/mod/
-                          User defined modules were found in ../typo3conf/
-
-                          Today almost all modules reside in extensions and they are found by the _PATHS array of the incoming $TBE_MODULES array
-               */
+                       // Originally modules were found in typo3/mod/
+                       // User defined modules were found in ../typo3conf/
+                       // Today almost all modules reside in extensions and they are found by the _PATHS array of the incoming $TBE_MODULES array
                        // Setting paths for 1) core modules (old concept from mod/) and 2) user-defined modules (from ../typo3conf)
                $paths = array();
-               $paths['defMods'] = PATH_typo3 . 'mod/'; // Path of static modules
-               $paths['userMods'] = PATH_typo3 . '../typo3conf/'; // local modules (maybe frontend specific)
+                       // Path of static modules
+               $paths['defMods'] = PATH_typo3 . 'mod/';
+                       // Local modules (maybe frontend specific)
+               $paths['userMods'] = PATH_typo3 . '../typo3conf/';
 
                        // Traverses the module setup and creates the internal array $this->modules
                foreach ($theMods as $mods => $subMod) {
                        $path = NULL;
 
                        $extModRelPath = $this->checkExtensionModule($mods);
-                       if ($extModRelPath) { // EXTENSION module:
+                               // EXTENSION module:
+                       if ($extModRelPath) {
                                $theMainMod = $this->checkMod($mods, PATH_site . $extModRelPath);
                                if (is_array($theMainMod) || $theMainMod != 'notFound') {
-                                       $path = 1; // ... just so it goes on... submodules cannot be within this path!
+                                               // ... just so it goes on... submodules cannot be within this path!
+                                       $path = 1;
                                }
                        } else { // 'CLASSIC' module
                                        // Checking for typo3/mod/ module existence...
@@ -154,7 +158,7 @@ class t3lib_loadModules {
                                }
                        }
 
-                               // if $theMainMod is not set (FALSE) there is no access to the module !(?)
+                               // If $theMainMod is not set (FALSE) there is no access to the module !(?)
                        if ($theMainMod && !is_null($path)) {
                                $this->modules[$mods] = $theMainMod;
 
@@ -164,14 +168,16 @@ class t3lib_loadModules {
                                                $extModRelPath = $this->checkExtensionModule($mods . '_' . $valsub);
                                                if ($extModRelPath) { // EXTENSION submodule:
                                                        $theTempSubMod = $this->checkMod($mods . '_' . $valsub, PATH_site . $extModRelPath);
-                                                       if (is_array($theTempSubMod)) { // default sub-module in either main-module-path, be it the default or the userdefined.
+                                                               // Default sub-module in either main-module-path, be it the default or the userdefined.
+                                                       if (is_array($theTempSubMod)) {
                                                                $this->modules[$mods]['sub'][$valsub] = $theTempSubMod;
                                                        }
                                                } else { // 'CLASSIC' submodule
                                                                // Checking for typo3/mod/xxx/ module existence...
                                                                // FIXME what about $path = 1; from above and using $path as string here?
                                                        $theTempSubMod = $this->checkMod($mods . '_' . $valsub, $path . $mods . '/' . $valsub);
-                                                       if (is_array($theTempSubMod)) { // default sub-module in either main-module-path, be it the default or the userdefined.
+                                                               // Default sub-module in either main-module-path, be it the default or the userdefined.
+                                                       if (is_array($theTempSubMod)) {
                                                                $this->modules[$mods]['sub'][$valsub] = $theTempSubMod;
                                                        } elseif ($path == $paths['defMods']) { // If the submodule did not exist in the default module path, then check if there is a submodule in the submodule path!
                                                                $theTempSubMod = $this->checkMod($mods . '_' . $valsub, $paths['userMods'] . $mods . '/' . $valsub);
@@ -196,8 +202,8 @@ class t3lib_loadModules {
        /**
         * If the module name ($name) is a module from an extension (has path in $this->absPathArray) then that path is returned relative to PATH_site
         *
-        * @param       string          Module name
-        * @return      string          If found, the relative path from PATH_site
+        * @param string $name Module name
+        * @return string If found, the relative path from PATH_site
         */
        function checkExtensionModule($name) {
                if (isset($this->absPathArray[$name])) {
@@ -212,9 +218,9 @@ class t3lib_loadModules {
         *       FALSE:         If no access to the module (access check failed)
         *       array():       Configuration array, in case a valid module where access IS granted exists.
         *
-        * @param       string          Module name
-        * @param       string          Absolute path to module
-        * @return      mixed           See description of function
+        * @param string $name Module name
+        * @param string $fullpath Absolute path to module
+        * @return mixed See description of function
         */
        function checkMod($name, $fullpath) {
                if ($name == 'user_ws' && !t3lib_extMgm::isLoaded('version')) {
@@ -233,27 +239,30 @@ class t3lib_loadModules {
                        }
                }
 
-                       // check if this is a submodule
+                       // Check if this is a submodule
                if (strpos($name, '_') !== FALSE) {
                        list($mainModule, ) = explode('_', $name, 2);
                }
 
                $modconf = array();
-               $path = preg_replace('/\/[^\/.]+\/\.\.\//', '/', $fullpath); // because 'path/../path' does not work
+                       // Because 'path/../path' does not work
+               $path = preg_replace('/\/[^\/.]+\/\.\.\//', '/', $fullpath);
                if (@is_dir($path) && file_exists($path . '/conf.php')) {
                        $MCONF = array();
                        $MLANG = array();
-                       include($path . '/conf.php'); // The conf-file is included. This must be valid PHP.
+                               // The conf-file is included. This must be valid PHP.
+                       include($path . '/conf.php');
                        if (!$MCONF['shy'] && $this->checkModAccess($name, $MCONF) && $this->checkModWorkspace($name, $MCONF)) {
                                $modconf['name'] = $name;
-                                       // language processing. This will add module labels and image reference to the internal ->moduleLabels array of the LANG object.
+                                       // Language processing. This will add module labels and image reference to the internal ->moduleLabels array of the LANG object.
                                if (is_object($GLOBALS['LANG'])) {
                                                // $MLANG['default']['tabs_images']['tab'] is for modules the reference to the module icon.
                                                // Here the path is transformed to an absolute reference.
                                        if ($MLANG['default']['tabs_images']['tab']) {
 
                                                        // Initializing search for alternative icon:
-                                               $altIconKey = 'MOD:' . $name . '/' . $MLANG['default']['tabs_images']['tab']; // Alternative icon key (might have an alternative set in $TBE_STYLES['skinImg']
+                                                       // Alternative icon key (might have an alternative set in $TBE_STYLES['skinImg']
+                                               $altIconKey = 'MOD:' . $name . '/' . $MLANG['default']['tabs_images']['tab'];
                                                $altIconAbsPath = is_array($GLOBALS['TBE_STYLES']['skinImg'][$altIconKey]) ? t3lib_div::resolveBackPath(PATH_typo3 . $GLOBALS['TBE_STYLES']['skinImg'][$altIconKey][0]) : '';
 
                                                        // Setting icon, either default or alternative:
@@ -334,15 +343,16 @@ class t3lib_loadModules {
        /**
         * Returns TRUE if the internal BE_USER has access to the module $name with $MCONF (based on security level set for that module)
         *
-        * @param       string          Module name
-        * @param       array           MCONF array (module configuration array) from the modules conf.php file (contains settings about what access level the module has)
-        * @return      boolean         TRUE if access is granted for $this->BE_USER
+        * @param string $name Module name
+        * @param array $MCONF MCONF array (module configuration array) from the modules conf.php file (contains settings about what access level the module has)
+        * @return boolean TRUE if access is granted for $this->BE_USER
         */
        function checkModAccess($name, $MCONF) {
                if ($MCONF['access']) {
                        $access = strtolower($MCONF['access']);
                                // Checking if admin-access is required
-                       if (strstr($access, 'admin')) { // If admin-permissions is required then return TRUE if user is admin
+                               // If admin-permissions is required then return TRUE if user is admin
+                       if (strstr($access, 'admin')) {
                                if ($this->BE_USER->isAdmin()) {
                                        return TRUE;
                                }
@@ -368,9 +378,9 @@ class t3lib_loadModules {
         * Check if a module is allowed inside the current workspace for be user
         * Processing happens only if $this->observeWorkspaces is TRUE
         *
-        * @param       string          Module name
-        * @param       array           MCONF array (module configuration array) from the modules conf.php file (contains settings about workspace restrictions)
-        * @return      boolean         TRUE if access is granted for $this->BE_USER
+        * @param string $name Module name
+        * @param array $MCONF MCONF array (module configuration array) from the modules conf.php file (contains settings about workspace restrictions)
+        * @return boolean TRUE if access is granted for $this->BE_USER
         */
        function checkModWorkspace($name, $MCONF) {
                if ($this->observeWorkspaces) {
@@ -395,14 +405,15 @@ class t3lib_loadModules {
         * Parses the moduleArray ($TBE_MODULES) into a internally useful structure.
         * Returns an array where the keys are names of the module and the values may be TRUE (only module) or an array (of submodules)
         *
-        * @param       array           moduleArray ($TBE_MODULES)
-        * @return      array           Output structure with available modules
+        * @param array $arr ModuleArray ($TBE_MODULES)
+        * @return array Output structure with available modules
         */
        function parseModulesArray($arr) {
                $theMods = array();
                if (is_array($arr)) {
                        foreach ($arr as $mod => $subs) {
-                               $mod = $this->cleanName($mod); // clean module name to alphanum
+                                       // Clean module name to alphanum
+                               $mod = $this->cleanName($mod);
                                if ($mod) {
                                        if ($subs) {
                                                $subsArr = t3lib_div::trimExplode(',', $subs);
@@ -424,8 +435,8 @@ class t3lib_loadModules {
        /**
         * The $str is cleaned so that it contains alphanumerical characters only. Modules must only consist of these characters
         *
-        * @param       string          String to clean up
-        * @return      string
+        * @param string $str String to clean up
+        * @return string
         */
        function cleanName($str) {
                return preg_replace('/[^a-z0-9]/i', '', $str);
@@ -434,18 +445,18 @@ class t3lib_loadModules {
        /**
         * Get relative path for $destDir compared to $baseDir
         *
-        * @param       string          Base directory
-        * @param       string          Destination directory
-        * @return      string          The relative path of destination compared to base.
+        * @param string $baseDir Base directory
+        * @param string $destDir Destination directory
+        * @return string The relative path of destination compared to base.
         */
        function getRelativePath($baseDir, $destDir) {
-                       // By René Fritz
-                       // a special case , the dirs are equals
+                       // A special case , the dirs are equals
                if ($baseDir == $destDir) {
                        return './';
                }
 
-               $baseDir = ltrim($baseDir, '/'); // remove beginning
+                       // Remove beginning
+               $baseDir = ltrim($baseDir, '/');
                $destDir = ltrim($destDir, '/');
 
                $found = TRUE;
index b6183b8..08cc698 100644 (file)
 /**
  * Class for providing locking features in TYPO3
  *
- * @author     Michael Stucki <michael@typo3.org>
+ * @author Michael Stucki <michael@typo3.org>
  */
 
-
 /**
  * TYPO3 locking class
  * This class provides an abstract layer to various locking features for TYPO3
@@ -38,7 +37,7 @@
  * It is intended to blocks requests until some data has been generated.
  * This is especially useful if two clients are requesting the same website short after each other. While the request of client 1 triggers building and caching of the website, client 2 will be waiting at this lock.
  *
- * @author     Michael Stucki <michael@typo3.org>
+ * @author Michael Stucki <michael@typo3.org>
  * @package TYPO3
  * @subpackage t3lib
  * @see        class.t3lib_tstemplate.php, class.tslib_fe.php
@@ -90,7 +89,6 @@ class t3lib_lock {
         */
        protected $isLoggingEnabled = TRUE;
 
-
        /**
         * Constructor:
         * initializes locking, check input parameters and set variables accordingly.
@@ -157,10 +155,11 @@ class t3lib_lock {
         *
         * It is important to know that the lock will be acquired in any case, even if the request was blocked first. Therefore, the lock needs to be released in every situation.
         *
-        * @return      boolean         Returns TRUE if lock could be acquired without waiting, FALSE otherwise.
+        * @return boolean Returns TRUE if lock could be acquired without waiting, FALSE otherwise.
         */
        public function acquire() {
-               $noWait = TRUE; // Default is TRUE, which means continue without caring for other clients. In the case of TYPO3s cache management, this has no negative effect except some resource overhead.
+                       // Default is TRUE, which means continue without caring for other clients. In the case of TYPO3s cache management, this has no negative effect except some resource overhead.
+               $noWait = TRUE;
                $isAcquired = TRUE;
 
                switch ($this->method) {
@@ -198,8 +197,8 @@ class t3lib_lock {
                                if (($this->filepointer = fopen($this->resource, 'w+')) == FALSE) {
                                        throw new RuntimeException('Lock file could not be opened', 1294586099);
                                }
-
-                               if (flock($this->filepointer, LOCK_EX | LOCK_NB) == TRUE) { // Lock without blocking
+                                       // Lock without blocking
+                               if (flock($this->filepointer, LOCK_EX | LOCK_NB) == TRUE) {
                                        $noWait = TRUE;
                                } elseif (flock($this->filepointer, LOCK_EX) == TRUE) { // Lock with blocking (waiting for similar locks to become released)
                                        $noWait = FALSE;
@@ -226,7 +225,7 @@ class t3lib_lock {
        /**
         * Release the lock
         *
-        * @return      boolean         Returns TRUE on success or FALSE on failure
+        * @return boolean Returns TRUE on success or FALSE on failure
         */
        public function release() {
                if (!$this->isAcquired) {
@@ -270,7 +269,7 @@ class t3lib_lock {
        /**
         * Return the locking method which is currently used
         *
-        * @return      string          Locking method
+        * @return string Locking method
         */
        public function getMethod() {
                return $this->method;
@@ -279,7 +278,7 @@ class t3lib_lock {
        /**
         * Return the ID which is currently used
         *
-        * @return      string          Locking ID
+        * @return string Locking ID
         */
        public function getId() {
                return $this->id;
@@ -289,7 +288,7 @@ class t3lib_lock {
         * Return the resource which is currently used.
         * Depending on the locking method this can be a filename or a semaphore resource.
         *
-        * @return      mixed           Locking resource (filename as string or semaphore as resource)
+        * @return mixed Locking resource (filename as string or semaphore as resource)
         */
        public function getResource() {
                return $this->resource;
@@ -298,7 +297,7 @@ class t3lib_lock {
        /**
         * Return the status of a lock
         *
-        * @return      string          Returns TRUE if lock is acquired, FALSE otherwise
+        * @return string Returns TRUE if lock is acquired, FALSE otherwise
         */
        public function getLockStatus() {
                return $this->isAcquired;
@@ -326,9 +325,9 @@ class t3lib_lock {
         * Adds a common log entry for this locking API using t3lib_div::sysLog().
         * Example: 25-02-08 17:58 - cms: Locking [simple::0aeafd2a67a6bb8b9543fb9ea25ecbe2]: Acquired
         *
-        * @param       string          $message: The message to be logged
-        * @param       integer         $severity: Severity - 0 is info (default), 1 is notice, 2 is warning, 3 is error, 4 is fatal error
-        * @return      void
+        * @param string $message The message to be logged
+        * @param integer $severity Severity - 0 is info (default), 1 is notice, 2 is warning, 3 is error, 4 is fatal error
+        * @return void
         */
        public function sysLog($message, $severity = 0) {
                if ($this->isLoggingEnabled) {
index 70888e0..84de535 100644 (file)
  *
  * inspired by t3lib_fullsearch
  *
- * @author     René Fritz <r.fritz@colorcube.de>
+ * @author René Fritz <r.fritz@colorcube.de>
  */
 
-
 /**
  * usage inside of scbase class
  *
@@ -57,8 +56,6 @@
  *      // show control panel
  * $this->content.= $this->doc->section('Settings',$store->getStoreControl(),0,1);
  *
- *
- *
  * Format of saved settings
  *
  *     $GLOBALS['SOBE']->MOD_SETTINGS[$this->prefix.'_storedSettings'] = serialize(
@@ -80,7 +77,7 @@
  * Manage storing and restoring of $GLOBALS['SOBE']->MOD_SETTINGS settings.
  * Provides a presets box for BE modules.
  *
- * @author     René Fritz <r.fritz@colorcube.de>
+ * @author René Fritz <r.fritz@colorcube.de>
  * @package TYPO3
  * @subpackage t3lib
  */
@@ -112,15 +109,13 @@ class t3lib_modSettings {
         */
        var $msg = '';
 
-
        /**
         * Name of the form. Needed for JS
         */
        var $formName = 'storeControl';
 
-
-       var $writeDevLog = 0; // write messages into the devlog?
-
+               // Write messages into the devlog?
+       var $writeDevLog = 0;
 
        /********************************
         *
@@ -128,20 +123,19 @@ class t3lib_modSettings {
         *
         ********************************/
 
-
        /**
         * Initializes the object
         *
-        * @param       string          Prefix of MOD_SETTING array keys that should be stored
-        * @param       array           additional names of keys of the MOD_SETTING array which should be stored (array or comma list)
-        * @return      void
+        * @param string $prefix Prefix of MOD_SETTING array keys that should be stored
+        * @param array $storeList Additional names of keys of the MOD_SETTING array which should be stored (array or comma list)
+        * @return void
         */
        function init($prefix = '', $storeList = '') {
                $this->prefix = $prefix;
                $this->setStoreList($storeList);
                $this->type = 'perm';
 
-                       // enable dev logging if set
+                       // Enable dev logging if set
                if ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_modSettings.php']['writeDevLog']) {
                        $this->writeDevLog = TRUE;
                }
@@ -153,26 +147,24 @@ class t3lib_modSettings {
        /**
         * Set session type to 'ses' which will store the settings data not permanently.
         *
-        * @param       string          Default is 'ses'
-        * @return      void
+        * @param string $type Default is 'ses'
+        * @return void
         */
        function setSessionType($type = 'ses') {
                $this->type = $type;
        }
 
-
        /********************************
         *
         * Store list - which values should be stored
         *
         ********************************/
 
-
        /**
         * Set MOD_SETTINGS keys which should be stored
         *
-        * @param       mixed           array or string (,) - set additional names of keys of the MOD_SETTING array which should be stored
-        * @return      void
+        * @param mixed $storeList Array or string (,) - set additional names of keys of the MOD_SETTING array which should be stored
+        * @return void
         */
        function setStoreList($storeList) {
                $this->storeList = is_array($storeList) ? $storeList : t3lib_div::trimExplode(',', $storeList, 1);
@@ -182,12 +174,11 @@ class t3lib_modSettings {
                }
        }
 
-
        /**
         * Add MOD_SETTINGS keys to the current list
         *
-        * @param       mixed           array or string (,) - add names of keys of the MOD_SETTING array which should be stored
-        * @return      void
+        * @param mixed Array or string (,) - add names of keys of the MOD_SETTING array which should be stored
+        * @return void
         */
        function addToStoreList($storeList) {
                $storeList = is_array($storeList) ? $storeList : t3lib_div::trimExplode(',', $storeList, 1);
@@ -198,12 +189,11 @@ class t3lib_modSettings {
                }
        }
 
-
        /**
         * Add names of keys of the MOD_SETTING array by a prefix
         *
-        * @param       string          prefix of MOD_SETTING array keys that should be stored
-        * @return      void
+        * @param string $prefix Prefix of MOD_SETTING array keys that should be stored
+        * @return void
         */
        function addToStoreListFromPrefix($prefix = '') {
                $prefix = $prefix ? $prefix : $this->prefix;
@@ -221,36 +211,33 @@ class t3lib_modSettings {
                }
        }
 
-
        /********************************
         *
         * Process storage array
         *
         ********************************/
 
-
        /**
         * Get the stored settings from MOD_SETTINGS and set them in $this->storedSettings
         *
-        * @return      void
+        * @return void
         */
        function initStorage() {
                $storedSettings = unserialize($GLOBALS['SOBE']->MOD_SETTINGS[$this->prefix . '_storedSettings']);
                $this->storedSettings = $this->cleanupStorageArray($storedSettings);
        }
 
-
        /**
         * Remove corrupted data entries from the stored settings array
         *
-        * @param       array           $storedSettings
-        * @return      array           $storedSettings
+        * @param array $storedSettings The stored settings
+        * @return array Cleaned up stored settings
         */
        function cleanupStorageArray($storedSettings) {
 
                $storedSettings = is_array($storedSettings) ? $storedSettings : array();
 
-                       // clean up the array
+                       // Clean up the array
                foreach ($storedSettings as $id => $sdArr) {
                        if (!is_array($sdArr)) {
                                unset($storedSettings[$id]);
@@ -266,13 +253,12 @@ class t3lib_modSettings {
                return $storedSettings;
        }
 
-
        /**
         * Creates an entry for the stored settings array
         * Collects data from MOD_SETTINGS selected by the storeList
         *
-        * @param       array           Should work with data from _GP('storeControl'). This is ['title']: Title for the entry. ['desc']: A description text. Currently not used by this class
-        * @return      array           $storageArr: entry for the stored settings array
+        * @param array $data Should work with data from _GP('storeControl'). This is ['title']: Title for the entry. ['desc']: A description text. Currently not used by this class
+        * @return array Entry for the stored settings array
         */
        function compileEntry($data) {
                $storageData = array();
@@ -291,13 +277,12 @@ class t3lib_modSettings {
                return $storageArr;
        }
 
-
        /**
         * Copies the stored data from entry $index to $writeArray which can be used to set MOD_SETTINGS
         *
-        * @param       mixed           The entry key
-        * @param       array           Preset data array. Will be overwritten by copied values.
-        * @return      array           Data array
+        * @param mixed $storeIndex The entry key
+        * @param array $writeArray Preset data array. Will be overwritten by copied values.
+        * @return array Data array
         */
        function getStoredData($storeIndex, $writeArray = array()) {
                if ($this->storedSettings[$storeIndex]) {
@@ -308,12 +293,11 @@ class t3lib_modSettings {
                return $writeArray;
        }
 
-
        /**
         * Processing of the storage command LOAD, SAVE, REMOVE
         *
-        * @param       string          Name of the module to store the settings for. Default: $GLOBALS['SOBE']->MCONF['name'] (current module)
-        * @return      string          Storage message. Also set in $this->msg
+        * @param string $mconfName Name of the module to store the settings for. Default: $GLOBALS['SOBE']->MCONF['name'] (current module)
+        * @return string Storage message. Also set in $this->msg
         */
        function processStoreControl($mconfName = '') {
 
@@ -331,31 +315,25 @@ class t3lib_modSettings {
                                t3lib_div::devLog('Store command: ' . t3lib_div::arrayToLogString($storeControl), 't3lib_modSettings', 0);
                        }
 
-                               //
-                               // processing LOAD
-                               //
-
+                               // Processing LOAD
                        if ($storeControl['LOAD'] AND $storeIndex) {
                                $writeArray = $this->getStoredData($storeIndex, $writeArray);
                                $saveSettings = TRUE;
                                $msg = "'" . $this->storedSettings[$storeIndex]['title'] . "' preset loaded!";
 
-                                       //
-                                       // processing SAVE
-                                       //
-
+                               // Processing SAVE
                        } elseif ($storeControl['SAVE']) {
                                if (trim($storeControl['title'])) {
 
-                                               // get the data to store
+                                               // Get the data to store
                                        $newEntry = $this->compileEntry($storeControl);
 
-                                               // create an index for the storage array
+                                               // Create an index for the storage array
                                        if (!$storeIndex) {
                                                $storeIndex = t3lib_div::shortMD5($newEntry['title']);
                                        }
 
-                                               // add data to the storage array
+                                               // Add data to the storage array
                                        $this->storedSettings[$storeIndex] = $newEntry;
 
                                        $saveSettings = TRUE;
@@ -365,10 +343,7 @@ class t3lib_modSettings {
                                        $msg = 'Please enter a name for the preset!';
                                }
 
-                                       //
-                                       // processing REMOVE
-                                       //
-
+                               // Processing REMOVE
                        } elseif ($storeControl['REMOVE'] AND $storeIndex) {
                                        // Removing entry
                                $msg = "'" . $this->storedSettings[$storeIndex]['title'] . "' preset entry removed!";
@@ -377,30 +352,28 @@ class t3lib_modSettings {
                                $saveSettings = TRUE;
                        }
 
-
                        $this->msg = $msg;
 
                        if ($saveSettings) {
                                $this->writeStoredSetting($writeArray, $mconfName);
                        }
-
                }
                return $this->msg;
        }
 
-
        /**
         * Write the current storage array and update MOD_SETTINGS
         *
-        * @param       array           Array of settings which should be overwrite current MOD_SETTINGS
-        * @param       string          Name of the module to store the settings for. Default: $GLOBALS['SOBE']->MCONF['name'] (current module)
-        * @return      void
+        * @param array $writeArray Array of settings which should be overwrite current MOD_SETTINGS
+        * @param string $mconfName Name of the module to store the settings for. Default: $GLOBALS['SOBE']->MCONF['name'] (current module)
+        * @return void
         */
        function writeStoredSetting($writeArray = array(), $mconfName = '') {
                        // for debugging: just removes all module data from user settings
                        // $GLOBALS['BE_USER']->pushModuleData($GLOBALS['SOBE']->MCONF['name'],array());
 
-               unset($this->storedSettings[0]); // making sure, index 0 is not set!
+                       // Making sure, index 0 is not set
+               unset($this->storedSettings[0]);!
                $this->storedSettings = $this->cleanupStorageArray($this->storedSettings);
                $writeArray[$this->prefix . '_storedSettings'] = serialize($this->storedSettings);
 
@@ -411,20 +384,18 @@ class t3lib_modSettings {
                }
        }
 
-
        /********************************
         *
         * GUI
         *
         ********************************/
 
-
        /**
         * Returns the storage control box
         *
-        * @param       string          List of elemetns which should be shown: load,remove,save
-        * @param       boolean         If set the box is wrapped with own form tag
-        * @return      string          HTML code
+        * @param string $showElements List of elemetns which should be shown: load,remove,save
+        * @param boolean $useOwnForm If set the box is wrapped with own form tag
+        * @return string HTML code
         */
        function getStoreControl($showElements = 'load,remove,save', $useOwnForm = TRUE) {
                $showElements = t3lib_div::trimExplode(',', $showElements, 1);
@@ -439,14 +410,12 @@ class t3lib_modSettings {
                }
                $storedEntries = count($opt) > 1;
 
-
                $codeTD = array();
 
-
                        // LOAD, REMOVE, but also show selector so you can overwrite an entry with SAVE
                if ($storedEntries AND (count($showElements))) {
 
-                               // selector box
+                               // Selector box
                        $onChange = 'document.forms[\'' . $this->formName . '\'][\'storeControl[title]\'].value= this.options[this.selectedIndex].value!=0 ? this.options[this.selectedIndex].text : \'\';';
                        $code = '
                                        <select name="storeControl[STORE]" onChange="' . htmlspecialchars($onChange) . '">
@@ -454,13 +423,13 @@ class t3lib_modSettings {
                                                ', $opt) . '
                                        </select>';
 
-                               // load button
+                               // Load button
                        if (in_array('load', $showElements)) {
                                $code .= '
                                        <input type="submit" name="storeControl[LOAD]" value="Load" /> ';
                        }
 
-                               // remove button
+                               // Remove button
                        if (in_array('remove', $showElements)) {
                                $code .= '
                                        <input type="submit" name="storeControl[REMOVE]" value="Remove" /> ';
@@ -469,7 +438,6 @@ class t3lib_modSettings {
                        $codeTD[] = '<td nowrap="nowrap">' . $code . '&nbsp;&nbsp;</td>';
                }
 
-
                        // SAVE
                if (in_array('save', $showElements)) {
                        $onClick = (!$storedEntries) ? '' : 'if (document.forms[\'' . $this->formName . '\'][\'storeControl[STORE]\'].options[document.forms[\'' . $this->formName . '\'][\'storeControl[STORE]\'].selectedIndex].value<0) return confirm(\'Are you sure you want to overwrite the existing entry?\');';
@@ -478,7 +446,6 @@ class t3lib_modSettings {
                        $codeTD[] = '<td nowrap="nowrap">' . $code . '</td>';
                }
 
-
                $codeTD = implode('
                        ', $codeTD);
 
@@ -499,7 +466,7 @@ class t3lib_modSettings {
                        $code .= '
                        <div><strong>' . htmlspecialchars($this->msg) . '</strong></div>';
                }
-               #TODO need to add parameters
+                       // TODO need to add parameters
                if ($useOwnForm AND trim($code)) {
                        $code = '
                <form action="' . t3lib_div::getIndpEnv('SCRIPT_NAME') . '" method="post" name="' . $this->formName . '" enctype="' . $GLOBALS['TYPO3_CONF_VARS']['SYS']['form_enctype'] . '">' . $code . '</form>';
@@ -508,20 +475,18 @@ class t3lib_modSettings {
                return $code;
        }
 
-
        /********************************
         *
         * Misc
         *
         ********************************/
 
-
        /**
         * Processing entry for the stored settings array
         * Can be overwritten by extended class
         *
-        * @param       array           $storageData: entry for the stored settings array
-        * @return      array           $storageData: entry for the stored settings array
+        * @param array $storageData Entry for the stored settings array
+        * @return array Entry for the stored settings array
         */
        function processEntry($storageArr) {
                return $storageArr;