Added feature #5242: IRRE - Storage page for child records
[Packages/TYPO3.CMS.git] / t3lib / class.t3lib_recordlist.php
index 11e737b..526911e 100755 (executable)
@@ -1,22 +1,22 @@
 <?php
 /***************************************************************
 *  Copyright notice
-*  
-*  (c) 1999-2004 Kasper Skaarhoj (kasper@typo3.com)
+*
+*  (c) 1999-2006 Kasper Skaarhoj (kasperYYYY@typo3.com)
 *  All rights reserved
 *
-*  This script is part of the TYPO3 project. The TYPO3 project is 
+*  This script is part of the TYPO3 project. The TYPO3 project is
 *  free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
-* 
+*
 *  The GNU General Public License can be found at
 *  http://www.gnu.org/copyleft/gpl.html.
-*  A copy is found in the textfile GPL.txt and important notices to the license 
+*  A copy is found in the textfile GPL.txt and important notices to the license
 *  from the author is found in LICENSE.txt distributed with these scripts.
 *
-* 
+*
 *  This script is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *
 *  This copyright notice MUST APPEAR in all copies of the script!
 ***************************************************************/
-/** 
+/**
  * Library with a single function addElement that returns tablerows based on some input.
  *
  * $Id$
  * Revised for TYPO3 3.6 July/2003 by Kasper Skaarhoj
  * XHTML compliant
  *
- * @author     Kasper Skaarhoj <kasper@typo3.com>
+ * @author     Kasper Skaarhoj <kasperYYYY@typo3.com>
  */
 /**
  * [CLASS/FUNCTION INDEX of SCRIPT]
  *
  *
  *
- *   78: class t3lib_recordList 
- *  119:     function addElement($h,$icon,$data,$tdParams='',$lMargin='',$altLine='')  
- *  193:     function writeTop()       
- *  201:     function writeBottom()    
- *  220:     function fwd_rwd_nav($table='')   
- *  253:     function fwd_rwd_HTML($type,$pointer,$table='')   
- *  276:     function listURL()        
- *  285:     function CBfunctions()    
+ *   80: class t3lib_recordList
+ *  123:     function addElement($h,$icon,$data,$tdParams='',$lMargin='',$altLine='')
+ *  198:     function writeTop()
+ *  206:     function writeBottom()
+ *  225:     function fwd_rwd_nav($table='')
+ *  258:     function fwd_rwd_HTML($type,$pointer,$table='')
+ *  284:     function listURL($altId='')
+ *  294:     function CBfunctions()
+ *  344:     function initializeLanguages()
+ *  411:     function languageFlag($sys_language_uid)
  *
- * TOTAL FUNCTIONS: 7
+ * TOTAL FUNCTIONS: 9
  * (This index is automatically created/updated by the extension "extdeveval")
  *
  */
