[TASK] Clean up phpDoc comments in typo3/
authorWouter Wolters <typo3@wouterwolters.nl>
Mon, 11 Jun 2012 21:16:22 +0000 (23:16 +0200)
committerChristian Kuhn <lolli@schwarzbu.ch>
Mon, 11 Jun 2012 22:12:38 +0000 (00:12 +0200)
Clean up phpDoc comments for the following classes:

* typo3/class.db_list.inc
* typo3/class.db_list_extra.inc

Clean up provides:

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

Change-Id: I13914081107bf321dd7bb35b7943e7dd3c0fd5e1
Resolves: #37924
Releases: 6.0
Reviewed-on: http://review.typo3.org/11966
Reviewed-by: Christian Kuhn
Tested-by: Christian Kuhn
typo3/class.db_list.inc
typo3/class.db_list_extra.inc

index 39d6a74..b009000 100644 (file)
@@ -24,6 +24,7 @@
 *
 *  This copyright notice MUST APPEAR in all copies of the script!
 ***************************************************************/
+
 /**
  * Include file extending t3lib_recordList
  * Shared between Web>List (db_list.php) and Web>Page (sysext/cms/layout/db_layout.php)
  * Revised for TYPO3 3.6 December/2003 by Kasper Skårhøj
  * XHTML compliant
  *
- * @author     Kasper Skårhøj <kasperYYYY@typo3.com>
+ * @author Kasper Skårhøj <kasperYYYY@typo3.com>
  */
 
-
-
-
-
-
-
-
-
-
-
 /**
  * Child class for rendering of Web > List (not the final class. see class.db_list_extra)
  *
- * @author     Kasper Skårhøj <kasperYYYY@typo3.com>
+ * @author Kasper Skårhøj <kasperYYYY@typo3.com>
  * @package TYPO3
  * @subpackage core
  * @see localRecordList
 class recordList extends t3lib_recordList {
 
                // External, static:
-       var $tableList='';                              // Specify a list of tables which are the only ones allowed to be displayed.
-       var $returnUrl='';                              // Return URL
-       var $thumbs = 0;                                // Boolean. Thumbnails on records containing files (pictures)
-       var $itemsLimitPerTable = 20;                   // default Max items shown per table in "multi-table mode", may be overridden by tables.php
-       var $itemsLimitSingleTable = 100;               // default Max items shown per table in "single-table mode", may be overridden by tables.php
+               // Specify a list of tables which are the only ones allowed to be displayed.
+       var $tableList = '';
+               // Return URL
+       var $returnUrl = '';
+               // Boolean. Thumbnails on records containing files (pictures)
+       var $thumbs = 0;
+               // default Max items shown per table in "multi-table mode", may be overridden by tables.php
+       var $itemsLimitPerTable = 20;
+               // default Max items shown per table in "single-table mode", may be overridden by tables.php
+       var $itemsLimitSingleTable = 100;
        var $widthGif = '<img src="clear.gif" width="1" height="4" hspace="160" alt="" />';
-       var $script = 'index.php';                      // Current script name
-       var $allFields=0;                               // Indicates if all available fields for a user should be selected or not.
-       var $localizationView=FALSE;                    // Whether to show localization view or not.
+               // Current script name
+       var $script = 'index.php';
+               // Indicates if all available fields for a user should be selected or not.
+       var $allFields = 0;
+               // Whether to show localization view or not.
+       var $localizationView = FALSE;
 
                // Internal, static: GPvar:
-       var $csvOutput=FALSE;                           // If set, csvList is outputted.
-       var $sortField;                                 // Field, to sort list by
-       var $sortRev;                                   // Field, indicating to sort in reverse order.
-       var $displayFields;                             // Array, containing which fields to display in extended mode
-       var $duplicateField;                            // String, can contain the field name from a table which must have duplicate values marked.
+               // If set, csvList is outputted.
+       var $csvOutput = FALSE;
+               // Field, to sort list by
+       var $sortField;
+               // Field, indicating to sort in reverse order.
+       var $sortRev;
+               // Array, containing which fields to display in extended mode
+       var $displayFields;
+               // String, can contain the field name from a table which must have duplicate values marked.
+       var $duplicateField;
 
                // Internal, static:
-       var $id;                                        // Page id
-       var $table='';                                  // Tablename if single-table mode
-       var $listOnlyInSingleTableMode=FALSE;           // If TRUE, records are listed only if a specific table is selected.
-       var $firstElementNumber=0;                      // Pointer for browsing list
-       var $searchString='';                           // Search string
-       var $searchLevels='';                           // Levels to search down.
-       var $showLimit=0;                               // Number of records to show
-       var $pidSelect='';                              // List of ids from which to select/search etc. (when search-levels are set high). See start()
-       var $perms_clause='';                           // Page select permissions
-       var $calcPerms=0;                               // Some permissions...
-       var $clickTitleMode = '';                       // Mode for what happens when a user clicks the title of a record.
-       var $modSharedTSconfig = array();               // Shared module configuration, used by localization features
-       var $pageRecord = array();              // Loaded with page record with version overlay if any.
-       var $hideTables = '';                   // Tables which should not get listed
+               // Page id
+       var $id;
+               // Tablename if single-table mode
+       var $table = '';
+               // If TRUE, records are listed only if a specific table is selected.
+       var $listOnlyInSingleTableMode = FALSE;
+               // Pointer for browsing list
+       var $firstElementNumber = 0;
+               // Search string
+       var $searchString = '';
+               // Levels to search down.
+       var $searchLevels = '';
+               // Number of records to show
+       var $showLimit = 0;
+               // List of ids from which to select/search etc. (when search-levels are set high). See start()
+       var $pidSelect = '';
+               // Page select permissions
+       var $perms_clause = '';
+               // Some permissions...
+       var $calcPerms = 0;
+               // Mode for what happens when a user clicks the title of a record.
+       var $clickTitleMode = '';
+               // Shared module configuration, used by localization features
+       var $modSharedTSconfig = array();
+               // Loaded with page record with version overlay if any.
+       var $pageRecord = array();
+               // Tables which should not get listed
+       var $hideTables = '';
 
        /**
         * Tables which should not list their translations
         * @var $hideTranslations string
         */
        public $hideTranslations = '';
-
-       var $tableTSconfigOverTCA = array(); //TSconfig which overwrites TCA-Settings
-       var $tablesCollapsed = array(); // Array of collapsed / uncollapsed tables in multi table view
+               //TSconfig which overwrites TCA-Settings
+       var $tableTSconfigOverTCA = array();
+               // Array of collapsed / uncollapsed tables in multi table view
+       var $tablesCollapsed = array();
 
                // Internal, dynamic:
