Updated copyright notices to show "2004"
[Packages/TYPO3.CMS.git] / typo3 / template.php
1 <?php
2 /***************************************************************
3 * Copyright notice
4 *
5 * (c) 1999-2004 Kasper Skaarhoj (kasper@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 * Contains class with layout/output function for TYPO3 Backend Scripts
29 *
30 * $Id$
31 * Revised for TYPO3 3.6 2/2003 by Kasper Skaarhoj
32 * XHTML-trans compliant
33 *
34 * @author Kasper Skaarhoj <kasper@typo3.com>
35 */
36 /**
37 * [CLASS/FUNCTION INDEX of SCRIPT]
38 *
39 * 133: function fw($str)
40 *
41 *
42 * 157: class template
43 * 212: function template()
44 *
45 * SECTION: EVALUATION FUNCTIONS
46 * 279: function wrapClickMenuOnIcon($str,$table,$uid='',$listFr=1)
47 * 295: function viewPageIcon($id,$backPath,$addParams='hspace="3"')
48 * 320: function issueCommand($params,$rUrl='')
49 * 335: function isCMlayers()
50 * 345: function thisBlur()
51 * 355: function helpStyle()
52 * 372: function getHeader($table,$row,$path,$noViewPageIcon=0,$tWrap=array('',''))
53 * 398: function getFileheader($title,$path,$iconfile)
54 * 413: function makeShortcutIcon($gvList,$setList,$modName,$motherModName="")
55 * 446: function makeShortcutUrl($gvList,$setList)
56 * 468: function formWidth($size=48,$textarea=0,$styleOverride='')
57 * 493: function formWidthText($size=48,$styleOverride='',$wrap='')
58 * 510: function redirectUrls($thisLocation='')
59 * 534: function formatTime($tstamp,$type)
60 * 547: function parseTime()
61 *
62 * SECTION: PAGE BUILDING FUNCTIONS.
63 * 580: function startPage($title)
64 * 649: function endPage()
65 * 674: function header($text)
66 * 695: function section($label,$text,$nostrtoupper=FALSE,$sH=FALSE,$type=0,$allowHTMLinHeader=FALSE)
67 * 719: function divider($dist)
68 * 735: function spacer($dist)
69 * 754: function sectionHeader($label,$sH=FALSE,$addAttrib='')
70 * 771: function sectionBegin()
71 * 792: function sectionEnd()
72 * 812: function middle()
73 * 821: function endPageJS()
74 * 838: function docBodyTagBegin()
75 * 848: function docStyle()
76 * 889: function insertStylesAndJS($content)
77 * 909: function initCharset()
78 * 921: function generator()
79 *
80 * SECTION: OTHER ELEMENTS
81 * 953: function icons($type)
82 * 982: function t3Button($onClick,$label)
83 * 993: function dfw($string)
84 * 1003: function rfw($string)
85 * 1013: function wrapInCData($string)
86 * 1030: function wrapScriptTags($string, $linebreak=TRUE)
87 * 1067: function table($arr)
88 * 1107: function menuTable($arr1,$arr2=array(), $arr3=array())
89 * 1140: function funcMenu($content,$menu)
90 * 1158: function clearCacheMenu($id,$addSaveOptions=0)
91 * 1194: function getContextMenuCode()
92 * 1340: function getTabMenu($id,$elementName,$currentValue,$menuItems,$script='',$addparams='')
93 *
94 *
95 * 1452: class bigDoc extends template
96 *
97 *
98 * 1461: class noDoc extends template
99 *
100 *
101 * 1470: class smallDoc extends template
102 *
103 *
104 * 1479: class mediumDoc extends template
105 *
106 * TOTAL FUNCTIONS: 45
107 * (This index is automatically created/updated by the extension "extdeveval")
108 *
109 */
110
111
112
113 if (!defined('TYPO3_MODE')) die("Can't include this file directly.");
114
115
116
117
118
119
120
121
122
123
124
125
126 /**
127 * Depreciated fontwrap function. Is just transparent now.
128 *
129 * @param string Input string
130 * @return string Output string (in the old days this was wrapped in <font> tags)
131 * @depreciated
132 */
133 function fw($str) {
134 return $str;
135 }
136
137
138 /**
139 * TYPO3 Backend Template Class
140 *
141 * This class contains functions for starting and ending the HTML of backend modules
142 * It also contains methods for outputting sections of content.
143 * Further there are functions for making icons, links, setting form-field widths etc.
144 * Color scheme and stylesheet definitions are also available here.
145 * Finally this file includes the language class for TYPO3's backend.
146 *
147 * After this file $LANG and $TBE_TEMPLATE are global variables / instances of their respective classes.
148 * This file is typically included right after the init.php file,
149 * if language and layout is needed.
150 *
151 * Please refer to Inside TYPO3 for a discussion of how to use this API.
152 *
153 * @author Kasper Skaarhoj <kasper@typo3.com>
154 * @package TYPO3
155 * @subpackage core
156 */
157 class template {
158
159 // Vars you typically might want to/should set from outside after making instance of this class:
160 var $backPath = ''; // 'backPath' pointing back to the PATH_typo3
161 var $form=''; // This can be set to the HTML-code for a formtag. Useful when you need a form to span the whole page; Inserted exactly after the body-tag.
162 var $JScode=''; // Additional header code (eg. a JavaScript section) could be accommulated in this var. It will be directly outputted in the header.
163 var $JScodeArray=array(); // Similar to $JScode but for use as array with assioziative keys to prevent double inclusion of JS code. a <script> tag is automatically wrapped around.
164 var $postCode=''; // Additional 'page-end' code could be accommulated in this var. It will be outputted at the end of page before </body> and some other internal page-end code.
165 var $docType=''; // Doc-type used in the header. Default is HTML 3.2. You can also set it to 'strict', 'xhtml_trans', or 'xhtml_frames'.
166
167 // Other vars you can change, but less frequently used:
168 var $scriptID=''; // Script ID.
169 var $bodyTagId=''; // Id which can be set for the body tag. Default value is based on script ID
170 var $bodyTagAdditions=''; // You can add additional attributes to the body-tag through this variable.
171 var $inDocStyles=''; // Additional CSS styles which will be added to the <style> section in the header
172 var $inDocStylesArray=array(); // Like $inDocStyles but for use as array with associative keys to prevent double inclusion of css code
173 var $form_rowsToStylewidth = 9.58; // Multiplication factor for formWidth() input size (default is 48* this value).
174 var $form_largeComp = 1.33; // Compensation for large documents (used in class.t3lib_tceforms.php)
175 var $endJS=1; // If set, then a JavaScript section will be outputted in the bottom of page which will try and update the top.busy session expiry object.
176
177 // TYPO3 Colorscheme.
178 // If you want to change this, please do so through a skin using the global var $TBE_STYLES
179 var $bgColor = '#F7F3EF'; // Light background color
180 var $bgColor2 = '#9BA1A8'; // Steel-blue
181 var $bgColor3 = '#F6F2E6'; // dok.color
182 var $bgColor4 = '#D9D5C9'; // light tablerow background, brownish
183 var $bgColor5 = '#ABBBB4'; // light tablerow background, greenish
184 var $bgColor6 = '#E7DBA8'; // light tablerow background, yellowish, for section headers. Light.
185 var $hoverColor = '#254D7B';
186 var $styleSheetFile = 'stylesheet.css'; // Filename of stylesheet (relative to PATH_typo3)
187 var $styleSheetFile2 = ''; // Filename of stylesheet #2 - linked to right after the $this->styleSheetFile script (relative to PATH_typo3)
188 var $styleSheetFile_post = ''; // Filename of a post-stylesheet - included right after all inline styles.
189 var $backGroundImage = ''; // Background image of page (relative to PATH_typo3)
190 var $inDocStyles_TBEstyle = ''; // Inline css styling set from TBE_STYLES array
191
192 // DEV:
193 var $parseTimeFlag = 0; // Will output the parsetime of the scripts in milliseconds (for admin-users). Set this to false when releasing TYPO3. Only for dev.
194
195 // INTERNAL
196 var $charset = 'iso-8859-1'; // Default charset. see function initCharset()
197
198 var $sectionFlag=0; // Internal: Indicates if a <div>-output section is open
199 var $divClass = ''; // (Default) Class for wrapping <DIV>-tag of page. Is set in class extensions.
200
201
202
203
204
205
206 /**
207 * Constructor
208 * Imports relevant parts from global $TBE_STYLES (colorscheme)
209 *
210 * @return void
211 */
212 function template() {
213 global $TBE_STYLES;
214
215 // Setting default scriptID:
216 $this->scriptID = ereg_replace('^.*\/(sysext|ext)\/','ext/',substr(PATH_thisScript,strlen(PATH_site)));
217 if (TYPO3_mainDir!='typo3/' && substr($this->scriptID,0,strlen(TYPO3_mainDir)) == TYPO3_mainDir) {
218 $this->scriptID = 'typo3/'.substr($this->scriptID,strlen(TYPO3_mainDir)); // This fixes if TYPO3_mainDir has been changed so the script ids are STILL "typo3/..."
219 }
220
221 $this->bodyTagId = ereg_replace('[^[:alnum:]-]','-',$this->scriptID);
222
223 // Individual configuration per script? If so, make a recursive merge of the arrays:
224 if (is_array($TBE_STYLES['scriptIDindex'][$this->scriptID])) {
225 $ovr = $TBE_STYLES['scriptIDindex'][$this->scriptID]; // Make copy
226 $TBE_STYLES = t3lib_div::array_merge_recursive_overrule($TBE_STYLES,$ovr); // merge styles.
227 unset($TBE_STYLES['scriptIDindex'][$this->scriptID]); // Have to unset - otherwise the second instantiation will do it again!
228 }
229
230 // Color scheme:
231 if ($TBE_STYLES['mainColors']['bgColor']) $this->bgColor=$TBE_STYLES['mainColors']['bgColor'];
232 if ($TBE_STYLES['mainColors']['bgColor1']) $this->bgColor1=$TBE_STYLES['mainColors']['bgColor1'];
233 if ($TBE_STYLES['mainColors']['bgColor2']) $this->bgColor2=$TBE_STYLES['mainColors']['bgColor2'];
234 if ($TBE_STYLES['mainColors']['bgColor3']) $this->bgColor3=$TBE_STYLES['mainColors']['bgColor3'];
235 if ($TBE_STYLES['mainColors']['bgColor4']) $this->bgColor4=$TBE_STYLES['mainColors']['bgColor4'];
236 if ($TBE_STYLES['mainColors']['bgColor5']) $this->bgColor5=$TBE_STYLES['mainColors']['bgColor5'];
237 if ($TBE_STYLES['mainColors']['bgColor6']) $this->bgColor6=$TBE_STYLES['mainColors']['bgColor6'];
238 if ($TBE_STYLES['mainColors']['hoverColor']) $this->hoverColor=$TBE_STYLES['mainColors']['hoverColor'];
239
240 // Main Stylesheets:
241 if ($TBE_STYLES['stylesheet']) $this->styleSheetFile = $TBE_STYLES['stylesheet'];
242 if ($TBE_STYLES['stylesheet2']) $this->styleSheetFile2 = $TBE_STYLES['stylesheet2'];
243 if ($TBE_STYLES['styleSheetFile_post']) $this->styleSheetFile_post = $TBE_STYLES['styleSheetFile_post'];
244 if ($TBE_STYLES['inDocStyles_TBEstyle']) $this->inDocStyles_TBEstyle = $TBE_STYLES['inDocStyles_TBEstyle'];
245
246 // Background image
247 if ($TBE_STYLES['background']) $this->backGroundImage = $TBE_STYLES['background'];
248 }
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265 /*****************************************
266 *
267 * EVALUATION FUNCTIONS
268 * Various centralized processing
269 *
270 *****************************************/
271
272 /**
273 * Makes click menu link (context sensitive menu)
274 * Returns $str (possibly an <|img> tag/icon) wrapped in a link which will activate the context sensitive menu for the record ($table/$uid) or file ($table = file)
275 * The link will load the top frame with the parameter "&item" which is the table,uid and listFr arguments imploded by "|": rawurlencode($table.'|'.$uid.'|'.$listFr)
276 *
277 * @param string String to be wrapped in link, typ. image tag.
278 * @param string Table name/File path. If the icon is for a database record, enter the tablename from $TCA. If a file then enter the absolute filepath
279 * @param integer If icon is for database record this is the UID for the record from $table
280 * @param boolean Tells the top frame script that the link is coming from a "list" frame which means a frame from within the backend content frame.
281 * @return string The link-wrapped input string.
282 */
283 function wrapClickMenuOnIcon($str,$table,$uid='',$listFr=1) {
284 $backPath = '&backPath='.rawurlencode($this->backPath).'|'.t3lib_div::shortMD5($this->backPath.'|'.$GLOBALS['TYPO3_CONF_VARS']['SYS']['encryptionKey']);
285 $onClick = 'top.loadTopMenu(\''.$this->backPath.'alt_clickmenu.php?item='.rawurlencode($table.'|'.$uid.'|'.$listFr).$backPath.'\');'.$this->thisBlur().'return false;';
286 return '<a href="#" onclick="'.htmlspecialchars($onClick).'">'.$str.'</a>';
287 }
288
289 /**
290 * Makes link to page $id in frontend (view page)
291 * Returns an magnifier-glass icon which links to the frontend index.php document for viewing the page with id $id
292 * $id must be a page-uid
293 * If the BE_USER has access to Web>List then a link to that module is shown as well (with return-url)
294 *
295 * @param integer The page id
296 * @param string The current "BACK_PATH" (the back relative to the typo3/ directory)
297 * @param string Additional parameters for the image tag(s)
298 * @return string HTML string with linked icon(s)
299 */
300 function viewPageIcon($id,$backPath,$addParams='hspace="3"') {
301 global $BE_USER;
302 $str = '';
303 // If access to Web>List for user, then link to that module.
304 if ($BE_USER->check('modules','web_list')) {
305 $href=$backPath.'db_list.php?id='.$id.'&returnUrl='.rawurlencode(t3lib_div::getIndpEnv('REQUEST_URI'));
306 $str.= '<a href="'.htmlspecialchars($href).'">'.
307 '<img'.t3lib_iconWorks::skinImg($backPath,'gfx/list.gif','width="11" height="11"').' title="'.$GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:labels.showList',1).'"'.($addParams?' '.trim($addParams):'').' alt="" />'.
308 '</a>';
309 }
310 // Make link to view page
311 $str.= '<a href="#" onclick="'.htmlspecialchars(t3lib_BEfunc::viewOnClick($id,$backPath,t3lib_BEfunc::BEgetRootLine($id))).'">'.
312 '<img'.t3lib_iconWorks::skinImg($backPath,'gfx/zoom.gif','width="12" height="12"').' title="'.$GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:labels.showPage',1).'"'.($addParams?' '.trim($addParams):"").' hspace="3" alt="" />'.
313 '</a>';
314 return $str;
315 }
316
317 /**
318 * Returns a URL with a command to TYPO3 Core Engine (tce_db.php)
319 * See description of the API elsewhere.
320 *
321 * @param string $params is a set of GET params to send to tce_db.php. Example: "&cmd[tt_content][123][move]=456" or "&data[tt_content][123][hidden]=1&data[tt_content][123][title]=Hello%20World"
322 * @param string Redirect URL if any other that t3lib_div::getIndpEnv('REQUEST_URI') is wished
323 * @return string URL to tce_db.php + parameters (backpath is taken from $this->backPath)
324 */
325 function issueCommand($params,$rUrl='') {
326 $rUrl = $rUrl ? $rUrl : t3lib_div::getIndpEnv('REQUEST_URI');
327 return $this->backPath.'tce_db.php?'.
328 $params.
329 '&redirect='.($rUrl==-1?"'+T3_THIS_LOCATION+'":rawurlencode($rUrl)).
330 '&vC='.rawurlencode($GLOBALS['BE_USER']->veriCode()).
331 '&prErr=1&uPT=1';
332 }
333
334 /**
335 * Returns true if click-menu layers can be displayed for the current user/browser
336 * Use this to test if click-menus (context sensitive menus) can and should be displayed in the backend.
337 *
338 * @return boolean
339 */
340 function isCMlayers() {
341 return !$GLOBALS['BE_USER']->uc['disableCMlayers'] && $GLOBALS['CLIENT']['FORMSTYLE'] && $GLOBALS['CLIENT']['SYSTEM']!='mac';
342 }
343
344 /**
345 * Returns 'this.blur();' if the client supports CSS styles
346 * Use this in links to remove the underlining after being clicked
347 *
348 * @return string
349 */
350 function thisBlur() {
351 return ($GLOBALS['CLIENT']['FORMSTYLE']?'this.blur();':'');
352 }
353
354 /**
355 * Returns ' style='cursor:help;'' if the client supports CSS styles
356 * Use for <a>-links to help texts
357 *
358 * @return string
359 */
360 function helpStyle() {
361 return $GLOBALS['CLIENT']['FORMSTYLE'] ? ' style="cursor:help;"':'';
362 }
363
364 /**
365 * Makes the header (icon+title) for a page (or other record). Used in most modules under Web>*
366 * $table and $row must be a tablename/record from that table
367 * $path will be shown as alt-text for the icon.
368 * The title will be truncated to 45 chars.
369 *
370 * @param string Table name
371 * @param array Record row
372 * @param string Alt text
373 * @param boolean Set $noViewPageIcon true if you don't want a magnifier-icon for viewing the page in the frontend
374 * @param array $tWrap is an array with indexes 0 and 1 each representing HTML-tags (start/end) which will wrap the title
375 * @return string HTML content
376 */
377 function getHeader($table,$row,$path,$noViewPageIcon=0,$tWrap=array('','')) {
378 global $TCA;
379 if (is_array($row) && $row['uid']) {
380 $iconImgTag=t3lib_iconWorks::getIconImage($table,$row,$this->backPath,'title="'.htmlspecialchars($path).'"');
381 $title= strip_tags($row[$TCA[$table]['ctrl']['label']]);
382 $viewPage = $noViewPageIcon ? '' : $this->viewPageIcon($row['uid'],$this->backPath,'');
383 if ($table=='pages') $path.=' - '.t3lib_BEfunc::titleAttribForPages($row,'',0);
384 } else {
385 $iconImgTag='<img'.t3lib_iconWorks::skinImg($this->backPath,'gfx/i/_icon_website.gif',$wHattribs='width="18" height="16"').' title="'.htmlspecialchars($path).'" alt="" />';
386 $title=$GLOBALS['TYPO3_CONF_VARS']['SYS']['sitename'];
387 }
388
389 return '<span class="typo3-moduleHeader">'.$this->wrapClickMenuOnIcon($iconImgTag,$table,$row['uid']).
390 $viewPage.
391 $tWrap[0].htmlspecialchars(t3lib_div::fixed_lgd($title,45)).$tWrap[1].'</span>';
392 }
393
394 /**
395 * Like ->getHeader() but for files in the File>* main module/submodules
396 * Returns the file-icon with the path of the file set in the alt/title attribute. Shows the file-name after the icon.
397 *
398 * @param string Title string, expected to be the filepath
399 * @param string Alt text
400 * @param string The icon file (relative to TYPO3 dir)
401 * @return string HTML content
402 */
403 function getFileheader($title,$path,$iconfile) {
404 $fileInfo = t3lib_div::split_fileref($title);
405 $title = htmlspecialchars(t3lib_div::fixed_lgd_pre($fileInfo['path'],35)).'<b>'.htmlspecialchars($fileInfo['file']).'</b>';
406 return '<span class="typo3-moduleHeader"><img'.t3lib_iconWorks::skinImg($this->backPath,$iconfile,'width="18" height="16"').' title="'.htmlspecialchars($path).'" alt="" />'.$title.'</span>';
407 }
408
409 /**
410 * Returns a linked shortcut-icon which will call the shortcut frame and set a shortcut there back to the calling page/module
411 *
412 * @param string Is the list of GET variables to store (if any)
413 * @param string Is the list of SET[] variables to store (if any) - SET[] variables a stored in $GLOBALS["SOBE"]->MOD_SETTINGS for backend modules
414 * @param string Module name string
415 * @param string Is used to enter the "parent module name" if the module is a submodule under eg. Web>* or File>*. You can also set this value to "1" in which case the currentLoadedModule is sent to the shortcut script (so - not a fixed value!) - that is used in file_edit.php and wizard_rte.php scripts where those scripts are really running as a part of another module.
416 * @return string HTML content
417 */
418 function makeShortcutIcon($gvList,$setList,$modName,$motherModName="") {
419 $backPath=$this->backPath;
420 $storeUrl=$this->makeShortcutUrl($gvList,$setList);
421 $pathInfo = parse_url(t3lib_div::getIndpEnv('REQUEST_URI'));
422
423 if (!strcmp($motherModName,'1')) {
424 $mMN="&motherModName='+top.currentModuleLoaded+'";
425 } elseif ($motherModName) {
426 $mMN='&motherModName='.rawurlencode($motherModName);
427 } else $mMN="";
428
429 $onClick = 'if (top.shortcutFrame && confirm('.
430 $GLOBALS['LANG']->JScharCode($GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:labels.makeShortcut')).
431 ')){top.shortcutFrame.document.location=\''.$backPath.'alt_shortcut.php?modName='.rawurlencode($modName).
432 '&URL='.rawurlencode($pathInfo['path']."?".$storeUrl).
433 $mMN.
434 '\';}return false;';
435
436 $sIcon = '<a href="#" onclick="'.htmlspecialchars($onClick).'">
437 <img'.t3lib_iconWorks::skinImg($backPath,'gfx/shortcut.gif','width="14" height="14"').' title="'.$GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:labels.makeShortcut',1).'" alt="" /></a>';
438 return $sIcon;
439 }
440
441 /**
442 * MAKE url for storing
443 * Internal func
444 *
445 * @param string Is the list of GET variables to store (if any)
446 * @param string Is the list of SET[] variables to store (if any) - SET[] variables a stored in $GLOBALS["SOBE"]->MOD_SETTINGS for backend modules
447 * @return string
448 * @access private
449 * @see makeShortcutIcon()
450 */
451 function makeShortcutUrl($gvList,$setList) {
452 global $HTTP_GET_VARS;
453
454 $storeArray = array_merge(
455 t3lib_div::compileSelectedGetVarsFromArray($gvList,$HTTP_GET_VARS),
456 array('SET'=>t3lib_div::compileSelectedGetVarsFromArray($setList,$GLOBALS['SOBE']->MOD_SETTINGS))
457 );
458 $storeUrl = t3lib_div::implodeArrayForUrl('',$storeArray);
459 return $storeUrl;
460 }
461
462 /**
463 * Returns <input> attributes to set the width of an text-type input field.
464 * For client browsers with no CSS support the cols/size attribute is returned.
465 * For CSS compliant browsers (recommended) a ' style="width: ...px;"' is returned.
466 *
467 * @param integer A relative number which multiplied with approx. 10 will lead to the width in pixels
468 * @param boolean A flag you can set for textareas - DEPRECIATED, use ->formWidthText() for textareas!!!
469 * @param string A string which will be returned as attribute-value for style="" instead of the calculated width (if CSS is enabled)
470 * @return string Tag attributes for an <input> tag (regarding width)
471 * @see formWidthText()
472 */
473 function formWidth($size=48,$textarea=0,$styleOverride='') {
474 $wAttrib = $textarea?'cols':'size';
475 if (!$GLOBALS['CLIENT']['FORMSTYLE']) { // If not setting the width by style-attribute
476 $size = $size;
477 $retVal = ' '.$wAttrib.'="'.$size.'"';
478 } else { // Setting width by style-attribute. 'cols' MUST be avoided with NN6+
479 $pixels = ceil($size*$this->form_rowsToStylewidth);
480 $retVal = $styleOverride ? ' style="'.$styleOverride.'"' : ' style="width:'.$pixels.'px;"';
481 }
482 return $retVal;
483 }
484
485 /**
486 * This function is dedicated to textareas, which has the wrapping on/off option to observe.
487 * EXAMPLE:
488 * <textarea rows="10" wrap="off" '.$GLOBALS["TBE_TEMPLATE"]->formWidthText(48,"","off").'>
489 * or
490 * <textarea rows="10" wrap="virtual" '.$GLOBALS["TBE_TEMPLATE"]->formWidthText(48,"","virtual").'>
491 *
492 * @param integer A relative number which multiplied with approx. 10 will lead to the width in pixels
493 * @param string A string which will be returned as attribute-value for style="" instead of the calculated width (if CSS is enabled)
494 * @param string Pass on the wrap-attribute value you use in your <textarea>! This will be used to make sure that some browsers will detect wrapping alright.
495 * @return string Tag attributes for an <input> tag (regarding width)
496 * @see formWidth()
497 */
498 function formWidthText($size=48,$styleOverride='',$wrap='') {
499 $wTags = $this->formWidth($size,1,$styleOverride);
500 // Netscape 6+/Mozilla seems to have this ODD problem where there WILL ALWAYS be wrapping with the cols-attribute set and NEVER without the col-attribute...
501 if (strtolower(trim($wrap))!='off' && $GLOBALS['CLIENT']['BROWSER']=='net' && $GLOBALS['CLIENT']['VERSION']>=5) {
502 $wTags.=' cols="'.$size.'"';
503 }
504 return $wTags;
505 }
506
507 /**
508 * Returns JavaScript variables setting the returnUrl and thisScript location for use by JavaScript on the page.
509 * Used in fx. db_list.php (Web>List)
510 *
511 * @param string URL to "this location" / current script
512 * @return string
513 * @see typo3/db_list.php
514 */
515 function redirectUrls($thisLocation='') {
516 $thisLocation = $thisLocation?$thisLocation:t3lib_div::linkThisScript(
517 array(
518 'CB'=>'',
519 'SET'=>'',
520 'cmd' => '',
521 'popViewId'=>''
522 ));
523
524 $out ="
525 var T3_RETURN_URL = '".str_replace('%20','',rawurlencode(t3lib_div::GPvar('returnUrl')))."';
526 var T3_THIS_LOCATION = '".str_replace('%20','',rawurlencode($thisLocation))."';
527 ";
528 return $out;
529 }
530
531 /**
532 * Returns a formatted string of $tstamp
533 * Uses $GLOBALS['TYPO3_CONF_VARS']['SYS']['hhmm'] and $GLOBALS['TYPO3_CONF_VARS']['SYS']['ddmmyy'] to format date and time
534 *
535 * @param integer UNIX timestamp, seconds since 1970
536 * @param integer How much data to show: $type = 1: hhmm, $type = 10: ddmmmyy
537 * @return string Formatted timestamp
538 */
539 function formatTime($tstamp,$type) {
540 switch($type) {
541 case 1: return date($GLOBALS['TYPO3_CONF_VARS']['SYS']['hhmm'],$tstamp); break;
542 case 10: return date($GLOBALS['TYPO3_CONF_VARS']['SYS']['ddmmyy'],$tstamp); break;
543 }
544 }
545
546 /**
547 * Returns script parsetime IF ->parseTimeFlag is set and user is "admin"
548 * Automatically outputted in page end
549 *
550 * @return string
551 */
552 function parseTime() {
553 if ($this->parseTimeFlag && $GLOBALS['BE_USER']->isAdmin()) {
554 return '<p>(ParseTime: '.(t3lib_div::milliseconds()-$GLOBALS['PARSETIME_START']).' ms</p>
555 <p>REQUEST_URI-length: '.strlen(t3lib_div::getIndpEnv('REQUEST_URI')).')</p>';
556 }
557 }
558
559
560
561
562
563
564
565
566
567
568
569
570 /*****************************************
571 *
572 * PAGE BUILDING FUNCTIONS.
573 * Use this to build the HTML of your backend modules
574 *
575 *****************************************/
576
577 /**
578 * Returns page start
579 * This includes the proper header with charset, title, meta tag and beginning body-tag.
580 *
581 * @param string HTML Page title for the header
582 * @return string Returns the whole header section of a HTML-document based on settings in internal variables (like styles, javascript code, charset, generator and docType)
583 * @see endPage()
584 */
585 function startPage($title) {
586 // Get META tag containing the currently selected charset for backend output. The function sets $this->charSet.
587 $charSet = $this->initCharset();
588 $generator = $this->generator();
589
590 // For debugging: If this outputs "QuirksMode"/"BackCompat" (IE) the browser runs in quirks-mode. Otherwise the value is "CSS1Compat"
591 # $this->JScodeArray[]='alert(document.compatMode);';
592
593 // Send HTTP header for selected charset. Added by Robert Lemke 23.10.2003
594 header ('Content-Type:text/html;charset='.$this->charset);
595
596 switch($this->docType) {
597 case 'xhtml_strict':
598 $headerStart= '<!DOCTYPE html
599 PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
600 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
601 <?xml version="1.0" encoding="'.$this->charset.'"?>
602 <?xml-stylesheet href="#internalStyle" type="text/css"?>
603 ';
604 break;
605 case 'xhtml_trans':
606 $headerStart= '<!DOCTYPE html
607 PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
608 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
609 <?xml version="1.0" encoding="'.$this->charset.'"?>
610 <?xml-stylesheet href="#internalStyle" type="text/css"?>
611 ';
612 break;
613 case 'xhtml_frames':
614 $headerStart= '<!DOCTYPE html
615 PUBLIC "-//W3C//DTD XHTML 1.0 Frameset//EN"
616 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd">
617 <?xml version="1.0" encoding="'.$this->charset.'"?>
618 ';
619 break;
620 default:
621 $headerStart='<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">';
622 break;
623 }
624
625 // Construct page header.
626 $str = $headerStart.'
627 <html>
628 <head>
629 <!-- TYPO3 Script ID: '.htmlspecialchars($this->scriptID).' -->
630 '.$charSet.'
631 '.$generator.'
632 <title>'.htmlspecialchars($title).'</title>
633 '.$this->docStyle().'
634 '.$this->JScode.'
635 '.$this->wrapScriptTags(implode("\n", $this->JScodeArray)).'
636 <!--###POSTJSMARKER###-->
637 </head>
638 ';
639 $this->JScode='';
640 $this->JScodeArray=array();
641
642 if ($this->docType=='xhtml_frames') {
643 return $str;
644 } else
645 $str.=$this->docBodyTagBegin().
646 ($this->divClass?'
647
648 <!-- Wrapping DIV-section for whole page BEGIN -->
649 <div class="'.$this->divClass.'">
650 ':'').trim($this->form);
651 return $str;
652 }
653
654 /**
655 * Returns page end; This includes finishing form, div, body and html tags.
656 *
657 * @return string The HTML end of a page
658 * @see startPage()
659 */
660 function endPage() {
661 $str = $this->sectionEnd().
662 $this->postCode.
663 $this->endPageJS().
664 t3lib_BEfunc::getSetUpdateSignal().
665 $this->parseTime().
666 ($this->form?'
667 </form>':'').
668 ($this->divClass?'
669
670 <!-- Wrapping DIV-section for whole page END -->
671 </div>':'').
672 '
673 </body>
674 </html> ';
675 return $str;
676 }
677
678 /**
679 * Returns the header-bar in the top of most backend modules
680 * Closes section if open.
681 *
682 * @param string The text string for the header
683 * @return string HTML content
684 */
685 function header($text) {
686 $str='
687
688 <!-- MAIN Header in page top -->
689 <h2>'.htmlspecialchars($text).'</h2>
690 ';
691 return $this->sectionEnd().$str;
692 }
693
694 /**
695 * Begins an output section and sets header and content
696 *
697 * @param string The header
698 * @param string The HTML-content
699 * @param boolean A flag that will prevent the header from being converted to uppercase
700 * @param boolean Defines the type of header (if set, "<h3>" rather than the default "h4")
701 * @param integer The number of an icon to show with the header (see the icon-function). -1,1,2,3
702 * @param boolean If set, HTML tags are allowed in $label (otherwise this value is by default htmlspecialchars()'ed)
703 * @return string HTML content
704 * @see icons(), sectionHeader()
705 */
706 function section($label,$text,$nostrtoupper=FALSE,$sH=FALSE,$type=0,$allowHTMLinHeader=FALSE) {
707 $str='';
708
709 // Setting header
710 if ($label) {
711 if (!$allowHTMLinHeader) $label = htmlspecialchars($label);
712 $str.=$this->sectionHeader($this->icons($type).$label, $sH, $nostrtoupper ? '' : ' class="uppercase"');
713 }
714 // Setting content
715 $str.='
716
717 <!-- Section content -->
718 '.$text;
719
720 return $this->sectionBegin().$str;
721 }
722
723 /**
724 * Inserts a divider image
725 * Ends a section (if open) before inserting the image
726 *
727 * @param integer The margin-top/-bottom of the <hr> ruler.
728 * @return string HTML content
729 */
730 function divider($dist) {
731 $dist = intval($dist);
732 $str='
733
734 <!-- DIVIDER -->
735 <hr style="margin-top: '.$dist.'px; margin-bottom: '.$dist.'px;" />
736 ';
737 return $this->sectionEnd().$str;
738 }
739
740 /**
741 * Returns a blank <div>-section with a height
742 *
743 * @param integer Padding-top for the div-section (should be margin-top but konquorer (3.1) don't like it :-(
744 * @return string HTML content
745 */
746 function spacer($dist) {
747 if ($dist>0) {
748 return '
749
750 <!-- Spacer element -->
751 <div style="padding-top: '.intval($dist).'px;"></div>
752 ';
753 }
754 }
755
756 /**
757 * Make a section header.
758 * Begins a section if not already open.
759 *
760 * @param string The label between the <h3> or <h4> tags. (Allows HTML)
761 * @param boolean If set, <h3> is used, otherwise <h4>
762 * @param string Additional attributes to h-tag, eg. ' class=""'
763 * @return string HTML content
764 */
765 function sectionHeader($label,$sH=FALSE,$addAttrib='') {
766 $tag = ($sH?'h3':'h4');
767 $str='
768
769 <!-- Section header -->
770 <'.$tag.$addAttrib.'>'.$label.'</'.$tag.'>
771 ';
772 return $this->sectionBegin().$str;
773 }
774
775 /**
776 * Begins an output section.
777 * Returns the <div>-begin tag AND sets the ->sectionFlag true (if the ->sectionFlag is not already set!)
778 * You can call this function even if a section is already begun since the function will only return something if the sectionFlag is not already set!
779 *
780 * @return string HTML content
781 */
782 function sectionBegin() {
783 if (!$this->sectionFlag) {
784 $this->sectionFlag=1;
785 $str='
786
787 <!-- ***********************
788 Begin output section.
789 *********************** -->
790 <div>
791 ';
792 return $str;
793 } else return '';
794 }
795
796 /**
797 * Ends and output section
798 * Returns the </div>-end tag AND clears the ->sectionFlag (but does so only IF the sectionFlag is set - that is a section is 'open')
799 * See sectionBegin() also.
800 *
801 * @return string HTML content
802 */
803 function sectionEnd() {
804 if ($this->sectionFlag) {
805 $this->sectionFlag=0;
806 return '
807 </div>
808 <!-- *********************
809 End output section.
810 ********************* -->
811 ';
812 } else return '';
813 }
814
815 /**
816 * Originally it printed a kind of divider.
817 * Depreciated. Just remove function calls to it or call the divider() function instead.
818 *
819 * @return void
820 * @internal
821 * @depreciated
822 */
823 function middle() {
824 }
825
826 /**
827 * If a form-tag is defined in ->form then and end-tag for that <form> element is outputted
828 * Further a JavaScript section is outputted which will update the top.busy session-expiry object (unless $this->endJS is set to false)
829 *
830 * @return string HTML content (<script> tag section)
831 */
832 function endPageJS() {
833 return ($this->endJS?'
834 <script type="text/javascript">
835 /*<![CDATA[*/
836 if (top.busy && top.busy.loginRefreshed) {
837 top.busy.loginRefreshed();
838 }
839 /*]]>*/
840 </script>':'');
841 }
842
843 /**
844 * Creates the bodyTag.
845 * You can add to the bodyTag by $this->bodyTagAdditions
846 *
847 * @return string HTML body tag
848 */
849 function docBodyTagBegin() {
850 $bodyContent = 'body '.trim($this->bodyTagAdditions.($this->bodyTagId ? ' id="'.$this->bodyTagId.'"' : ''));
851 return '<'.trim($bodyContent).'>';
852 }
853
854 /**
855 * Outputting document style
856 *
857 * @return string HTML style section/link tags
858 */
859 function docStyle() {
860
861 // Request background image:
862 if ($this->backGroundImage) {
863 $this->inDocStylesArray[]=' BODY { background-image: url('.$this->backPath.$this->backGroundImage.'); }';
864 }
865
866 // Add inDoc styles variables as well:
867 $this->inDocStylesArray[] = $this->inDocStyles;
868 $this->inDocStylesArray[] = $this->inDocStyles_TBEstyle;
869
870 // Implode it all:
871 $inDocStyles = implode('
872 ',$this->inDocStylesArray);
873
874 // The default color scheme should also in full be represented in the stylesheet.
875 $style=trim('
876 '.($this->styleSheetFile?'<link rel="stylesheet" type="text/css" href="'.$this->backPath.$this->styleSheetFile.'" />':'').'
877 '.($this->styleSheetFile2?'<link rel="stylesheet" type="text/css" href="'.$this->backPath.$this->styleSheetFile2.'" />':'').'
878 '.(trim($inDocStyles) ? '
879 <style type="text/css" id="internalStyle">
880 /*<![CDATA[*/
881 '.trim($inDocStyles).'
882 /*]]>*/
883 </style>' : '').'
884 '.($this->styleSheetFile_post?'<link rel="stylesheet" type="text/css" href="'.$this->backPath.$this->styleSheetFile_post.'" />':'')
885 )
886 ;
887 $this->inDocStyles='';
888 $this->inDocStylesArray=array();
889
890 return '
891 '.$style;
892 }
893
894 /**
895 * Insert post rendering document style into already rendered content
896 *
897 * @param string style-content to insert.
898 * @return string content with inserted styles
899 */
900 function insertStylesAndJS($content) {
901 // insert accumulated CSS
902 $this->inDocStylesArray[] = $this->inDocStyles;
903 $styles = "\n".implode("\n", $this->inDocStylesArray);
904 $content = str_replace('/*###POSTCSSMARKER###*/',$styles,$content);
905
906 // insert accumulated JS
907 $jscode = $this->JScode."\n".$this->wrapScriptTags(implode("\n", $this->JScodeArray));
908 $content = str_replace('<!--###POSTJSMARKER###-->',$jscode,$content);
909
910 return $content;
911 }
912
913 /**
914 * Initialize the charset.
915 * Sets the internal $this->charset variable to the charset defined in $GLOBALS["LANG"] (or the default as set in this class)
916 * Returns the meta-tag for the document header
917 *
918 * @return string <meta> tag with charset from $this->charset or $GLOBALS['LANG']->charSet
919 */
920 function initCharset() {
921 // Set charset to the charset provided by the current backend users language selection:
922 $this->charset = $GLOBALS['LANG']->charSet ? $GLOBALS['LANG']->charSet : $this->charset;
923 // Return meta tag:
924 return '<meta http-equiv="Content-Type" content="text/html; charset='.$this->charset.'" />';
925 }
926
927 /**
928 * Returns generator meta tag
929 *
930 * @return string <meta> tag with name "GENERATOR"
931 */
932 function generator() {
933 $str = 'TYPO3 '.$GLOBALS['TYPO_VERSION'].', http://typo3.com, &#169; Kasper Sk&#229;rh&#248;j 1998-2003, extensions are copyright of their respective owners.';
934 return '<meta name="GENERATOR" content="'.$str .'" />';
935 }
936
937
938
939
940
941
942
943
944 /*****************************************
945 *
946 * OTHER ELEMENTS
947 * Tables, buttons, formatting dimmed/red strings
948 *
949 ******************************************/
950
951
952 /**
953 * Returns an image-tag with an 18x16 icon of the following types:
954 *
955 * $type:
956 * -1: OK icon (Check-mark)
957 * 1: Notice (Speach-bubble)
958 * 2: Warning (Yellow triangle)
959 * 3: Fatal error (Red stop sign)
960 *
961 * @param integer See description
962 * @return string HTML image tag (if applicable)
963 */
964 function icons($type) {
965 switch($type) {
966 case '3':
967 $icon = 'gfx/icon_fatalerror.gif';
968 break;
969 case '2':
970 $icon = 'gfx/icon_warning.gif';
971 break;
972 case '1':
973 $icon = 'gfx/icon_note.gif';
974 break;
975 case '-1':
976 $icon = 'gfx/icon_ok.gif';
977 break;
978 default:
979 break;
980 }
981 if ($icon) {
982 return '<img'.t3lib_iconWorks::skinImg($this->backPath,$icon,'width="18" height="16"').' class="absmiddle" alt="" />';
983 }
984 }
985
986 /**
987 * Returns an <input> button with the $onClick action and $label
988 *
989 * @param string The value of the onclick attribute of the input tag (submit type)
990 * @param string The label for the button (which will be htmlspecialchar'ed)
991 * @return string A <input> tag of the type "submit"
992 */
993 function t3Button($onClick,$label) {
994 $button = '<input type="submit" onclick="'.htmlspecialchars($onClick).'; return false;" value="'.htmlspecialchars($label).'" />';
995 return $button;
996 }
997
998 /**
999 * dimmed-fontwrap. Returns the string wrapped in a <span>-tag defining the color to be gray/dimmed
1000 *
1001 * @param string Input string
1002 * @return string Output string
1003 */
1004 function dfw($string) {
1005 return '<span class="typo3-dimmed">'.$string.'</span>';
1006 }
1007
1008 /**
1009 * red-fontwrap. Returns the string wrapped in a <span>-tag defining the color to be red
1010 *
1011 * @param string Input string
1012 * @return string Output string
1013 */
1014 function rfw($string) {
1015 return '<span class="typo3-red">'.$string.'</span>';
1016 }
1017
1018 /**
1019 * Returns string wrapped in CDATA "tags" for XML / XHTML (wrap content of <script> and <style> sections in those!)
1020 *
1021 * @param string Input string
1022 * @return string Output string
1023 */
1024 function wrapInCData($string) {
1025 $string = '/*<![CDATA[*/'.
1026 $string.
1027 '/*]]>*/';
1028
1029 return $string;
1030 }
1031
1032 /**
1033 * Wraps the input string in script tags.
1034 * Automatic re-identing of the JS code is done by using the first line as ident reference.
1035 * This is nice for identing JS code with PHP code on the same level.
1036 *
1037 * @param string Input string
1038 * @param boolean Wrap script element in linebreaks? Default is TRUE.
1039 * @return string Output string
1040 */
1041 function wrapScriptTags($string, $linebreak=TRUE) {
1042 if(trim($string)) {
1043 // <script wrapped in nl?
1044 $cr = $linebreak? "\n" : '';
1045
1046 // remove nl from the beginning
1047 $string = preg_replace ('/^\n+/', '', $string);
1048 // re-ident to one tab using the first line as reference
1049 if(preg_match('/^(\t+)/',$string,$match)) {
1050 $string = str_replace($match[1],"\t", $string);
1051 }
1052 $string = $cr.'<script type="text/javascript">
1053 /*<![CDATA[*/
1054 '.$string.'
1055 /*]]>*/
1056 </script>'.$cr;
1057 }
1058 return trim($string);
1059 }
1060
1061 // These vars defines the layout for the table produced by the table() function.
1062 // You can override these values from outside if you like.
1063 var $tableLayout = Array (
1064 'defRow' => Array (
1065 'defCol' => Array('<td valign="top">','</td>')
1066 )
1067 );
1068 var $table_TR = '<tr>';
1069 var $table_TABLE = '<table border="0" cellspacing="0" cellpadding="0" id="typo3-tmpltable">';
1070
1071 /**
1072 * Returns a table based on the input $arr
1073 *
1074 * @param array Multidim array with first levels = rows, second levels = cells
1075 * @return string The HTML table.
1076 * @internal
1077 */
1078 function table($arr) {
1079 if (is_array($arr)) {
1080 reset($arr);
1081 $code='';
1082 $rc=0;
1083 while(list(,$val)=each($arr)) {
1084 if ($rc % 2) {
1085 $layout = is_array($this->tableLayout['defRowOdd']) ? $this->tableLayout['defRowOdd'] : $this->tableLayout['defRow'];
1086 } else {
1087 $layout = is_array($this->tableLayout['defRowEven']) ? $this->tableLayout['defRowEven'] : $this->tableLayout['defRow'];
1088 }
1089 $layout = is_array($this->tableLayout[$rc]) ? $this->tableLayout[$rc] : $layout;
1090 $code_td='';
1091 if (is_array($val)) {
1092 $cc=0;
1093 while(list(,$content)=each($val)) {
1094 $wrap= is_array($layout[$cc]) ? $layout[$cc] : $layout['defCol'];
1095 $code_td.=$wrap[0].$content.$wrap[1];
1096 $cc++;
1097 }
1098 }
1099 $trWrap = is_array($layout['tr']) ? $layout['tr'] : array($this->table_TR, '</tr>');
1100 $code.=$trWrap[0].$code_td.$trWrap[1];
1101 $rc++;
1102 }
1103 $tableWrap = is_array($this->tableLayout['table']) ? $this->tableLayout['table'] : array($this->table_TABLE, '</table>');
1104 $code=$tableWrap[0].$code.$tableWrap[1];
1105 }
1106 return $code;
1107 }
1108
1109 /**
1110 * Constructs a table with content from the $arr1, $arr2 and $arr3.
1111 * Used in eg. ext/belog/mod/index.php - refer to that for examples
1112 *
1113 * @param array Menu elements on first level
1114 * @param array Secondary items
1115 * @param array Third-level items
1116 * @return string HTML content, <table>...</table>
1117 */
1118 function menuTable($arr1,$arr2=array(), $arr3=array()) {
1119 $rows = max(array(count($arr1),count($arr2),count($arr3)));
1120
1121 $menu='
1122 <table border="0" cellpadding="0" cellspacing="0" id="typo3-tablemenu">';
1123 for($a=0;$a<$rows;$a++) {
1124 $menu.='<tr>';
1125 $cls=array();
1126 $valign='middle';
1127 $cls[]='<td valign="'.$valign.'">'.$arr1[$a][0].'</td><td>'.$arr1[$a][1].'</td>';
1128 if (count($arr2)) {
1129 $cls[]='<td valign="'.$valign.'">'.$arr2[$a][0].'</td><td>'.$arr2[$a][1].'</td>';
1130 if (count($arr3)) {
1131 $cls[]='<td valign="'.$valign.'">'.$arr3[$a][0].'</td><td>'.$arr3[$a][1].'</td>';
1132 }
1133 }
1134 $menu.=implode($cls,'<td>&nbsp;&nbsp;</td>');
1135 $menu.='</tr>';
1136 }
1137 $menu.='
1138 </table>
1139 ';
1140 return $menu;
1141 }
1142
1143 /**
1144 * Returns a one-row/two-celled table with $content and $menu side by side.
1145 * The table is a 100% width table and each cell is aligned left / right
1146 *
1147 * @param string Content cell content (left)
1148 * @param string Menu cell content (right)
1149 * @return string HTML output
1150 */
1151 function funcMenu($content,$menu) {
1152 return '
1153 <table border="0" cellpadding="0" cellspacing="0" width="100%" id="typo3-funcmenu">
1154 <tr>
1155 <td valign="top" nowrap="nowrap">'.$content.'</td>
1156 <td valign="top" align="right" nowrap="nowrap">'.$menu.'</td>
1157 </tr>
1158 </table>';
1159 }
1160
1161 /**
1162 * Creates a selector box with clear-cache items.
1163 * Rather specialized functions - at least don't use it with $addSaveOptions unless you know what you do...
1164 *
1165 * @param integer The page uid of the "current page" - the one that will be cleared as "clear cache for this page".
1166 * @param boolean If $addSaveOptions is set, then also the array of save-options for TCE_FORMS will appear.
1167 * @return string <select> tag with content - a selector box for clearing the cache
1168 */
1169 function clearCacheMenu($id,$addSaveOptions=0) {
1170 global $BE_USER;
1171 $opt=$addOptions;
1172 if ($addSaveOptions) {
1173 $opt[]='<option value="">'.$GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:rm.menu',1).'</option>';
1174 $opt[]='<option value="TBE_EDITOR_checkAndDoSubmit(1);">'.$GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:rm.saveDoc',1).'</option>';
1175 $opt[]='<option value="document.editform.closeDoc.value=-2; TBE_EDITOR_checkAndDoSubmit(1);">'.$GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:rm.saveCloseDoc',1).'</option>';
1176 if ($BE_USER->uc['allSaveFunctions']) $opt[]='<option value="document.editform.closeDoc.value=-3; TBE_EDITOR_checkAndDoSubmit(1);">'.$GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:rm.saveCloseAllDocs',1).'</option>';
1177 $opt[]='<option value="document.editform.closeDoc.value=2; document.editform.submit();">'.$GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:rm.closeDoc',1).'</option>';
1178 $opt[]='<option value="document.editform.closeDoc.value=3; document.editform.submit();">'.$GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:rm.closeAllDocs',1).'</option>';
1179 $opt[]='<option value=""></option>';
1180 }
1181 $opt[]='<option value="">[ '.$GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:rm.clearCache_clearCache',1).' ]</option>';
1182 if ($id) $opt[]='<option value="'.$id.'">'.$GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:rm.clearCache_thisPage',1).'</option>';
1183 if ($BE_USER->isAdmin() || $BE_USER->getTSConfigVal('options.clearCache.pages')) $opt[]='<option value="pages">'.$GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:rm.clearCache_pages',1).'</option>';
1184 if ($BE_USER->isAdmin() || $BE_USER->getTSConfigVal('options.clearCache.all')) $opt[]='<option value="all">'.$GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:rm.clearCache_all',1).'</option>';
1185
1186 $onChange = 'if (!this.options[this.selectedIndex].value) {
1187 this.selectedIndex=0;
1188 } else if (this.options[this.selectedIndex].value.indexOf(\';\')!=-1) {
1189 eval(this.options[this.selectedIndex].value);
1190 }else{
1191 document.location=\''.$this->backPath.'tce_db.php?vC='.$BE_USER->veriCode().'&redirect='.rawurlencode(t3lib_div::getIndpEnv('REQUEST_URI')).'&cacheCmd=\'+this.options[this.selectedIndex].value;
1192 }';
1193 $af_content = '<select name="cacheCmd" onchange="'.htmlspecialchars($onChange).'">'.implode('',$opt).'</select>';
1194
1195 if (count($opt)>2) {
1196 return $af_content;
1197 }
1198 }
1199
1200 /**
1201 * Returns an array with parts (JavaScript, init-functions, <div>-layers) for use on pages which displays the clickmenu layers (context sensitive menus)
1202 *
1203 * @return array If values are present: [0] = A <script> section for the HTML page header, [1] = onmousemove/onload handler for HTML tag or alike, [2] = Two empty <div> layers for the context menu
1204 */
1205 function getContextMenuCode() {
1206 if ($this->isCMlayers()) {
1207 $content='
1208 <script type="text/javascript">
1209 /*<![CDATA[*/
1210 var GLV_gap=10;
1211 var GLV_curLayerX=new Array(0,0);
1212 var GLV_curLayerY=new Array(0,0);
1213 var GLV_curLayerWidth=new Array(0,0);
1214 var GLV_curLayerHeight=new Array(0,0);
1215 var GLV_isVisible=new Array(0,0);
1216 var GLV_x=0;
1217 var GLV_y=0;
1218 var GLV_xRel=0;
1219 var GLV_yRel=0;
1220 var layerObj=new Array();
1221 var layerObjCss=new Array();
1222
1223 //browsercheck...
1224 function GL_checkBrowser(){ //
1225 this.dom= (document.getElementById);
1226 this.op= (navigator.userAgent.indexOf("Opera")>-1);
1227 this.op7= this.op && (navigator.appVersion.indexOf("7")>-1); // check for Opera version 7
1228 this.konq= (navigator.userAgent.indexOf("Konq")>-1);
1229 this.ie4= (document.all && !this.dom && !this.op && !this.konq);
1230 this.ie5= (document.all && this.dom && !this.op && !this.konq);
1231 this.ns4= (document.layers && !this.dom && !this.konq);
1232 this.ns5= (!document.all && this.dom && !this.op && !this.konq);
1233 this.ns6= (this.ns5);
1234 this.bw= (this.ie4 || this.ie5 || this.ns4 || this.ns6 || this.op || this.konq);
1235 return this;
1236 }
1237 bw= new GL_checkBrowser();
1238
1239 // GL_getObj(obj)
1240 function GL_getObj(obj){ //
1241 nest="";
1242 this.el= (bw.ie4||bw.op7)?document.all[obj]:bw.ns4?eval(nest+"document."+obj):document.getElementById(obj);
1243 this.css= bw.ns4?this.el:this.el.style;
1244 this.ref= bw.ns4?this.el.document:document;
1245 this.x= (bw.ns4||bw.op)?this.css.left:this.el.offsetLeft;
1246 this.y= (bw.ns4||bw.op)?this.css.top:this.el.offsetTop;
1247 this.height= (bw.ie4||bw.ie5||bw.ns6||this.konq||bw.op7)?this.el.offsetHeight:bw.ns4?this.ref.height:bw.op?this.css.pixelHeight:0;
1248 this.width= (bw.ie4||bw.ie5||bw.ns6||this.konq||bw.op7)?this.el.offsetWidth:bw.ns4?this.ref.width:bw.op?this.css.pixelWidth:0;
1249 return this;
1250 }
1251 // GL_getObjCss(obj)
1252 function GL_getObjCss(obj){ //
1253 return bw.dom? document.getElementById(obj).style:bw.ie4?document.all[obj].style:bw.ns4?document.layers[obj]:0;
1254 }
1255 // GL_getMouse(event)
1256 function GL_getMouse(event) { //
1257 if (layerObj) {
1258 // GLV_x= (bw.ns4||bw.ns5)?event.pageX:(bw.ie4||bw.op)?event.clientX:(event.clientX-2)+document.body.scrollLeft;
1259 // GLV_y= (bw.ns4||bw.ns5)?event.pageY:(bw.ie4||bw.op)?event.clientY:(event.clientY-2)+document.body.scrollTop;
1260 // 17/12 2003: When documents run in XHTML standard compliance mode, the old scrollLeft/Top properties of document.body is gone - and for Opera/MSIE we have to use document.documentElement:
1261
1262 GLV_xRel = event.clientX-2;
1263 GLV_yRel = event.clientY-2;
1264 GLV_x = GLV_xRel + (document.documentElement.scrollLeft ? document.documentElement.scrollLeft : document.body.scrollLeft);
1265 GLV_y = GLV_yRel + (document.documentElement.scrollTop ? document.documentElement.scrollTop : document.body.scrollTop);
1266
1267 // status = (GLV_x+GLV_gap-GLV_curLayerX[0]) + " | " + (GLV_y+GLV_gap-GLV_curLayerY[0]);
1268 if (GLV_isVisible[1]) {
1269 if (outsideLayer(1)) hideSpecific(1);
1270 } else if (GLV_isVisible[0]) {
1271 if (outsideLayer(0)) hideSpecific(0);
1272 }
1273 }
1274 }
1275 // outsideLayer(level)
1276 function outsideLayer(level) { //
1277 return GLV_x+GLV_gap-GLV_curLayerX[level] <0 ||
1278 GLV_y+GLV_gap-GLV_curLayerY[level] <0 ||
1279 GLV_curLayerX[level]+GLV_curLayerWidth[level]+GLV_gap-GLV_x <0 ||
1280 GLV_curLayerY[level]+GLV_curLayerHeight[level]+GLV_gap-GLV_y <0;
1281 }
1282 // setLayerObj(html,level)
1283 function setLayerObj(html,level) { //
1284 var tempLayerObj = GL_getObj("contentMenu"+level);
1285 var tempLayerObjCss = GL_getObjCss("contentMenu"+level);
1286
1287 if (tempLayerObj && (level==0 || GLV_isVisible[level-1])) {
1288 tempLayerObj.el.innerHTML = html;
1289 tempLayerObj.width= (bw.ie4||bw.ie5||bw.ns6||bw.konq||bw.op7)?this.el.offsetWidth:bw.ns4?this.ref.width:bw.op?this.css.pixelWidth:0;
1290 tempLayerObj.height= (bw.ie4||bw.ie5||bw.ns6||bw.konq||bw.op7)?this.el.offsetHeight:bw.ns4?this.ref.height:bw.op?this.css.pixelHeight:0;
1291
1292 // Adjusting the Y-height of the layer to fit it into the window frame if it goes under the window frame in the bottom:
1293 tempLayerObj.winHeight = document.documentElement.clientHeight && !bw.op7 ? document.documentElement.clientHeight : document.body.clientHeight;
1294 if (tempLayerObj.winHeight-tempLayerObj.height < GLV_yRel) {
1295 if (GLV_yRel < tempLayerObj.height) {
1296 GLV_y+= (tempLayerObj.winHeight-tempLayerObj.height-GLV_yRel); // Setting it so bottom is just above window height.
1297 } else {
1298 GLV_y-= tempLayerObj.height-8; // Showing the menu upwards
1299 }
1300 }
1301
1302 GLV_curLayerX[level] = GLV_x;
1303 GLV_curLayerY[level] = GLV_y;
1304 tempLayerObjCss.left = GLV_x+"px";
1305 tempLayerObjCss.top = GLV_y+"px";
1306 tempLayerObjCss.visibility = "visible";
1307 if (bw.ie5) showHideSelectorBoxes("hidden");
1308
1309 GLV_isVisible[level]=1;
1310 GLV_curLayerWidth[level] = tempLayerObj.width;
1311 GLV_curLayerHeight[level] = tempLayerObj.height;
1312 }
1313 }
1314 // hideEmpty()
1315 function hideEmpty() { //
1316 hideSpecific(0);
1317 hideSpecific(1);
1318 return false;
1319 }
1320 // hideSpecific(level)
1321 function hideSpecific(level) { //
1322 GL_getObjCss("contentMenu"+level).visibility = "hidden";
1323 GL_getObj("contentMenu"+level).el.innerHTML = "";
1324 GLV_isVisible[level]=0;
1325
1326 if (bw.ie5 && level==0) showHideSelectorBoxes("visible");
1327 }
1328 // debugObj(obj,name)
1329 function debugObj(obj,name) { //
1330 var acc;
1331 for (i in obj) {if (obj[i]) {acc+=i+": "+obj[i]+"\n";}}
1332 alert("Object: "+name+"\n\n"+acc);
1333 }
1334 // initLayer()
1335 function initLayer(){ //
1336 if (document.all) {
1337 window.onmousemove=GL_getMouse;
1338 }
1339 layerObj = GL_getObj("contentMenu1");
1340 layerObjCss = GL_getObjCss("contentMenu1");
1341 }
1342 function showHideSelectorBoxes(action) { // This function by Michiel van Leening
1343 for (i=0;i<document.forms.length;i++) {
1344 for (j=0;j<document.forms[i].elements.length;j++) {
1345 if(document.forms[i].elements[j].type=="select-one") {
1346 document.forms[i].elements[j].style.visibility=action;
1347 }
1348 }
1349 }
1350 }
1351 /*]]>*/
1352 </script>
1353 ';
1354 return array(
1355 $content,
1356 ' onmousemove="GL_getMouse(event);" onload="initLayer();"',
1357 '<div id="contentMenu0" style="z-index:1; position:absolute;visibility:hidden"></div><div id="contentMenu1" style="z-index:2; position:absolute;visibility:hidden"></div>'
1358 );
1359 } else return array('','','');
1360 }
1361
1362
1363
1364
1365 /**
1366 * creates a tab menu from an array definition
1367 *
1368 * Returns a tab menu for a module
1369 * Requires the JS function jumpToUrl() to be available
1370 *
1371 * @param string $id is the "&id=" parameter value to be sent to the module
1372 * @param string $elementName it the form elements name, probably something like "SET[...]"
1373 * @param string $currentValue is the value to be selected currently.
1374 * @param array $menuItems is an array with the menu items for the selector box
1375 * @param string $script is the script to send the &id to, if empty it's automatically found
1376 * @param string $addParams is additional parameters to pass to the script.
1377 * @return string HTML code for tab menu
1378 * @todo Update the HTML code to use the stylesheet.css instead.
1379 * @author René Fritz <r.fritz@colorcube.de>
1380 */
1381 function getTabMenu($id,$elementName,$currentValue,$menuItems,$script='',$addparams='') {
1382 $content='';
1383
1384 if (is_array($menuItems)) {
1385 if (!$script) {$script=basename(PATH_thisScript);}
1386 $options='';
1387
1388 $count = count($menuItems);
1389 $widthLeft = 1;
1390 $addToAct = 5;
1391
1392 $widthRight = max (1,floor(30-pow($count,1.72)));
1393 $widthTabs = 100 - $widthRight - $widthLeft;
1394 $widthNo = floor(($widthTabs - $addToAct)/$count);
1395 $addToAct = max ($addToAct,$widthTabs-($widthNo*$count));
1396 $widthAct = $widthNo + $addToAct;
1397 $widthRight = 100 - ($widthLeft + ($count*$widthNo) + $addToAct);
1398
1399 $first=true;
1400 foreach($menuItems as $value => $label) {
1401 $isActive = !strcmp($currentValue,$value);
1402 $class = $isActive ? "tabact" : "tab";
1403 $width = $isActive ? $widthAct : $widthNo;
1404
1405 $label = t3lib_div::deHSCentities(htmlspecialchars($label));
1406 $link = htmlspecialchars($script.'?id='.rawurlencode($id).$addparams.'&'.$elementName.'='.$value);
1407 if($first) {
1408 $options.= '
1409 <td width="'.$width.'%" class="'.$class.'" style="border-left: solid #000 1px;"><a href="'.$link.'" class="'.$class.'" style="padding-left:5px;padding-right:2px;">'.$label.'</a></td>';
1410 } else {
1411 $options.='
1412 <td width="'.$width.'%" class="'.$class.'"><a href="'.$link.'" class="'.$class.'">'.$label.'</a></td>';
1413 }
1414 $first=false;
1415 }
1416
1417 if ($options) {
1418 $content .= '
1419 <!-- Tab menu -->
1420 <table cellpadding="0" cellspacing="0" border="0" width="100%" id="typo3-tabmenu">
1421 <tr>
1422 <td width="'.$widthLeft.'%">&nbsp;</td>
1423 '.$options.'
1424 <td width="'.$widthRight.'%">&nbsp;</td>
1425 </tr>
1426 </table>
1427 <div class="hr" style="display:block;margin:0px;padding:0px;"></div>';
1428 }
1429
1430 // include CSS
1431 $actBgColor = t3lib_div::modifyHTMLcolorAll($this->bgColor6,0);
1432 $lgBgColor = t3lib_div::modifyHTMLcolorAll($this->bgColor5,25);
1433 $hoverBgColor = t3lib_div::modifyHTMLcolorAll($this->bgColor6,15);
1434
1435 $this->inDocStylesArray['getTabMenu'] = '
1436 td.tabact {
1437 border: solid black 1px;
1438 background: '.$actBgColor.';
1439 color:#000;
1440 }
1441 td.tabact>a {
1442 color:#000;
1443 }
1444 td.tab {
1445 border: solid #555 1px;
1446 border-left: solid #aaa 3px;
1447 background: '.$lgBgColor.';
1448 color:grey;
1449 }
1450 td.tab, td.tabact {
1451 border-bottom: none;
1452 border-radius: 3px;
1453 -moz-border-radius: 3px;
1454 }
1455 a.tab, a.tabact {
1456 color:grey;
1457 text-decoration:none;
1458 display: block;
1459 width:auto;
1460 padding:2px;
1461 padding-left:3px;
1462 padding-right:5px;
1463 }
1464 a.tabact {
1465 padding-left:10px;
1466 padding-right:10px;
1467 }
1468 a.tab:hover,a.tabact:hover {
1469 color:black;
1470 background: '.$hoverBgColor.';
1471 text-decoration:none;
1472 cursor: pointer;
1473 }';
1474 }
1475 return $content;
1476 }
1477 }
1478
1479
1480
1481 // ******************************
1482 // Extension classes of the template class.
1483 // These are meant to provide backend screens with different widths.
1484 // They still do because of the different class-prefixes used for the <div>-sections
1485 // but obviously the final width is determined by the stylesheet used.
1486 // ******************************
1487
1488 /**
1489 * Extension class for "template" - used for backend pages which are wide. Typically modules taking up all the space in the "content" frame of the backend
1490 * The class were more significant in the past than today.
1491 *
1492 */
1493 class bigDoc extends template {
1494 var $divClass = 'typo3-bigDoc';
1495 }
1496
1497 /**
1498 * Extension class for "template" - used for backend pages without the "document" background image
1499 * The class were more significant in the past than today.
1500 *
1501 */
1502 class noDoc extends template {
1503 var $divClass = 'typo3-noDoc';
1504 }
1505
1506 /**
1507 * Extension class for "template" - used for backend pages which were narrow (like the Web>List modules list frame. Or the "Show details" pop up box)
1508 * The class were more significant in the past than today.
1509 *
1510 */
1511 class smallDoc extends template {
1512 var $divClass = 'typo3-smallDoc';
1513 }
1514
1515 /**
1516 * Extension class for "template" - used for backend pages which were medium wide. Typically submodules to Web or File which were presented in the list-frame when the content frame were divided into a navigation and list frame.
1517 * The class were more significant in the past than today. But probably you should use this one for most modules you make.
1518 *
1519 */
1520 class mediumDoc extends template {
1521 var $divClass = 'typo3-mediumDoc';
1522 }
1523
1524
1525
1526 // Include extension to the template class?
1527 if (defined('TYPO3_MODE') && $TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['typo3/template.php']) {
1528 include_once($TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['typo3/template.php']);
1529 }
1530
1531
1532
1533 // ******************************************************
1534 // The backend language engine is started (ext: "lang")
1535 // ******************************************************
1536 require_once(PATH_typo3.'sysext/lang/lang.php');
1537 $LANG = t3lib_div::makeInstance('language');
1538 $LANG->init($BE_USER->uc['lang']);
1539
1540
1541
1542 // ******************************
1543 // The template is loaded
1544 // ******************************
1545 $TBE_TEMPLATE = t3lib_div::makeInstance('template');
1546 ?>