@@ -69,8 +71,8 @@
 
 /**
  * This class is the base for listing of database records and files in the modules Web>List and File>Filelist
- * 
- * @author     Kasper Skaarhoj <kasper@typo3.com>
+ *
+ * @author     Kasper Skaarhoj <kasperYYYY@typo3.com>
  * @package TYPO3
  * @subpackage t3lib
  * @see typo3/db_list.php, typo3/file_list.php
 class t3lib_recordList {
 
                // Used in this class:
-       var $iLimit = 10;                                               // default Max items shown 
+       var $iLimit = 10;                                               // default Max items shown
        var $leftMargin = 0;                                    // OBSOLETE - NOT USED ANYMORE. leftMargin
        var $showIcon = 1;
        var $no_noWrap = 0;
        var $oddColumnsTDParams ='';                    // If set this is <td>-params for odd columns in addElement. Used with db_layout / pages section
-       var $backPath='';       
+       var $backPath='';
        var $fieldArray = Array();                              // Decides the columns shown. Filled with values that refers to the keys of the data-array. $this->fieldArray[0] is the title column.
-       var $addElement_tdParams=array();               // Keys are fieldnames and values are td-parameters to add in addElement();
+       var $addElement_tdParams = array();             // Keys are fieldnames and values are td-parameters to add in addElement();
 
                // Not used in this class - but maybe extension classes...
        var $fixedL = 50;                                               // Max length of strings
        var $script = '';
        var $thumbScript = 'thumbs.php';
-       var $setLMargin=1;                                              // Set to zero, if you don't want a left-margin with addElement function        
+       var $setLMargin=1;                                              // Set to zero, if you don't want a left-margin with addElement function
 
        var $counter=0;                                                 // Counter increased for each element. Used to index elements for the JavaScript-code that transfers to the clipboard
        var $totalItems = '';                                   // This could be set to the total number of items. Used by the fwd_rew_navigation...
@@ -101,13 +103,15 @@ class t3lib_recordList {
        var $eCounter=0;
        var $HTMLcode='';                       // String with accumulated HTML content
 
+       var $pageOverlays = array();                    // Contains page translation languages
+       var $languageIconTitles = array();              // Contains sys language icons and titles
+
 
 
-       
        /**
         * Returns a table-row with the content from the fields in the input data array.
         * OBS: $this->fieldArray MUST be set! (represents the list of fields to display)
-        * 
+        *
         * @param       integer         $h is an integer >=0 and denotes how tall a element is. Set to '0' makes a halv line, -1 = full line, set to 1 makes a 'join' and above makes 'line'
         * @param       string          $icon is the <img>+<a> of the record. If not supplied the first 'join'-icon will be a 'line' instead
         * @param       array           $data is the dataarray, record with the fields. Notice: These fields are (currently) NOT htmlspecialchar'ed before being wrapped in <td>-tags
@@ -119,7 +123,7 @@ class t3lib_recordList {
        function addElement($h,$icon,$data,$tdParams='',$lMargin='',$altLine='')        {
                $noWrap = ($this->no_noWrap) ? '' : ' nowrap="nowrap"';
 
-                       // Start up:            
+                       // Start up:
                $out='
                <!-- Element, begin: -->
                <tr>';
@@ -127,7 +131,7 @@ class t3lib_recordList {
                if ($this->showIcon)    {
                        $out.='
                        <td nowrap="nowrap"'.$tdParams.'>';
-                       
+
                        if (!$h)        {
 #                              $out.='<img'.t3lib_iconWorks::skinImg($this->backPath,'gfx/ol/halfline.gif','width="18" height="8"').' alt="" />';
                                $out.='<img src="clear.gif" width="1" height="8" alt="" />';
@@ -145,26 +149,26 @@ class t3lib_recordList {
                        ';
                }
 
-                       // Init rendering.              
+                       // Init rendering.
                $colsp='';
                $lastKey='';
                $c=0;
                $ccount=0;
-               $tdP[0]= $this->oddColumnsTDParams ? $this->oddColumnsTDParams : $tdParams;
-               $tdP[1]=$tdParams;
+               $tdP[0] = $this->oddColumnsTDParams ? $this->oddColumnsTDParams : $tdParams;
+               $tdP[1] = $tdParams;
 
                        // Traverse field array which contains the data to present:
                reset($this->fieldArray);
                while(list(,$vKey)=each($this->fieldArray))     {
                        if (isset($data[$vKey]))        {
-                               if ($lastKey)   {       
+                               if ($lastKey)   {
                                        $out.='
                                                <td'.
                                                $noWrap.
                                                $tdP[($ccount%2)].
                                                $colsp.
                                                $this->addElement_tdParams[$lastKey].
-                                               '>'.$data[$lastKey].'</td>';    
+                                               '>'.$data[$lastKey].'</td>';
                                }
                                $lastKey=$vKey;
                                $c=1;
@@ -185,23 +189,23 @@ class t3lib_recordList {
                        // Return row.
                return $out;
        }
-       
+
        /**
         * Dummy function, used to write the top of a table listing.
-        * 
-        * @return      void            
+        *
+        * @return      void
         */
        function writeTop()     {
        }
-       
+
        /**
         * Finishes the list with the "stopper"-gif, adding the HTML code for that item to the internal ->HTMLcode string
-        * 
-        * @return      void            
+        *
+        * @return      void
         */
        function writeBottom()  {
                $this->HTMLcode.='
-               
+
                <!--
                        End of list table:
                -->
@@ -209,12 +213,12 @@ class t3lib_recordList {
                $theIcon='<img'.t3lib_iconWorks::skinImg($this->backPath,'gfx/ol/stopper.gif','width="18" height="16"').' alt="" />';
                $this->HTMLcode.=$this->addElement(1,'','','',$this->leftMargin,$theIcon);
                $this->HTMLcode.='
-               </table>';      
+               </table>';
        }
-       
+
        /**
         * Creates a forward/reverse button based on the status of ->eCounter, ->firstElementNumber, ->iLimit
-        * 
+        *
         * @param       string          Table name
         * @return      array           array([boolean], [HTML]) where [boolean] is 1 for reverse element, [HTML] is the table-row code for the element
         */
@@ -239,49 +243,53 @@ class t3lib_recordList {
                        }
                        return Array(0,$code);
                }