-       var $JScode = '';                               // JavaScript code accumulation
-       var $HTMLcode = '';                             // HTML output
-       var $iLimit=0;                                  // "LIMIT " in SQL...
-       var $eCounter=0;                                // Counting the elements no matter what...
-       var $totalItems='';                             // Set to the total number of items for a table when selecting.
-       var $recPath_cache=array();                     // Cache for record path
-       var $setFields=array();                         // Fields to display for the current table
-       var $currentTable = array();                    // Used for tracking next/prev uids
-       var $duplicateStack=array();                    // Used for tracking duplicate values of fields
-
-       var $modTSconfig;                               // module configuratio
-
-
+               // JavaScript code accumulation
+       var $JScode = '';
+               // HTML output
+       var $HTMLcode = '';
+               // "LIMIT " in SQL...
+       var $iLimit = 0;
+               // Counting the elements no matter what...
+       var $eCounter = 0;
+               // Set to the total number of items for a table when selecting.
+       var $totalItems = '';
+               // Cache for record path
+       var $recPath_cache = array();
+               // Fields to display for the current table
+       var $setFields = array();
+               // Used for tracking next/prev uids
+       var $currentTable = array();
+               // Used for tracking duplicate values of fields
+       var $duplicateStack = array();
+               // module configuratio
+       var $modTSconfig;
 
        /**
         * Initializes the list generation
         *
-        * @param       integer         Page id for which the list is rendered. Must be >= 0
-        * @param       string          Tablename - if extended mode where only one table is listed at a time.
-        * @param       integer         Browsing pointer.
-        * @param       string          Search word, if any
-        * @param       integer         Number of levels to search down the page tree
-        * @param       integer         Limit of records to be listed.
-        * @return      void
+        * @param integer $id Page id for which the list is rendered. Must be >= 0
+        * @param string $table Tablename - if extended mode where only one table is listed at a time.
+        * @param integer $pointer Browsing pointer.
+        * @param string $search Search word, if any
+        * @param integer $levels Number of levels to search down the page tree
+        * @param integer $showLimit Limit of records to be listed.
+        * @return void
         */
        function start($id, $table, $pointer, $search = '', $levels = '', $showLimit = 0) {
 
                        // Setting internal variables:
-               $this->id=intval($id);                                  // sets the parent id
+                       // sets the parent id
+               $this->id = intval($id);
                if ($GLOBALS['TCA'][$table]) {
                                // Setting single table mode, if table exists:
                        $this->table = $table;
                }
-               $this->firstElementNumber=$pointer;
-               $this->searchString=trim($search);
-               $this->searchLevels=trim($levels);
-               $this->showLimit=t3lib_utility_Math::forceIntegerInRange($showLimit,0,10000);
+               $this->firstElementNumber = $pointer;
+               $this->searchString = trim($search);
+               $this->searchLevels = trim($levels);
+               $this->showLimit = t3lib_utility_Math::forceIntegerInRange($showLimit,0,10000);
 
                        // Setting GPvars:
                $this->csvOutput = t3lib_div::_GP('csv') ? TRUE : FALSE;
@@ -148,15 +175,15 @@ class recordList extends t3lib_recordList {
                }
 
                        // Init dynamic vars:
-               $this->counter=0;
-               $this->JScode='';
-               $this->HTMLcode='';
+               $this->counter = 0;
+               $this->JScode = '';
+               $this->HTMLcode = '';
 
-                       // limits
-               if(isset($this->modTSconfig['properties']['itemsLimitPerTable'])) {
+                       // Limits
+               if (isset($this->modTSconfig['properties']['itemsLimitPerTable'])) {
                        $this->itemsLimitPerTable = t3lib_utility_Math::forceIntegerInRange(intval($this->modTSconfig['properties']['itemsLimitPerTable']), 1, 10000);
                }
-               if(isset($this->modTSconfig['properties']['itemsLimitSingleTable'])) {
+               if (isset($this->modTSconfig['properties']['itemsLimitSingleTable'])) {
                        $this->itemsLimitSingleTable = t3lib_utility_Math::forceIntegerInRange(intval($this->modTSconfig['properties']['itemsLimitSingleTable']), 1, 10000);
                }
 
@@ -164,18 +191,18 @@ class recordList extends t3lib_recordList {
                $searchLevels = intval($this->searchLevels);
                $this->perms_clause = $GLOBALS['BE_USER']->getPagePermsClause(1);
 
-                       // this will hide records from display - it has nothing todo with user rights!!
+                       // This will hide records from display - it has nothing todo with user rights!!
                if ($pidList = $GLOBALS['BE_USER']->getTSConfigVal('options.hideRecords.pages')) {
                        if ($pidList = $GLOBALS['TYPO3_DB']->cleanIntList($pidList)) {
                                $this->perms_clause .= ' AND pages.uid NOT IN ('.$pidList.')';
                        }
                }
 
-               // Get configuration of collapsed tables from user uc and merge with sanitized GP vars
+                       // Get configuration of collapsed tables from user uc and merge with sanitized GP vars
                $this->tablesCollapsed = is_array($GLOBALS['BE_USER']->uc['moduleData']['list']) ? $GLOBALS['BE_USER']->uc['moduleData']['list'] : array();
                $collapseOverride = t3lib_div::_GP('collapse');
                if (is_array($collapseOverride)) {
-                       foreach($collapseOverride as $collapseTable => $collapseValue) {
+                       foreach ($collapseOverride as $collapseTable => $collapseValue) {
                                if (is_array($GLOBALS['TCA'][$collapseTable]) && ($collapseValue == 0 || $collapseValue == 1)) {
                                        $this->tablesCollapsed[$collapseTable] = $collapseValue;
                                }
@@ -211,7 +238,7 @@ class recordList extends t3lib_recordList {
         * The HTML is accumulated in $this->HTMLcode
         * Finishes off with a stopper-gif
         *
-        * @return      void
+        * @return void
         */
        function generateList() {
 
@@ -270,7 +297,7 @@ class recordList extends t3lib_recordList {
                                }
 
                                        // Find ID to use (might be different for "versioning_followPages" tables)
-                               if (intval($this->searchLevels)==0) {
+                               if (intval($this->searchLevels) == 0) {
                                        if ($GLOBALS['TCA'][$tableName]['ctrl']['versioning_followPages'] && $this->pageRecord['_ORIG_pid'] == -1
                                                && $this->pageRecord['t3ver_swapmode'] == 0) {
                                                $this->pidSelect = 'pid='.intval($this->pageRecord['_ORIG_uid']);
@@ -288,19 +315,19 @@ class recordList extends t3lib_recordList {
        /**
         * Creates the search box
         *
-        * @param       boolean         If TRUE, the search box is wrapped in its own form-tags
-        * @return      string          HTML for the search box
+        * @param boolean $formFields If TRUE, the search box is wrapped in its own form-tags
+        * @return string HTML for the search box
         */
-       function getSearchBox($formFields=1) {
+       function getSearchBox($formFields = 1) {
 
                        // Setting form-elements, if applicable:
-               $formElements=array('','');
+               $formElements = array('','');
                if ($formFields) {
                        $formElements = array('<form action="' . htmlspecialchars($this->listURL('', -1, 'firstElementNumber')) . '" method="post">', '</form>');
                }
 
                        // Make level selector:
-               $opt=array();
+               $opt = array();
                $parts = explode('|',$GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:labels.enterSearchLevels'));
                foreach ($parts as $kv => $label) {
                        $opt[] = '<option value="'.$kv.'"'.($kv==intval($this->searchLevels)?' selected="selected"':'').'>'.htmlspecialchars($label).'</option>';
@@ -335,13 +362,13 @@ class recordList extends t3lib_recordList {
         * Creates the display of sys_notes for the page.
         * Relies on the "sys_note" extension to be loaded.
         *
-        * @return      string          HTML for the sys-notes (if any)
+        * @return string HTML for the sys-notes (if any)
         */
        function showSysNotesForPage() {
-               $out='';
+               $out = '';
 
                        // Checking if extension is loaded:
-               if (!t3lib_extMgm::isLoaded('sys_note'))        return '';
+               if (!t3lib_extMgm::isLoaded('sys_note')) return '';
 
                        // Create query for selecting the notes:
                $result = $GLOBALS['TYPO3_DB']->exec_SELECTquery('*','sys_note','pid IN ('.$this->id.') AND (personal=0 OR cruser='.intval($GLOBALS['BE_USER']->user['uid']).')'.t3lib_BEfunc::deleteClause('sys_note').t3lib_BEfunc::versioningPlaceholderClause('sys_note'));
@@ -365,7 +392,7 @@ class recordList extends t3lib_recordList {
                        }
 
                                // For each note found, make rendering:
-                       while($row = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($result)) {
+                       while ($row = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($result)) {
 
                                        // Create content:
                                $iconImg = t3lib_iconWorks::getSpriteIconForRecord('sys_note', $row);
@@ -376,7 +403,7 @@ class recordList extends t3lib_recordList {
                                $fields['Note:'] = nl2br(htmlspecialchars($row['message']));
 
                                        // Compile content:
-                               $out.='
+                               $out .= '
 
 
                                <!--
@@ -394,13 +421,6 @@ class recordList extends t3lib_recordList {
                return $out;
        }
 
-
-
-
-
-
-
-
        /******************************
         *
         * Various helper functions
@@ -411,7 +431,7 @@ class recordList extends t3lib_recordList {
         * Setting the field names to display in extended list.
         * Sets the internal variable $this->setFields
         *
-        * @return      void
+        * @return void
         */
        function setDispFields() {
 
@@ -445,13 +465,13 @@ class recordList extends t3lib_recordList {
        /**
         * Returns the SQL-query array to select the records from a table $table with pid = $id
         *
-        * @param       string          Table name
-        * @param       integer         Page id (NOT USED! $this->pidSelect is used instead)
-        * @param       string          Additional part for where clause
-        * @param       string          Field list to select, * for all (for "SELECT [fieldlist] FROM ...")
-        * @return      array           Returns query array
+        * @param string $table Table name
+        * @param integer $id Page id (NOT USED! $this->pidSelect is used instead)
+        * @param string $addWhere Additional part for where clause
+        * @param string $fieldList Field list to select, * for all (for "SELECT [fieldlist] FROM ...")
+        * @return array Returns query array
         */
-       function makeQueryArray($table, $id, $addWhere='', $fieldList='*') {
+       function makeQueryArray($table, $id, $addWhere = '', $fieldList = '*') {
                $hookObjectsArr = array();
                if (is_array($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['typo3/class.db_list.inc']['makeQueryArray'])) {
                        foreach ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['typo3/class.db_list.inc']['makeQueryArray'] as $classRef) {
@@ -474,7 +494,7 @@ class recordList extends t3lib_recordList {
                $limit = $this->iLimit ? ($this->firstElementNumber ? $this->firstElementNumber.',' : '').($this->iLimit+1) : '';
 
                        // Filtering on displayable pages (permissions):
-               $pC = ($table=='pages' && $this->perms_clause)?' AND '.$this->perms_clause:'';
+               $pC = ($table == 'pages' && $this->perms_clause)?' AND '.$this->perms_clause:'';
 
                        // Adding search constraints:
                $search = $this->makeSearchString($table, $id);
@@ -521,8 +541,8 @@ class recordList extends t3lib_recordList {
        /**
         * Based on input query array (query for selecting count(*) from a table) it will select the number of records and set the value in $this->totalItems
         *
-        * @param       array           Query array
-        * @return      void
+        * @param array $queryParts Query array
+        * @return void
         * @see makeQueryArray()
         */
        function setTotalItems($queryParts) {
@@ -560,7 +580,7 @@ class recordList extends t3lib_recordList {
                                                'uid=' . $this->searchString
                                        );
 
-                                       foreach($searchableFields as $fieldName) {
+                                       foreach ($searchableFields as $fieldName) {
                                                if (isset($GLOBALS['TCA'][$table]['columns'][$fieldName])) {
                                                        $fieldConfig = &$GLOBALS['TCA'][$table]['columns'][$fieldName]['config'];
                                                        if ($fieldConfig['type'] == 'input' && $fieldConfig['eval'] && t3lib_div::inList($fieldConfig['eval'], 'int')) {
@@ -577,7 +597,7 @@ class recordList extends t3lib_recordList {
                                        $like = '\'%' .
                                                $GLOBALS['TYPO3_DB']->quoteStr($GLOBALS['TYPO3_DB']->escapeStrForLike($this->searchString, $table), $table) .
                                                '%\'';
-                                       foreach($searchableFields as $fieldName) {
+                                       foreach ($searchableFields as $fieldName) {
                                                if (isset($GLOBALS['TCA'][$table]['columns'][$fieldName])) {
                                                        $fieldConfig = &$GLOBALS['TCA'][$table]['columns'][$fieldName]['config'];
                                                        $format = 'LCASE(%s) LIKE LCASE(%s)';
@@ -646,12 +666,12 @@ class recordList extends t3lib_recordList {
         * Returns the title (based on $code) of a table ($table) with the proper link around. For headers over tables.
         * The link will cause the display of all extended mode or not for the table.
         *
-        * @param       string          Table name
-        * @param       string          Table label
-        * @return      string          The linked table label
+        * @param string $table Table name
+        * @param string $code Table label
+        * @return string The linked table label
         */
-       function linkWrapTable($table,$code) {
-               if ($this->table!=$table) {
+       function linkWrapTable($table, $code) {
+               if ($this->table != $table) {
                        return '<a href="' . htmlspecialchars($this->listURL('', $table, 'firstElementNumber')) . '">' . $code . '</a>';
                } else {
                        return '<a href="' . htmlspecialchars($this->listURL('', '', 'sortField,sortRev,table,firstElementNumber')) . '">' . $code . '</a>';
@@ -661,13 +681,13 @@ class recordList extends t3lib_recordList {
        /**
         * Returns the title (based on $code) of a record (from table $table) with the proper link around (that is for 'pages'-records a link to the level of that record...)
         *
-        * @param       string          Table name
-        * @param       integer         Item uid
-        * @param       string          Item title (not htmlspecialchars()'ed yet)
-        * @param       array           Item row
-        * @return      string          The item title. Ready for HTML output (is htmlspecialchars()'ed)
+        * @param string $table Table name
+        * @param integer $uid Item uid
+        * @param string $code Item title (not htmlspecialchars()'ed yet)
+        * @param array $row Item row
+        * @return string The item title. Ready for HTML output (is htmlspecialchars()'ed)
         */
-       function linkWrapItems($table,$uid,$code,$row) {
+       function linkWrapItems($table, $uid, $code, $row) {
                $origCode = $code;
 
                        // If the title is blank, make a "no title" label:
@@ -683,7 +703,7 @@ class recordList extends t3lib_recordList {
                switch((string)$this->clickTitleMode) {
                        case 'edit':
                                        // If the listed table is 'pages' we have to request the permission settings for each page:
-                               if ($table=='pages') {
+                               if ($table == 'pages') {
                                        $localCalcPerms = $GLOBALS['BE_USER']->calcPerms(t3lib_BEfunc::getRecord('pages',$row['uid']));
                                        $permsEdit = $localCalcPerms&2;
                                } else {
@@ -692,7 +712,7 @@ class recordList extends t3lib_recordList {
 
                                        // "Edit" link: ( Only if permissions to edit the page-record of the content of the parent page ($this->id)
                                if ($permsEdit) {
-                                       $params='&edit['.$table.']['.$row['uid'].']=edit';
+                                       $params = '&edit['.$table.']['.$row['uid'].']=edit';
                                        $code = '<a href="#" onclick="' . htmlspecialchars(t3lib_BEfunc::editOnClick($params, $this->backPath, -1)) .
                                                '" title="' . $GLOBALS['LANG']->getLL('edit', 1) . '">' .
                                                        $code .
@@ -701,7 +721,7 @@ class recordList extends t3lib_recordList {
                        break;
                        case 'show':
                                        // "Show" link (only pages and tt_content elements)
-                               if ($table=='pages' || $table=='tt_content') {
+                               if ($table == 'pages' || $table == 'tt_content') {
                                        $code = '<a href="#" onclick="'. htmlspecialchars(t3lib_BEfunc::viewOnClick(
                                                        $table == 'tt_content' ? $this->id . '#' . $row['uid'] : $row['uid'])
                                                ) . '" title="'.$GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:labels.showPage', 1) . '">'.
@@ -709,7 +729,7 @@ class recordList extends t3lib_recordList {
                                }
                        break;
                        case 'info':
-                               // "Info": (All records)
+                                       // "Info": (All records)
                                $code = '<a href="#" onclick="'.htmlspecialchars('top.launchView(\'' . $table . '\', \'' . $row['uid'] .
                                        '\'); return false;') . '" title="'.$GLOBALS['LANG']->getLL('showInfo', 1) . '">' .
                                        $code.
@@ -717,7 +737,7 @@ class recordList extends t3lib_recordList {
                        break;
                        default:
                                        // Output the label now:
-                               if ($table=='pages') {
+                               if ($table == 'pages') {
                                        $code = '<a href="' . htmlspecialchars($this->listURL($uid, '', 'firstElementNumber')) . '" onclick="setHighlight(' . $uid . ')">' . $code . '</a>';
                                } else {
                                        $code = $this->linkUrlMail($code,$origCode);
@@ -731,11 +751,11 @@ class recordList extends t3lib_recordList {
        /**
         * Wrapping input code in link to URL or email if $testString is either.
         *
-        * @param       string          code to wrap
-        * @param       string          String which is tested for being a URL or email and which will be used for the link if so.
-        * @return      string          Link-Wrapped $code value, if $testString was URL or email.
+        * @param string $code code to wrap
+        * @param string $testString String which is tested for being a URL or email and which will be used for the link if so.
+        * @return string Link-Wrapped $code value, if $testString was URL or email.
         */
-       function linkUrlMail($code,$testString) {
+       function linkUrlMail($code, $testString) {
 
                        // Check for URL:
                $schema = parse_url($testString);
@@ -757,12 +777,12 @@ class recordList extends t3lib_recordList {
         * Fixed GPvars are id, table, imagemode, returlUrl, search_field, search_levels and showLimit
         * The GPvars "sortField" and "sortRev" are also included UNLESS they are found in the $exclList variable.
         *
-        * @param       string          Alternative id value. Enter blank string for the current id ($this->id)
-        * @param       string          Tablename to display. Enter "-1" for the current table.
-        * @param       string          Commalist of fields NOT to include ("sortField", "sortRev" or "firstElementNumber")
-        * @return      string          URL
+        * @param string $altId Alternative id value. Enter blank string for the current id ($this->id)
+        * @param string $table Tablename to display. Enter "-1" for the current table.
+        * @param string $exclList Commalist of fields NOT to include ("sortField", "sortRev" or "firstElementNumber")
+        * @return string URL
         */
-       function listURL($altId='',$table=-1,$exclList='') {
+       function listURL($altId = '', $table = -1, $exclList = '') {
                $urlParameters = array();
                if (strcmp($altId, '')) {
                        $urlParameters['id'] = $altId;
@@ -805,7 +825,7 @@ class recordList extends t3lib_recordList {
        /**
         * Returns "requestUri" - which is basically listURL
         *
-        * @return      string          Content of ->listURL()
+        * @return string Content of ->listURL()
         */
        function requestUri() {
                return $this->listURL();
@@ -814,12 +834,12 @@ class recordList extends t3lib_recordList {
        /**
         * Makes the list of fields to select for a table
         *
-        * @param       string          Table name
-        * @param       boolean         If set, users access to the field (non-exclude-fields) is NOT checked.
-        * @param       boolean         If set, also adds crdate and tstamp fields (note: they will also be added if user is admin or dontCheckUser is set)
-        * @return      array           Array, where values are fieldnames to include in query
+        * @param string $table Table name
+        * @param boolean $dontCheckUser If set, users access to the field (non-exclude-fields) is NOT checked.
+        * @param boolean $addDateFields If set, also adds crdate and tstamp fields (note: they will also be added if user is admin or dontCheckUser is set)
+        * @return array Array, where values are fieldnames to include in query
         */
-       function makeFieldList($table,$dontCheckUser=0,$addDateFields=0) {
+       function makeFieldList($table, $dontCheckUser = 0, $addDateFields = 0) {
 
                        // Init fieldlist array:
                $fieldListArr = array();
@@ -833,7 +853,7 @@ class recordList extends t3lib_recordList {
 
                        if (isset($GLOBALS['TCA'][$table]['columns']) && is_array($GLOBALS['TCA'][$table]['columns'])) {
                                        // Traverse configured columns and add them to field array, if available for user.
-                               foreach($GLOBALS['TCA'][$table]['columns'] as $fN => $fieldValue) {
+                               foreach ($GLOBALS['TCA'][$table]['columns'] as $fN => $fieldValue) {
                                        if ($dontCheckUser ||
                                                        ((!$fieldValue['exclude'] || $GLOBALS['BE_USER']->check('non_exclude_fields', $table . ':' . $fN))
                                                                        && $fieldValue['config']['type']!='passthrough')) {
@@ -841,36 +861,36 @@ class recordList extends t3lib_recordList {
                                        }
                                }
 
-                               // Add special fields:
+                                       // Add special fields:
                                if ($dontCheckUser || $GLOBALS['BE_USER']->isAdmin()) {
-                                       $fieldListArr[]='uid';
-                                       $fieldListArr[]='pid';
+                                       $fieldListArr[] = 'uid';
+                                       $fieldListArr[] = 'pid';
                                }
 
-                               // Add date fields
+                                       // Add date fields
                                if ($dontCheckUser || $GLOBALS['BE_USER']->isAdmin() || $addDateFields) {
                                        if ($GLOBALS['TCA'][$table]['ctrl']['tstamp']) {
-                                               $fieldListArr[]=$GLOBALS['TCA'][$table]['ctrl']['tstamp'];
+                                               $fieldListArr[] = $GLOBALS['TCA'][$table]['ctrl']['tstamp'];
                                        }
                                        if ($GLOBALS['TCA'][$table]['ctrl']['crdate']) {
-                                               $fieldListArr[]=$GLOBALS['TCA'][$table]['ctrl']['crdate'];
+                                               $fieldListArr[] = $GLOBALS['TCA'][$table]['ctrl']['crdate'];
                                        }
                                }
 
                                // Add more special fields:
                                if ($dontCheckUser || $GLOBALS['BE_USER']->isAdmin()) {
                                        if ($GLOBALS['TCA'][$table]['ctrl']['cruser_id']) {
-                                               $fieldListArr[]=$GLOBALS['TCA'][$table]['ctrl']['cruser_id'];
+                                               $fieldListArr[] = $GLOBALS['TCA'][$table]['ctrl']['cruser_id'];
                                        }
                                        if ($GLOBALS['TCA'][$table]['ctrl']['sortby']) {
-                                               $fieldListArr[]=$GLOBALS['TCA'][$table]['ctrl']['sortby'];
+                                               $fieldListArr[] = $GLOBALS['TCA'][$table]['ctrl']['sortby'];
                                        }
                                        if ($GLOBALS['TCA'][$table]['ctrl']['versioningWS']) {
-                                               $fieldListArr[]='t3ver_id';
-                                               $fieldListArr[]='t3ver_state';
-                                               $fieldListArr[]='t3ver_wsid';
-                                               if ($table==='pages') {
-                                                       $fieldListArr[]='t3ver_swapmode';
+                                               $fieldListArr[] = 't3ver_id';
+                                               $fieldListArr[] = 't3ver_state';
+                                               $fieldListArr[] = 't3ver_wsid';
+                                               if ($table === 'pages') {
+                                                       $fieldListArr[] = 't3ver_swapmode';
                                                }
                                        }
                                }
@@ -888,31 +908,31 @@ class recordList extends t3lib_recordList {
        /**
         * Creates an instance of t3lib_pageTree which will select a page tree to $depth and return the object. In that object we will find the ids of the tree.
         *
-        * @param       integer         Page id.
-        * @param       integer         Depth to go down.
-        * @param       string          Select clause
-        * @return      object          t3lib_pageTree instance with created list of ids.
+        * @param integer $id Page id.
+        * @param integer $depth Depth to go down.
+        * @param string $perms_clause Select clause
+        * @return object t3lib_pageTree instance with created list of ids.
         */
-       function getTreeObject($id,$depth,$perms_clause) {
+       function getTreeObject($id, $depth, $perms_clause) {
                $tree = t3lib_div::makeInstance('t3lib_pageTree');
                $tree->init('AND '.$perms_clause);
-               $tree->makeHTML=0;
-               $tree->fieldArray = Array('uid','php_tree_stop');
+               $tree->makeHTML = 0;
+               $tree->fieldArray = array('uid', 'php_tree_stop');
                if ($depth) {
                        $tree->getTree($id, $depth, '');
                }
-               $tree->ids[]=$id;
+               $tree->ids[] = $id;
                return $tree;
        }
 
        /**
         * Redirects to TCEforms (alt_doc) if a record is just localized.
         *
-        * @param       string          string with table, orig uid and language separated by ":"
-        * @return      void
+        * @param string $justLocalized String with table, orig uid and language separated by ":"
+        * @return void
         */
        function localizationRedirect($justLocalized) {
-               list($table,$orig_uid,$language) = explode(':',$justLocalized);
+               list($table,$orig_uid,$language) = explode(':', $justLocalized);
 
                if ($GLOBALS['TCA'][$table] && $GLOBALS['TCA'][$table]['ctrl']['languageField']
                        && $GLOBALS['TCA'][$table]['ctrl']['transOrigPointerField']) {
@@ -943,4 +963,4 @@ if (defined('TYPO3_MODE') && isset($GLOBALS['TYPO3_CONF_VARS'][TYPO3_MODE]['XCLA
        include_once($GLOBALS['TYPO3_CONF_VARS'][TYPO3_MODE]['XCLASS']['typo3/class.db_list.inc']);
 }
 
-?>
+?>
\ No newline at end of file
index 4809b80..81ef151 100644 (file)
@@ -24,6 +24,7 @@
 *
 *  This copyright notice MUST APPEAR in all copies of the script!
 ***************************************************************/
+
 /**
  * Include file extending recordList which extended t3lib_recordList
  * Used specifically for the Web>List module (db_list.php)
  * Revised for TYPO3 3.6 December/2003 by Kasper Skårhøj
  * XHTML compliant
  *
- * @author     Kasper Skårhøj <kasperYYYY@typo3.com>
+ * @author Kasper Skårhøj <kasperYYYY@typo3.com>
  */
 
-
-
-
-
-
-
-
-
-
 /**
  * Class for rendering of Web>List module
  *
- * @author     Kasper Skårhøj <kasperYYYY@typo3.com>
+ * @author Kasper Skårhøj <kasperYYYY@typo3.com>
  * @package TYPO3
  * @subpackage core
  */
 class localRecordList extends recordList {
 
                // External:
-       var $alternateBgColors = FALSE;                 // If TRUE, table rows in the list will alternate in background colors (and have background colors at all!)
-       var $allowedNewTables = array();                        // Used to indicate which tables (values in the array) that can have a create-new-record link. If the array is empty, all tables are allowed.
-       var $deniedNewTables = array();                 // Used to indicate which tables (values in the array) that cannot have a create-new-record link. If the array is empty, all tables are allowed.
-       var $newWizards = FALSE;                                        // If TRUE, the control panel will contain links to the create-new wizards for pages and tt_content elements (normally, the link goes to just creating a new element without the wizards!).
-
-       var $dontShowClipControlPanels = FALSE; // If TRUE, will disable the rendering of clipboard + control panels.
-       var $showClipboard = FALSE;                             // If TRUE, will show the clipboard in the field list.
-       var $noControlPanels = FALSE;                   // If TRUE, will DISABLE all control panels in lists. (Takes precedence)
-       var $clickMenuEnabled = TRUE;                   // If TRUE, clickmenus will be rendered
-
-       var $totalRowCount;                                             // count of record rows in view
-
-       var $spaceIcon;                                                 // space icon used for alignment
+               // If TRUE, table rows in the list will alternate in background colors (and have background colors at all!)
+       var $alternateBgColors = FALSE;
+               // Used to indicate which tables (values in the array) that can have a create-new-record link. If the array is empty, all tables are allowed.
+       var $allowedNewTables = array();
+               // Used to indicate which tables (values in the array) that cannot have a create-new-record link. If the array is empty, all tables are allowed.
+       var $deniedNewTables = array();
+               // If TRUE, the control panel will contain links to the create-new wizards for pages and tt_content elements (normally, the link goes to just creating a new element without the wizards!).
+       var $newWizards = FALSE;
+               // If TRUE, will disable the rendering of clipboard + control panels.
+       var $dontShowClipControlPanels = FALSE;
+               // If TRUE, will show the clipboard in the field list.
+       var $showClipboard = FALSE;
+               // If TRUE, will DISABLE all control panels in lists. (Takes precedence)
+       var $noControlPanels = FALSE;
+               // If TRUE, clickmenus will be rendered
+       var $clickMenuEnabled = TRUE;
+               // Count of record rows in view
+       var $totalRowCount;
+               // Space icon used for alignment
+       var $spaceIcon;
 
                // Internal:
-       var $pageRow=array();                                   // Set to the page record (see writeTop())
+                       // Set to the page record (see writeTop())
+       var $pageRow = array();
 
                // Used to accumulate CSV lines for CSV export.
        protected $csvLines = array();
-
-       var $csvOutput=FALSE;                                   // If set, the listing is returned as CSV instead.
+               // If set, the listing is returned as CSV instead.
+       var $csvOutput = FALSE;
 
        /**
         * Clipboard object
@@ -81,8 +81,10 @@ class localRecordList extends recordList {
         * @var t3lib_clipboard
         */
        var $clipObj;
-       var $CBnames=array();                                   // Tracking names of elements (for clipboard use)
-       var $duplicateStack=array();                    // Used to track which elements has duplicates and how many
+               // Tracking names of elements (for clipboard use)
+       var $CBnames = array();
+               // Used to track which elements has duplicates and how many
+       var $duplicateStack = array();
 
        /**
         * [$tablename][$uid] = number of references to this record
@@ -91,11 +93,16 @@ class localRecordList extends recordList {
         */
        protected $referenceCount = array();
 
-       var $translations;                                              // Translations of the current record
-       var $selFieldList;                                              // select fields for the query which fetches the translations of the current record
+               // Translations of the current record
+       var $translations;
+               // select fields for the query which fetches the translations of the current record
+       var $selFieldList;
 
        public $disableSingleTableView = FALSE;
 
+       /**
+        * Constructor
+        */
        public function __construct() {
                parent::__construct();
        }
@@ -103,7 +110,7 @@ class localRecordList extends recordList {
        /**
         * Create the panel of buttons for submitting the form or otherwise perform operations.
         *
-        * @return      array   all available buttons as an assoc. array
+        * @return array All available buttons as an assoc. array
         */
        public function getButtons() {
                $buttons = array(
@@ -129,14 +136,14 @@ class localRecordList extends recordList {
                        // CSH
                if (!strlen($this->id)) {
                        $buttons['csh'] = t3lib_BEfunc::cshItem('xMOD_csh_corebe', 'list_module_noId', $GLOBALS['BACK_PATH'], '', TRUE);
-               } elseif(!$this->id) {
+               } elseif (!$this->id) {
                        $buttons['csh'] = t3lib_BEfunc::cshItem('xMOD_csh_corebe', 'list_module_root', $GLOBALS['BACK_PATH'], '', TRUE);
                } else {
                        $buttons['csh'] = t3lib_BEfunc::cshItem('xMOD_csh_corebe', 'list_module', $GLOBALS['BACK_PATH'], '', TRUE);
                }
 
                if (isset($this->id)) {
-                               // View  Exclude doktypes 254,255 Configuration: mod.web_list.noViewWithDokTypes = 254,255
+                               // View Exclude doktypes 254,255 Configuration: mod.web_list.noViewWithDokTypes = 254,255
                        if (isset($GLOBALS['SOBE']->modTSconfig['properties']['noViewWithDokTypes'])) {
                                $noViewDokTypes = t3lib_div::trimExplode(',', $GLOBALS['SOBE']->modTSconfig['properties']['noViewWithDokTypes'], TRUE);
                        } else {
@@ -223,12 +230,12 @@ class localRecordList extends recordList {
        /**
         * Creates the listing of records from a single table
         *
-        * @param       string          Table name
-        * @param       integer         Page id
-        * @param       string          List of fields to show in the listing. Pseudo fields will be added including the record header.
-        * @return      string          HTML table with the listing for the record.
+        * @param string $table Table name
+        * @param integer $id Page id
+        * @param string $rowlist List of fields to show in the listing. Pseudo fields will be added including the record header.
+        * @return string HTML table with the listing for the record.
         */
-       function getTable($table,$id,$rowlist) {
+       function getTable($table, $id, $rowlist) {
                        // Loading all TCA details for this table:
                t3lib_div::loadTCA($table);
 
@@ -244,10 +251,11 @@ class localRecordList extends recordList {
                $this->spaceIcon = t3lib_iconWorks::getSpriteIcon('empty-empty', array('style' => 'background-position: 0 10px;'));
 
                        // Cleaning rowlist for duplicates and place the $titleCol as the first column always!
-               $this->fieldArray=array();
+               $this->fieldArray = array();
 
                        // title Column
-               $this->fieldArray[] = $titleCol;        // Add title column
+                       // Add title column
+               $this->fieldArray[] = $titleCol;
 
                        // Control-Panel
                if (!t3lib_div::inList($rowlist, '_CONTROL_')) {
@@ -262,13 +270,13 @@ class localRecordList extends recordList {
 
                        // Ref
                if (!$this->dontShowClipControlPanels) {
-                       $this->fieldArray[]='_REF_';
-                       $this->fieldArray[]='_AFTERREF_';
+                       $this->fieldArray[] = '_REF_';
+                       $this->fieldArray[] = '_AFTERREF_';
                }
 
                        // Path
                if ($this->searchLevels) {
-                       $this->fieldArray[]='_PATH_';
+                       $this->fieldArray[] = '_PATH_';
                }
 
                        // Localization
@@ -295,8 +303,9 @@ class localRecordList extends recordList {
                $selectFields = $this->fieldArray;
                $selectFields[] = 'uid';
                $selectFields[] = 'pid';
-               if ($thumbsCol) $selectFields[] = $thumbsCol;   // adding column for thumbnails
-               if ($table=='pages') {
+                       // adding column for thumbnails
+               if ($thumbsCol) $selectFields[] = $thumbsCol;
+               if ($table == 'pages') {
                        if (t3lib_extMgm::isLoaded('cms')) {
                                $selectFields[] = 'module';
                                $selectFields[] = 'extendToSubpages';
@@ -317,7 +326,8 @@ class localRecordList extends recordList {
                        $selectFields[] = 't3ver_id';
                        $selectFields[] = 't3ver_state';
                        $selectFields[] = 't3ver_wsid';
-                       $selectFields[] = 't3ver_swapmode';             // Filtered out when pages in makeFieldList()
+                               // Filtered out when pages in makeFieldList()
+                       $selectFields[] = 't3ver_swapmode';
                }
                if ($l10nEnabled) {
                        $selectFields[] = $GLOBALS['TCA'][$table]['ctrl']['languageField'];
@@ -329,7 +339,8 @@ class localRecordList extends recordList {
                                t3lib_div::trimExplode(',', $GLOBALS['TCA'][$table]['ctrl']['label_alt'], 1)
                        );
                }
-               $selectFields = array_unique($selectFields);            // Unique list!
+                       // Unique list!
+               $selectFields = array_unique($selectFields);
                $fieldListFields = $this->makeFieldList($table, 1);
                if (empty($fieldListFields) && $GLOBALS['TYPO3_CONF_VARS']['BE']['debug']) {
 
@@ -350,20 +361,22 @@ class localRecordList extends recordList {
                        /** @var t3lib_FlashMessage $flashMessage */
                        t3lib_FlashMessageQueue::addMessage($flashMessage);
                }
-               $selectFields = array_intersect($selectFields, $fieldListFields);       // Making sure that the fields in the field-list ARE in the field-list from TCA!
-               $selFieldList = implode(',', $selectFields);            // implode it into a list of fields for the SQL-statement.
+                       // Making sure that the fields in the field-list ARE in the field-list from TCA!
+               $selectFields = array_intersect($selectFields, $fieldListFields);
+                       // Implode it into a list of fields for the SQL-statement.
+               $selFieldList = implode(',', $selectFields);
                $this->selFieldList = $selFieldList;
 
                /**
-                * @hook                        DB-List getTable
-                * @date                        2007-11-16
-                * @request             Malte Jansen  <mail@maltejansen.de>
+                * @hook DB-List getTable
+                * @date 2007-11-16
+                * @request Malte Jansen <mail@maltejansen.de>
                 */
-               if(is_array($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['typo3/class.db_list_extra.inc']['getTable'])) {
-                       foreach($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['typo3/class.db_list_extra.inc']['getTable'] as $classData) {
+               if (is_array($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['typo3/class.db_list_extra.inc']['getTable'])) {
+                       foreach ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['typo3/class.db_list_extra.inc']['getTable'] as $classData) {
                                $hookObject = t3lib_div::getUserObj($classData);
 
-                               if(!($hookObject instanceof t3lib_localRecordListGetTableHook)) {
+                               if (!($hookObject instanceof t3lib_localRecordListGetTableHook)) {
                                        throw new UnexpectedValueException('$hookObject must implement interface t3lib_localRecordListGetTableHook', 1195114460);
                                }
 
@@ -372,7 +385,8 @@ class localRecordList extends recordList {
                }
 
                        // Create the SQL query for selecting the elements in the listing:
-               if ($this->csvOutput) { // do not do paging when outputting as CSV
+                       // do not do paging when outputting as CSV
+               if ($this->csvOutput) {
                        $this->iLimit = 0;
                }
 
@@ -380,14 +394,16 @@ class localRecordList extends recordList {
                                // Get the two previous rows for sorting if displaying page > 1
                        $this->firstElementNumber = $this->firstElementNumber - 2;
                        $this->iLimit = $this->iLimit + 2;
-                       $queryParts = $this->makeQueryArray($table, $id,$addWhere,$selFieldList);       // (API function from class.db_list.inc)
+                               // (API function from class.db_list.inc)
+                       $queryParts = $this->makeQueryArray($table, $id,$addWhere,$selFieldList);
                        $this->firstElementNumber = $this->firstElementNumber + 2;
                        $this->iLimit = $this->iLimit - 2;
                } else {
-                       $queryParts = $this->makeQueryArray($table, $id,$addWhere,$selFieldList);       // (API function from class.db_list.inc)
+                               // (API function from class.db_list.inc)
+                       $queryParts = $this->makeQueryArray($table, $id,$addWhere,$selFieldList);
                }
-
-               $this->setTotalItems($queryParts);              // Finding the total amount of records on the page (API function from class.db_list.inc)
+                       // Finding the total amount of records on the page (API function from class.db_list.inc)
+               $this->setTotalItems($queryParts);
 
                        // Init:
                $dbCount = 0;
@@ -396,11 +412,11 @@ class localRecordList extends recordList {
 
                        // If the count query returned any number of records, we perform the real query, selecting records.
                if ($this->totalItems) {
-                       // Fetch records only if not in single table mode or if in multi table mode and not collapsed
+                               // Fetch records only if not in single table mode or if in multi table mode and not collapsed
                        if ($listOnlyInSingleTableMode || (!$this->table && $tableCollapsed)) {
                                $dbCount = $this->totalItems;
                        } else {
-                                       // set the showLimit to the number of records when outputting as CSV
+                                       // Set the showLimit to the number of records when outputting as CSV
                                if ($this->csvOutput) {
                                        $this->showLimit = $this->totalItems;
                                        $this->iLimit = $this->totalItems;
@@ -447,7 +463,7 @@ class localRecordList extends recordList {
                                                <td class="t3-row-header" style="width:95%;">' . t3lib_BEfunc::wrapInHelp($table, '', $theData[$titleCol]) . '</td>
                                        </tr>';
                        } else {
-                               // Render collapse button if in multi table mode
+                                       // Render collapse button if in multi table mode
                                $collapseIcon = '';
                                if (!$this->table) {
                                        $collapseIcon = '<a href="' . htmlspecialchars($this->listURL() . '&collapse[' . $table . ']=' . ($tableCollapsed ? '0' : '1')) . '" title="' . ($tableCollapsed ? $GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:labels.expandTable', TRUE) : $GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:labels.collapseTable', TRUE)) . '">' .
@@ -476,7 +492,7 @@ class localRecordList extends recordList {
                                }
 
                                $accRows = array();     // Accumulate rows here
-                               while($row = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($result)) {
+                               while ($row = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($result)) {
 
                                        if (!$this->isRowListingConditionFulfilled($table, $row)) {
                                                continue;
@@ -507,26 +523,29 @@ class localRecordList extends recordList {
                                if ($this->csvOutput) $this->initCSV();
 
                                        // Render items:
-                               $this->CBnames=array();
-                               $this->duplicateStack=array();
-                               $this->eCounter=$this->firstElementNumber;
+                               $this->CBnames = array();
+                               $this->duplicateStack = array();
+                               $this->eCounter = $this->firstElementNumber;
 
                                $iOut = '';
                                $cc = 0;
 
-                               foreach($accRows as $row) {
-                                       // Render item row if counter < limit
+                               foreach ($accRows as $row) {
+                                               // Render item row if counter < limit
                                        if ($cc < $this->iLimit) {
                                                $cc++;
                                                $this->translations = FALSE;
                                                $iOut.= $this->renderListRow($table, $row, $cc, $titleCol, $thumbsCol);
 
-                                                       // If localization view is enabled it means that the selected records are either default or All language and here we will not select translations which point to the main record:
+                                                       // If localization view is enabled it means that the selected records are
+                                                       // either default or All language and here we will not select translations
+                                                       // which point to the main record:
                                                if ($this->localizationView && $l10nEnabled) {
                                                                // For each available translation, render the record:
                                                        if (is_array($this->translations)) {
                                                                foreach ($this->translations as $lRow) {
-                                                                               // $lRow isn't always what we want - if record was moved we've to work with the placeholder records otherwise the list is messed up a bit
+                                                                               // $lRow isn't always what we want - if record was moved we've to work with the
+                                                                               // placeholder records otherwise the list is messed up a bit
                                                                        if ($row['_MOVE_PLH_uid'] && $row['_MOVE_PLH_pid']) {
                                                                                $tmpRow = t3lib_BEfunc::getRecordRaw($table, 't3ver_move_id="'.intval($lRow['uid']) . '" AND pid="' . $row['_MOVE_PLH_pid'] . '" AND t3ver_wsid=' . $row['t3ver_wsid'] . t3lib_beFunc::deleteClause($table), $selFieldList);
                                                                                $lRow = is_array($tmpRow) ? $tmpRow : $lRow;
@@ -550,7 +569,7 @@ class localRecordList extends recordList {
                                if ($this->table) {
                                        $iOut = $this->renderListNavigation('top') . $iOut . $this->renderListNavigation('bottom');
                                } else {
-                                               // show that there are more records than shown
+                                               // Show that there are more records than shown
                                        if ($this->totalItems > $this->itemsLimitPerTable) {
                                                $countOnFirstPage = $this->totalItems > $this->itemsLimitSingleTable ? $this->itemsLimitSingleTable : $this->totalItems;
                                                $hasMore = ($this->totalItems > $this->itemsLimitSingleTable);
@@ -572,7 +591,7 @@ class localRecordList extends recordList {
                        unset($iOut);
 
                                // ... and it is all wrapped in a table:
-                       $out='
+                       $out = '
 
 
 
@@ -584,7 +603,8 @@ class localRecordList extends recordList {
                                </table>';
 
                                // Output csv if...
-                       if ($this->csvOutput)   $this->outputCSV($table);       // This ends the page with exit.
+                               // This ends the page with exit.
+                       if ($this->csvOutput)   $this->outputCSV($table);
                }
 
                        // Return content:
@@ -597,9 +617,9 @@ class localRecordList extends recordList {
         *
         * This function serves as a dummy method to be overriden in extending classes.
         *
-        * @param   string  $table Table name
-        * @param   array   $row Record
-        * @return  bool    True, if all conditions are fulfilled.
+        * @param string $table Table name
+        * @param array $row Record
+        * @return boolean True, if all conditions are fulfilled.
         */
        protected function isRowListingConditionFulfilled($table, $row) {
                return TRUE;
@@ -608,26 +628,27 @@ class localRecordList extends recordList {
        /**
         * Rendering a single row for the list
         *
-        * @param       string          Table name
-        * @param       array           Current record
-        * @param       integer         Counter, counting for each time an element is rendered (used for alternating colors)
-        * @param       string          Table field (column) where header value is found
-        * @param       string          Table field (column) where (possible) thumbnails can be found
-        * @param       integer         Indent from left.
-        * @return      string          Table row for the element
+        * @param string $table Table name
+        * @param array $row Current record
+        * @param integer $cc Counter, counting for each time an element is rendered (used for alternating colors)
+        * @param string $titleCol Table field (column) where header value is found
+        * @param string $thumbsCol Table field (column) where (possible) thumbnails can be found
+        * @param integer $indent Indent from left.
+        * @return string Table row for the element
         * @access private
         * @see getTable()
         */
        function renderListRow($table, $row, $cc, $titleCol, $thumbsCol, $indent = 0) {
                $iOut = '';
 
-               if (strlen($this->searchString)) {      // If in search mode, make sure the preview will show the correct page
+                       // If in search mode, make sure the preview will show the correct page
+               if (strlen($this->searchString)) {
                        $id_orig = $this->id;
                        $this->id = $row['pid'];
                }
 
                if (is_array($row)) {
-                               // add special classes for first and last row
+                               // Add special classes for first and last row
                        $rowSpecial = '';
                        if ($cc == 1 && $indent == 0) {
                                $rowSpecial .= ' firstcol';
@@ -656,8 +677,8 @@ class localRecordList extends recordList {
                        $theIcon = $this->clickMenuEnabled ? $GLOBALS['SOBE']->doc->wrapClickMenuOnIcon($iconImg, $table, $row['uid']) : $iconImg;
 
                                // Preparing and getting the data-array
-                       $theData = Array();
-                       foreach($this->fieldArray as $fCol) {
+                       $theData = array();
+                       foreach ($this->fieldArray as $fCol) {
                                if ($fCol == $titleCol) {
                                        $recTitle = t3lib_BEfunc::getRecordTitle($table, $row, FALSE, TRUE);
                                                // If the record is edit-locked by another user, we will show a little warning sign:
@@ -677,7 +698,7 @@ class localRecordList extends recordList {
                                        if (isset($GLOBALS['TCA'][$table]['ctrl']['languageField'])
                                        && $row[$GLOBALS['TCA'][$table]['ctrl']['languageField']] != 0
                                        && $row[$GLOBALS['TCA'][$table]['ctrl']['transOrigPointerField']] != 0) {
-                                                       // it's a translated record with a language parent
+                                                       // It's a translated record with a language parent
                                                $localizationMarkerClass = ' localization';
                                        }
                                } elseif ($fCol == 'pid') {
@@ -707,7 +728,8 @@ class localRecordList extends recordList {
                                }
                        }
 
-                       if (strlen($this->searchString)) {      // Reset the ID if it was overwritten
+                               // Reset the ID if it was overwritten
+                       if (strlen($this->searchString)) {
                                $this->id = $id_orig;
                        }
 
@@ -717,7 +739,7 @@ class localRecordList extends recordList {
                        }
 
                        // Add classes to table cells
-                       $this->addElement_tdCssClass[$titleCol]         = 'col-title' . $localizationMarkerClass;
+                       $this->addElement_tdCssClass[$titleCol] = 'col-title' . $localizationMarkerClass;
                        if (!$this->dontShowClipControlPanels) {
                                $this->addElement_tdCssClass['_CONTROL_']       = 'col-control';
                                $this->addElement_tdCssClass['_AFTERCONTROL_']  = 'col-control-space';
@@ -740,11 +762,11 @@ class localRecordList extends recordList {
         * the table $tableName.
         *
         * @param string $tableName
-        *        table name of the referenced record, must not be empty
+        *        Table name of the referenced record, must not be empty
         * @param integer $uid
         *        UID of the referenced record, must be > 0
         *
-        * @return integer the number of references to record $uid in table
+        * @return integer The number of references to record $uid in table
         *                 $tableName, will be >= 0
         */
        protected function getReferenceCount($tableName, $uid) {
@@ -768,15 +790,15 @@ class localRecordList extends recordList {
        /**
         * Rendering the header row for a table
         *
-        * @param       string          Table name
-        * @param       array           Array of the currently displayed uids of the table
-        * @return      string          Header table row
+        * @param string $table Table name
+        * @param array $currentIdList Array of the currently displayed uids of the table
+        * @return string Header table row
         * @access private
         * @see getTable()
         */
        function renderListHeader($table, $currentIdList) {
                        // Init:
-               $theData = Array();
+               $theData = array();
 
                        // Traverse the fields:
                foreach($this->fieldArray as $fCol) {
@@ -848,18 +870,17 @@ class localRecordList extends recordList {
                                                                t3lib_iconWorks::getSpriteIcon('actions-document-select') .
                                                                '</a>';
                                        } else {
-                                               $cells['empty']='';
+                                               $cells['empty'] = '';
                                        }
 
                                        /**
-                                        * @hook                        renderListHeaderActions: Allows to change the clipboard icons of the Web>List table headers
-                                        * @date                        2007-11-20
-                                        * @request             Bernhard Kraft  <krafbt@kraftb.at>
-                                        * @usage               Above each listed table in Web>List a header row is shown. This hook allows to modify the icons responsible for the clipboard functions (shown above the clipboard checkboxes when a clipboard other than "Normal" is selected), or other "Action" functions which perform operations on the listed records.
+                                        * @hook renderListHeaderActions: Allows to change the clipboard icons of the Web>List table headers
+                                        * @date 2007-11-20
+                                        * @request     Bernhard Kraft  <krafbt@kraftb.at>
+                                        * @usage Above each listed table in Web>List a header row is shown. This hook allows to modify the icons responsible for the clipboard functions (shown above the clipboard checkboxes when a clipboard other than "Normal" is selected), or other "Action" functions which perform operations on the listed records.
                                         */
-
                                        if (is_array($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['typo3/class.db_list_extra.inc']['actions'])) {
-                                               foreach($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['typo3/class.db_list_extra.inc']['actions'] as $classData) {
+                                               foreach ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['typo3/class.db_list_extra.inc']['actions'] as $classData) {
                                                        $hookObject = t3lib_div::getUserObj($classData);
                                                        if (!($hookObject instanceof localRecordList_actionsHook)) {
                                                                throw new UnexpectedValueException('$hookObject must implement interface localRecordList_actionsHook', 1195567850);
@@ -909,7 +930,7 @@ class localRecordList extends recordList {
                                                                        t3lib_iconWorks::getSpriteIcon('actions-document-open') .
                                                                        '</a>';
                                                }
-                                                       // add an empty entry, so column count fits again after moving this into $icon
+                                                       // Add an empty entry, so column count fits again after moving this into $icon
                                                $theData[$fCol] = '&nbsp;';
                                        }
                                        break;
@@ -947,13 +968,13 @@ class localRecordList extends recordList {
                }
 
                /**
-                * @hook                        renderListHeader: Allows to change the contents of columns/cells of the Web>List table headers
-                * @date                        2007-11-20
-                * @request             Bernhard Kraft  <krafbt@kraftb.at>
-                * @usage               Above each listed table in Web>List a header row is shown. Containing the labels of all shown fields and additional icons to create new records for this table or perform special clipboard tasks like mark and copy all listed records to clipboard, etc.
+                * @hook renderListHeader: Allows to change the contents of columns/cells of the Web>List table headers
+                * @date 2007-11-20
+                * @request Bernhard Kraft <krafbt@kraftb.at>
+                * @usage Above each listed table in Web>List a header row is shown. Containing the labels of all shown fields and additional icons to create new records for this table or perform special clipboard tasks like mark and copy all listed records to clipboard, etc.
                 */
                if (is_array($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['typo3/class.db_list_extra.inc']['actions'])) {
-                       foreach($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['typo3/class.db_list_extra.inc']['actions'] as $classData) {
+                       foreach ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['typo3/class.db_list_extra.inc']['actions'] as $classData) {
                                $hookObject = t3lib_div::getUserObj($classData);
                                if (!($hookObject instanceof localRecordList_actionsHook)) {
                                        throw new UnexpectedValueException('$hookObject must implement interface localRecordList_actionsHook', 1195567855);
@@ -969,8 +990,8 @@ class localRecordList extends recordList {
        /**
         * Creates a page browser for tables with many records
         *
-        * @param       string          Distinguish between 'top' and 'bottom' part of the navigation (above or below the records)
-        * @return      string  Navigation HTML
+        * @param string $renderPart Distinguish between 'top' and 'bottom' part of the navigation (above or below the records)
+        * @return string Navigation HTML
         *
         */
        protected function renderListNavigation($renderPart = 'top') {
@@ -1083,7 +1104,7 @@ class localRecordList extends recordList {
                                . $reload
                                . '</div>';
 
-                       $data = Array();
+                       $data = array();
                        $titleColumn = $this->fieldArray[0];
                        $data[$titleColumn] = $content;
 
@@ -1093,11 +1114,6 @@ class localRecordList extends recordList {
                return $returnContent;
        }
 
-
-
-
-
-
        /*********************************
         *
         * Rendering of various elements
@@ -1107,11 +1123,11 @@ class localRecordList extends recordList {
        /**
         * Creates the control panel for a single record in the listing.
         *
-        * @param       string          The table
-        * @param       array           The record for which to make the control panel.
-        * @return      string          HTML table with the control panel (unless disabled)
+        * @param string $table The table
+        * @param array $row The record for which to make the control panel.
+        * @return string HTML table with the control panel (unless disabled)
         */
-       function makeControl($table,$row) {
+       function makeControl($table, $row) {
                if ($this->dontShowClipControlPanels)
                        return '';
 
@@ -1125,7 +1141,7 @@ class localRecordList extends recordList {
                $cells = array();
 
                        // If the listed table is 'pages' we have to request the permission settings for each page:
-               if ($table=='pages') {
+               if ($table == 'pages') {
                        $localCalcPerms = $GLOBALS['BE_USER']->calcPerms(t3lib_BEfunc::getRecord('pages',$row['uid']));
                }
 
@@ -1133,14 +1149,14 @@ class localRecordList extends recordList {
                $permsEdit = ($table=='pages' && ($localCalcPerms&2)) || ($table!='pages' && ($this->calcPerms&16));
 
                        // "Show" link (only pages and tt_content elements)
-               if ($table=='pages' || $table=='tt_content') {
-                       $params='&edit['.$table.']['.$row['uid'].']=edit';
+               if ($table == 'pages' || $table == 'tt_content') {
+                       $params = '&edit['.$table.']['.$row['uid'].']=edit';
                        $cells['view'] = '<a href="#" onclick="' . htmlspecialchars(t3lib_BEfunc::viewOnClick(
-                                       $table=='tt_content' ? $this->id . '#' . $row['uid'] : $row['uid'],
+                                       $table == 'tt_content' ? $this->id . '#' . $row['uid'] : $row['uid'],
                                        $this->backPath)
                                ) . '" title="' . $GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:labels.showPage', TRUE) . '">' .
                                t3lib_iconWorks::getSpriteIcon('actions-document-view') . '</a>';
-               } elseif(!$this->table) {
+               } elseif (!$this->table) {
                        $cells['view'] = $this->spaceIcon;
                }
 
@@ -1151,19 +1167,19 @@ class localRecordList extends recordList {
                                '" title="' . $GLOBALS['LANG']->getLL('edit', TRUE) . '">' .
                                ( $GLOBALS['TCA'][$table]['ctrl']['readOnly'] ? t3lib_iconWorks::getSpriteIcon('actions-document-open-read-only') : t3lib_iconWorks::getSpriteIcon('actions-document-open')) .
                                '</a>';
-               } elseif(!$this->table) {
+               } elseif (!$this->table) {
                        $cells['edit'] = $this->spaceIcon;
                }
 
                        // "Move" wizard link for pages/tt_content elements:
-               if (($table == 'tt_content' && $permsEdit) || ($table=='pages')) {
+               if (($table == 'tt_content' && $permsEdit) || ($table == 'pages')) {
                        $cells['move'] = '<a href="#" onclick="' .
                                htmlspecialchars(
                                        'return jumpExt(\'' . $this->backPath . 'move_el.php?table=' . $table . '&uid='.$row['uid'] . '\');'
                                ) .'" title="' . $GLOBALS['LANG']->getLL('move_' . ($table == 'tt_content' ? 'record' : 'page'), TRUE) . '">' .
                                                ($table == 'tt_content' ? t3lib_iconWorks::getSpriteIcon('actions-document-move') : t3lib_iconWorks::getSpriteIcon('actions-page-move')) .
                                        '</a>';
-               } elseif(!$this->table) {
+               } elseif (!$this->table) {
                        $cells['move'] = $this->spaceIcon;
                }
 
@@ -1190,7 +1206,8 @@ class localRecordList extends recordList {
                                        // Versioning:
                                if (t3lib_extMgm::isLoaded('version') && !t3lib_extMgm::isLoaded('workspaces')) {
                                        $vers = t3lib_BEfunc::selectVersionsOfRecord($table, $row['uid'], 'uid', $GLOBALS['BE_USER']->workspace, FALSE, $row);
-                                       if (is_array($vers))    {       // If table can be versionized.
+                                               // If table can be versionized.
+                                       if (is_array($vers)) {
                                                $versionIcon = 'no-version';
                                                if (count($vers) > 1) {
                                                        $versionIcon = count($vers) - 1;
@@ -1199,7 +1216,7 @@ class localRecordList extends recordList {
                                                $cells['version'] = '<a href="' . htmlspecialchars($this->backPath . t3lib_extMgm::extRelPath('version') . 'cm1/index.php?table=' . rawurlencode($table) . '&uid=' . rawurlencode($row['uid'])) . '" title="' . $GLOBALS['LANG']->getLL('displayVersions', TRUE) . '">' .
                                                                t3lib_iconWorks::getSpriteIcon('status-version-' . $versionIcon) .
                                                                '</a>';
-                                       } elseif(!$this->table) {
+                                       } elseif (!$this->table) {
                                                $cells['version'] = $this->spaceIcon;
                                        }
                                }
@@ -1216,7 +1233,7 @@ class localRecordList extends recordList {
                                                '">'.
                                                        t3lib_iconWorks::getSpriteIcon('status-status-locked') .
                                                '</a>';
-                               } elseif(!$this->table && $GLOBALS['BE_USER']->check('modules','web_perm')) {
+                               } elseif (!$this->table && $GLOBALS['BE_USER']->check('modules','web_perm')) {
                                        $cells['perms'] = $this->spaceIcon;
                                }
 
@@ -1235,7 +1252,7 @@ class localRecordList extends recordList {
                                                                '</a>';
                                                }
                                        }
-                               } elseif(!$this->table) {
+                               } elseif (!$this->table) {
                                        $cells['new'] = $this->spaceIcon;
                                }
 
@@ -1259,8 +1276,8 @@ class localRecordList extends recordList {
                                        } else {
                                                $cells['moveDown'] = $this->spaceIcon;
                                        }
-                               } elseif(!$this->table) {
-                                       $cells['moveUp']  = $this->spaceIcon;
+                               } elseif (!$this->table) {
+                                       $cells['moveUp'] = $this->spaceIcon;
                                        $cells['moveDown'] = $this->spaceIcon;
                                }
 
@@ -1278,12 +1295,12 @@ class localRecordList extends recordList {
                                                                        t3lib_iconWorks::getSpriteIcon('actions-edit-hide') .
                                                                '</a>';
                                        }
-                               } elseif(!$this->table) {
+                               } elseif (!$this->table) {
                                        $cells['hide'] = $this->spaceIcon;
                                }
 
                                        // "Delete" link:
-                               if (($table=='pages' && ($localCalcPerms&4)) || ($table!='pages' && ($this->calcPerms&16))) {
+                               if (($table == 'pages' && ($localCalcPerms&4)) || ($table != 'pages' && ($this->calcPerms&16))) {
                                        $titleOrig = t3lib_BEfunc::getRecordTitle($table,$row,FALSE,TRUE);
                                        $title = t3lib_div::slashJS(t3lib_div::fixed_lgd_cs($titleOrig, $this->fixedL), 1);
                                        $params = '&cmd['.$table.']['.$row['uid'].'][delete]=1';
@@ -1300,7 +1317,7 @@ class localRecordList extends recordList {
                                        $cells['delete'] = '<a href="#" onclick="' . htmlspecialchars('if (confirm(' . $GLOBALS['LANG']->JScharCode($GLOBALS['LANG']->getLL('deleteWarning') . ' "' .  $title . '" ' . $refCountMsg) . ')) {jumpToUrl(\'' . $GLOBALS['SOBE']->doc->issueCommand($params, -1) . '\');} return false;') . '" title="' . $GLOBALS['LANG']->getLL('delete', TRUE) . '">' .
                                                        t3lib_iconWorks::getSpriteIcon('actions-edit-delete') .
                                                        '</a>';
-                               } elseif(!$this->table) {
+                               } elseif (!$this->table) {
                                        $cells['delete'] = $this->spaceIcon;
                                }
 
@@ -1328,7 +1345,7 @@ class localRecordList extends recordList {
                                        } else {
                                                $cells['moveRight'] = $this->spaceIcon;
                                        }
-                               } elseif(!$this->table) {
+                               } elseif (!$this->table) {
                                        $cells['moveLeft'] = $this->spaceIcon;
                                        $cells['moveRight'] = $this->spaceIcon;
                                }
@@ -1337,28 +1354,28 @@ class localRecordList extends recordList {
 
 
                /**
-                * @hook                        recStatInfoHooks: Allows to insert HTML before record icons on various places
-                * @date                        2007-09-22
-                * @request             Kasper Skårhøj  <kasper2007@typo3.com>
+                * @hook recStatInfoHooks: Allows to insert HTML before record icons on various places
+                * @date 2007-09-22
+                * @request Kasper Skårhøj <kasper2007@typo3.com>
                 */
                if (is_array($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['GLOBAL']['recStatInfoHooks'])) {
-                       $stat='';
+                       $stat = '';
                        $_params = array($table,$row['uid']);
                        foreach ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['GLOBAL']['recStatInfoHooks'] as $_funcRef) {
-                               $stat.=t3lib_div::callUserFunction($_funcRef,$_params,$this);
+                               $stat .= t3lib_div::callUserFunction($_funcRef,$_params,$this);
                        }
                        $cells['stat'] = $stat;
                }
                /**
-                * @hook                        makeControl: Allows to change control icons of records in list-module
-                * @date                        2007-11-20
-                * @request             Bernhard Kraft  <krafbt@kraftb.at>
-                * @usage               This hook method gets passed the current $cells array as third parameter. This array contains values for the icons/actions generated for each record in Web>List. Each array entry is accessible by an index-key. The order of the icons is dependend on the order of those array entries.
+                * @hook makeControl: Allows to change control icons of records in list-module
+                * @date 2007-11-20
+                * @request Bernhard Kraft <krafbt@kraftb.at>
+                * @usage This hook method gets passed the current $cells array as third parameter. This array contains values for the icons/actions generated for each record in Web>List. Each array entry is accessible by an index-key. The order of the icons is dependend on the order of those array entries.
                 */
-               if(is_array($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['typo3/class.db_list_extra.inc']['actions'])) {
-                       foreach($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['typo3/class.db_list_extra.inc']['actions'] as $classData) {
+               if (is_array($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['typo3/class.db_list_extra.inc']['actions'])) {
+                       foreach ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['typo3/class.db_list_extra.inc']['actions'] as $classData) {
                                $hookObject = t3lib_div::getUserObj($classData);
-                               if(!($hookObject instanceof localRecordList_actionsHook)) {
+                               if (!($hookObject instanceof localRecordList_actionsHook)) {
                                        throw new UnexpectedValueException('$hookObject must implement interface localRecordList_actionsHook', 1195567840);
                                }
                                $cells = $hookObject->makeControl($table, $row, $cells, $this);
@@ -1374,13 +1391,13 @@ class localRecordList extends recordList {
        /**
         * Creates the clipboard panel for a single record in the listing.
         *
-        * @param       string          The table
-        * @param       array           The record for which to make the clipboard panel.
-        * @return      string          HTML table with the clipboard panel (unless disabled)
+        * @param string $table The table
+        * @param array $row The record for which to make the clipboard panel.
+        * @return string HTML table with the clipboard panel (unless disabled)
         */
-       function makeClip($table,$row) {
+       function makeClip($table, $row) {
                        // Return blank, if disabled:
-               if ($this->dontShowClipControlPanels)   return '';
+               if ($this->dontShowClipControlPanels) return '';
                $cells=array();
 
                $cells['pasteAfter'] = $cells['pasteInto'] = $this->spaceIcon;
@@ -1388,7 +1405,8 @@ class localRecordList extends recordList {
                $isL10nOverlay = $this->localizationView && $table != 'pages_language_overlay' && $row[$GLOBALS['TCA'][$table]['ctrl']['transOrigPointerField']] != 0;
                        // Return blank, if disabled:
                        // Whether a numeric clipboard pad is active or the normal pad we will see different content of the panel:
-               if ($this->clipObj->current=='normal')  {       // For the "Normal" pad:
+                       // For the "Normal" pad:
+               if ($this->clipObj->current=='normal') {
 
                                // Show copy/cut icons:
                        $isSel = (string)$this->clipObj->isSelected($table,$row['uid']);
@@ -1402,8 +1420,8 @@ class localRecordList extends recordList {
                } else {        // For the numeric clipboard pads (showing checkboxes where one can select elements on/off)
 
                                // Setting name of the element in ->CBnames array:
-                       $n=$table.'|'.$row['uid'];
-                       $this->CBnames[]=$n;
+                       $n = $table.'|'.$row['uid'];
+                       $this->CBnames[] = $n;
 
                                // Check if the current element is selected and if so, prepare to set the checkbox as selected:
                        $checked = ($this->clipObj->isSelected($table,$row['uid'])?' checked="checked"':'');
@@ -1438,16 +1456,16 @@ class localRecordList extends recordList {
                                        '</a>';
                }
 
-               /*
-                * @hook                        makeClip: Allows to change clip-icons of records in list-module
-                * @date                        2007-11-20
-                * @request             Bernhard Kraft  <krafbt@kraftb.at>
-                * @usage               This hook method gets passed the current $cells array as third parameter. This array contains values for the clipboard icons generated for each record in Web>List. Each array entry is accessible by an index-key. The order of the icons is dependend on the order of those array entries.
+               /**
+                * @hook makeClip: Allows to change clip-icons of records in list-module
+                * @date 2007-11-20
+                * @request Bernhard Kraft <krafbt@kraftb.at>
+                * @usage This hook method gets passed the current $cells array as third parameter. This array contains values for the clipboard icons generated for each record in Web>List. Each array entry is accessible by an index-key. The order of the icons is dependend on the order of those array entries.
                 */
-               if(is_array($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['typo3/class.db_list_extra.inc']['actions'])) {
-                       foreach($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['typo3/class.db_list_extra.inc']['actions'] as $classData) {
+               if (is_array($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['typo3/class.db_list_extra.inc']['actions'])) {
+                       foreach ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['typo3/class.db_list_extra.inc']['actions'] as $classData) {
                                $hookObject = t3lib_div::getUserObj($classData);
-                               if(!($hookObject instanceof localRecordList_actionsHook)) {
+                               if (!($hookObject instanceof localRecordList_actionsHook)) {
                                        throw new UnexpectedValueException('$hookObject must implement interface localRecordList_actionsHook', 1195567845);
                                }
                                $cells = $hookObject->makeClip($table, $row, $cells, $this);
@@ -1514,11 +1532,11 @@ class localRecordList extends recordList {
        /**
         * Creates the localization panel
         *
-        * @param       string          The table
-        * @param       array           The record for which to make the localization panel.
-        * @return      array           Array with key 0/1 with content for column 1 and 2
+        * @param string $table The table
+        * @param array $row The record for which to make the localization panel.
+        * @return array Array with key 0/1 with content for column 1 and 2
         */
-       function makeLocalizationPanel($table,$row) {
+       function makeLocalizationPanel($table, $row) {
                $out = array(
                        0 => '',
                        1 => '',
@@ -1534,7 +1552,7 @@ class localRecordList extends recordList {
 
                                // Traverse page translations and add icon for each language that does NOT yet exist:
                        $lNew = '';
-                       foreach($this->pageOverlays as $lUid_OnPage => $lsysRec) {
+                       foreach ($this->pageOverlays as $lUid_OnPage => $lsysRec) {
                                if (!isset($translations['translations'][$lUid_OnPage]) && $GLOBALS['BE_USER']->checkLanguageAccess($lUid_OnPage)) {
                                        $url = substr($this->listURL(), strlen($this->backPath));
                                        $href = $GLOBALS['SOBE']->doc->issueCommand(
@@ -1558,43 +1576,42 @@ class localRecordList extends recordList {
                        $out[0] = '&nbsp;&nbsp;&nbsp;&nbsp;'.$out[0];
                }
 
-
                return $out;
        }
 
        /**
         * Create the selector box for selecting fields to display from a table:
         *
-        * @param       string          Table name
-        * @param       boolean         If TRUE, form-fields will be wrapped around the table.
-        * @return      string          HTML table with the selector box (name: displayFields['.$table.'][])
+        * @param string $table Table name
+        * @param boolean $formFields If TRUE, form-fields will be wrapped around the table.
+        * @return string HTML table with the selector box (name: displayFields['.$table.'][])
         */
-       function fieldSelectBox($table,$formFields=1) {
+       function fieldSelectBox($table, $formFields = 1) {
 
                        // Init:
                t3lib_div::loadTCA($table);
-               $formElements=array('','');
+               $formElements = array('','');
                if ($formFields) {
                        $formElements=array('<form action="'.htmlspecialchars($this->listURL()).'" method="post">','</form>');
                }
 
                        // Load already selected fields, if any:
-               $setFields=is_array($this->setFields[$table]) ? $this->setFields[$table] : array();
+               $setFields = is_array($this->setFields[$table]) ? $this->setFields[$table] : array();
 
                        // Request fields from table:
                $fields = $this->makeFieldList($table, FALSE, TRUE);
 
                        // Add pseudo "control" fields
-               $fields[]='_PATH_';
-               $fields[]='_REF_';
-               $fields[]='_LOCALIZATION_';
-               $fields[]='_CONTROL_';
-               $fields[]='_CLIPBOARD_';
+               $fields[] = '_PATH_';
+               $fields[] = '_REF_';
+               $fields[] = '_LOCALIZATION_';
+               $fields[] = '_CONTROL_';
+               $fields[] = '_CLIPBOARD_';
 
                        // Create an option for each field:
-               $opt=array();
+               $opt = array();
                $opt[] = '<option value=""></option>';
-               foreach($fields as $fN) {
+               foreach ($fields as $fN) {
                                // Field label
                        $fL = (is_array($GLOBALS['TCA'][$table]['columns'][$fN])
                                ? rtrim($GLOBALS['LANG']->sL($GLOBALS['TCA'][$table]['columns'][$fN]['label']), ':')
@@ -1626,16 +1643,6 @@ class localRecordList extends recordList {
                return '<div class="db_list-fieldSelect">' . $content . '</div>';
        }
 
-
-
-
-
-
-
-
-
-
-
        /*********************************
         *
         * Helper functions
@@ -1646,13 +1653,13 @@ class localRecordList extends recordList {
         * Creates a link around $string. The link contains an onclick action which submits the script with some clipboard action.
         * Currently, this is used for setting elements / delete elements.
         *
-        * @param       string          The HTML content to link (image/text)
-        * @param       string          Table name
-        * @param       string          Clipboard command (eg. "setCB" or "delete")
-        * @param       string          Warning text, if any ("delete" uses this for confirmation)
-        * @return      string          <a> tag wrapped link.
+        * @param string $string The HTML content to link (image/text)
+        * @param string $table Table name
+        * @param string $cmd Clipboard command (eg. "setCB" or "delete")
+        * @param string $warning Warning text, if any ("delete" uses this for confirmation)
+        * @return string <a> tag wrapped link.
         */
-       function linkClipboardHeaderIcon($string,$table,$cmd,$warning='') {
+       function linkClipboardHeaderIcon($string, $table, $cmd, $warning = '') {
                $onClickEvent = 'document.dblistForm.cmd.value=\''.$cmd.'\';document.dblistForm.cmd_table.value=\''.$table.'\';document.dblistForm.submit();';
                if ($warning)   $onClickEvent = 'if (confirm('.$GLOBALS['LANG']->JScharCode($warning).')){'.$onClickEvent.'}';
                return '<a href="#" onclick="'.htmlspecialchars($onClickEvent.'return false;').'">'.$string.'</a>';
@@ -1661,7 +1668,7 @@ class localRecordList extends recordList {
        /**
         * Returns TRUE if a numeric clipboard pad is selected/active
         *
-        * @return      boolean
+        * @return boolean
         */
        function clipNumPane() {
                return in_Array('_CLIPBOARD_',$this->fieldArray) && $this->clipObj->current!='normal';
@@ -1672,18 +1679,18 @@ class localRecordList extends recordList {
         * It will automatically detect if sorting should be ascending or descending depending on $this->sortRev.
         * Also some fields will not be possible to sort (including if single-table-view is disabled).
         *
-        * @param       string          The string to link (text)
-        * @param       string          The fieldname represented by the title ($code)
-        * @param       string          Table name
-        * @return      string          Linked $code variable
+        * @param string $code The string to link (text)
+        * @param string $field The fieldname represented by the title ($code)
+        * @param string $table Table name
+        * @return string Linked $code variable
         */
-       function addSortLink($code,$field,$table) {
+       function addSortLink($code, $field, $table) {
 
                        // Certain circumstances just return string right away (no links):
-               if ($field=='_CONTROL_' || $field=='_LOCALIZATION_' || $field=='_CLIPBOARD_' || $field=='_REF_' || $this->disableSingleTableView)       return $code;
+               if ($field == '_CONTROL_' || $field == '_LOCALIZATION_' || $field == '_CLIPBOARD_' || $field == '_REF_' || $this->disableSingleTableView)       return $code;
 
                        // If "_PATH_" (showing record path) is selected, force sorting by pid field (will at least group the records!)
-               if ($field=='_PATH_')   $field=pid;
+               if ($field == '_PATH_') $field = pid;
 
                        //       Create the sort link:
                $sortUrl = $this->listURL('', -1, 'sortField,sortRev,table,firstElementNumber') . '&table=' . $table . '&sortField=' . $field . '&sortRev=' . ($this->sortRev || ($this->sortField != $field) ? 0 : 1);
@@ -1699,8 +1706,8 @@ class localRecordList extends recordList {
         * Returns the path for a certain pid
         * The result is cached internally for the session, thus you can call this function as much as you like without performance problems.
         *
-        * @param       integer         The page id for which to get the path
-        * @return      string          The path.
+        * @param integer $pid The page id for which to get the path
+        * @return string The path.
         */
        function recPath($pid) {
                if (!isset($this->recPath_cache[$pid])) {
@@ -1712,9 +1719,9 @@ class localRecordList extends recordList {
        /**
         * Returns TRUE if a link for creating new records should be displayed for $table
         *
-        * @param       string          Table name
-        * @return      boolean         Returns TRUE if a link for creating new records should be displayed for $table
-        * @see         SC_db_new::showNewRecLink
+        * @param string $table Table name
+        * @return boolean Returns TRUE if a link for creating new records should be displayed for $table
+        * @see SC_db_new::showNewRecLink
         */
        function showNewRecLink($table) {
                        // No deny/allow tables are set:
@@ -1733,22 +1740,12 @@ class localRecordList extends recordList {
         * Creates the "&returnUrl" parameter for links - this is used when the script links to other scripts and passes its own URL with the link so other scripts can return to the listing again.
         * Uses REQUEST_URI as value.
         *
-        * @return      string
+        * @return string
         */
        function makeReturnUrl() {
                return '&returnUrl='.rawurlencode(t3lib_div::getIndpEnv('REQUEST_URI'));
        }
 
-
-
-
-
-
-
-
-
-
-
        /************************************
         *
         * CSV related functions
@@ -1758,7 +1755,7 @@ class localRecordList extends recordList {
        /**
         * Initializes internal csvLines array with the header of field names
         *
-        * @return      void
+        * @return void
         */
        protected function initCSV() {
                $this->addHeaderRowToCSV();
@@ -1777,8 +1774,8 @@ class localRecordList extends recordList {
        /**
         * Adds selected columns of one table row as CSV line.
         *
-        * @param       array           Record array, from which the values of fields found in $this->fieldArray will be listed in the CSV output.
-        * @return      void
+        * @param array $row Record array, from which the values of fields found in $this->fieldArray will be listed in the CSV output.
+        * @return void
         */
        protected function addToCSV(array $row = array()) {
                $rowReducedByControlFields = self::removeControlFieldsFromFieldRow($row);
@@ -1789,7 +1786,7 @@ class localRecordList extends recordList {
        /**
         * Remove control fields from row for CSV export
         *
-        * @param array fieldNames => fieldValues
+        * @param array $row fieldNames => fieldValues
         * @return array Input array reduces by control fields
         */
        protected static function removeControlFieldsFromFieldRow(array $row = array()) {
@@ -1807,12 +1804,11 @@ class localRecordList extends recordList {
                return array_diff_key($row, array_flip($controlFields));
        }
 
-
        /**
         * Adds input row of values to the internal csvLines array as a CSV formatted line
         *
-        * @param       array           Array with values to be listed.
-        * @return      void
+        * @param array $csvRow Array with values to be listed.
+        * @return void
         */
        function setCsvRow($csvRow) {
                $this->csvLines[] = t3lib_div::csvValues($csvRow);
@@ -1822,8 +1818,8 @@ class localRecordList extends recordList {
         * Compiles the internal csvLines array to a csv-string and outputs it to the browser.
         * This function exits!
         *
-        * @param       string          Filename prefix:
-        * @return      void            EXITS php execusion!
+        * @param string $prefix Filename prefix:
+        * @return void EXITS php execusion!
         */
        function outputCSV($prefix) {
 
@@ -1832,8 +1828,8 @@ class localRecordList extends recordList {
 
                        // Creating output header:
                $mimeType = 'application/octet-stream';
-               Header('Content-Type: '.$mimeType);
-               Header('Content-Disposition: attachment; filename='.$filename);
+               header('Content-Type: '.$mimeType);
+               header('Content-Disposition: attachment; filename='.$filename);
 
                        // Printing the content of the CSV lines:
                echo implode(chr(13).chr(10),$this->csvLines);
@@ -1843,10 +1839,8 @@ class localRecordList extends recordList {
        }
 }
 
-
-
 if (defined('TYPO3_MODE') && isset($GLOBALS['TYPO3_CONF_VARS'][TYPO3_MODE]['XCLASS']['typo3/class.db_list_extra.inc'])) {
        include_once($GLOBALS['TYPO3_CONF_VARS'][TYPO3_MODE]['XCLASS']['typo3/class.db_list_extra.inc']);
 }
 
-?>
+?>
\ No newline at end of file