[TASK] Clean up phpDoc comments in t3lib_befunc
authorWouter Wolters <typo3@wouterwolters.nl>
Sun, 6 May 2012 13:24:42 +0000 (15:24 +0200)
committerChristian Kuhn <lolli@schwarzbu.ch>
Mon, 7 May 2012 17:20:47 +0000 (19:20 +0200)
* Provide correct parameter names in phpDoc
* Provide correct data types in phpDoc
* CGLify phpDoc (remove tabs)

Change-Id: Iab137d8c601aa543abdd5dcf4aeae55454a77fd4
Resolves: #36886
Releases: 6.0
Reviewed-on: http://review.typo3.org/11028
Reviewed-by: Tolleiv Nietsch
Tested-by: Tolleiv Nietsch
Reviewed-by: Philipp Gampe
Tested-by: Philipp Gampe
Reviewed-by: Christian Kuhn
Tested-by: Christian Kuhn
t3lib/class.t3lib_befunc.php

index 79e9c25..4dda01a 100644 (file)
@@ -45,15 +45,14 @@ final class t3lib_BEfunc {
         *
         *******************************************/
 
-
        /**
         * Returns the WHERE clause " AND NOT [tablename].[deleted-field]" if a deleted-field is configured in $GLOBALS['TCA'] for the tablename, $table
         * This function should ALWAYS be called in the backend for selection on tables which are configured in $GLOBALS['TCA'] since it will ensure consistent selection of records, even if they are marked deleted (in which case the system must always treat them as non-existent!)
         * In the frontend a function, ->enableFields(), is known to filter hidden-field, start- and endtime and fe_groups as well. But that is a job of the frontend, not the backend. If you need filtering on those fields as well in the backend you can use ->BEenableFields() though.
         *
-        * @param       string          Table name present in $GLOBALS['TCA']
-        * @param       string          Table alias if any
-        * @return      string          WHERE clause for filtering out deleted records, eg " AND tablename.deleted=0"
+        * @param string $table Table name present in $GLOBALS['TCA']
+        * @param string $tableAlias Table alias if any
+        * @return string WHERE clause for filtering out deleted records, eg " AND tablename.deleted=0"
         */
        public static function deleteClause($table, $tableAlias = '') {
                if ($GLOBALS['TCA'][$table]['ctrl']['delete']) {
@@ -70,12 +69,12 @@ final class t3lib_BEfunc {
         * Will automatically check if records has been deleted and if so, not return anything.
         * $table must be found in $GLOBALS['TCA']
         *
-        * @param       string          Table name present in $GLOBALS['TCA']
-        * @param       integer         UID of record
-        * @param       string          List of fields to select
-        * @param       string          Additional WHERE clause, eg. " AND blablabla = 0"
-        * @param       boolean         Use the deleteClause to check if a record is deleted (default TRUE)
-        * @return      array           Returns the row if found, otherwise nothing
+        * @param string $table Table name present in $GLOBALS['TCA']
+        * @param integer $uid UID of record
+        * @param string $fields List of fields to select
+        * @param string $where Additional WHERE clause, eg. " AND blablabla = 0"
+        * @param boolean $useDeleteClause Use the deleteClause to check if a record is deleted (default TRUE)
+        * @return array Returns the row if found, otherwise nothing
         */
        public static function getRecord($table, $uid, $fields = '*', $where = '', $useDeleteClause = TRUE) {
                if ($GLOBALS['TCA'][$table]) {
@@ -95,13 +94,13 @@ final class t3lib_BEfunc {
        /**
         * Like getRecord(), but overlays workspace version if any.
         *
-        * @param       string          Table name present in $GLOBALS['TCA']
-        * @param       integer         UID of record
-        * @param       string          List of fields to select
-        * @param       string          Additional WHERE clause, eg. " AND blablabla = 0"
-        * @param       boolean         Use the deleteClause to check if a record is deleted (default TRUE)
-        * @param       boolean         If TRUE the function does not return a "pointer" row for moved records in a workspace
-        * @return      array           Returns the row if found, otherwise nothing
+        * @param string $table Table name present in $GLOBALS['TCA']
+        * @param integer $uid UID of record
+        * @param string $fields List of fields to select
+        * @param string $where Additional WHERE clause, eg. " AND blablabla = 0"
+        * @param boolean $useDeleteClause Use the deleteClause to check if a record is deleted (default TRUE)
+        * @param boolean $unsetMovePointers If TRUE the function does not return a "pointer" row for moved records in a workspace
+        * @return array Returns the row if found, otherwise nothing
         */
        public static function getRecordWSOL($table, $uid, $fields = '*', $where = '', $useDeleteClause = TRUE, $unsetMovePointers = FALSE) {
                if ($fields !== '*') {
@@ -130,10 +129,10 @@ final class t3lib_BEfunc {
         * The query used is simply this:
         * $query = 'SELECT '.$fields.' FROM '.$table.' WHERE '.$where;
         *
-        * @param       string          Table name (not necessarily in TCA)
-        * @param       string          WHERE clause
-        * @param       string          $fields is a list of fields to select, default is '*'
-        * @return      array           First row found, if any, FALSE otherwise
+        * @param string $table Table name (not necessarily in TCA)
+        * @param string $where WHERE clause
+        * @param string $fields $fields is a list of fields to select, default is '*'
+        * @return array First row found, if any, FALSE otherwise
         */
        public static function getRecordRaw($table, $where = '', $fields = '*') {
                $row = FALSE;
@@ -149,15 +148,15 @@ final class t3lib_BEfunc {
         * The records are returned in an array
         * If no records were selected, the function returns nothing
         *
-        * @param       string          Table name present in $GLOBALS['TCA']
-        * @param       string          Field to select on
-        * @param       string          Value that $theField must match
-        * @param       string          Optional additional WHERE clauses put in the end of the query. DO NOT PUT IN GROUP BY, ORDER BY or LIMIT!
-        * @param       string          Optional GROUP BY field(s), if none, supply blank string.
-        * @param       string          Optional ORDER BY field(s), if none, supply blank string.
-        * @param       string          Optional LIMIT value ([begin,]max), if none, supply blank string.
-        * @param       boolean         Use the deleteClause to check if a record is deleted (default TRUE)
-        * @return      mixed           Multidimensional array with selected records (if any is selected)
+        * @param string $theTable Table name present in $GLOBALS['TCA']
+        * @param string $theField Field to select on
+        * @param string $theValue Value that $theField must match
+        * @param string $whereClause Optional additional WHERE clauses put in the end of the query. DO NOT PUT IN GROUP BY, ORDER BY or LIMIT!
+        * @param string $groupBy Optional GROUP BY field(s), if none, supply blank string.
+        * @param string $orderBy Optional ORDER BY field(s), if none, supply blank string.
+        * @param string $limit Optional LIMIT value ([begin,]max), if none, supply blank string.
+        * @param boolean $useDeleteClause Use the deleteClause to check if a record is deleted (default TRUE)
+        * @return mixed Multidimensional array with selected records (if any is selected)
         */
        public static function getRecordsByField($theTable, $theField, $theValue, $whereClause = '', $groupBy = '', $orderBy = '', $limit = '', $useDeleteClause = TRUE) {
                if (is_array($GLOBALS['TCA'][$theTable])) {
@@ -187,8 +186,8 @@ final class t3lib_BEfunc {
         * Makes an backwards explode on the $str and returns an array with ($table, $uid).
         * Example: tt_content_45 => array('tt_content', 45)
         *
-        * @param       string          [tablename]_[uid] string to explode
-        * @return      array
+        * @param string $str [tablename]_[uid] string to explode
+        * @return array
         */
        public static function splitTable_Uid($str) {
                list($uid, $table) = explode('_', strrev($str), 2);
@@ -199,10 +198,10 @@ final class t3lib_BEfunc {
         * Returns a list of pure integers based on $in_list being a list of records with table-names prepended.
         * Ex: $in_list = "pages_4,tt_content_12,45" would result in a return value of "4,45" if $tablename is "pages" and $default_tablename is 'pages' as well.
         *
-        * @param       string          Input list
-        * @param       string          Table name from which ids is returned
-        * @param       string          $default_tablename denotes what table the number '45' is from (if nothing is prepended on the value)
-        * @return      string          List of ids
+        * @param string $in_list Input list
+        * @param string $tablename Table name from which ids is returned
+        * @param string $default_tablename $default_tablename denotes what table the number '45' is from (if nothing is prepended on the value)
+        * @return string List of ids
         */
        public static function getSQLselectableList($in_list, $tablename, $default_tablename) {
                $list = Array();
@@ -229,9 +228,9 @@ final class t3lib_BEfunc {
         * Notice that deleted-fields are NOT filtered - you must ALSO call deleteClause in addition.
         * $GLOBALS["SIM_ACCESS_TIME"] is used for date.
         *
-        * @param       string          $table is the table from which to return enableFields WHERE clause. Table name must have a 'ctrl' section in $GLOBALS['TCA'].
-        * @param       boolean         $inv means that the query will select all records NOT VISIBLE records (inverted selection)
-        * @return      string          WHERE clause part
+        * @param string $table The table from which to return enableFields WHERE clause. Table name must have a 'ctrl' section in $GLOBALS['TCA'].
+        * @param boolean $inv Means that the query will select all records NOT VISIBLE records (inverted selection)
+        * @return string WHERE clause part
         */
        public static function BEenableFields($table, $inv = 0) {
                $ctrl = $GLOBALS['TCA'][$table]['ctrl'];
@@ -264,11 +263,11 @@ final class t3lib_BEfunc {
        /**
         * Fetches the localization for a given record.
         *
-        * @param       string          $table: Table name present in $GLOBALS['TCA']
-        * @param       integer         $uid: The uid of the record
-        * @param       integer         $language: The uid of the language record in sys_language
-        * @param       string          $andWhereClause: Optional additional WHERE clause (default: '')
-        * @return      mixed           Multidimensional array with selected records; if none exist, FALSE is returned
+        * @param string $table Table name present in $GLOBALS['TCA']
+        * @param integer $uid The uid of the record
+        * @param integer $language The uid of the language record in sys_language
+        * @param string $andWhereClause Optional additional WHERE clause (default: '')
+        * @return mixed Multidimensional array with selected records; if none exist, FALSE is returned
         */
        public static function getRecordLocalization($table, $uid, $language, $andWhereClause = '') {
                $recordLocalization = FALSE;
@@ -287,7 +286,6 @@ final class t3lib_BEfunc {
                return $recordLocalization;
        }
 
-
        /*******************************************
         *
         * Page tree, TCA related
@@ -299,10 +297,10 @@ final class t3lib_BEfunc {
         * By default deleted pages are filtered.
         * This RootLine will follow the tree all the way to the root. This is opposite to another kind of root line known from the frontend where the rootline stops when a root-template is found.
         *
-        * @param       integer         Page id for which to create the root line.
-        * @param       string          $clause can be used to select other criteria. It would typically be where-clauses that stops the process if we meet a page, the user has no reading access to.
-        * @param       boolean         If TRUE, version overlay is applied. This must be requested specifically because it is usually only wanted when the rootline is used for visual output while for permission checking you want the raw thing!
-        * @return      array           Root line array, all the way to the page tree root (or as far as $clause allows!)
+        * @param integer $uid Page id for which to create the root line.
+        * @param string $clause Clause can be used to select other criteria. It would typically be where-clauses that stops the process if we meet a page, the user has no reading access to.
+        * @param boolean $workspaceOL If TRUE, version overlay is applied. This must be requested specifically because it is usually only wanted when the rootline is used for visual output while for permission checking you want the raw thing!
+        * @return array Root line array, all the way to the page tree root (or as far as $clause allows!)
         */
        public static function BEgetRootLine($uid, $clause = '', $workspaceOL = FALSE) {
                static $BEgetRootLine_cache = array();
@@ -358,11 +356,11 @@ final class t3lib_BEfunc {
        /**
         * Gets the cached page record for the rootline
         *
-        * @param       integer         $uid: Page id for which to create the root line.
-        * @param       string          $clause: can be used to select other criteria. It would typically be where-clauses that stops the process if we meet a page, the user has no reading access to.
-        * @param       boolean         $workspaceOL: If TRUE, version overlay is applied. This must be requested specifically because it is usually only wanted when the rootline is used for visual output while for permission checking you want the raw thing!
-        * @return      array           Cached page record for the rootline
-        * @see         BEgetRootLine
+        * @param integer $uid Page id for which to create the root line.
+        * @param string $clause Clause can be used to select other criteria. It would typically be where-clauses that stops the process if we meet a page, the user has no reading access to.
+        * @param boolean $workspaceOL If TRUE, version overlay is applied. This must be requested specifically because it is usually only wanted when the rootline is used for visual output while for permission checking you want the raw thing!
+        * @return array Cached page record for the rootline
+        * @see BEgetRootLine
         */
        protected static function getPageForRootline($uid, $clause, $workspaceOL) {
                static $getPageForRootline_cache = array();
@@ -397,9 +395,9 @@ final class t3lib_BEfunc {
        /**
         * Opens the page tree to the specified page id
         *
-        * @param       integer         Page id.
-        * @param       boolean         If set, then other open branches are closed.
-        * @return      void
+        * @param integer $pid Page id.
+        * @param boolean $clearExpansion If set, then other open branches are closed.
+        * @return void
         */
        public static function openPageTree($pid, $clearExpansion) {
 
@@ -438,11 +436,11 @@ final class t3lib_BEfunc {
         * Each part of the path will be limited to $titleLimit characters
         * Deleted pages are filtered out.
         *
-        * @param       integer         Page uid for which to create record path
-        * @param       string          $clause is additional where clauses, eg. "
-        * @param       integer         Title limit
-        * @param       integer         Title limit of Full title (typ. set to 1000 or so)
-        * @return      mixed           Path of record (string) OR array with short/long title if $fullTitleLimit is set.
+        * @param integer $uid Page uid for which to create record path
+        * @param string $clause Clause is additional where clauses, eg. "
+        * @param integer $titleLimit Title limit
+        * @param integer $fullTitleLimit Title limit of Full title (typ. set to 1000 or so)
+        * @return mixed Path of record (string) OR array with short/long title if $fullTitleLimit is set.
         */
        public static function getRecordPath($uid, $clause, $titleLimit, $fullTitleLimit = 0) {
                if (!$titleLimit) {
@@ -479,7 +477,7 @@ final class t3lib_BEfunc {
         * Returns an array with the exclude-fields as defined in TCA and FlexForms
         * Used for listing the exclude-fields in be_groups forms
         *
-        * @return      array           Array of arrays with excludeFields (fieldname, table:fieldname) from all TCA entries and from FlexForms (fieldname, table:extkey;sheetname;fieldname)
+        * @return array Array of arrays with excludeFields (fieldname, table:fieldname) from all TCA entries and from FlexForms (fieldname, table:extkey;sheetname;fieldname)
         */
        public static function getExcludeFields() {
                        // All TCA keys
@@ -503,7 +501,7 @@ final class t3lib_BEfunc {
                                        }
                                }
                        }
-                       // All FlexForm fields
+                               // All FlexForm fields
                        $flexFormArray = self::getRegisteredFlexForms($table);
                        foreach ($flexFormArray as $tableField => $flexForms) {
                                        // Prefix for field label, e.g. "Plugin Options:"
@@ -543,7 +541,7 @@ final class t3lib_BEfunc {
         * Returns an array with explicit Allow/Deny fields.
         * Used for listing these field/value pairs in be_groups forms
         *
-        * @return      array           Array with information from all of $GLOBALS['TCA']
+        * @return array Array with information from all of $GLOBALS['TCA']
         */
        public static function getExplicitAuthFieldValues() {
 
@@ -575,9 +573,10 @@ final class t3lib_BEfunc {
 
                                                                // Check for items:
                                                        foreach ($fCfg['items'] as $iVal) {
-                                                               if (strcmp($iVal[1], '')) { // Values '' is not controlled by this setting.
+                                                                       // Values '' is not controlled by this setting.
+                                                               if (strcmp($iVal[1], '')) {
 
-                                                                               // Find iMode:
+                                                                               // Find iMode
                                                                        $iMode = '';
                                                                        switch ((string) $fCfg['authMode']) {
                                                                                case 'explicitAllow':
@@ -595,7 +594,7 @@ final class t3lib_BEfunc {
                                                                                        break;
                                                                        }
 
-                                                                               // Set iMode:
+                                                                               // Set iMode
                                                                        if ($iMode) {
                                                                                $allowDenyOptions[$table . ':' . $field]['items'][$iVal[1]] = array($iMode, $GLOBALS['LANG']->sl($iVal[0]), $adLabel[$iMode]);
                                                                        }
@@ -618,7 +617,7 @@ final class t3lib_BEfunc {
         * t3lib_iconWorks::getSpriteIcon(<flags-xx>) to get an HTML which will represent
         * the flag of this language.
         *
-        * @return      array           Array with languages (title, uid, flagIcon)
+        * @return array Array with languages (title, uid, flagIcon)
         */
        public static function getSystemLanguages() {
                $languages = t3lib_div::makeInstance('t3lib_transl8tools')->getSystemLanguages();
@@ -639,8 +638,8 @@ final class t3lib_BEfunc {
        /**
         * Determines whether a table is localizable and has the languageField and transOrigPointerField set in $GLOBALS['TCA'].
         *
-        * @param       string          $table: The table to check
-        * @return      boolean         Whether a table is localizable
+        * @param string $table The table to check
+        * @return boolean Whether a table is localizable
         */
        public static function isTableLocalizable($table) {
                $isLocalizable = FALSE;
@@ -656,9 +655,9 @@ final class t3lib_BEfunc {
         * If the table is prepared for localization and no localizationMode is set, 'select' is returned by default.
         * If the table is not prepared for localization or not defined at all in $GLOBALS['TCA'], FALSE is returned.
         *
-        * @param       string          $table: The name of the table to lookup in TCA
-        * @param       mixed           $fieldOrConfig: The fieldname (string) or the configuration of the field to check (array)
-        * @return      mixed           If table is localizable, the set localizationMode is returned (if property is not set, 'select' is returned by default); if table is not localizable, FALSE is returned
+        * @param string $table The name of the table to lookup in TCA
+        * @param mixed $fieldOrConfig The fieldname (string) or the configuration of the field to check (array)
+        * @return mixed If table is localizable, the set localizationMode is returned (if property is not set, 'select' is returned by default); if table is not localizable, FALSE is returned
         */
        public static function getInlineLocalizationMode($table, $fieldOrConfig) {
                $localizationMode = FALSE;
@@ -682,9 +681,9 @@ final class t3lib_BEfunc {
         * If $id is zero a pseudo root-page with "_thePath" set is returned IF the current BE_USER is admin.
         * In any case ->isInWebMount must return TRUE for the user (regardless of $perms_clause)
         *
-        * @param       integer         Page uid for which to check read-access
-        * @param       string          $perms_clause is typically a value generated with $GLOBALS['BE_USER']->getPagePermsClause(1);
-        * @return      array           Returns page record if OK, otherwise FALSE.
+        * @param integer $id Page uid for which to check read-access
+        * @param string $perms_clause This is typically a value generated with $GLOBALS['BE_USER']->getPagePermsClause(1);
+        * @return array Returns page record if OK, otherwise FALSE.
         */
        public static function readPageAccess($id, $perms_clause) {
                if ((string) $id != '') {
@@ -713,10 +712,10 @@ final class t3lib_BEfunc {
        /**
         * Returns the "types" configuration parsed into an array for the record, $rec, from table, $table
         *
-        * @param       string          Table name (present in TCA)
-        * @param       array           Record from $table
-        * @param       boolean         If $useFieldNameAsKey is set, then the fieldname is associative keys in the return array, otherwise just numeric keys.
-        * @return      array
+        * @param string $table Table name (present in TCA)
+        * @param array $rec Record from $table
+        * @param boolean $useFieldNameAsKey If $useFieldNameAsKey is set, then the fieldname is associative keys in the return array, otherwise just numeric keys.
+        * @return array
         */
        public static function getTCAtypes($table, $rec, $useFieldNameAsKey = 0) {
                t3lib_div::loadTCA($table);
@@ -768,9 +767,9 @@ final class t3lib_BEfunc {
         *       2) The $rec array looks different in TCEForms, as in there it's not the raw record but the t3lib_transferdata version of it, which changes e.g. how "select"
         *          and "group" field values are stored, which makes different processing of the "foreign pointer field" type field variant necessary.
         *
-        * @param       string          Table name present in TCA
-        * @param       array           Record from $table
-        * @return      string          Field value
+        * @param string $table Table name present in TCA
+        * @param array $row Record from $table
+        * @return string Field value
         * @see getTCAtypes()
         */
        public static function getTCAtypeValue($table, $row) {
@@ -784,7 +783,7 @@ final class t3lib_BEfunc {
                        if (strpos($field, ':') !== FALSE) {
                                list($pointerField, $foreignTableTypeField) = explode(':', $field);
 
-                               // Get field value from database if field is not in the $row array
+                                       // Get field value from database if field is not in the $row array
                                if (!isset($row[$pointerField])) {
                                        $localRow = t3lib_BEfunc::getRecord($table, $row['uid'], $pointerField);
                                        $foreignUid = $localRow[$pointerField];
@@ -813,18 +812,18 @@ final class t3lib_BEfunc {
                        } else {
                                $typeNum = $row[$field];
                        }
-
-                       if (!strcmp($typeNum, '')) {  // If that value is an empty string, set it to "0" (zero)
+                               // If that value is an empty string, set it to "0" (zero)
+                       if (!strcmp($typeNum, '')) {
                                $typeNum = 0;
                        }
                }
 
-               // If current typeNum doesn't exist, set it to 0 (or to 1 for historical reasons, if 0 doesn't exist)
+                       // If current typeNum doesn't exist, set it to 0 (or to 1 for historical reasons, if 0 doesn't exist)
                if (!$GLOBALS['TCA'][$table]['types'][$typeNum]) {
                        $typeNum = $GLOBALS['TCA'][$table]['types']["0"] ? 0 : 1;
                }
-
-               $typeNum = (string)$typeNum; // Force to string. Necessary for eg '-1' to be recognized as a type value.
+                       // Force to string. Necessary for eg '-1' to be recognized as a type value.
+               $typeNum = (string)$typeNum;
 
                return $typeNum;
        }
@@ -834,9 +833,9 @@ final class t3lib_BEfunc {
         * Elements are splitted by ":" and within those parts, parameters are splitted by "|".
         * Everything is returned in an array and you should rather see it visually than listen to me anymore now...  Check out example in Inside TYPO3
         *
-        * @param       string          Content from the "types" configuration of TCA (the special configuration) - see description of function
-        * @param       string          The ['defaultExtras'] value from field configuration
-        * @return      array
+        * @param string $str Content from the "types" configuration of TCA (the special configuration) - see description of function
+        * @param string $defaultExtras The ['defaultExtras'] value from field configuration
+        * @return array
         */
        public static function getSpecConfParts($str, $defaultExtras) {
 
@@ -865,8 +864,8 @@ final class t3lib_BEfunc {
         * Takes an array of "[key] = [value]" strings and returns an array with the keys set as keys pointing to the value.
         * Better see it in action! Find example in Inside TYPO3
         *
-        * @param       array           Array of "[key] = [value]" strings to convert.
-        * @return      array
+        * @param array $pArr Array of "[key] = [value]" strings to convert.
+        * @return array
         */
        public static function getSpecConfParametersFromArray($pArr) {
                $out = array();
@@ -887,13 +886,13 @@ final class t3lib_BEfunc {
         * Finds the Data Structure for a FlexForm field
         * NOTE ON data structures for deleted records: This function may fail to deliver the data structure for a record for a few reasons: a) The data structure could be deleted (either with deleted-flagged or hard-deleted), b) the data structure is fetched using the ds_pointerField_searchParent in which case any deleted record on the route to the final location of the DS will make it fail. In theory, we can solve the problem in the case where records that are deleted-flagged keeps us from finding the DS - this is done at the markers ###NOTE_A### where we make sure to also select deleted records. However, we generally want the DS lookup to fail for deleted records since for the working website we expect a deleted-flagged record to be as inaccessible as one that is completely deleted from the DB. Any way we look at it, this may lead to integrity problems of the reference index and even lost files if attached. However, that is not really important considering that a single change to a data structure can instantly invalidate large amounts of the reference index which we do accept as a cost for the flexform features. Other than requiring a reference index update, deletion of/changes in data structure or the failure to look them up when completely deleting records may lead to lost files in the uploads/ folders since those are now without a proper reference.
         *
-        * @param       array           Field config array
-        * @param       array           Record data
-        * @param       string          The table name
-        * @param       string          Optional fieldname passed to hook object
-        * @param       boolean         Boolean; If set, workspace overlay is applied to records. This is correct behaviour for all presentation and export, but NOT if you want a TRUE reflection of how things are in the live workspace.
-        * @param       integer         SPECIAL CASES: Use this, if the DataStructure may come from a parent record and the INPUT row doesn't have a uid yet (hence, the pid cannot be looked up). Then it is necessary to supply a PID value to search recursively in for the DS (used from TCEmain)
-        * @return      mixed           If array, the data structure was found and returned as an array. Otherwise (string) it is an error message.
+        * @param array $conf Field config array
+        * @param array $row Record data
+        * @param string $table The table name
+        * @param string $fieldName Optional fieldname passed to hook object
+        * @param boolean $WSOL Boolean; If set, workspace overlay is applied to records. This is correct behaviour for all presentation and export, but NOT if you want a TRUE reflection of how things are in the live workspace.
+        * @param integer $newRecordPidValue SPECIAL CASES: Use this, if the DataStructure may come from a parent record and the INPUT row doesn't have a uid yet (hence, the pid cannot be looked up). Then it is necessary to supply a PID value to search recursively in for the DS (used from TCEmain)
+        * @return mixed If array, the data structure was found and returned as an array. Otherwise (string) it is an error message.
         * @see t3lib_TCEforms::getSingleField_typeFlex()
         */
        public static function getFlexFormDS($conf, $row, $table, $fieldName = '', $WSOL = TRUE, $newRecordPidValue = 0) {
@@ -905,13 +904,16 @@ final class t3lib_BEfunc {
 
                        // Find source value:
                $dataStructArray = '';
-               if (is_array($ds_array)) { // If there is a data source array, that takes precedence
+                       // If there is a data source array, that takes precedence
+               if (is_array($ds_array)) {
                                // If a pointer field is set, take the value from that field in the $row array and use as key.
                        if ($ds_pointerField) {
 
                                        // Up to two pointer fields can be specified in a comma separated list.
                                $pointerFields = t3lib_div::trimExplode(',', $ds_pointerField);
-                               if (count($pointerFields) == 2) { // If we have two pointer fields, the array keys should contain both field values separated by comma. The asterisk "*" catches all values. For backwards compatibility, it's also possible to specify only the value of the first defined ds_pointerField.
+
+                                       // If we have two pointer fields, the array keys should contain both field values separated by comma. The asterisk "*" catches all values. For backwards compatibility, it's also possible to specify only the value of the first defined ds_pointerField.
+                               if (count($pointerFields) == 2) {
                                        if ($ds_array[$row[$pointerFields[0]] . ',' . $row[$pointerFields[1]]]) { // Check if we have a DS for the combination of both pointer fields values
                                                $srcPointer = $row[$pointerFields[0]] . ',' . $row[$pointerFields[1]];
                                        } elseif ($ds_array[$row[$pointerFields[1]] . ',*']) { // Check if we have a DS for the value of the first pointer field suffixed with ",*"
@@ -966,7 +968,7 @@ final class t3lib_BEfunc {
                                        $rr = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res);
                                        $GLOBALS['TYPO3_DB']->sql_free_result($res);
 
-                                               // break if no result from SQL db or if looping...
+                                               // Break if no result from SQL db or if looping...
                                        if (!is_array($rr) || isset($uidAcc[$rr['uid']])) {
                                                break;
                                        }
@@ -1008,12 +1010,14 @@ final class t3lib_BEfunc {
                                        if ($file && @is_file($file)) {
                                                $dataStructArray = t3lib_div::xml2array(t3lib_div::getUrl($file));
                                        } else {
+                                                       // Error message.
                                                $dataStructArray = 'The file "' . $srcPointer . '" was not found ("' . $file . '")';
-                                       } // Error message.
+                                       }
                                }
                        } else {
+                                       // Error message.
                                $dataStructArray = 'No source value in fieldname "' . $ds_pointerField . '"';
-                       } // Error message.
+                       }
                } else {
                        $dataStructArray = 'No proper configuration!';
                }
@@ -1034,8 +1038,8 @@ final class t3lib_BEfunc {
        /**
         * Returns all registered FlexForm definitions with title and fields
         *
-        * @param       string          The content table
-        * @return      array           The data structures with speaking extension title
+        * @param string $table The content table
+        * @return array The data structures with speaking extension title
         * @see t3lib_BEfunc::getExcludeFields()
         */
        public static function getRegisteredFlexForms($table = 'tt_content') {
@@ -1043,7 +1047,6 @@ final class t3lib_BEfunc {
                        return array();
                }
 
-
                $flexForms = array();
 
                foreach ($GLOBALS['TCA'][$table]['columns'] as $tableField => $fieldConf) {
@@ -1114,7 +1117,6 @@ final class t3lib_BEfunc {
                return $flexForms;
        }
 
-
        /*******************************************
         *
         * Caching related
@@ -1126,9 +1128,9 @@ final class t3lib_BEfunc {
         * hash key, $hash, and visual/symbolic identification, $ident
         * IDENTICAL to the function by same name found in t3lib_page:
         *
-        * @param       string          32 bit hash string (eg. a md5 hash of a serialized array identifying the data being stored)
-        * @param       string          The data string. If you want to store an array, then just serialize it first.
-        * @param       string          $ident is just a textual identification in order to inform about the content!
+        * @param string $hash 32 bit hash string (eg. a md5 hash of a serialized array identifying the data being stored)
+        * @param string $data The data string. If you want to store an array, then just serialize it first.
+        * @param string $ident $ident is just a textual identification in order to inform about the content!
         * @return      void
         */
        public static function storeHash($hash, $data, $ident) {
@@ -1146,8 +1148,9 @@ final class t3lib_BEfunc {
         *
         * IDENTICAL to the function by same name found in t3lib_page
         *
-        * @param       string          The hash-string which was used to store the data value
-        * @return      string
+        * @param string $hash The hash-string which was used to store the data value
+        * @param integer $expTime Variabele is not used in the function
+        * @return string
         */
        public static function getHash($hash, $expTime = 0) {
                $hashContent = NULL;
@@ -1158,7 +1161,6 @@ final class t3lib_BEfunc {
                return $hashContent;
        }
 
-
        /*******************************************
         *
         * TypoScript related
@@ -1169,10 +1171,10 @@ final class t3lib_BEfunc {
         * Returns the Page TSconfig for page with id, $id
         * Requires class "t3lib_TSparser"
         *
-        * @param       integer         Page uid for which to create Page TSconfig
-        * @param       array           If $rootLine is an array, that is used as rootline, otherwise rootline is just calculated
-        * @param       boolean         If $returnPartArray is set, then the array with accumulated Page TSconfig is returned non-parsed. Otherwise the output will be parsed by the TypoScript parser.
-        * @return      array           Page TSconfig
+        * @param $id integer Page uid for which to create Page TSconfig
+        * @param $rootLine array If $rootLine is an array, that is used as rootline, otherwise rootline is just calculated
+        * @param boolean $returnPartArray If $returnPartArray is set, then the array with accumulated Page TSconfig is returned non-parsed. Otherwise the output will be parsed by the TypoScript parser.
+        * @return array Page TSconfig
         * @see t3lib_TSparser
         */
        public static function getPagesTSconfig($id, $rootLine = '', $returnPartArray = 0) {
@@ -1180,9 +1182,11 @@ final class t3lib_BEfunc {
                if (!is_array($rootLine)) {
                        $rootLine = self::BEgetRootLine($id, '', TRUE);
                }
-               ksort($rootLine); // Order correctly
+                       // Order correctly
+               ksort($rootLine);
                $TSdataArray = array();
-               $TSdataArray['defaultPageTSconfig'] = $GLOBALS['TYPO3_CONF_VARS']['BE']['defaultPageTSconfig']; // Setting default configuration:
+                       // Setting default configuration
+               $TSdataArray['defaultPageTSconfig'] = $GLOBALS['TYPO3_CONF_VARS']['BE']['defaultPageTSconfig'];
                foreach ($rootLine as $k => $v) {
                        $TSdataArray['uid_' . $v['uid']] = $v['TSconfig'];
                }
@@ -1214,7 +1218,7 @@ final class t3lib_BEfunc {
                        }
                }
 
-                       // get User TSconfig overlay
+                       // Get User TSconfig overlay
                $userTSconfig = $GLOBALS['BE_USER']->userTS['page.'];
                if (is_array($userTSconfig)) {
                        $TSconfig = t3lib_div::array_merge_recursive_overrule($TSconfig, $userTSconfig);
@@ -1230,10 +1234,10 @@ final class t3lib_BEfunc {
         * THIS DOES NOT CHECK ANY PERMISSIONS. SHOULD IT?
         * More documentation is needed.
         *
-        * @param       integer         Page id
-        * @param       array           Page TS array to write
-        * @param       string          Prefix for object paths
-        * @param       array           [Description needed.]
+        * @param integer $id Page id
+        * @param array $pageTS Page TS array to write
+        * @param string $TSconfPrefix Prefix for object paths
+        * @param array $impParams [Description needed.]
         * @return      void
         * @internal
         * @see implodeTSParams(), getPagesTSconfig()
@@ -1274,7 +1278,7 @@ final class t3lib_BEfunc {
                                }
                                $TSlines = array_reverse($TSlines);
 
-                                       // store those changes
+                                       // Store those changes
                                $TSconf = implode(LF, $TSlines);
 
                                $GLOBALS['TYPO3_DB']->exec_UPDATEquery('pages', 'uid=' . intval($id), array('TSconfig' => $TSconf));
@@ -1285,9 +1289,9 @@ final class t3lib_BEfunc {
        /**
         * Implodes a multi dimensional TypoScript array, $p, into a one-dimentional array (return value)
         *
-        * @param       array           TypoScript structure
-        * @param       string          Prefix string
-        * @return      array           Imploded TypoScript objectstring/values
+        * @param array $p TypoScript structure
+        * @param string $k Prefix string
+        * @return array Imploded TypoScript objectstring/values
         */
        public static function implodeTSParams($p, $k = '') {
                $implodeParams = array();
@@ -1303,7 +1307,6 @@ final class t3lib_BEfunc {
                return $implodeParams;
        }
 
-
        /*******************************************
         *
         * Users / Groups related
@@ -1314,12 +1317,12 @@ final class t3lib_BEfunc {
         * Returns an array with be_users records of all user NOT DELETED sorted by their username
         * Keys in the array is the be_users uid
         *
-        * @param       string          Optional $fields list (default: username,usergroup,usergroup_cached_list,uid) can be used to set the selected fields
-        * @param       string          Optional $where clause (fx. "AND username='pete'") can be used to limit query
-        * @return      array
+        * @param string $fields Optional $fields list (default: username,usergroup,usergroup_cached_list,uid) can be used to set the selected fields
+        * @param string $where Optional $where clause (fx. "AND username='pete'") can be used to limit query
+        * @return array
         */
        public static function getUserNames($fields = 'username,usergroup,usergroup_cached_list,uid', $where = '') {
-               $be_user_Array = Array();
+               $be_user_Array = array();
 
                $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery($fields, 'be_users', 'pid=0 ' . $where . self::deleteClause('be_users'), '', 'username');
                while ($row = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res)) {
@@ -1333,8 +1336,8 @@ final class t3lib_BEfunc {
        /**
         * Returns an array with be_groups records (title, uid) of all groups NOT DELETED sorted by their title
         *
-        * @param       string          Field list
-        * @param       string          WHERE clause
+        * @param string $fields Field list
+        * @param string $where WHERE clause
         * @return      array
         */
        public static function getGroupNames($fields = 'title,uid', $where = '') {
@@ -1353,7 +1356,7 @@ final class t3lib_BEfunc {
         * Returns an array with be_groups records (like ->getGroupNames) but:
         * - if the current BE_USER is admin, then all groups are returned, otherwise only groups that the current user is member of (usergroup_cached_list) will be returned.
         *
-        * @param       string          Field list; $fields specify the fields selected (default: title,uid)
+        * @param string $fields Field list; $fields specify the fields selected (default: title,uid)
         * @return      array
         */
        public static function getListGroupNames($fields = 'title, uid') {
@@ -1369,10 +1372,10 @@ final class t3lib_BEfunc {
         * If $excludeBlindedFlag is set, then these records are unset from the array $usernames
         * Takes $usernames (array made by t3lib_BEfunc::getUserNames()) and a $groupArray (array with the groups a certain user is member of) as input
         *
-        * @param       array           User names
-        * @param       array           Group names
-        * @param       boolean         If $excludeBlindedFlag is set, then these records are unset from the array $usernames
-        * @return      array           User names, blinded
+        * @param array $usernames User names
+        * @param array $groupArray Group names
+        * @param boolean $excludeBlindedFlag If $excludeBlindedFlag is set, then these records are unset from the array $usernames
+        * @return array User names, blinded
         */
        public static function blindUserNames($usernames, $groupArray, $excludeBlindedFlag = 0) {
                if (is_array($usernames) && is_array($groupArray)) {
@@ -1402,10 +1405,10 @@ final class t3lib_BEfunc {
        /**
         * Corresponds to blindUserNames but works for groups instead
         *
-        * @param       array           Group names
-        * @param       array           Group names (reference)
-        * @param       boolean         If $excludeBlindedFlag is set, then these records are unset from the array $usernames
-        * @return      array
+        * @param array $groups Group names
+        * @param array $groupArray Group names (reference)
+        * @param boolean $excludeBlindedFlag If $excludeBlindedFlag is set, then these records are unset from the array $usernames
+        * @return array
         */
        public static function blindGroupNames($groups, $groupArray, $excludeBlindedFlag = 0) {
                if (is_array($groups) && is_array($groupArray)) {
@@ -1425,7 +1428,6 @@ final class t3lib_BEfunc {
                return $groups;
        }
 
-
        /*******************************************
         *
         * Output related
@@ -1435,8 +1437,8 @@ final class t3lib_BEfunc {
        /**
         * Returns the difference in days between input $tstamp and $EXEC_TIME
         *
-        * @param       integer         Time stamp, seconds
-        * @return      integer
+        * @param integer $tstamp Time stamp, seconds
+        * @return integer
         */
        public static function daysUntil($tstamp) {
                $delta_t = $tstamp - $GLOBALS['EXEC_TIME'];
@@ -1446,8 +1448,8 @@ final class t3lib_BEfunc {
        /**
         * Returns $tstamp formatted as "ddmmyy" (According to $GLOBALS['TYPO3_CONF_VARS']['SYS']['ddmmyy'])
         *
-        * @param       integer         Time stamp, seconds
-        * @return      string          Formatted time
+        * @param integer $tstamp Time stamp, seconds
+        * @return string Formatted time
         */
        public static function date($tstamp) {
                return date($GLOBALS['TYPO3_CONF_VARS']['SYS']['ddmmyy'], (int) $tstamp);
@@ -1456,8 +1458,8 @@ final class t3lib_BEfunc {
        /**
         * Returns $tstamp formatted as "ddmmyy hhmm" (According to $GLOBALS['TYPO3_CONF_VARS']['SYS']['ddmmyy'] AND $GLOBALS['TYPO3_CONF_VARS']['SYS']['hhmm'])
         *
-        * @param       integer         Time stamp, seconds
-        * @return      string          Formatted time
+        * @param integer $value Time stamp, seconds
+        * @return string Formatted time
         */
        public static function datetime($value) {
                return date($GLOBALS['TYPO3_CONF_VARS']['SYS']['ddmmyy'] . ' ' . $GLOBALS['TYPO3_CONF_VARS']['SYS']['hhmm'], $value);
@@ -1467,9 +1469,9 @@ final class t3lib_BEfunc {
         * Returns $value (in seconds) formatted as hh:mm:ss
         * For instance $value = 3600 + 60*2 + 3 should return "01:02:03"
         *
-        * @param       integer         Time stamp, seconds
-        * @param       boolean         Output hh:mm:ss. If FALSE: hh:mm
-        * @return      string          Formatted time
+        * @param integer $value Time stamp, seconds
+        * @param boolean $withSeconds Output hh:mm:ss. If FALSE: hh:mm
+        * @return string Formatted time
         */
        public static function time($value, $withSeconds = TRUE) {
                $hh = floor($value / 3600);
@@ -1485,9 +1487,9 @@ final class t3lib_BEfunc {
        /**
         * Returns the "age" in minutes / hours / days / years of the number of $seconds inputted.
         *
-        * @param       integer         $seconds could be the difference of a certain timestamp and time()
-        * @param       string          $labels should be something like ' min| hrs| days| yrs| min| hour| day| year'. This value is typically delivered by this function call: $GLOBALS["LANG"]->sL("LLL:EXT:lang/locallang_core.php:labels.minutesHoursDaysYears")
-        * @return      string          Formatted time
+        * @param integer $seconds Seconds could be the difference of a certain timestamp and time()
+        * @param string $labels Labels should be something like ' min| hrs| days| yrs| min| hour| day| year'. This value is typically delivered by this function call: $GLOBALS["LANG"]->sL("LLL:EXT:lang/locallang_core.php:labels.minutesHoursDaysYears")
+        * @return string Formatted time
         */
        public static function calcAge($seconds, $labels = ' min| hrs| days| yrs| min| hour| day| year') {
                $labelArr = explode('|', $labels);
@@ -1513,10 +1515,10 @@ final class t3lib_BEfunc {
         * Returns a formatted timestamp if $tstamp is set.
         * The date/datetime will be followed by the age in parenthesis.
         *
-        * @param       integer         Time stamp, seconds
-        * @param       integer         1/-1 depending on polarity of age.
-        * @param       string          $date=="date" will yield "dd:mm:yy" formatting, otherwise "dd:mm:yy hh:mm"
-        * @return      string
+        * @param integer $tstamp Time stamp, seconds
+        * @param integer $prefix 1/-1 depending on polarity of age.
+        * @param string $date $date=="date" will yield "dd:mm:yy" formatting, otherwise "dd:mm:yy hh:mm"
+        * @return string
         */
        public static function dateTimeAge($tstamp, $prefix = 1, $date = '') {
                return $tstamp ?
@@ -1528,8 +1530,8 @@ final class t3lib_BEfunc {
        /**
         * Returns alt="" and title="" attributes with the value of $content.
         *
-        * @param       string          Value for 'alt' and 'title' attributes (will be htmlspecialchars()'ed before output)
-        * @return      string
+        * @param string $content Value for 'alt' and 'title' attributes (will be htmlspecialchars()'ed before output)
+        * @return string
         */
        public static function titleAltAttrib($content) {
                $out = '';
@@ -1543,15 +1545,15 @@ final class t3lib_BEfunc {
         * All $GLOBALS['TYPO3_CONF_VARS']['GFX']['imagefile_ext'] extension are made to thumbnails + ttf file (renders font-example)
         * Thumbsnails are linked to the show_item.php script which will display further details.
         *
-        * @param       array           $row is the database row from the table, $table.
-        * @param       string          Table name for $row (present in TCA)
-        * @param       string          $field is pointing to the field with the list of image files
-        * @param       string          Back path prefix for image tag src="" field
-        * @param       string          Optional: $thumbScript - not used anymore since FAL
-        * @param       string          Optional: $uploaddir is the directory relative to PATH_site where the image files from the $field value is found (Is by default set to the entry in $GLOBALS['TCA'] for that field! so you don't have to!)
-        * @param       boolean         If set, uploaddir is NOT prepended with "../"
-        * @param       string          Optional: $tparams is additional attributes for the image tags
-        * @param       integer         Optional: $size is [w]x[h] of the thumbnail. 56 is default.
+        * @param array $row Row is the database row from the table, $table.
+        * @param string $table Table name for $row (present in TCA)
+        * @param string $field Field is pointing to the list of image files
+        * @param string $backPath Back path prefix for image tag src="" field
+        * @param string $thumbScript Optional: $thumbScript - not used anymore since FAL
+        * @param string $uploaddir Optional: $uploaddir is the directory relative to PATH_site where the image files from the $field value is found (Is by default set to the entry in $GLOBALS['TCA'] for that field! so you don't have to!)
+        * @param boolean $abs If set, uploaddir is NOT prepended with "../"
+        * @param string $tparams Optional: $tparams is additional attributes for the image tags
+        * @param integer $size Optional: $size is [w]x[h] of the thumbnail. 56 is default.
         * @param boolean $linkInfoPopup Whether to wrap with a link opening the info popup
         * @return string Thumbnail image tag.
         */
@@ -1587,7 +1589,7 @@ final class t3lib_BEfunc {
                                $fileReferenceObject = t3lib_file_Factory::getInstance()->getFileReferenceObject($referenceUid['uid']);
                                $fileObject = $fileReferenceObject->getOriginalFile();
 
-                                       // web image
+                                       // Web image
                                if (t3lib_div::inList($GLOBALS['TYPO3_CONF_VARS']['GFX']['imagefile_ext'], $fileReferenceObject->getExtension())) {
                                        $imageUrl = $fileObject->process(t3lib_file_ProcessedFile::CONTEXT_IMAGEPREVIEW, array(
                                                'width'  => $sizeParts[0],
@@ -1679,11 +1681,11 @@ final class t3lib_BEfunc {
        /**
         * Returns single image tag to thumbnail using a thumbnail script (like thumbs.php)
         *
-        * @param       string          $thumbScript must point to "thumbs.php" relative to the script position
-        * @param       string          $theFile must be the proper reference to the file thumbs.php should show
-        * @param       string          $tparams are additional attributes for the image tag
-        * @param       integer         $size is the size of the thumbnail send along to "thumbs.php"
-        * @return      string          Image tag
+        * @param string $thumbScript Must point to "thumbs.php" relative to the script position
+        * @param string $theFile Must be the proper reference to the file that thumbs.php should show
+        * @param string $tparams The additional attributes for the image tag
+        * @param integer $size The size of the thumbnail send along to "thumbs.php"
+        * @return string Image tag
         */
        public static function getThumbNail($thumbScript, $theFile, $tparams = '', $size = '') {
                $check = basename($theFile) . ':' . filemtime($theFile) . ':' . $GLOBALS['TYPO3_CONF_VARS']['SYS']['encryptionKey'];
@@ -1699,10 +1701,10 @@ final class t3lib_BEfunc {
        /**
         * Returns title-attribute information for a page-record informing about id, alias, doktype, hidden, starttime, endtime, fe_group etc.
         *
-        * @param       array           Input must be a page row ($row) with the proper fields set (be sure - send the full range of fields for the table)
-        * @param       string          $perms_clause is used to get the record path of the shortcut page, if any (and doktype==4)
-        * @param       boolean         If $includeAttrib is set, then the 'title=""' attribute is wrapped about the return value, which is in any case htmlspecialchar()'ed already
-        * @return      string
+        * @param array $row Input must be a page row ($row) with the proper fields set (be sure - send the full range of fields for the table)
+        * @param string $perms_clause This is used to get the record path of the shortcut page, if any (and doktype==4)
+        * @param boolean $includeAttrib If $includeAttrib is set, then the 'title=""' attribute is wrapped about the return value, which is in any case htmlspecialchar()'ed already
+        * @return string
         */
        public static function titleAttribForPages($row, $perms_clause = '', $includeAttrib = 1) {
                $parts = array();
@@ -1793,8 +1795,8 @@ final class t3lib_BEfunc {
         * The included information depends on features of the table, but if hidden, starttime, endtime and fe_group fields are configured for, information about the record status in regard to these features are is included.
         * "pages" table can be used as well and will return the result of ->titleAttribForPages() for that page.
         *
-        * @param       array           Table row; $row is a row from the table, $table
-        * @param       string          Table name
+        * @param array $row Table row; $row is a row from the table, $table
+        * @param string $table Table name
         * @return      string
         */
        public static function getRecordIconAltText($row, $table = 'pages') {
@@ -1803,7 +1805,8 @@ final class t3lib_BEfunc {
                } else {
                        $ctrl = $GLOBALS['TCA'][$table]['ctrl']['enablecolumns'];
 
-                       $out = 'id=' . $row['uid']; // Uid is added
+                               // Uid is added
+                       $out = 'id=' . $row['uid'];
                        if ($table == 'pages' && $row['alias']) {
                                $out .= ' / ' . $row['alias'];
                        }
@@ -1830,7 +1833,8 @@ final class t3lib_BEfunc {
                                }
                        }
 
-                       if ($ctrl['disabled']) { // Hidden ...
+                               // Hidden
+                       if ($ctrl['disabled']) {
                                $out .= ($row[$ctrl['disabled']] ? ' - ' . $GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:labels.hidden') : '');
                        }
                        if ($ctrl['starttime']) {
@@ -1852,10 +1856,10 @@ final class t3lib_BEfunc {
        /**
         * Returns the label of the first found entry in an "items" array from $GLOBALS['TCA'] (tablename = $table/fieldname = $col) where the value is $key
         *
-        * @param       string          Table name, present in $GLOBALS['TCA']
-        * @param       string          Field name, present in $GLOBALS['TCA']
-        * @param       string          items-array value to match
-        * @return      string          Label for item entry
+        * @param string $table Table name, present in $GLOBALS['TCA']
+        * @param string $col Field name, present in $GLOBALS['TCA']
+        * @param string $key items-array value to match
+        * @return string Label for item entry
         */
        public static function getLabelFromItemlist($table, $col, $key) {
                        // Load full TCA for $table
@@ -1877,7 +1881,6 @@ final class t3lib_BEfunc {
         * Splits the given key with commas and returns the list of all the localized items labels, separated by a comma.
         * NOTE: this does not take itemsProcFunc into account
         *
-        * @static
         * @param string $table Table name, present in TCA
         * @param string $column Field name
         * @param string $key Key or comma-separated list of keys.
@@ -1912,17 +1915,16 @@ final class t3lib_BEfunc {
         * Returns the label-value for fieldname $col in table, $table
         * If $printAllWrap is set (to a "wrap") then it's wrapped around the $col value IF THE COLUMN $col DID NOT EXIST in TCA!, eg. $printAllWrap = '<strong>|</strong>' and the fieldname was 'not_found_field' then the return value would be '<strong>not_found_field</strong>'
         *
-        * @param       string          Table name, present in $GLOBALS['TCA']
-        * @param       string          Field name
-        * @param       string          Wrap value - set function description
-        * @return      string
+        * @param string $table Table name, present in $GLOBALS['TCA']
+        * @param string $col Field name
+        * @param string $printAllWrap Wrap value - set function description
+        * @return string
         */
        public static function getItemLabel($table, $col, $printAllWrap = '') {
                        // Load full TCA for $table
                t3lib_div::loadTCA($table);
                        // Check if column exists
                if (is_array($GLOBALS['TCA'][$table]) && is_array($GLOBALS['TCA'][$table]['columns'][$col])) {
-                               // Re
                        return $GLOBALS['TCA'][$table]['columns'][$col]['label'];
                }
                if ($printAllWrap) {
@@ -1935,11 +1937,11 @@ final class t3lib_BEfunc {
         * Returns the "title"-value in record, $row, from table, $table
         * The field(s) from which the value is taken is determined by the "ctrl"-entries 'label', 'label_alt' and 'label_alt_force'
         *
-        * @param       string          Table name, present in TCA
-        * @param       array           Row from table
-        * @param       boolean         If set, result is prepared for output: The output is cropped to a limited lenght (depending on BE_USER->uc['titleLen']) and if no value is found for the title, '<em>[No title]</em>' is returned (localized). Further, the output is htmlspecialchars()'ed
-        * @param       boolean         If set, the function always returns an output. If no value is found for the title, '[No title]' is returned (localized).
-        * @return      string
+        * @param string $table Table name, present in TCA
+        * @param array $row Row from table
+        * @param boolean $prep If set, result is prepared for output: The output is cropped to a limited lenght (depending on BE_USER->uc['titleLen']) and if no value is found for the title, '<em>[No title]</em>' is returned (localized). Further, the output is htmlspecialchars()'ed
+        * @param boolean $forceResult If set, the function always returns an output. If no value is found for the title, '[No title]' is returned (localized).
+        * @return string
         */
        public static function getRecordTitle($table, $row, $prep = FALSE, $forceResult = TRUE) {
                if (is_array($GLOBALS['TCA'][$table])) {
@@ -1949,7 +1951,7 @@ final class t3lib_BEfunc {
                                $params['table'] = $table;
                                $params['row'] = $row;
                                $params['title'] = '';
-                                       //create NULL-reference
+                                       // Create NULL-reference
                                $null = NULL;
                                t3lib_div::callUserFunction($GLOBALS['TCA'][$table]['ctrl']['label_userFunc'], $params, $null);
                                $t = $params['title'];
@@ -1997,9 +1999,9 @@ final class t3lib_BEfunc {
         * Crops a title string to a limited lenght and if it really was cropped, wrap it in a <span title="...">|</span>,
         * which offers a tooltip with the original title when moving mouse over it.
         *
-        * @param       string          $title: The title string to be cropped
-        * @param       integer         $titleLength: Crop title after this length - if not set, BE_USER->uc['titleLen'] is used
-        * @return      string          The processed title string, wrapped in <span title="...">|</span> if cropped
+        * @param string $title The title string to be cropped
+        * @param integer $titleLength Crop title after this length - if not set, BE_USER->uc['titleLen'] is used
+        * @return string The processed title string, wrapped in <span title="...">|</span> if cropped
         */
        public static function getRecordTitlePrep($title, $titleLength = 0) {
                        // If $titleLength is not a valid positive integer, use BE_USER->uc['titleLen']:
@@ -2018,8 +2020,8 @@ final class t3lib_BEfunc {
        /**
         * Get a localized [No title] string, wrapped in <em>|</em> if $prep is TRUE.
         *
-        * @param       boolean         $prep: Wrap result in <em>|</em>
-        * @return      string          Localized [No title] string
+        * @param boolean $prep Wrap result in <em>|</em>
+        * @return string Localized [No title] string
         */
        public static function getNoRecordTitle($prep = FALSE) {
                $noTitle = '[' . $GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:labels.no_title', 1) . ']';
@@ -2035,19 +2037,19 @@ final class t3lib_BEfunc {
         * $table/$col is tablename and fieldname
         * REMEMBER to pass the output through htmlspecialchars() if you output it to the browser! (To protect it from XSS attacks and be XHTML compliant)
         *
-        * @param       string          Table name, present in TCA
-        * @param       string          Field name, present in TCA
-        * @param       string          $value is the value of that field from a selected record
-        * @param       integer         $fixed_lgd_chars is the max amount of characters the value may occupy
-        * @param       boolean         $defaultPassthrough flag means that values for columns that has no conversion will just be pass through directly (otherwise cropped to 200 chars or returned as "N/A")
-        * @param       boolean         If set, no records will be looked up, UIDs are just shown.
-        * @param       integer         uid of the current record
-        * @param       boolean         If t3lib_BEfunc::getRecordTitle is used to process the value, this parameter is forwarded.
-        * @return      string
+        * @param string $table Table name, present in TCA
+        * @param string $col Field name, present in TCA
+        * @param string $value The value of that field from a selected record
+        * @param integer $fixed_lgd_chars The max amount of characters the value may occupy
+        * @param boolean $defaultPassthrough Flag means that values for columns that has no conversion will just be pass through directly (otherwise cropped to 200 chars or returned as "N/A")
+        * @param boolean $noRecordLookup If set, no records will be looked up, UIDs are just shown.
+        * @param integer $uid Uid of the current record
+        * @param boolean $forceResult If t3lib_BEfunc::getRecordTitle is used to process the value, this parameter is forwarded.
+        * @return string
         */
        public static function getProcessedValue($table, $col, $value, $fixed_lgd_chars = 0, $defaultPassthrough = 0, $noRecordLookup = FALSE, $uid = 0, $forceResult = TRUE) {
                if ($col == 'uid') {
-                               // no need to load TCA as uid is not in TCA-array
+                               // No need to load TCA as uid is not in TCA-array
                        return $value;
                }
                        // Load full TCA for $table
@@ -2061,7 +2063,7 @@ final class t3lib_BEfunc {
                         *HOOK: pre-processing the human readable output from a record
                         ****************/
                        if (is_array($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_befunc.php']['preProcessValue'])) {
-                                       // create NULL-reference
+                                       // Create NULL-reference
                                $null = NULL;
                                foreach ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_befunc.php']['preProcessValue'] as $_funcRef) {
                                        t3lib_div::callUserFunction($_funcRef, $theColConf, $null);
@@ -2159,7 +2161,7 @@ final class t3lib_BEfunc {
                                        }
                                        break;
                                case 'input':
-                                               // hide value 0 for dates, but show it for everything else
+                                               // Hide value 0 for dates, but show it for everything else
                                        if (isset($value)) {
                                                if (t3lib_div::inList($theColConf['eval'], 'date')) {
                                                        if (!empty($value)) {
@@ -2213,7 +2215,7 @@ final class t3lib_BEfunc {
                         *HOOK: post-processing the human readable output from a record
                         ****************/
                        if (is_array($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_befunc.php']['postProcessValue'])) {
-                                       // create NULL-reference
+                                       // Create NULL-reference
                                $null = NULL;
                                foreach ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_befunc.php']['postProcessValue'] as $_funcRef) {
                                        $params = array(
@@ -2235,13 +2237,13 @@ final class t3lib_BEfunc {
        /**
         * Same as ->getProcessedValue() but will go easy on fields like "tstamp" and "pid" which are not configured in TCA - they will be formatted by this function instead.
         *
-        * @param       string          Table name, present in TCA
-        * @param       string          Field name
-        * @param       string          Field value
-        * @param       integer         $fixed_lgd_chars is the max amount of characters the value may occupy
-        * @param       integer         uid of the current record
-        * @param       boolean         If t3lib_BEfunc::getRecordTitle is used to process the value, this parameter is forwarded.
-        * @return      string
+        * @param string $table Table name, present in TCA
+        * @param string $fN Field name
+        * @param string $fV Field value
+        * @param integer $fixed_lgd_chars The max amount of characters the value may occupy
+        * @param integer $uid Uid of the current record
+        * @param boolean $forceResult If t3lib_BEfunc::getRecordTitle is used to process the value, this parameter is forwarded.
+        * @return string
         * @see getProcessedValue()
         */
        public static function getProcessedValueExtra($table, $fN, $fV, $fixed_lgd_chars = 0, $uid = 0, $forceResult = TRUE) {
@@ -2251,7 +2253,8 @@ final class t3lib_BEfunc {
                                if ($fN == $GLOBALS['TCA'][$table]['ctrl']['tstamp'] || $fN == $GLOBALS['TCA'][$table]['ctrl']['crdate']) {
                                        $fVnew = self::datetime($fV);
                                } elseif ($fN == 'pid') {
-                                       $fVnew = self::getRecordPath($fV, '1=1', 20); // Fetches the path with no regard to the users permissions to select pages.
+                                               // Fetches the path with no regard to the users permissions to select pages.
+                                       $fVnew = self::getRecordPath($fV, '1=1', 20);
                                } else {
                                        $fVnew = $fV;
                                }
@@ -2263,8 +2266,8 @@ final class t3lib_BEfunc {
        /**
         * Returns file icon name (from $FILEICONS) for the fileextension $ext
         *
-        * @param       string          File extension, lowercase
-        * @return      string          File icon filename
+        * @param string $ext File extension, lowercase
+        * @return string File icon filename
         */
        public static function getFileIcon($ext) {
                return $GLOBALS['FILEICONS'][$ext] ? $GLOBALS['FILEICONS'][$ext] : $GLOBALS['FILEICONS']['default'];
@@ -2275,10 +2278,10 @@ final class t3lib_BEfunc {
         * This includes uid, the fields defined for title, icon-field.
         * Returned as a list ready for query ($prefix can be set to eg. "pages." if you are selecting from the pages table and want the table name prefixed)
         *
-        * @param       string          Table name, present in $GLOBALS['TCA']
-        * @param       string          Table prefix
-        * @param       array           Preset fields (must include prefix if that is used)
-        * @return      string          List of fields.
+        * @param string $table Table name, present in $GLOBALS['TCA']
+        * @param string $prefix Table prefix
+        * @param array $fields Preset fields (must include prefix if that is used)
+        * @return string List of fields.
         */
        public static function getCommonSelectFields($table, $prefix = '', $fields = array()) {
                $fields[] = $prefix . 'uid';
@@ -2325,14 +2328,16 @@ final class t3lib_BEfunc {
        }
 
        /**
-        * Makes a form for configuration of some values based on configuration found in the array $configArray, with default values from $defaults and a data-prefix $dataPrefix
+        * Makes a form for configuration of some values based on configuration found in the array $configArray,
+        * with default values from $defaults and a data-prefix $dataPrefix
         * <form>-tags must be supplied separately
-        * Needs more documentation and examples, in particular syntax for configuration array. See Inside TYPO3. That's were you can expect to find example, if anywhere.
+        * Needs more documentation and examples, in particular syntax for configuration array. See Inside TYPO3.
+        * That's were you can expect to find example, if anywhere.
         *
-        * @param       array           Field configuration code.
-        * @param       array           Defaults
-        * @param       string          Prefix for formfields
-        * @return      string          HTML for a form.
+        * @param array $configArray Field configuration code.
+        * @param array $defaults Defaults
+        * @param string $dataPrefix Prefix for formfields
+        * @return string HTML for a form.
         */
        public static function makeConfigForm($configArray, $defaults, $dataPrefix) {
                $params = $defaults;
@@ -2382,7 +2387,6 @@ final class t3lib_BEfunc {
                return $out;
        }
 
-
        /*******************************************
         *
         * Backend Modules API functions
@@ -2399,11 +2403,11 @@ final class t3lib_BEfunc {
         * Please also note that since TYPO3 4.5 the option to enable help (none, icon only, full text)
         * was completely removed.
         *
-        * @param       string          Table name
-        * @param       string          Field name
-        * @param       string          Back path
-        * @param       boolean         Force display of icon no matter BE_USER setting for help
-        * @return      string          HTML content for a help icon/text
+        * @param string $table Table name
+        * @param string $field Field name
+        * @param string $BACK_PATH Back path
+        * @param boolean $force Force display of icon no matter BE_USER setting for help
+        * @return string HTML content for a help icon/text
         */
        public static function helpTextIcon($table, $field, $BACK_PATH, $force = 0) {
                if (is_array($GLOBALS['TCA_DESCR'][$table]) && is_array($GLOBALS['TCA_DESCR'][$table]['columns'][$field]) && (isset($GLOBALS['BE_USER']->uc['edit_showFieldHelp']) || $force)) {
@@ -2414,9 +2418,9 @@ final class t3lib_BEfunc {
        /**
         * Returns CSH help text (description), if configured for, as an array (title, description)
         *
-        * @param       string  Table name
-        * @param       string  Field name
-        * @return      array   With keys 'description' (raw, as available in locallang), 'title' (optional), 'moreInfo'
+        * @param string $table Table name
+        * @param string $field Field name
+        * @return array With keys 'description' (raw, as available in locallang), 'title' (optional), 'moreInfo'
         */
        public static function helpTextArray($table, $field) {
                if (!isset($GLOBALS['TCA_DESCR'][$table]['columns'])) {
@@ -2430,17 +2434,17 @@ final class t3lib_BEfunc {
                if (is_array($GLOBALS['TCA_DESCR'][$table]) && is_array($GLOBALS['TCA_DESCR'][$table]['columns'][$field])) {
                        $data = $GLOBALS['TCA_DESCR'][$table]['columns'][$field];
 
-                               // add alternative title, if defined
+                               // Add alternative title, if defined
                        if ($data['alttitle']) {
                                $output['title'] = $data['alttitle'];
                        }
 
-                               // if we have more information to show
+                               // If we have more information to show
                        if ($data['image_descr'] || $data['seeAlso'] || $data['details'] || $data['syntax']) {
                                $output['moreInfo'] = TRUE;
                        }
 
-                               // add description
+                               // Add description
                        if ($data['description']) {
                                $output['description'] = $data['description'];
                        }
@@ -2453,9 +2457,9 @@ final class t3lib_BEfunc {
         * $GLOBALS['TCA_DESCR'] must be loaded prior to this function and $GLOBALS['BE_USER'] must have "edit_showFieldHelp" set to "text",
         * otherwise nothing is returned.
         *
-        * @param       string          Table name
-        * @param       string          Field name
-        * @return      string          HTML content for help text
+        * @param string $table Table name
+        * @param string $field Field name
+        * @return string HTML content for help text
         */
        public static function helpText($table, $field) {
                $helpTextArray = self::helpTextArray($table, $field);
@@ -2485,11 +2489,11 @@ final class t3lib_BEfunc {
         * This is the new help API function since TYPO3 4.5, and uses the new behaviour
         * (hover over text, no icon, no fulltext option, no option to disable the help)
         *
-        * @param       string  $table  The table name for which the help should be shown
-        * @param       string  $field  The field name for which the help should be shown
-        * @param       string  $text   the text which should be wrapped with the help text
-        * @return      string  the HTML code ready to render
-        * @api public
+        * @param string $table The table name for which the help should be shown
+        * @param string $field The field name for which the help should be shown
+        * @param string $text The text which should be wrapped with the help text
+        * @param array $overloadHelpText Array with text to overload help text
+        * @return string the HTML code ready to render
         */
        public static function wrapInHelp($table, $field, $text = '', array $overloadHelpText = array()) {
                        // Initialize some variables
@@ -2533,14 +2537,13 @@ final class t3lib_BEfunc {
         * API for getting CSH icons/text for use in backend modules.
         * TCA_DESCR will be loaded if it isn't already
         *
-        * @param       string          Table name ('_MOD_'+module name)
-        * @param       string          Field name (CSH locallang main key)
-        * @param       string          Back path
-        * @param       string          Wrap code for icon-mode, splitted by "|". Not used for full-text mode.
-        * @param       boolean         If set, the full text will never be shown (only icon).
-        *                               Useful for places where it will break the page if the table with full text is shown.
-        * @param       string          Additional style-attribute content for wrapping table (full text mode only)
-        * @return      string          HTML content for help text
+        * @param string $table Table name ('_MOD_'+module name)
+        * @param string $field Field name (CSH locallang main key)
+        * @param string $BACK_PATH Back path
+        * @param string $wrap Wrap code for icon-mode, splitted by "|". Not used for full-text mode.
+        * @param boolean $onlyIconMode If set, the full text will never be shown (only icon). Useful for places where it will break the page if the table with full text is shown.
+        * @param string $styleAttrib Additional style-attribute content for wrapping table (full text mode only)
+        * @return string HTML content for help text
         * @see helpText(), helpTextIcon()
         */
        public static function cshItem($table, $field, $BACK_PATH, $wrap = '', $onlyIconMode = FALSE, $styleAttrib = '') {
@@ -2584,10 +2587,10 @@ final class t3lib_BEfunc {
         * Returns a JavaScript string (for an onClick handler) which will load the alt_doc.php script that shows the form for editing of the record(s) you have send as params.
         * REMEMBER to always htmlspecialchar() content in href-properties to ampersands get converted to entities (XHTML requirement and XSS precaution)
         *
-        * @param       string          $params is parameters sent along to alt_doc.php. This requires a much more details description which you must seek in Inside TYPO3s documentation of the alt_doc.php API. And example could be '&edit[pages][123] = edit' which will show edit form for page record 123.
-        * @param       string          $backPath must point back to the TYPO3_mainDir directory (where alt_doc.php is)
-        * @param       string          $requestUri is an optional returnUrl you can set - automatically set to REQUEST_URI.
-        * @return      string
+        * @param string $params Parameters sent along to alt_doc.php. This requires a much more details description which you must seek in Inside TYPO3s documentation of the alt_doc.php API. And example could be '&edit[pages][123] = edit' which will show edit form for page record 123.
+        * @param string $backPath Must point back to the TYPO3_mainDir directory (where alt_doc.php is)
+        * @param string $requestUri An optional returnUrl you can set - automatically set to REQUEST_URI.
+        * @return string
         * @see template::issueCommand()
         */
        public static function editOnClick($params, $backPath = '', $requestUri = '') {
@@ -2597,16 +2600,17 @@ final class t3lib_BEfunc {
 
        /**
         * Returns a JavaScript string for viewing the page id, $id
-        * It will detect the correct domain name if needed and provide the link with the right back path. Also it will re-use any window already open.
-        *
-        * @param       integer         $pageUid is page id
-        * @param       string          $backPath must point back to TYPO3_mainDir (where the site is assumed to be one level above)
-        * @param       array           $rootLine If root line is supplied the function will look for the first found domain record and use that URL instead (if found)
-        * @param       string          $anchorSection is optional anchor to the URL
-        * @param       string          $alternativeUrl is an alternative URL which - if set - will make all other parameters ignored: The function will just return the window.open command wrapped around this URL!
-        * @param       string          $additionalGetVars Additional GET variables.
-        * @param       boolean         If TRUE, then the preview window will gain the focus.
-        * @return      string
+        * It will detect the correct domain name if needed and provide the link with the right back path.
+        * Also it will re-use any window already open.
+        *
+        * @param integer $pageUid Page id
+        * @param string $backPath Must point back to TYPO3_mainDir (where the site is assumed to be one level above)
+        * @param array $rootLine If root line is supplied the function will look for the first found domain record and use that URL instead (if found)
+        * @param string $anchorSection Optional anchor to the URL
+        * @param string $alternativeUrl An alternative URL which - if set - will make all other parameters ignored: The function will just return the window.open command wrapped around this URL!
+        * @param string $additionalGetVars Additional GET variables.
+        * @param boolean $switchFocus If TRUE, then the preview window will gain the focus.
+        * @return string
         */
        public static function viewOnClick($pageUid, $backPath = '', $rootLine = '', $anchorSection = '', $alternativeUrl = '', $additionalGetVars = '', $switchFocus = TRUE) {
                $viewScript = '/index.php?id=';
@@ -2650,11 +2654,11 @@ final class t3lib_BEfunc {
                                        break;
                                }
                        }
-                               // Add it:
+                               // Add it
                        $additionalGetVars .= $suffix;
                }
 
-                       // check a mount point needs to be previewed
+                       // Check a mount point needs to be previewed
                $sys_page = t3lib_div::makeInstance('t3lib_pageSelect');
                $sys_page->init(FALSE);
                $mountPointInfo = $sys_page->getMountPointInfo($pageUid);
@@ -2673,10 +2677,10 @@ final class t3lib_BEfunc {
         * Builds the frontend view domain for a given page ID with a given root
         * line.
         *
-        * @param integer $pageId the page ID to use, must be > 0
-        * @param array $rootLine the root line structure to use
+        * @param integer $pageId The page ID to use, must be > 0
+        * @param array $rootLine The root line structure to use
         *
-        * @return string the full domain including the protocol http:// or https://, but without the trailing '/'
+        * @return string The full domain including the protocol http:// or https://, but without the trailing '/'
         *
         * @author Michael Klapper <michael.klapper@aoemedia.de>
         */
@@ -2687,7 +2691,7 @@ final class t3lib_BEfunc {
                        $rootLine = self::BEgetRootLine($pageId);
                }
 
-                       // checks alternate domains
+                       // Checks alternate domains
                if (count($rootLine) > 0) {
                        $urlParts = parse_url($domain);
 
@@ -2723,9 +2727,9 @@ final class t3lib_BEfunc {
         * Returns the merged User/Page TSconfig for page id, $id.
         * Please read details about module programming elsewhere!
         *
-        * @param       integer         Page uid
-        * @param       string          $TSref is an object string which determines the path of the TSconfig to return.
-        * @return      array
+        * @param integer $id Page uid
+        * @param string $TSref An object string which determines the path of the TSconfig to return.
+        * @return array
         */
        public static function getModTSconfig($id, $TSref) {
                $pageTS_modOptions = $GLOBALS['BE_USER']->getTSConfig($TSref, self::getPagesTSconfig($id));
@@ -2739,13 +2743,13 @@ final class t3lib_BEfunc {
         * Requires the JS function jumpToUrl() to be available
         * See Inside TYPO3 for details about how to use / make Function menus
         *
-        * @param       mixed           $id is the "&id=" parameter value to be sent to the module, but it can be also a parameter array which will be passed instead of the &id=...
-        * @param       string          $elementName it the form elements name, probably something like "SET[...]"
-        * @param       string          $currentValue is the value to be selected currently.
-        * @param       array           $menuItems is an array with the menu items for the selector box
-        * @param       string          $script is the script to send the &id to, if empty it's automatically found
-        * @param       string          $addParams is additional parameters to pass to the script.
-        * @return      string          HTML code for selector box
+        * @param mixed $id The "&id=" parameter value to be sent to the module, but it can be also a parameter array which will be passed instead of the &id=...
+        * @param string $elementName The form elements name, probably something like "SET[...]"
+        * @param string $currentValue The value to be selected currently.
+        * @param array  $menuItems An array with the menu items for the selector box
+        * @param string $script The script to send the &id to, if empty it's automatically found
+        * @param string $addParams Additional parameters to pass to the script.
+        * @return string HTML code for selector box
         */
        public static function getFuncMenu($mainParams, $elementName, $currentValue, $menuItems, $script = '', $addparams = '') {
                if (is_array($menuItems)) {
@@ -2783,13 +2787,13 @@ final class t3lib_BEfunc {
         * Checkbox function menu.
         * Works like ->getFuncMenu() but takes no $menuItem array since this is a simple checkbox.
         *
-        * @param       mixed           $mainParams $id is the "&id=" parameter value to be sent to the module, but it can be also a parameter array which will be passed instead of the &id=...
-        * @param       string          $elementName it the form elements name, probably something like "SET[...]"
-        * @param       string          $currentValue is the value to be selected currently.
-        * @param       string          $script is the script to send the &id to, if empty it's automatically found
-        * @param       string          $addParams is additional parameters to pass to the script.
-        * @param       string          Additional attributes for the checkbox input tag
-        * @return      string          HTML code for checkbox
+        * @param mixed $mainParams $id is the "&id=" parameter value to be sent to the module, but it can be also a parameter array which will be passed instead of the &id=...
+        * @param string $elementName The form elements name, probably something like "SET[...]"
+        * @param string $currentValue The value to be selected currently.
+        * @param string $script The script to send the &id to, if empty it's automatically found
+        * @param string $addParams Additional parameters to pass to the script.
+        * @param string $tagParams Additional attributes for the checkbox input tag
+        * @return string HTML code for checkbox
         * @see getFuncMenu()
         */
        public static function getFuncCheck($mainParams, $elementName, $currentValue, $script = '', $addparams = '', $tagParams = '') {
@@ -2811,13 +2815,13 @@ final class t3lib_BEfunc {
         * Input field function menu
         * Works like ->getFuncMenu() / ->getFuncCheck() but displays a input field instead which updates the script "onchange"
         *
-        * @param       mixed           $id is the "&id=" parameter value to be sent to the module, but it can be also a parameter array which will be passed instead of the &id=...
-        * @param       string          $elementName it the form elements name, probably something like "SET[...]"
-        * @param       string          $currentValue is the value to be selected currently.
-        * @param       integer         Relative size of input field, max is 48
-        * @param       string          $script is the script to send the &id to, if empty it's automatically found
-        * @param       string          $addParams is additional parameters to pass to the script.
-        * @return      string          HTML code for input text field.
+        * @param mixed $mainParams $id is the "&id=" parameter value to be sent to the module, but it can be also a parameter array which will be passed instead of the &id=...
+        * @param string $elementName The form elements name, probably something like "SET[...]"
+        * @param string $currentValue The value to be selected currently.
+        * @param integer $size Relative size of input field, max is 48
+        * @param string $script The script to send the &id to, if empty it's automatically found
+        * @param string $addParams Additional parameters to pass to the script.
+        * @return string HTML code for input text field.
         * @see getFuncMenu()
         */
        public static function getFuncInput($mainParams, $elementName, $currentValue, $size = 10, $script = "", $addparams = "") {
@@ -2839,10 +2843,10 @@ final class t3lib_BEfunc {
         * Removes menu items from $itemArray if they are configured to be removed by TSconfig for the module ($modTSconfig)
         * See Inside TYPO3 about how to program modules and use this API.
         *
-        * @param       array           Module TS config array
-        * @param       array           Array of items from which to remove items.
-        * @param       string          $TSref points to the "object string" in $modTSconfig
-        * @return      array           The modified $itemArray is returned.
+        * @param array $modTSconfig Module TS config array
+        * @param array $itemArray Array of items from which to remove items.
+        * @param string $TSref $TSref points to the "object string" in $modTSconfig
+        * @return array The modified $itemArray is returned.
         */
        public static function unsetMenuItems($modTSconfig, $itemArray, $TSref) {
                        // Getting TS-config options for this module for the Backend User:
@@ -2861,9 +2865,9 @@ final class t3lib_BEfunc {
         * Call to update the page tree frame (or something else..?) after
         * use 'updatePageTree' as a first parameter will set the page tree to be updated.
         *
-        * @param       string          Key to set the update signal. When setting, this value contains strings telling WHAT to set. At this point it seems that the value "updatePageTree" is the only one it makes sense to set. If empty, all update signals will be removed.
-        * @param       mixed           Additional information for the update signal, used to only refresh a branch of the tree
-        * @return      void
+        * @param string $set Key to set the update signal. When setting, this value contains strings telling WHAT to set. At this point it seems that the value "updatePageTree" is the only one it makes sense to set. If empty, all update signals will be removed.
+        * @param mixed $params Additional information for the update signal, used to only refresh a branch of the tree
+        * @return void
         * @see t3lib_BEfunc::getUpdateSignalCode()
         */
        public static function setUpdateSignal($set = '', $params = '') {
@@ -2879,12 +2883,11 @@ final class t3lib_BEfunc {
                $GLOBALS['BE_USER']->pushModuleData('t3lib_BEfunc::getUpdateSignal', $modData);
        }
 
-
        /**
         * Call to update the page tree frame (or something else..?) if this is set by the function
         * setUpdateSignal(). It will return some JavaScript that does the update (called in the typo3/template.php file, end() function)
         *
-        * @return      string          HTML javascript code
+        * @return string HTML javascript code
         * @see t3lib_BEfunc::setUpdateSignal()
         */
        public static function getUpdateSignalCode() {
@@ -2901,7 +2904,7 @@ final class t3lib_BEfunc {
                        $updateSignals = array();
                }
 
-                       // loop through all setUpdateSignals and get the JS code
+                       // Loop through all setUpdateSignals and get the JS code
                foreach ($modData as $set => $val) {
                        if (isset($updateSignals[$set])) {
                                $params = array('set' => $set, 'parameter' => $val['parameter'], 'JScode' => '');
@@ -2934,30 +2937,29 @@ final class t3lib_BEfunc {
                }
 
                $content = implode(LF, $signals);
-
-               self::setUpdateSignal(); // for backwards compatibility, should be replaced
+                       // For backwards compatibility, should be replaced
+               self::setUpdateSignal();
                return $content;
        }
 
-
        /**
         * Returns an array which is most backend modules becomes MOD_SETTINGS containing values from function menus etc. determining the function of the module.
         * This is kind of session variable management framework for the backend users.
         * If a key from MOD_MENU is set in the CHANGED_SETTINGS array (eg. a value is passed to the script from the outside), this value is put into the settings-array
         * Ultimately, see Inside TYPO3 for how to use this function in relation to your modules.
         *
-        * @param       array           MOD_MENU is an array that defines the options in menus.
-        * @param       array           CHANGED_SETTINGS represents the array used when passing values to the script from the menus.
-        * @param       string          modName is the name of this module. Used to get the correct module data.
-        * @param       string          If type is 'ses' then the data is stored as session-lasting data. This means that it'll be wiped out the next time the user logs in.
-        * @param       string          dontValidateList can be used to list variables that should not be checked if their value is found in the MOD_MENU array. Used for dynamically generated menus.
-        * @param       string          List of default values from $MOD_MENU to set in the output array (only if the values from MOD_MENU are not arrays)
-        * @return      array           The array $settings, which holds a key for each MOD_MENU key and the values of each key will be within the range of values for each menuitem
+        * @param array $MOD_MENU MOD_MENU is an array that defines the options in menus.
+        * @param array $CHANGED_SETTINGS CHANGED_SETTINGS represents the array used when passing values to the script from the menus.
+        * @param string $modName modName is the name of this module. Used to get the correct module data.
+        * @param string $type If type is 'ses' then the data is stored as session-lasting data. This means that it'll be wiped out the next time the user logs in.
+        * @param string $dontValidateList dontValidateList can be used to list variables that should not be checked if their value is found in the MOD_MENU array. Used for dynamically generated menus.
+        * @param string $setDefaultList List of default values from $MOD_MENU to set in the output array (only if the values from MOD_MENU are not arrays)
+        * @return array The array $settings, which holds a key for each MOD_MENU key and the values of each key will be within the range of values for each menuitem
         */
        public static function getModuleData($MOD_MENU, $CHANGED_SETTINGS, $modName, $type = '', $dontValidateList = '', $setDefaultList = '') {
 
                if ($modName && is_string($modName)) {
-                               // GETTING stored user-data from this module:
+                               // Getting stored user-data from this module:
                        $settings = $GLOBALS['BE_USER']->getModuleData($modName, $type);
 
                        $changed = 0;
@@ -2992,7 +2994,8 @@ final class t3lib_BEfunc {
                                                        $changed = 1;
                                                }
                                        }
-                                       if ($setDefaultList && !is_array($var)) { // Sets default values (only strings/checkboxes, not menus)
+                                               // Sets default values (only strings/checkboxes, not menus)
+                                       if ($setDefaultList && !is_array($var)) {
                                                if (t3lib_div::inList($setDefaultList, $key) && !isset($settings[$key])) {
                                                        $settings[$key] = (string) $var;
                                                }
@@ -3012,16 +3015,14 @@ final class t3lib_BEfunc {
                }
        }
 
-
-
        /**
         * Returns the URL to a given module
         *
         * @param string $moduleName Name of the module
         * @param array $urlParameters URL parameters that should be added as key value pairs
-        * @param bool/string $backPathOverride backpath that should be used instead of the global $BACK_PATH
-        * @param bool $returnAbsoluteUrl If set to TRUE, the URL returned will be absolute, $backPathOverride will be ignored in this case
-        * @return bool/string calculated URL or FALSE
+        * @param boolean/string $backPathOverride backpath that should be used instead of the global $BACK_PATH
+        * @param boolean $returnAbsoluteUrl If set to TRUE, the URL returned will be absolute, $backPathOverride will be ignored in this case
+        * @return boolean/string Calculated URL or FALSE
         */
        public static function getModuleUrl($moduleName, $urlParameters = array(), $backPathOverride = FALSE, $returnAbsoluteUrl = FALSE) {
                if (!$GLOBALS['BE_USER']->check('modules', $moduleName)) {
@@ -3053,7 +3054,7 @@ final class t3lib_BEfunc {
         * @param array $urlParameters URL parameters that should be added as key value pairs
         * @param string $linkTitle title for the link tag
         * @param string $linkText optional link text after the icon
-        * @return string a complete link tag or empty string
+        * @return string A complete link tag or empty string
         */
        public static function getListViewLink($urlParameters = array(), $linkTitle = '', $linkText = '') {
                $url = self::getModuleUrl('web_list', $urlParameters);
@@ -3073,7 +3074,7 @@ final class t3lib_BEfunc {
         *
         * @param string $formName Context of the token
         * @param string $tokenName The name of the token GET variable
-        * @return string a URL GET variable including ampersand
+        * @return string A URL GET variable including ampersand
         */
        public static function getUrlToken($formName = 'securityToken', $tokenName = 'formToken') {
                $formprotection = t3lib_formprotection_Factory::get();
@@ -3086,7 +3087,7 @@ final class t3lib_BEfunc {
         *
         *******************************************/
 
-       /**
+               /**
         * Set preview keyword, eg:
         *       $previewUrl = t3lib_div::getIndpEnv('TYPO3_SITE_URL').'index.php?ADMCMD_prev='.t3lib_BEfunc::compilePreviewKeyword('id='.$pageId.'&L='.$language.'&ADMCMD_view=1&ADMCMD_editIcons=1&ADMCMD_previewWS='.$this->workspace, $GLOBALS['BE_USER']->user['uid'], 120);
         *
@@ -3123,10 +3124,10 @@ final class t3lib_BEfunc {
         * Unlock or Lock a record from $table with $uid
         * If $table and $uid is not set, then all locking for the current BE_USER is removed!
         *
-        * @param       string          Table name
-        * @param       integer         Record uid
-        * @param       integer         Record pid
-        * @return      void
+        * @param string $table Table name
+        * @param integer $uid Record uid
+        * @param integer $pid Record pid
+        * @return void
         * @internal
         * @see t3lib_transferData::lockRecord(), alt_doc.php, db_layout.php, db_list.php, wizard_rte.php
         */
@@ -3153,9 +3154,9 @@ final class t3lib_BEfunc {
         * Returns information about whether the record from table, $table, with uid, $uid is currently locked (edited by another user - which should issue a warning).
         * Notice: Locking is not strictly carried out since locking is abandoned when other backend scripts are activated - which means that a user CAN have a record "open" without having it locked. So this just serves as a warning that counts well in 90% of the cases, which should be sufficient.
         *
-        * @param       string          Table name
-        * @param       integer         Record uid
-        * @return      array
+        * @param string $table Table name
+        * @param integer $uid Record uid
+        * @return array
         * @internal
         * @see class.db_layout.inc, alt_db_navframe.php, alt_doc.php, db_layout.php
         */
@@ -3209,11 +3210,11 @@ final class t3lib_BEfunc {
        /**
         * Returns select statement for MM relations (as used by TCEFORMs etc)
         *
-        * @param       array           Configuration array for the field, taken from $GLOBALS['TCA']
-        * @param       string          Field name
-        * @param       array           TSconfig array from which to get further configuration settings for the field name
-        * @param       string          Prefix string for the key "*foreign_table_where" from $fieldValue array
-        * @return      string          Part of query
+        * @param array $fieldValue Configuration array for the field, taken from $GLOBALS['TCA']
+        * @param string $field Field name
+        * @param array $TSconfig TSconfig array from which to get further configuration settings for the field name
+        * @param string $prefix Prefix string for the key "*foreign_table_where" from $fieldValue array
+        * @return string Part of query
         * @internal
         * @see t3lib_transferData::renderRecord(), t3lib_TCEforms::foreignTable()
         */
@@ -3296,9 +3297,9 @@ final class t3lib_BEfunc {
         * Returns TSConfig for the TCEFORM object in Page TSconfig.
         * Used in TCEFORMs
         *
-        * @param       string          Table name present in TCA
-        * @param       array           Row from table
-        * @return      array
+        * @param string $table Table name present in TCA
+        * @param array $row Row from table
+        * @return array
         * @see t3lib_transferData::renderRecord(), t3lib_TCEforms::setTSconfig(), SC_wizard_list::main(), SC_wizard_add::main()
         */
        public static function getTCEFORM_TSconfig($table, $row) {
@@ -3329,7 +3330,8 @@ final class t3lib_BEfunc {
                $res['_CURRENT_PID'] = $cPid;
                $res['_THIS_UID'] = $row['uid'];
                $res['_THIS_CID'] = $row['cid'];
-               $res['_THIS_ROW'] = $row; // So the row will be passed to foreign_table_where_query()
+                       // So the row will be passed to foreign_table_where_query()
+               $res['_THIS_ROW'] = $row;
 
                foreach ($rootLine as $rC) {
                        if (!$res['_STORAGE_PID']) {
@@ -3344,27 +3346,32 @@ final class t3lib_BEfunc {
        }
 
        /**
-        * Find the real PID of the record (with $uid from $table). This MAY be impossible if the pid is set as a reference to the former record or a page (if two records are created at one time).
-        * NOTICE: Make sure that the input PID is never negative because the record was an offline version! Therefore, you should always use t3lib_BEfunc::fixVersioningPid($table,$row); on the data you input before calling this function!
-        *
-        * @param       string          Table name
-        * @param       integer         Record uid
-        * @param       integer         Record pid, could be negative then pointing to a record from same table whose pid to find and return.
-        * @return      integer
+        * Find the real PID of the record (with $uid from $table).
+        * This MAY be impossible if the pid is set as a reference to the former record or a page (if two records are created at one time).
+        * NOTICE: Make sure that the input PID is never negative because the record was an offline version!
+        * Therefore, you should always use t3lib_BEfunc::fixVersioningPid($table,$row); on the data you input before calling this function!
+        *
+        * @param string $table Table name
+        * @param integer $uid Record uid
+        * @param integer $pid Record pid, could be negative then pointing to a record from same table whose pid to find and return.
+        * @return integer
         * @internal
         * @see t3lib_TCEmain::copyRecord(), getTSCpid()
         */
        public static function getTSconfig_pidValue($table, $uid, $pid) {
-
-               if (t3lib_utility_Math::canBeInterpretedAsInteger($pid)) { // If pid is an integer this takes precedence in our lookup.
+                       // If pid is an integer this takes precedence in our lookup.
+               if (t3lib_utility_Math::canBeInterpretedAsInteger($pid)) {
                        $thePidValue = intval($pid);
-                       if ($thePidValue < 0) { // If ref to another record, look that record up.
+                               // If ref to another record, look that record up.
+                       if ($thePidValue < 0) {
                                $pidRec = self::getRecord($table, abs($thePidValue), 'pid');
                                $thePidValue = is_array($pidRec) ? $pidRec['pid'] : -2; // Returns -2 if the record did not exist.
                        }
                        // ... else the pos/zero pid is just returned here.
-               } else { // No integer pid and we are forced to look up the $pid
-                       $rr = self::getRecord($table, $uid); // Try to fetch the record pid from uid. If the uid is 'NEW...' then this will of course return nothing...
+                       // No integer pid and we are forced to look up the $pid
+               } else {
+                               // Try to fetch the record pid from uid. If the uid is 'NEW...' then this will of course return nothing
+                       $rr = self::getRecord($table, $uid);
 
                        if (is_array($rr)) {
                                        // First check if the pid is -1 which means it is a workspaced element. Get the "real" record:
@@ -3374,13 +3381,15 @@ final class t3lib_BEfunc {
                                                $thePidValue = $rr['pid'];
                                        }
                                } else {
-                                       $thePidValue = $rr['pid']; // Returning the "pid" of the record
+                                               // Returning the "pid" of the record
+                                       $thePidValue = $rr['pid'];
                                }
                        }
 
                        if (!$thePidValue) {
+                                       // Returns -1 if the record with this pid was not found.
                                $thePidValue = -1;
-                       } // Returns -1 if the record with this pid was not found.
+                       }
                }
 
                return $thePidValue;
@@ -3389,10 +3398,10 @@ final class t3lib_BEfunc {
        /**
         * Return $uid if $table is pages and $uid is integer - otherwise the $pid
         *
-        * @param       string          Table name
-        * @param       integer         Record uid
-        * @param       integer         Record pid
-        * @return      integer
+        * @param string $table Table name
+        * @param integer $uid Record uid
+        * @param integer $pid Record pid
+        * @return integer
         * @internal
         * @see t3lib_TCEforms::getTSCpid()
         */
@@ -3404,10 +3413,10 @@ final class t3lib_BEfunc {
        /**
         * Returns the REAL pid of the record, if possible. If both $uid and $pid is strings, then pid=-1 is returned as an error indication.
         *
-        * @param       string          Table name
-        * @param       integer         Record uid
-        * @param       integer         Record pid
-        * @return      array           Array of two integers; first is the REAL PID of a record and if its a new record negative values are resolved to the true PID, second value is the PID value for TSconfig (uid if table is pages, otherwise the pid)
+        * @param string $table Table name
+        * @param integer $uid Record uid
+        * @param integer $pid Record pid
+        * @return array Array of two integers; first is the REAL PID of a record and if its a new record negative values are resolved to the true PID, second value is the PID value for TSconfig (uid if table is pages, otherwise the pid)
         * @internal
         * @see t3lib_TCEmain::setHistory(), t3lib_TCEmain::process_datamap()
         */
@@ -3423,8 +3432,8 @@ final class t3lib_BEfunc {
        /**
         * Returns first found domain record "domainName" (without trailing slash) if found in the input $rootLine
         *
-        * @param       array           Root line array
-        * @return      string          Domain name, if found.
+        * @param array $rootLine Root line array
+        * @return string Domain name, if found.
         */
        public static function firstDomainRecord($rootLine) {
                if (t3lib_extMgm::isLoaded('cms')) {
@@ -3441,17 +3450,17 @@ final class t3lib_BEfunc {
        /**
         * Returns the sys_domain record for $domain, optionally with $path appended.
         *
-        * @param       string          Domain name
-        * @param       string          Appended path
-        * @return      array           Domain record, if found
+        * @param string $domain Domain name
+        * @param string $path Appended path
+        * @return array Domain record, if found
         */
        public static function getDomainStartPage($domain, $path = '') {
                if (t3lib_extMgm::isLoaded('cms')) {
                        $domain = explode(':', $domain);
                        $domain = strtolower(preg_replace('/\.$/', '', $domain[0]));
-                               // path is calculated.
+                               // Path is calculated.
                        $path = trim(preg_replace('/\/[^\/]*$/', '', $path));
-                               // stuff:
+                               // Stuff
                        $domain .= $path;
 
                        $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery('sys_domain.*', 'pages,sys_domain', '
@@ -3469,11 +3478,11 @@ final class t3lib_BEfunc {
        /**
         * Returns overlayered RTE setup from an array with TSconfig. Used in TCEforms and TCEmain
         *
-        * @param       array           The properties of Page TSconfig in the key "RTE."
-        * @param       string          Table name
-        * @param       string          Field name
-        * @param       string          Type value of the current record (like from CType of tt_content)
-        * @return      array           Array with the configuration for the RTE
+        * @param array $RTEprop The properties of Page TSconfig in the key "RTE."
+        * @param string $table Table name
+        * @param string $field Field name
+        * @param string $type Type value of the current record (like from CType of tt_content)
+        * @return array Array with the configuration for the RTE
         * @internal
         */
        public static function RTEsetup($RTEprop, $table, $field, $type = '') {
@@ -3493,7 +3502,7 @@ final class t3lib_BEfunc {
         * Returns first possible RTE object if available.
         * Usage: $RTEobj = &t3lib_BEfunc::RTEgetObj();
         *
-        * @return      mixed           If available, returns RTE object, otherwise an array of messages from possible RTEs
+        * @return mixed If available, returns RTE object, otherwise an array of messages from possible RTEs
         */
        public static function &RTEgetObj() {
 
@@ -3531,8 +3540,8 @@ final class t3lib_BEfunc {
         * Returns soft-reference parser for the softRef processing type
         * Usage: $softRefObj = &t3lib_BEfunc::softRefParserObj('[parser key]');
         *
-        * @param       string          softRef parser key
-        * @return      mixed           If available, returns Soft link parser object.
+        * @param string $spKey softRef parser key
+        * @return mixed If available, returns Soft link parser object.
         */
        public static function &softRefParserObj($spKey) {
 
@@ -3561,10 +3570,8 @@ final class t3lib_BEfunc {
        /**
         * Returns array of soft parser references
         *
-        * @param       string          softRef parser list
-        * @param       string          Table name
-        * @param       string          Field name
-        * @return      array           Array where the parser key is the key and the value is the parameter string
+        * @param string $parserList softRef parser list
+        * @return array Array where the parser key is the key and the value is the parameter string
         */
        public static function explodeSoftRefParserList($parserList) {
 
@@ -3596,8 +3603,8 @@ final class t3lib_BEfunc {
        /**
         * Returns TRUE if $modName is set and is found as a main- or submodule in $TBE_MODULES array
         *
-        * @param       string          Module name
-        * @return      boolean
+        * @param string $modName Module name
+        * @return boolean
         */
        public static function isModuleSetInTBE_MODULES($modName) {
                $loaded = array();
@@ -3617,11 +3624,11 @@ final class t3lib_BEfunc {
        /**
         * Counting references to a record/file
         *
-        * @param       string          Table name (or "_FILE" if its a file)
-        * @param       string          Reference: If table, then integer-uid, if _FILE, then file reference (relative to PATH_site)
-        * @param       string          Message with %s, eg. "There were %s records pointing to this file!"
-        * @param       string          reference count
-        * @return      string          Output string (or integer count value if no msg string specified)
+        * @param string $table Table name (or "_FILE" if its a file)
+        * @param string $ref Reference: If table, then integer-uid, if _FILE, then file reference (relative to PATH_site)
+        * @param string $msg Message with %s, eg. "There were %s records pointing to this file!"
+        * @param string $count Reference count
+        * @return string Output string (or integer count value if no msg string specified)
         */
        public static function referenceCount($table, $ref, $msg = '', $count = NULL) {
                if ($count === NULL) {
@@ -3650,14 +3657,13 @@ final class t3lib_BEfunc {
                return ($count ? ($msg ? sprintf($msg, $count) : $count) : '');
        }
 
-
        /**
         * Counting translations of records
         *
-        * @param       string          Table name
-        * @param       string          Reference: the record's uid
-        * @param       string          Message with %s, eg. "This record has %s translation(s) which will be deleted, too!"
-        * @return      string          Output string (or integer count value if no msg string specified)
+        * @param string $table Table name
+        * @param string $ref Reference: the record's uid
+        * @param string $msg Message with %s, eg. "This record has %s translation(s) which will be deleted, too!"
+        * @return string Output string (or integer count value if no msg string specified)
         */
        public static function translationCount($table, $ref, $msg = '') {
                if (empty($GLOBALS['TCA'][$table]['ctrl']['transForeignTable']) &&
@@ -3682,7 +3688,6 @@ final class t3lib_BEfunc {
                return ($count ? ($msg ? sprintf($msg, $count) : $count) : '');
        }
 
-
        /*******************************************
         *
         * Workspaces / Versioning
@@ -3692,13 +3697,13 @@ final class t3lib_BEfunc {
        /**
         * Select all versions of a record, ordered by version id (DESC)
         *
-        * @param       string          Table name to select from
-        * @param       integer         Record uid for which to find versions.
-        * @param       string          Field list to select
-        * @param       integer         Workspace ID, if zero all versions regardless of workspace is found.
-        * @param       boolean         If set, deleted-flagged versions are included! (Only for clean-up script!)
-        * @param       array           The current record
-        * @return      array           Array of versions of table/uid
+        * @param string $table Table name to select from
+        * @param integer $uid Record uid for which to find versions.
+        * @param string $fields Field list to select
+        * @param integer $workspace Workspace ID, if zero all versions regardless of workspace is found.
+        * @param boolean $includeDeletedRecords If set, deleted-flagged versions are included! (Only for clean-up script!)
+        * @param array $row The current record
+        * @return array Array of versions of table/uid
         */
        public static function selectVersionsOfRecord($table, $uid, $fields = '*', $workspace = 0, $includeDeletedRecords = FALSE, $row = NULL) {
                $realPid = 0;
@@ -3764,10 +3769,10 @@ final class t3lib_BEfunc {
         * Will only translate if the workspace of the input record matches that of the current user (unless flag set)
         * Principle; Record offline! => Find online?
         *
-        * @param       string          Table name
-        * @param       array           Record array passed by reference. As minimum, "pid" and "uid" fields must exist! "t3ver_oid" and "t3ver_wsid" is nice and will save you a DB query.
-        * @param       boolean         Ignore workspace match
-        * @return      void            (Passed by ref). If the record had its pid corrected to the online versions pid, then "_ORIG_pid" is set to the original pid value (-1 of course). The field "_ORIG_pid" is used by various other functions to detect if a record was in fact in a versionized branch.
+        * @param string $table Table name
+        * @param array $rr Record array passed by reference. As minimum, "pid" and "uid" fields must exist! "t3ver_oid" and "t3ver_wsid" is nice and will save you a DB query.
+        * @param boolean $ignoreWorkspaceMatch Ignore workspace match
+        * @return void (Passed by ref). If the record had its pid corrected to the online versions pid, then "_ORIG_pid" is set to the original pid value (-1 of course). The field "_ORIG_pid" is used by various other functions to detect if a record was in fact in a versionized branch.
         * @see t3lib_page::fixVersioningPid()
         */
        public static function fixVersioningPid($table, &$rr, $ignoreWorkspaceMatch = FALSE) {
@@ -3801,23 +3806,29 @@ final class t3lib_BEfunc {
 
        /**
         * Workspace Preview Overlay
-        * Generally ALWAYS used when records are selected based on uid or pid. If records are selected on other fields than uid or pid (eg. "email = ....") then usage might produce undesired results and that should be evaluated on individual basis.
+        * Generally ALWAYS used when records are selected based on uid or pid.
+        * If records are selected on other fields than uid or pid (eg. "email = ....")
+        * then usage might produce undesired results and that should be evaluated on individual basis.
         * Principle; Record online! => Find offline?
-        * Recently, this function has been modified so it MAY set $row to FALSE. This happens if a version overlay with the move-id pointer is found in which case we would like a backend preview. In other words, you should check if the input record is still an array afterwards when using this function.
-        *
-        * @param       string          Table name
-        * @param       array           Record array passed by reference. As minimum, the "uid" and  "pid" fields must exist! Fake fields cannot exist since the fields in the array is used as field names in the SQL look up. It would be nice to have fields like "t3ver_state" and "t3ver_mode_id" as well to avoid a new lookup inside movePlhOL().
-        * @param       integer         Workspace ID, if not specified will use $GLOBALS['BE_USER']->workspace
-        * @param       boolean         If TRUE the function does not return a "pointer" row for moved records in a workspace
-        * @return      void            (Passed by ref).
+        * Recently, this function has been modified so it MAY set $row to FALSE.
+        * This happens if a version overlay with the move-id pointer is found in which case we would like a backend preview.
+        * In other words, you should check if the input record is still an array afterwards when using this function.
+        *
+        * @param string $table Table name
+        * @param array $row Record array passed by reference. As minimum, the "uid" and  "pid" fields must exist! Fake fields cannot exist since the fields in the array is used as field names in the SQL look up. It would be nice to have fields like "t3ver_state" and "t3ver_mode_id" as well to avoid a new lookup inside movePlhOL().
+        * @param integer $wsid Workspace ID, if not specified will use $GLOBALS['BE_USER']->workspace
+        * @param boolean $unsetMovePointers If TRUE the function does not return a "pointer" row for moved records in a workspace
+        * @return void (Passed by ref).
         * @see fixVersioningPid()
         */
        public static function workspaceOL($table, &$row, $wsid = -99, $unsetMovePointers = FALSE) {
                if (t3lib_extMgm::isLoaded('version')) {
 
-                       $previewMovePlaceholders = TRUE; // If this is FALSE the placeholder is shown raw in the backend. I don't know if this move can be useful for users to toggle. Technically it can help debugging...
+                               // If this is FALSE the placeholder is shown raw in the backend.
+                               // I don't know if this move can be useful for users to toggle. Technically it can help debugging.
+                       $previewMovePlaceholders = TRUE;
 
-                               // Initialize workspace ID:
+                               // Initialize workspace ID
                        if ($wsid == -99) {
                                $wsid = $GLOBALS['BE_USER']->workspace;
                        }
@@ -3830,7 +3841,6 @@ final class t3lib_BEfunc {
                                        $orig_uid = $row['uid'];
                                        $orig_pid = $row['pid'];
                                        $movePldSwap = self::movePlhOL($table, $row);
-                                       #                       if (!is_array($row)) return;
                                }
 
                                $wsAlt = self::getWorkspaceVersionOfRecord($wsid, $table, $row['uid'], implode(',', array_keys($row)));
@@ -3855,13 +3865,15 @@ final class t3lib_BEfunc {
                                                }
                                        }
 
-                                               // Always correct PID from -1 to what it should be:
+                                               // Always correct PID from -1 to what it should be
                                        if (isset($wsAlt['pid'])) {
-                                               $wsAlt['_ORIG_pid'] = $wsAlt['pid']; // Keep the old (-1) - indicates it was a version...
-                                               $wsAlt['pid'] = $row['pid']; // Set in the online versions PID.
+                                                       // Keep the old (-1) - indicates it was a version.
+                                               $wsAlt['_ORIG_pid'] = $wsAlt['pid'];
+                                                       // Set in the online versions PID.
+                                               $wsAlt['pid'] = $row['pid'];
                                        }
 
-                                               // For versions of single elements or page+content, swap UID and PID:
+                                               // For versions of single elements or page+content, swap UID and PID
                                        $wsAlt['_ORIG_uid'] = $wsAlt['uid'];
                                        $wsAlt['uid'] = $row['uid'];
 
@@ -3877,7 +3889,8 @@ final class t3lib_BEfunc {
                                        $row['_MOVE_PLH'] = TRUE;
                                        $row['_MOVE_PLH_uid'] = $orig_uid;
                                        $row['_MOVE_PLH_pid'] = $orig_pid;
-                                       $row['t3ver_state'] = 3; // For display; To make the icon right for the placeholder vs. the original
+                                               // For display; To make the icon right for the placeholder vs. the original
+                                       $row['t3ver_state'] = 3;
                                }
                        }
                }
@@ -3886,13 +3899,14 @@ final class t3lib_BEfunc {
        /**
         * Checks if record is a move-placeholder (t3ver_state==3) and if so it will set $row to be the pointed-to live record (and return TRUE)
         *
-        * @param       string          Table name
-        * @param       array           Row (passed by reference) - must be online record!
-        * @return      boolean         TRUE if overlay is made.
+        * @param string $table Table name
+        * @param array $row Row (passed by reference) - must be online record!
+        * @return boolean TRUE if overlay is made.
         * @see t3lib_page::movePlhOl()
         */
        public static function movePlhOL($table, &$row) {
-               if ($table == 'pages' || (int) $GLOBALS['TCA'][$table]['ctrl']['versioningWS'] >= 2) { // Only for WS ver 2... (moving)
+                       // Only for WS ver 2... (moving)
+               if ($table == 'pages' || (int) $GLOBALS['TCA'][$table]['ctrl']['versioningWS'] >= 2) {
 
                                // If t3ver_move_id or t3ver_state is not found, then find it... (but we like best if it is here...)
                        if (!isset($row['t3ver_move_id']) || !isset($row['t3ver_state'])) {
@@ -3918,11 +3932,11 @@ final class t3lib_BEfunc {
        /**
         * Select the workspace version of a record, if exists
         *
-        * @param       integer         Workspace ID
-        * @param       string          Table name to select from
-        * @param       integer         Record uid for which to find workspace version.
-        * @param       string          Field list to select
-        * @return      array           If found, return record, otherwise FALSE
+        * @param integer $workspace Workspace ID
+        * @param string $table Table name to select from
+        * @param integer $uid Record uid for which to find workspace version.
+        * @param string $fields Field list to select
+        * @return array If found, return record, otherwise FALSE
         */
        public static function getWorkspaceVersionOfRecord($workspace, $table, $uid, $fields = '*') {
                if (t3lib_extMgm::isLoaded('version')) {
@@ -3949,10 +3963,10 @@ final class t3lib_BEfunc {
        /**
         * Returns live version of record
         *
-        * @param       string          Table name
-        * @param       integer         Record UID of draft, offline version
-        * @param       string          Field list, default is *
-        * @return      array           If found, the record, otherwise nothing.
+        * @param string $table Table name
+        * @param integer $uid Record UID of draft, offline version
+        * @param string $fields Field list, default is *
+        * @return array If found, the record, otherwise nothing.
         */
        public static function getLiveVersionOfRecord($table, $uid, $fields = '*') {
                $liveVersionId = self::getLiveVersionIdOfRecord($table, $uid);
@@ -4014,8 +4028,8 @@ final class t3lib_BEfunc {
         * Will return where clause de-selecting new(/deleted)-versions from other workspaces.
         * If in live-workspace, don't show "MOVE-TO-PLACEHOLDERS" records if versioningWS is 2 (allows moving)
         *
-        * @param       string          Table name
-        * @return      string          Where clause if applicable.
+        * @param string $table Table name
+        * @return string Where clause if applicable.
         */
        public static function versioningPlaceholderClause($table) {
                if ($GLOBALS['TCA'][$table] && $GLOBALS['TCA'][$table]['ctrl']['versioningWS']) {
@@ -4027,9 +4041,9 @@ final class t3lib_BEfunc {
        /**
         * Get additional where clause to select records of a specific workspace (includes live as well).
         *
-        * @param  $table
-        * @param  $workspaceId
-        * @return string
+        * @param string $table Table name
+        * @param integer $workspaceId Workspace ID
+        * @return string Workspace where clause
         */
        public static function getWorkspaceWhereClause($table, $workspaceId = NULL) {
                $whereClause = '';
@@ -4050,9 +4064,9 @@ final class t3lib_BEfunc {
        /**
         * Count number of versions on a page
         *
-        * @param       integer         Workspace ID
-        * @param       integer         Page ID
-        * @return      array           Overview of records
+        * @param integer $workspace Workspace ID
+        * @param integer $pageId Page ID
+        * @return array Overview of records
         */
        public static function countVersionsOfRecordsOnPage($workspace, $pageId) {
                $output = array();
@@ -4085,9 +4099,9 @@ final class t3lib_BEfunc {
        /**
         * Performs mapping of new uids to new versions UID in case of import inside a workspace.
         *
-        * @param       string          Table name
-        * @param       integer         Record uid (of live record placeholder)
-        * @return      integer         Uid of offline version if any, otherwise live uid.
+        * @param string $table Table name
+        * @param integer $uid Record uid (of live record placeholder)
+        * @return integer Uid of offline version if any, otherwise live uid.
         */
        public static function wsMapId($table, $uid) {
                if ($wsRec = self::getWorkspaceVersionOfRecord($GLOBALS['BE_USER']->workspace, $table, $uid, 'uid')) {
@@ -4100,10 +4114,10 @@ final class t3lib_BEfunc {
        /**
         * Returns move placeholder of online (live) version
         *
-        * @param       string          Table name
-        * @param       integer         Record UID of online version
-        * @param       string          Field list, default is *
-        * @return      array           If found, the record, otherwise nothing.
+        * @param string $table Table name
+        * @param integer $uid Record UID of online version
+        * @param string $fields Field list, default is *
+        * @return array If found, the record, otherwise nothing.
         */
        public static function getMovePlaceholder($table, $uid, $fields = '*') {
                $workspace = $GLOBALS['BE_USER']->workspace;
@@ -4138,10 +4152,10 @@ final class t3lib_BEfunc {
        /**
         * Prints TYPO3 Copyright notice for About Modules etc. modules.
         *
-        * @return      void
+        * @return void
         */
        public static function TYPO3_copyRightNotice() {
-                       // COPYRIGHT NOTICE:
+                       // Copyright Notice
                $loginCopyrightWarrantyProvider = strip_tags(trim($GLOBALS['TYPO3_CONF_VARS']['SYS']['loginCopyrightWarrantyProvider']));
                $loginCopyrightWarrantyURL = strip_tags(trim($GLOBALS['TYPO3_CONF_VARS']['SYS']['loginCopyrightWarrantyURL']));
 
@@ -4180,14 +4194,17 @@ final class t3lib_BEfunc {
         * Display some warning messages if this installation is obviously insecure!!
         * These warnings are only displayed to admin users
         *
-        * @return      void
+        * @return void
         */
        public static function displayWarningMessages() {
                if ($GLOBALS['BE_USER']->isAdmin()) {
-                       $warnings = array(); // Array containing warnings that must be displayed
-                       $enableInstallToolFile = PATH_site . 'typo3conf/ENABLE_INSTALL_TOOL'; // If this file exists and it isn't older than one hour, the Install Tool is enabled
+                               // Array containing warnings that must be displayed
+                       $warnings = array();
+                               // If this file exists and it isn't older than one hour, the Install Tool is enabled
+                       $enableInstallToolFile = PATH_site . 'typo3conf/ENABLE_INSTALL_TOOL';
 
-                       $cmd = t3lib_div::_GET('adminWarning_cmd'); // Cleanup command, if set
+                               // Cleanup command, if set
+                       $cmd = t3lib_div::_GET('adminWarning_cmd');
                        switch ($cmd) {
                                case 'remove_ENABLE_INSTALL_TOOL':
                                        if (unlink($enableInstallToolFile)) {
@@ -4364,8 +4381,8 @@ final class t3lib_BEfunc {
        /**
         * Returns "web" if the $path (absolute) is within the DOCUMENT ROOT - and thereby qualifies as a "web" folder.
         *
-        * @param       string          Path to evaluate
-        * @return      boolean
+        * @param string $path Path to evaluate
+        * @return boolean
         */
        public static function getPathType_web_nonweb($path) {
                return t3lib_div::isFirstPartOfStr($path, t3lib_div::getIndpEnv('TYPO3_DOCUMENT_ROOT')) ? 'web' : '';
@@ -4374,8 +4391,8 @@ final class t3lib_BEfunc {
        /**
         * Creates ADMCMD parameters for the "viewpage" extension / "cms" frontend
         *
-        * @param       array           Page record
-        * @return      string          Query-parameters
+        * @param array $pageinfo Page record
+        * @return string Query-parameters
         * @internal
         */
        public static function ADMCMD_previewCmds($pageinfo) {
@@ -4396,8 +4413,8 @@ final class t3lib_BEfunc {
         * $params is exploded by line-breaks and each line is supposed to be on the syntax [key] = [some value]
         * These pairs will be parsed into an array an returned.
         *
-        * @param       string          String of parameters on multiple lines to parse into key-value pairs (see function description)
-        * @return      array
+        * @param string $params String of parameters on multiple lines to parse into key-value pairs (see function description)
+        * @return array
         */
        public static function processParams($params) {
                $paramArr = array();
@@ -4415,8 +4432,8 @@ final class t3lib_BEfunc {
        /**
         * Returns the name of the backend script relative to the TYPO3 main directory.
         *
-        * @param       string          Name of the backend interface  (backend, frontend) to look up the script name for. If no interface is given, the interface for the current backend user is used.
-        * @return      string          The name of the backend script relative to the TYPO3 main directory.
+        * @param string $interface Name of the backend interface  (backend, frontend) to look up the script name for. If no interface is given, the interface for the current backend user is used.
+        * @return string The name of the backend script relative to the TYPO3 main directory.
         */
        public static function getBackendScript($interface = '') {
                if (!$interface) {
@@ -4439,7 +4456,7 @@ final class t3lib_BEfunc {
        /**
         * Determines whether a table is enabled for workspaces.
         *
-        * @param  $table Name of the table to be checked
+        * @param string $table Name of the table to be checked
         * @return boolean
         */
        public static function isTableWorkspaceEnabled($table) {
@@ -4465,4 +4482,4 @@ final class t3lib_BEfunc {
        }
 }
 
-?>
+?>
\ No newline at end of file