-               
+
        }
-       
+
        /**
         * Creates the button with link to either forward or reverse
-        * 
+        *
         * @param       string          Type: "fwd" or "rwd"
         * @param       integer         Pointer
         * @param       string          Table name
-        * @return      string          
+        * @return      string
         * @access private
         */
        function fwd_rwd_HTML($type,$pointer,$table='') {
+               $content = '';
                $tParam = $table ? '&table='.rawurlencode($table) : '';
                switch($type)   {
                        case 'fwd':
                                $href = $this->listURL().'&pointer='.($pointer-$this->iLimit).$tParam;
-                               return '<a href="'.htmlspecialchars($href).'">'.
+                               $content = '<a href="'.htmlspecialchars($href).'">'.
                                                '<img'.t3lib_iconWorks::skinImg($this->backPath,'gfx/pilup.gif','width="14" height="14"').' alt="" />'.
                                                '</a> <i>[1 - '.$pointer.']</i>';
                        break;
                        case 'rwd':
                                $href = $this->listURL().'&pointer='.$pointer.$tParam;
-                               return '<a href="'.htmlspecialchars($href).'">'.
+                               $content = '<a href="'.htmlspecialchars($href).'">'.
                                                '<img'.t3lib_iconWorks::skinImg($this->backPath,'gfx/pildown.gif','width="14" height="14"').' alt="" />'.
                                                '</a> <i>['.($pointer+1).' - '.$this->totalItems.']</i>';
                        break;
                }
+               return $content;
        }
-       
+
        /**
-        * Returning "listURL" - the script with parameters to which forward/backward requests are sent
-        * 
-        * @return      string          
+        * Creates the URL to this script, including all relevant GPvars
+        *
+        * @param       string          Alternative id value. Enter blank string for the current id ($this->id)
+        * @return      string          URL
         */
-       function listURL()      {
-               return 'dummy.php?';
+       function listURL($altId='')     {
+               return $this->script.
+                       '?id='.(strcmp($altId,'')?$altId:$this->id);
        }
-       
+
        /**
         * Returning JavaScript for ClipBoard functionality.
-        * 
-        * @return      string          
+        *
+        * @return      string
         */
        function CBfunctions()  {
                return '
@@ -289,7 +297,7 @@ class t3lib_recordList {
        function checkOffCB(listOfCBnames)      {       //
                var notChecked=0;
                var total=0;
-               
+
                        // Checking how many is checked, how many is not
                var pointer=0;
                var pos = listOfCBnames.indexOf(",");
@@ -302,7 +310,7 @@ class t3lib_recordList {
                if (!cbValue(listOfCBnames.substr(pointer))) notChecked++;
                total++;
 
-                       // Setting the status...                
+                       // Setting the status...
                var flag = notChecked*2>total;
                pointer=0;
                pos = listOfCBnames.indexOf(",");
@@ -324,8 +332,44 @@ class t3lib_recordList {
                CBfullName = "CBC["+CBname+"]";
                document.dblistForm[CBfullName].checked = flag ? "on" : 0;
        }
+
+               ';
+       }
+
+       /**
+        * Initializes page languages and icons
+        *
+        * @return      void
+        */
+       function initializeLanguages()  {
+               global $TCA,$LANG;
+
+                       // Look up page overlays:
+               $this->pageOverlays = $GLOBALS['TYPO3_DB']->exec_SELECTgetRows(
+                       '*',
+                       'pages_language_overlay',
+                       'pid='.intval($this->id).
+                               t3lib_BEfunc::deleteClause('pages_language_overlay').
+                               t3lib_BEfunc::versioningPlaceholderClause('pages_language_overlay'),
+                       '',
+                       '',
+                       '',
+                       'sys_language_uid'
+               );
                
-               ';      
+               $t8Tools = t3lib_div::makeInstance('t3lib_transl8tools');
+               $this->languageIconTitles = $t8Tools->getSystemLanguages($this->id, $this->backPath);
+       }
+
+       /**
+        * Return the icon for the language
+        *
+        * @param       integer         Sys language uid
+        * @return      string          Language icon
+        */
+       function languageFlag($sys_language_uid)        {
+               return ($this->languageIconTitles[$sys_language_uid]['flagIcon'] ? '<img src="'.$this->languageIconTitles[$sys_language_uid]['flagIcon'].'" class="absmiddle" alt="" />&nbsp;' : '').
+                               htmlspecialchars($this->languageIconTitles[$sys_language_uid]['title']);
        }
 }