Fixed bug #10454: t3lib_div::makeInstanceClassName() allows to bypass checks for...
[Packages/TYPO3.CMS.git] / t3lib / class.t3lib_recordlist.php
1 <?php
2 /***************************************************************
3 * Copyright notice
4 *
5 * (c) 1999-2008 Kasper Skaarhoj (kasperYYYY@typo3.com)
6 * All rights reserved
7 *
8 * This script is part of the TYPO3 project. The TYPO3 project is
9 * free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
13 *
14 * The GNU General Public License can be found at
15 * http://www.gnu.org/copyleft/gpl.html.
16 * A copy is found in the textfile GPL.txt and important notices to the license
17 * from the author is found in LICENSE.txt distributed with these scripts.
18 *
19 *
20 * This script is distributed in the hope that it will be useful,
21 * but WITHOUT ANY WARRANTY; without even the implied warranty of
22 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23 * GNU General Public License for more details.
24 *
25 * This copyright notice MUST APPEAR in all copies of the script!
26 ***************************************************************/
27 /**
28 * Library with a single function addElement that returns tablerows based on some input.
29 *
30 * $Id$
31 * Revised for TYPO3 3.6 July/2003 by Kasper Skaarhoj
32 * XHTML compliant
33 *
34 * @author Kasper Skaarhoj <kasperYYYY@typo3.com>
35 */
36 /**
37 * [CLASS/FUNCTION INDEX of SCRIPT]
38 *
39 *
40 *
41 * 80: class t3lib_recordList
42 * 123: function addElement($h,$icon,$data,$tdParams='',$lMargin='',$altLine='')
43 * 198: function writeTop()
44 * 206: function writeBottom()
45 * 225: function fwd_rwd_nav($table='')
46 * 258: function fwd_rwd_HTML($type,$pointer,$table='')
47 * 284: function listURL($altId='')
48 * 294: function CBfunctions()
49 * 344: function initializeLanguages()
50 * 411: function languageFlag($sys_language_uid)
51 *
52 * TOTAL FUNCTIONS: 9
53 * (This index is automatically created/updated by the extension "extdeveval")
54 *
55 */
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72 /**
73 * This class is the base for listing of database records and files in the modules Web>List and File>Filelist
74 *
75 * @author Kasper Skaarhoj <kasperYYYY@typo3.com>
76 * @package TYPO3
77 * @subpackage t3lib
78 * @see typo3/db_list.php, typo3/file_list.php
79 */
80 class t3lib_recordList {
81
82 // Used in this class:
83 var $iLimit = 10; // default Max items shown
84 var $leftMargin = 0; // OBSOLETE - NOT USED ANYMORE. leftMargin
85 var $showIcon = 1;
86 var $no_noWrap = 0;
87 var $oddColumnsTDParams = ''; // Deprecated since TYPO3 4.2, remove in 4.4. If set this is <td>-params for odd columns in addElement. Used with db_layout / pages section
88 var $oddColumnsCssClass = ''; // If set this is <td> CSS-classname for odd columns in addElement. Used with db_layout / pages section
89 var $backPath='';
90 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.
91 var $addElement_tdParams = array(); // Keys are fieldnames and values are td-parameters to add in addElement(), please use $addElement_tdCSSClass for CSS-classes;
92 var $addElement_tdCssClass = array(); // Keys are fieldnames and values are td-css-classes to add in addElement();
93
94 // Not used in this class - but maybe extension classes...
95 var $fixedL = 30; // Max length of strings
96 var $script = '';
97 var $thumbScript = 'thumbs.php';
98 var $setLMargin=1; // Set to zero, if you don't want a left-margin with addElement function
99
100 var $counter=0; // Counter increased for each element. Used to index elements for the JavaScript-code that transfers to the clipboard
101 var $totalItems = ''; // This could be set to the total number of items. Used by the fwd_rew_navigation...
102
103 // Internal (used in this class.)
104 var $firstElementNumber=0;
105 var $eCounter=0;
106 var $HTMLcode=''; // String with accumulated HTML content
107
108 var $pageOverlays = array(); // Contains page translation languages
109 var $languageIconTitles = array(); // Contains sys language icons and titles
110
111
112
113 /**
114 * Returns a table-row with the content from the fields in the input data array.
115 * OBS: $this->fieldArray MUST be set! (represents the list of fields to display)
116 *
117 * @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'
118 * @param string $icon is the <img>+<a> of the record. If not supplied the first 'join'-icon will be a 'line' instead
119 * @param array $data is the dataarray, record with the fields. Notice: These fields are (currently) NOT htmlspecialchar'ed before being wrapped in <td>-tags
120 * @param string $tdParams is insert in the <td>-tags. Must carry a ' ' as first character
121 * @param integer OBSOLETE - NOT USED ANYMORE. $lMargin is the leftMargin (integer)
122 * @param string $altLine is the HTML <img>-tag for an alternative 'gfx/ol/line.gif'-icon (used in the top)
123 * @return string HTML content for the table row
124 */
125 function addElement($h, $icon, $data, $trParams = '', $lMargin = '', $altLine = '') {
126 $noWrap = ($this->no_noWrap) ? '' : ' nowrap="nowrap"';
127
128 // Start up:
129 $out='
130 <!-- Element, begin: -->
131 <tr '.$trParams.'>';
132 // Show icon and lines
133 if ($this->showIcon) {
134 $out.='
135 <td nowrap="nowrap" class="col-icon">';
136
137 if (!$h) {
138 # $out.='<img'.t3lib_iconWorks::skinImg($this->backPath,'gfx/ol/halfline.gif','width="18" height="8"').' alt="" />';
139 $out.='<img src="clear.gif" width="1" height="8" alt="" />';
140 } else {
141 for ($a=0;$a<$h;$a++) {
142 if (!$a) {
143 # $out.= $altLine ? $altLine : '<img'.t3lib_iconWorks::skinImg($this->backPath,'gfx/ol/line.gif','width="18" height="16"').' alt="" />';
144 if ($icon) $out.= $icon;
145 } else {
146 # $out.= $altLine ? $altLine :'<br /><img'.t3lib_iconWorks::skinImg($this->backPath,'gfx/ol/line.gif','width="18" height="16"').' alt="" />';
147 }
148 }
149 }
150 $out.='</td>
151 ';
152 }
153
154 // Init rendering.
155 $colsp='';
156 $lastKey='';
157 $c=0;
158 $ccount=0;
159
160 // Traverse field array which contains the data to present:
161 reset($this->fieldArray);
162 while(list(,$vKey)=each($this->fieldArray)) {
163 if (isset($data[$vKey])) {
164 if ($lastKey) {
165 $cssClass = $this->addElement_tdCssClass[$lastKey];
166 if($this->oddColumnsCssClass && $ccount % 2 == 0) {
167 $cssClass = implode(' ', array($this->addElement_tdCssClass[$lastKey], $this->oddColumnsCssClass));
168 }
169
170 $out.='
171 <td'.
172 $noWrap.
173 ' class="' . $cssClass . '"'.
174 $colsp.
175 $this->addElement_tdParams[$lastKey].
176 '>'.$data[$lastKey].'</td>';
177 }
178 $lastKey=$vKey;
179 $c=1;
180 $ccount++;
181 } else {
182 if (!$lastKey) {$lastKey=$vKey;}
183 $c++;
184 }
185 if ($c>1) {$colsp=' colspan="'.$c.'"';} else {$colsp='';}
186 }
187 if ($lastKey) {
188 $cssClass = $this->addElement_tdCssClass[$lastKey];
189 if($this->oddColumnsCssClass) {
190 $cssClass = implode(' ', array($this->addElement_tdCssClass[$lastKey], $this->oddColumnsCssClass));
191 }
192
193 $out.='
194 <td'.$noWrap.' class="' . $cssClass . '"' . $colsp.$this->addElement_tdParams[$lastKey].'>'.$data[$lastKey].'</td>'; }
195
196 // End row
197 $out.='
198 </tr>';
199
200 // Return row.
201 return $out;
202 }
203
204 /**
205 * Dummy function, used to write the top of a table listing.
206 *
207 * @return void
208 */
209 function writeTop() {
210 }
211
212 /**
213 * Finishes the list with the "stopper"-gif, adding the HTML code for that item to the internal ->HTMLcode string
214 *
215 * @return void
216 */
217 function writeBottom() {
218 $this->HTMLcode.='
219
220 <!--
221 End of list table:
222 -->
223 <table border="0" cellpadding="0" cellspacing="0">';
224 $theIcon='<img'.t3lib_iconWorks::skinImg($this->backPath,'gfx/ol/stopper.gif','width="18" height="16"').' alt="" />';
225 $this->HTMLcode.=$this->addElement(1,'','','',$this->leftMargin,$theIcon);
226 $this->HTMLcode.='
227 </table>';
228 }
229
230 /**
231 * Creates a forward/reverse button based on the status of ->eCounter, ->firstElementNumber, ->iLimit
232 *
233 * @param string Table name
234 * @return array array([boolean], [HTML]) where [boolean] is 1 for reverse element, [HTML] is the table-row code for the element
235 */
236 function fwd_rwd_nav($table='') {
237 $code='';
238 if ($this->eCounter >= $this->firstElementNumber && $this->eCounter < $this->firstElementNumber+$this->iLimit) {
239 if ($this->firstElementNumber && $this->eCounter==$this->firstElementNumber) {
240 // reverse
241 $theData = Array();
242 $titleCol=$this->fieldArray[0];
243 $theData[$titleCol] = $this->fwd_rwd_HTML('fwd',$this->eCounter,$table);
244 $code = $this->addElement(1, '', $theData, 'class="fwd_rwd_nav"');
245 }
246 return array(1, $code);
247 } else {
248 if ($this->eCounter==$this->firstElementNumber+$this->iLimit) {
249 // forward
250 $theData = Array();
251 $titleCol=$this->fieldArray[0];
252 $theData[$titleCol] = $this->fwd_rwd_HTML('rwd',$this->eCounter,$table);
253 $code = $this->addElement(1, '', $theData, 'class="fwd_rwd_nav"');
254 }
255 return array(0, $code);
256 }
257
258 }
259
260 /**
261 * Creates the button with link to either forward or reverse
262 *
263 * @param string Type: "fwd" or "rwd"
264 * @param integer Pointer
265 * @param string Table name
266 * @return string
267 * @access private
268 */
269 function fwd_rwd_HTML($type,$pointer,$table='') {
270 $content = '';
271 $tParam = $table ? '&table='.rawurlencode($table) : '';
272 switch($type) {
273 case 'fwd':
274 $href = $this->listURL().'&pointer='.($pointer-$this->iLimit).$tParam;
275 $content = '<a href="'.htmlspecialchars($href).'">'.
276 '<img'.t3lib_iconWorks::skinImg($this->backPath,'gfx/pilup.gif','width="14" height="14"').' alt="" />'.
277 '</a> <i>[1 - '.$pointer.']</i>';
278 break;
279 case 'rwd':
280 $href = $this->listURL().'&pointer='.$pointer.$tParam;
281 $content = '<a href="'.htmlspecialchars($href).'">'.
282 '<img'.t3lib_iconWorks::skinImg($this->backPath,'gfx/pildown.gif','width="14" height="14"').' alt="" />'.
283 '</a> <i>['.($pointer+1).' - '.$this->totalItems.']</i>';
284 break;
285 }
286 return $content;
287 }
288
289 /**
290 * Creates the URL to this script, including all relevant GPvars
291 *
292 * @param string Alternative id value. Enter blank string for the current id ($this->id)
293 * @return string URL
294 */
295 function listURL($altId='') {
296 return $this->script.
297 '?id='.(strcmp($altId,'')?$altId:$this->id);
298 }
299
300 /**
301 * Returning JavaScript for ClipBoard functionality.
302 *
303 * @return string
304 */
305 function CBfunctions() {
306 return '
307 // checkOffCB()
308 function checkOffCB(listOfCBnames) { //
309 var notChecked=0;
310 var total=0;
311
312 // Checking how many is checked, how many is not
313 var pointer=0;
314 var pos = listOfCBnames.indexOf(",");
315 while (pos!=-1) {
316 if (!cbValue(listOfCBnames.substr(pointer,pos-pointer))) notChecked++;
317 total++;
318 pointer=pos+1;
319 pos = listOfCBnames.indexOf(",",pointer);
320 }
321 if (!cbValue(listOfCBnames.substr(pointer))) notChecked++;
322 total++;
323
324 // Setting the status...
325 var flag = notChecked*2>total;
326 pointer=0;
327 pos = listOfCBnames.indexOf(",");
328 while (pos!=-1) {
329 setcbValue(listOfCBnames.substr(pointer,pos-pointer),flag);
330
331 pointer=pos+1;
332 pos = listOfCBnames.indexOf(",",pointer);
333 }
334 setcbValue(listOfCBnames.substr(pointer),flag);
335 }
336 // cbValue()
337 function cbValue(CBname) { //
338 var CBfullName = "CBC["+CBname+"]";
339 return (document.dblistForm[CBfullName] && document.dblistForm[CBfullName].checked ? 1 : 0);
340 }
341 // setcbValue()
342 function setcbValue(CBname,flag) { //
343 CBfullName = "CBC["+CBname+"]";
344 document.dblistForm[CBfullName].checked = flag ? "on" : 0;
345 }
346
347 ';
348 }
349
350 /**
351 * Initializes page languages and icons
352 *
353 * @return void
354 */
355 function initializeLanguages() {
356 global $TCA,$LANG;
357
358 // Look up page overlays:
359 $this->pageOverlays = $GLOBALS['TYPO3_DB']->exec_SELECTgetRows(
360 '*',
361 'pages_language_overlay',
362 'pid='.intval($this->id).
363 t3lib_BEfunc::deleteClause('pages_language_overlay').
364 t3lib_BEfunc::versioningPlaceholderClause('pages_language_overlay'),
365 '',
366 '',
367 '',
368 'sys_language_uid'
369 );
370
371 $t8Tools = t3lib_div::makeInstance('t3lib_transl8tools');
372 $this->languageIconTitles = $t8Tools->getSystemLanguages($this->id, $this->backPath);
373 }
374
375 /**
376 * Return the icon for the language
377 *
378 * @param integer Sys language uid
379 * @return string Language icon
380 */
381 function languageFlag($sys_language_uid) {
382 return ($this->languageIconTitles[$sys_language_uid]['flagIcon'] ? '<img src="'.$this->languageIconTitles[$sys_language_uid]['flagIcon'].'" class="absmiddle" alt="" />&nbsp;' : '').
383 htmlspecialchars($this->languageIconTitles[$sys_language_uid]['title']);
384 }
385 }
386
387
388 if (defined('TYPO3_MODE') && $TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['t3lib/class.t3lib_recordlist.php']) {
389 include_once($TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['t3lib/class.t3lib_recordlist.php']);
390 }
391
392 ?>