class.t3lib_recordlist.php

Go to the documentation of this file.

<?php
/***************************************************************
*  Copyright notice
*
*  (c) 1999-2004 Kasper Skaarhoj (kasperYYYY@typo3.com)
*  All rights reserved
*
*  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
*  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
*  GNU General Public License for more details.
*
*  This copyright notice MUST APPEAR in all copies of the script!
***************************************************************/
class t3lib_recordList {

      // Used in this class:
   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 $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();

      // 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 $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...

      // Internal (used in this class.)
   var $firstElementNumber=0;
   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



   function addElement($h,$icon,$data,$tdParams='',$lMargin='',$altLine='')   {
      $noWrap = ($this->no_noWrap) ? '' : ' nowrap="nowrap"';

         // Start up:
      $out='
      <!-- Element, begin: -->
      <tr>';
         // Show icon and lines
      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="" />';
         } else {
            for ($a=0;$a<$h;$a++)   {
               if (!$a) {
#                 $out.= $altLine ? $altLine : '<img'.t3lib_iconWorks::skinImg($this->backPath,'gfx/ol/line.gif','width="18" height="16"').' alt="" />';
                  if ($icon)  $out.= $icon;
               } else {
#                 $out.= $altLine ? $altLine :'<br /><img'.t3lib_iconWorks::skinImg($this->backPath,'gfx/ol/line.gif','width="18" height="16"').' alt="" />';
               }
            }
         }
         $out.='</td>
         ';
      }

         // Init rendering.
      $colsp='';
      $lastKey='';
      $c=0;
      $ccount=0;
      $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)  {
               $out.='
                  <td'.
                  $noWrap.
                  $tdP[($ccount%2)].
                  $colsp.
                  $this->addElement_tdParams[$lastKey].
                  '>'.$data[$lastKey].'</td>';
            }
            $lastKey=$vKey;
            $c=1;
            $ccount++;
         } else {
            if (!$lastKey) {$lastKey=$vKey;}
            $c++;
         }
         if ($c>1)   {$colsp=' colspan="'.$c.'"';} else {$colsp='';}
      }
      if ($lastKey)  {  $out.='
                  <td'.$noWrap.$tdP[($ccount%2)].$colsp.$this->addElement_tdParams[$lastKey].'>'.$data[$lastKey].'</td>';  }

         // End row
      $out.='
      </tr>';

         // Return row.
      return $out;
   }

   function writeTop()  {
   }

   function writeBottom()  {
      $this->HTMLcode.='

      <!--
         End of list table:
      -->
      <table border="0" cellpadding="0" cellspacing="0">';
      $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>';
   }

   function fwd_rwd_nav($table='')  {
      $code='';
      if ($this->eCounter >= $this->firstElementNumber   &&   $this->eCounter < $this->firstElementNumber+$this->iLimit)   {
         if ($this->firstElementNumber && $this->eCounter==$this->firstElementNumber)  {
               //    reverse
            $theData = Array();
            $titleCol=$this->fieldArray[0];
            $theData[$titleCol] = $this->fwd_rwd_HTML('fwd',$this->eCounter,$table);
            $code=$this->addElement(1,'',$theData);
         }
         return Array(1,$code);
      } else {
         if ($this->eCounter==$this->firstElementNumber+$this->iLimit)  {
               //    forward
            $theData = Array();
            $titleCol=$this->fieldArray[0];
            $theData[$titleCol] = $this->fwd_rwd_HTML('rwd',$this->eCounter,$table);
            $code=$this->addElement(1,'',$theData);
         }
         return Array(0,$code);
      }

   }

   function fwd_rwd_HTML($type,$pointer,$table='') {
      $tParam = $table ? '&table='.rawurlencode($table) : '';
      switch($type)  {
         case 'fwd':
            $href = $this->listURL().'&pointer='.($pointer-$this->iLimit).$tParam;
            return '<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).'">'.
                  '<img'.t3lib_iconWorks::skinImg($this->backPath,'gfx/pildown.gif','width="14" height="14"').' alt="" />'.
                  '</a> <i>['.($pointer+1).' - '.$this->totalItems.']</i>';
         break;
      }
   }

   function listURL($altId='')   {
      return $this->script.
         '?id='.(strcmp($altId,'')?$altId:$this->id);
   }

   function CBfunctions()  {
      return '
      // checkOffCB()
   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(",");
      while (pos!=-1)   {
         if (!cbValue(listOfCBnames.substr(pointer,pos-pointer))) notChecked++;
         total++;
         pointer=pos+1;
         pos = listOfCBnames.indexOf(",",pointer);
      }
      if (!cbValue(listOfCBnames.substr(pointer))) notChecked++;
      total++;

         // Setting the status...
      var flag = notChecked*2>total;
      pointer=0;
      pos = listOfCBnames.indexOf(",");
      while (pos!=-1)   {
         setcbValue(listOfCBnames.substr(pointer,pos-pointer),flag);

         pointer=pos+1;
         pos = listOfCBnames.indexOf(",",pointer);
      }
      setcbValue(listOfCBnames.substr(pointer),flag);
   }
      // cbValue()
   function cbValue(CBname)   {  //
      var CBfullName = "CBC["+CBname+"]";
      return (document.dblistForm[CBfullName] && document.dblistForm[CBfullName].checked ? 1 : 0);
   }
      // setcbValue()
   function setcbValue(CBname,flag) {  //
      CBfullName = "CBC["+CBname+"]";
      document.dblistForm[CBfullName].checked = flag ? "on" : 0;
   }

      ';
   }

   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'),
         '',
         '',
         '',
         'sys_language_uid'
      );

         // icons and language titles:
      t3lib_div::loadTCA ('sys_language');
      $flagAbsPath = t3lib_div::getFileAbsFileName($TCA['sys_language']['columns']['flag']['config']['fileFolder']);
      $flagIconPath = $this->backPath.'../'.substr($flagAbsPath, strlen(PATH_site));

      $this->modSharedTSconfig = t3lib_BEfunc::getModTSconfig($this->id, 'mod.SHARED');
      $this->languageIconTitles = array();

         // Set default:
      $this->languageIconTitles[0]=array(
         'uid' => 0,
         'title' => strlen ($this->modSharedTSconfig['properties']['defaultLanguageFlag']) ? $this->modSharedTSconfig['properties']['defaultLanguageLabel'].' ('.$LANG->getLL('defaultLanguage').')' : $LANG->getLL('defaultLanguage'),
         'ISOcode' => 'DEF',
         'flagIcon' => strlen($this->modSharedTSconfig['properties']['defaultLanguageFlag']) && @is_file($flagAbsPath.$this->modSharedTSconfig['properties']['defaultLanguageFlag']) ? $flagIconPath.$this->modSharedTSconfig['properties']['defaultLanguageFlag'] : null,
      );

         // Set "All" language:
      $this->languageIconTitles[-1]=array(
         'uid' => -1,
         'title' => $LANG->getLL ('multipleLanguages'),
         'ISOcode' => 'DEF',
         'flagIcon' => $flagIconPath.'multi-language.gif',
      );

         // Find all system languages:
      $sys_languages = $GLOBALS['TYPO3_DB']->exec_SELECTgetRows(
         '*',
         'sys_language',
         ''
      );
      foreach($sys_languages as $row)     {
         $this->languageIconTitles[$row['uid']] = $row;

         if ($row['static_lang_isocode']) {
            $staticLangRow = t3lib_BEfunc::getRecord('static_languages',$row['static_lang_isocode'],'lg_iso_2');
            if ($staticLangRow['lg_iso_2']) {
               $this->languageIconTitles[$row['uid']]['ISOcode'] = $staticLangRow['lg_iso_2'];
            }
         }
         if (strlen ($row['flag'])) {
            $this->languageIconTitles[$row['uid']]['flagIcon'] = @is_file($flagAbsPath.$row['flag']) ? $flagIconPath.$row['flag'] : '';
         }
      }
   }

   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']);
   }
}


if (defined('TYPO3_MODE') && $TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['t3lib/class.t3lib_recordlist.php']) {
   include_once($TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['t3lib/class.t3lib_recordlist.php']);
}
?>

---