Only changes to function indexes, comments and stripping of trailing whitespace in...
[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 * 284: function wrapClickMenuOnIcon($str,$table,$uid='',$listFr=1,$addParams='')
47 * 301: function viewPageIcon($id,$backPath,$addParams='hspace="3"')
48 * 326: function issueCommand($params,$rUrl='')
49 * 341: function isCMlayers()
50 * 351: function thisBlur()
51 * 361: function helpStyle()
52 * 378: function getHeader($table,$row,$path,$noViewPageIcon=0,$tWrap=array('',''))
53 * 404: function getFileheader($title,$path,$iconfile)
54 * 419: function makeShortcutIcon($gvList,$setList,$modName,$motherModName="")
55 * 452: function makeShortcutUrl($gvList,$setList)
56 * 473: function formWidth($size=48,$textarea=0,$styleOverride='')
57 * 498: function formWidthText($size=48,$styleOverride='',$wrap='')
58 * 515: function redirectUrls($thisLocation='')
59 * 539: function formatTime($tstamp,$type)
60 * 552: function parseTime()
61 *
62 * SECTION: PAGE BUILDING FUNCTIONS.
63 * 585: function startPage($title)
64 * 660: function endPage()
65 * 689: function header($text)
66 * 710: function section($label,$text,$nostrtoupper=FALSE,$sH=FALSE,$type=0,$allowHTMLinHeader=FALSE)
67 * 734: function divider($dist)
68 * 750: function spacer($dist)
69 * 769: function sectionHeader($label,$sH=FALSE,$addAttrib='')
70 * 786: function sectionBegin()
71 * 807: function sectionEnd()
72 * 827: function middle()
73 * 836: function endPageJS()
74 * 853: function docBodyTagBegin()
75 * 863: function docStyle()
76 * 904: function insertStylesAndJS($content)
77 * 924: function initCharset()
78 * 936: function generator()
79 *
80 * SECTION: OTHER ELEMENTS
81 * 968: function icons($type)
82 * 997: function t3Button($onClick,$label)
83 * 1008: function dfw($string)
84 * 1018: function rfw($string)
85 * 1028: function wrapInCData($string)
86 * 1045: function wrapScriptTags($string, $linebreak=TRUE)
87 * 1082: function table($arr)
88 * 1122: function menuTable($arr1,$arr2=array(), $arr3=array())
89 * 1155: function funcMenu($content,$menu)
90 * 1173: function clearCacheMenu($id,$addSaveOptions=0)
91 * 1209: function getContextMenuCode()
92 * 1385: function getTabMenu($id,$elementName,$currentValue,$menuItems,$script='',$addparams='')
93 *
94 *
95 * 1497: class bigDoc extends template
96 *
97 *
98 * 1506: class noDoc extends template
99 *
100 *
101 * 1515: class smallDoc extends template
102 *
103 *
104 * 1524: 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 associative 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 4. 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 * @param string Additional GET parameters for the link to alt_clickmenu.php
282 * @return string The link-wrapped input string.
283 */
284 function wrapClickMenuOnIcon($str,$table,$uid='',$listFr=1,$addParams='') {
285 $backPath = '&backPath='.rawurlencode($this->backPath).'|'.t3lib_div::shortMD5($this->backPath.'|'.$GLOBALS['TYPO3_CONF_VARS']['SYS']['encryptionKey']);
286 $onClick = 'top.loadTopMenu(\''.$this->backPath.'alt_clickmenu.php?item='.rawurlencode($table.'|'.$uid.'|'.$listFr).$backPath.$addParams.'\');'.$this->thisBlur().'return false;';
287 return '<a href="#" onclick="'.htmlspecialchars($onClick).'">'.$str.'</a>';
288 }
289
290 /**
291 * Makes link to page $id in frontend (view page)
292 * Returns an magnifier-glass icon which links to the frontend index.php document for viewing the page with id $id
293 * $id must be a page-uid
294 * If the BE_USER has access to Web>List then a link to that module is shown as well (with return-url)
295 *
296 * @param integer The page id
297 * @param string The current "BACK_PATH" (the back relative to the typo3/ directory)
298 * @param string Additional parameters for the image tag(s)
299 * @return string HTML string with linked icon(s)
300 */
301 function viewPageIcon($id,$backPath,$addParams='hspace="3"') {
302 global $BE_USER;
303 $str = '';
304 // If access to Web>List for user, then link to that module.
305 if ($BE_USER->check('modules','web_list')) {
306 $href=$backPath.'db_list.php?id='.$id.'&returnUrl='.rawurlencode(t3lib_div::getIndpEnv('REQUEST_URI'));
307 $str.= '<a href="'.htmlspecialchars($href).'">'.
308 '<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="" />'.
309 '</a>';
310 }
311 // Make link to view page
312 $str.= '<a href="#" onclick="'.htmlspecialchars(t3lib_BEfunc::viewOnClick($id,$backPath,t3lib_BEfunc::BEgetRootLine($id))).'">'.
313 '<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="" />'.
314 '</a>';
315 return $str;
316 }
317
318 /**
319 * Returns a URL with a command to TYPO3 Core Engine (tce_db.php)
320 * See description of the API elsewhere.
321 *
322 * @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"
323 * @param string Redirect URL if any other that t3lib_div::getIndpEnv('REQUEST_URI') is wished
324 * @return string URL to tce_db.php + parameters (backpath is taken from $this->backPath)
325 */
326 function issueCommand($params,$rUrl='') {
327 $rUrl = $rUrl ? $rUrl : t3lib_div::getIndpEnv('REQUEST_URI');
328 return $this->backPath.'tce_db.php?'.
329 $params.
330 '&redirect='.($rUrl==-1?"'+T3_THIS_LOCATION+'":rawurlencode($rUrl)).
331 '&vC='.rawurlencode($GLOBALS['BE_USER']->veriCode()).
332 '&prErr=1&uPT=1';
333 }
334
335 /**
336 * Returns true if click-menu layers can be displayed for the current user/browser
337 * Use this to test if click-menus (context sensitive menus) can and should be displayed in the backend.
338 *
339 * @return boolean
340 */
341 function isCMlayers() {
342 return !$GLOBALS['BE_USER']->uc['disableCMlayers'] && $GLOBALS['CLIENT']['FORMSTYLE'] && $GLOBALS['CLIENT']['SYSTEM']!='mac';
343 }
344
345 /**
346 * Returns 'this.blur();' if the client supports CSS styles
347 * Use this in links to remove the underlining after being clicked
348 *
349 * @return string
350 */
351 function thisBlur() {
352 return ($GLOBALS['CLIENT']['FORMSTYLE']?'this.blur();':'');
353 }
354
355 /**
356 * Returns ' style='cursor:help;'' if the client supports CSS styles
357 * Use for <a>-links to help texts
358 *
359 * @return string
360 */
361 function helpStyle() {
362 return $GLOBALS['CLIENT']['FORMSTYLE'] ? ' style="cursor:help;"':'';
363 }
364
365 /**
366 * Makes the header (icon+title) for a page (or other record). Used in most modules under Web>*
367 * $table and $row must be a tablename/record from that table
368 * $path will be shown as alt-text for the icon.
369 * The title will be truncated to 45 chars.
370 *
371 * @param string Table name
372 * @param array Record row
373 * @param string Alt text
374 * @param boolean Set $noViewPageIcon true if you don't want a magnifier-icon for viewing the page in the frontend
375 * @param array $tWrap is an array with indexes 0 and 1 each representing HTML-tags (start/end) which will wrap the title
376 * @return string HTML content
377 */
378 function getHeader($table,$row,$path,$noViewPageIcon=0,$tWrap=array('','')) {
379 global $TCA;
380 if (is_array($row) && $row['uid']) {
381 $iconImgTag = t3lib_iconWorks::getIconImage($table,$row,$this->backPath,'title="'.htmlspecialchars($path).'"');
382 $title = strip_tags($row[$TCA[$table]['ctrl']['label']]);
383 $viewPage = $noViewPageIcon ? '' : $this->viewPageIcon($row['uid'],$this->backPath,'');
384 if ($table=='pages') $path.=' - '.t3lib_BEfunc::titleAttribForPages($row,'',0);
385 } else {
386 $iconImgTag='<img'.t3lib_iconWorks::skinImg($this->backPath,'gfx/i/_icon_website.gif',$wHattribs='width="18" height="16"').' title="'.htmlspecialchars($path).'" alt="" />';
387 $title=$GLOBALS['TYPO3_CONF_VARS']['SYS']['sitename'];
388 }
389
390 return '<span class="typo3-moduleHeader">'.$this->wrapClickMenuOnIcon($iconImgTag,$table,$row['uid']).
391 $viewPage.
392 $tWrap[0].htmlspecialchars(t3lib_div::fixed_lgd($title,45)).$tWrap[1].'</span>';
393 }
394
395 /**
396 * Like ->getHeader() but for files in the File>* main module/submodules
397 * Returns the file-icon with the path of the file set in the alt/title attribute. Shows the file-name after the icon.
398 *
399 * @param string Title string, expected to be the filepath
400 * @param string Alt text
401 * @param string The icon file (relative to TYPO3 dir)
402 * @return string HTML content
403 */
404 function getFileheader($title,$path,$iconfile) {
405 $fileInfo = t3lib_div::split_fileref($title);
406 $title = htmlspecialchars(t3lib_div::fixed_lgd_pre($fileInfo['path'],35)).'<b>'.htmlspecialchars($fileInfo['file']).'</b>';
407 return '<span class="typo3-moduleHeader"><img'.t3lib_iconWorks::skinImg($this->backPath,$iconfile,'width="18" height="16"').' title="'.htmlspecialchars($path).'" alt="" />'.$title.'</span>';
408 }
409
410 /**
411 * Returns a linked shortcut-icon which will call the shortcut frame and set a shortcut there back to the calling page/module
412 *
413 * @param string Is the list of GET variables to store (if any)
414 * @param string Is the list of SET[] variables to store (if any) - SET[] variables a stored in $GLOBALS["SOBE"]->MOD_SETTINGS for backend modules
415 * @param string Module name string
416 * @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.
417 * @return string HTML content
418 */
419 function makeShortcutIcon($gvList,$setList,$modName,$motherModName="") {
420 $backPath=$this->backPath;
421 $storeUrl=$this->makeShortcutUrl($gvList,$setList);
422 $pathInfo = parse_url(t3lib_div::getIndpEnv('REQUEST_URI'));
423
424 if (!strcmp($motherModName,'1')) {
425 $mMN="&motherModName='+top.currentModuleLoaded+'";
426 } elseif ($motherModName) {
427 $mMN='&motherModName='.rawurlencode($motherModName);
428 } else $mMN="";
429
430 $onClick = 'if (top.shortcutFrame && confirm('.
431 $GLOBALS['LANG']->JScharCode($GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:labels.makeShortcut')).
432 ')){top.shortcutFrame.document.location=\''.$backPath.'alt_shortcut.php?modName='.rawurlencode($modName).
433 '&URL='.rawurlencode($pathInfo['path']."?".$storeUrl).
434 $mMN.
435 '\';}return false;';
436
437 $sIcon = '<a href="#" onclick="'.htmlspecialchars($onClick).'">
438 <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>';
439 return $sIcon;
440 }
441
442 /**
443 * MAKE url for storing
444 * Internal func
445 *
446 * @param string Is the list of GET variables to store (if any)
447 * @param string Is the list of SET[] variables to store (if any) - SET[] variables a stored in $GLOBALS["SOBE"]->MOD_SETTINGS for backend modules
448 * @return string
449 * @access private
450 * @see makeShortcutIcon()
451 */
452 function makeShortcutUrl($gvList,$setList) {
453 $GET = t3lib_div::_GET();
454 $storeArray = array_merge(
455 t3lib_div::compileSelectedGetVarsFromArray($gvList,$GET),
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::_GP('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
676 // Logging: Can't find better place to put it:
677 if (TYPO3_DLOG) t3lib_div::devLog('END of BACKEND session','',0,array('_FLUSH'=>TRUE));
678
679 return $str;
680 }
681
682 /**
683 * Returns the header-bar in the top of most backend modules
684 * Closes section if open.
685 *
686 * @param string The text string for the header
687 * @return string HTML content
688 */
689 function header($text) {
690 $str='
691
692 <!-- MAIN Header in page top -->
693 <h2>'.htmlspecialchars($text).'</h2>
694 ';
695 return $this->sectionEnd().$str;
696 }
697
698 /**
699 * Begins an output section and sets header and content
700 *
701 * @param string The header
702 * @param string The HTML-content
703 * @param boolean A flag that will prevent the header from being converted to uppercase
704 * @param boolean Defines the type of header (if set, "<h3>" rather than the default "h4")
705 * @param integer The number of an icon to show with the header (see the icon-function). -1,1,2,3
706 * @param boolean If set, HTML tags are allowed in $label (otherwise this value is by default htmlspecialchars()'ed)
707 * @return string HTML content
708 * @see icons(), sectionHeader()
709 */
710 function section($label,$text,$nostrtoupper=FALSE,$sH=FALSE,$type=0,$allowHTMLinHeader=FALSE) {
711 $str='';
712
713 // Setting header
714 if ($label) {
715 if (!$allowHTMLinHeader) $label = htmlspecialchars($label);
716 $str.=$this->sectionHeader($this->icons($type).$label, $sH, $nostrtoupper ? '' : ' class="uppercase"');
717 }
718 // Setting content
719 $str.='
720
721 <!-- Section content -->
722 '.$text;
723
724 return $this->sectionBegin().$str;
725 }
726
727 /**
728 * Inserts a divider image
729 * Ends a section (if open) before inserting the image
730 *
731 * @param integer The margin-top/-bottom of the <hr> ruler.
732 * @return string HTML content
733 */
734 function divider($dist) {
735 $dist = intval($dist);
736 $str='
737
738 <!-- DIVIDER -->
739 <hr style="margin-top: '.$dist.'px; margin-bottom: '.$dist.'px;" />
740 ';
741 return $this->sectionEnd().$str;
742 }
743
744 /**
745 * Returns a blank <div>-section with a height
746 *
747 * @param integer Padding-top for the div-section (should be margin-top but konquorer (3.1) don't like it :-(
748 * @return string HTML content
749 */
750 function spacer($dist) {
751 if ($dist>0) {
752 return '
753
754 <!-- Spacer element -->
755 <div style="padding-top: '.intval($dist).'px;"></div>
756 ';
757 }
758 }
759
760 /**
761 * Make a section header.
762 * Begins a section if not already open.
763 *
764 * @param string The label between the <h3> or <h4> tags. (Allows HTML)
765 * @param boolean If set, <h3> is used, otherwise <h4>
766 * @param string Additional attributes to h-tag, eg. ' class=""'
767 * @return string HTML content
768 */
769 function sectionHeader($label,$sH=FALSE,$addAttrib='') {
770 $tag = ($sH?'h3':'h4');
771 $str='
772
773 <!-- Section header -->
774 <'.$tag.$addAttrib.'>'.$label.'</'.$tag.'>
775 ';
776 return $this->sectionBegin().$str;
777 }
778
779 /**
780 * Begins an output section.
781 * Returns the <div>-begin tag AND sets the ->sectionFlag true (if the ->sectionFlag is not already set!)
782 * 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!
783 *
784 * @return string HTML content
785 */
786 function sectionBegin() {
787 if (!$this->sectionFlag) {
788 $this->sectionFlag=1;
789 $str='
790
791 <!-- ***********************
792 Begin output section.
793 *********************** -->
794 <div>
795 ';
796 return $str;
797 } else return '';
798 }
799
800 /**
801 * Ends and output section
802 * Returns the </div>-end tag AND clears the ->sectionFlag (but does so only IF the sectionFlag is set - that is a section is 'open')
803 * See sectionBegin() also.
804 *
805 * @return string HTML content
806 */
807 function sectionEnd() {
808 if ($this->sectionFlag) {
809 $this->sectionFlag=0;
810 return '
811 </div>
812 <!-- *********************
813 End output section.
814 ********************* -->
815 ';
816 } else return '';
817 }
818
819 /**
820 * Originally it printed a kind of divider.
821 * Depreciated. Just remove function calls to it or call the divider() function instead.
822 *
823 * @return void
824 * @internal
825 * @depreciated
826 */
827 function middle() {
828 }
829
830 /**
831 * If a form-tag is defined in ->form then and end-tag for that <form> element is outputted
832 * Further a JavaScript section is outputted which will update the top.busy session-expiry object (unless $this->endJS is set to false)
833 *
834 * @return string HTML content (<script> tag section)
835 */
836 function endPageJS() {
837 return ($this->endJS?'
838 <script type="text/javascript">
839 /*<![CDATA[*/
840 if (top.busy && top.busy.loginRefreshed) {
841 top.busy.loginRefreshed();
842 }
843 /*]]>*/
844 </script>':'');
845 }
846
847 /**
848 * Creates the bodyTag.
849 * You can add to the bodyTag by $this->bodyTagAdditions
850 *
851 * @return string HTML body tag
852 */
853 function docBodyTagBegin() {
854 $bodyContent = 'body '.trim($this->bodyTagAdditions.($this->bodyTagId ? ' id="'.$this->bodyTagId.'"' : ''));
855 return '<'.trim($bodyContent).'>';
856 }
857
858 /**
859 * Outputting document style
860 *
861 * @return string HTML style section/link tags
862 */
863 function docStyle() {
864
865 // Request background image:
866 if ($this->backGroundImage) {
867 $this->inDocStylesArray[]=' BODY { background-image: url('.$this->backPath.$this->backGroundImage.'); }';
868 }
869
870 // Add inDoc styles variables as well:
871 $this->inDocStylesArray[] = $this->inDocStyles;
872 $this->inDocStylesArray[] = $this->inDocStyles_TBEstyle;
873
874 // Implode it all:
875 $inDocStyles = implode('
876 ',$this->inDocStylesArray);
877
878 // The default color scheme should also in full be represented in the stylesheet.
879 $style=trim('
880 '.($this->styleSheetFile?'<link rel="stylesheet" type="text/css" href="'.$this->backPath.$this->styleSheetFile.'" />':'').'
881 '.($this->styleSheetFile2?'<link rel="stylesheet" type="text/css" href="'.$this->backPath.$this->styleSheetFile2.'" />':'').'
882 '.(trim($inDocStyles) ? '
883 <style type="text/css" id="internalStyle">
884 /*<![CDATA[*/
885 '.trim($inDocStyles).'
886 /*]]>*/
887 </style>' : '').'
888 '.($this->styleSheetFile_post?'<link rel="stylesheet" type="text/css" href="'.$this->backPath.$this->styleSheetFile_post.'" />':'')
889 )
890 ;
891 $this->inDocStyles='';
892 $this->inDocStylesArray=array();
893
894 return '
895 '.$style;
896 }
897
898 /**
899 * Insert post rendering document style into already rendered content
900 *
901 * @param string style-content to insert.
902 * @return string content with inserted styles
903 */
904 function insertStylesAndJS($content) {
905 // insert accumulated CSS
906 $this->inDocStylesArray[] = $this->inDocStyles;
907 $styles = "\n".implode("\n", $this->inDocStylesArray);
908 $content = str_replace('/*###POSTCSSMARKER###*/',$styles,$content);
909
910 // insert accumulated JS
911 $jscode = $this->JScode."\n".$this->wrapScriptTags(implode("\n", $this->JScodeArray));
912 $content = str_replace('<!--###POSTJSMARKER###-->',$jscode,$content);
913
914 return $content;
915 }
916
917 /**
918 * Initialize the charset.
919 * Sets the internal $this->charset variable to the charset defined in $GLOBALS["LANG"] (or the default as set in this class)
920 * Returns the meta-tag for the document header
921 *
922 * @return string <meta> tag with charset from $this->charset or $GLOBALS['LANG']->charSet
923 */
924 function initCharset() {
925 // Set charset to the charset provided by the current backend users language selection:
926 $this->charset = $GLOBALS['LANG']->charSet ? $GLOBALS['LANG']->charSet : $this->charset;
927 // Return meta tag:
928 return '<meta http-equiv="Content-Type" content="text/html; charset='.$this->charset.'" />';
929 }
930
931 /**
932 * Returns generator meta tag
933 *
934 * @return string <meta> tag with name "GENERATOR"
935 */
936 function generator() {
937 $str = 'TYPO3 '.$GLOBALS['TYPO_VERSION'].', http://typo3.com, &#169; Kasper Sk&#229;rh&#248;j 1998-2004, extensions are copyright of their respective owners.';
938 return '<meta name="GENERATOR" content="'.$str .'" />';
939 }
940
941
942
943
944
945
946
947
948 /*****************************************
949 *
950 * OTHER ELEMENTS
951 * Tables, buttons, formatting dimmed/red strings
952 *
953 ******************************************/
954
955
956 /**
957 * Returns an image-tag with an 18x16 icon of the following types:
958 *
959 * $type:
960 * -1: OK icon (Check-mark)
961 * 1: Notice (Speach-bubble)
962 * 2: Warning (Yellow triangle)
963 * 3: Fatal error (Red stop sign)
964 *
965 * @param integer See description
966 * @return string HTML image tag (if applicable)
967 */
968 function icons($type) {
969 switch($type) {
970 case '3':
971 $icon = 'gfx/icon_fatalerror.gif';
972 break;
973 case '2':
974 $icon = 'gfx/icon_warning.gif';
975 break;
976 case '1':
977 $icon = 'gfx/icon_note.gif';
978 break;
979 case '-1':
980 $icon = 'gfx/icon_ok.gif';
981 break;
982 default:
983 break;
984 }
985 if ($icon) {
986 return '<img'.t3lib_iconWorks::skinImg($this->backPath,$icon,'width="18" height="16"').' class="absmiddle" alt="" />';
987 }
988 }
989
990 /**
991 * Returns an <input> button with the $onClick action and $label
992 *
993 * @param string The value of the onclick attribute of the input tag (submit type)
994 * @param string The label for the button (which will be htmlspecialchar'ed)
995 * @return string A <input> tag of the type "submit"
996 */
997 function t3Button($onClick,$label) {
998 $button = '<input type="submit" onclick="'.htmlspecialchars($onClick).'; return false;" value="'.htmlspecialchars($label).'" />';
999 return $button;
1000 }
1001
1002 /**
1003 * dimmed-fontwrap. Returns the string wrapped in a <span>-tag defining the color to be gray/dimmed
1004 *
1005 * @param string Input string
1006 * @return string Output string
1007 */
1008 function dfw($string) {
1009 return '<span class="typo3-dimmed">'.$string.'</span>';
1010 }
1011
1012 /**
1013 * red-fontwrap. Returns the string wrapped in a <span>-tag defining the color to be red
1014 *
1015 * @param string Input string
1016 * @return string Output string
1017 */
1018 function rfw($string) {
1019 return '<span class="typo3-red">'.$string.'</span>';
1020 }
1021
1022 /**
1023 * Returns string wrapped in CDATA "tags" for XML / XHTML (wrap content of <script> and <style> sections in those!)
1024 *
1025 * @param string Input string
1026 * @return string Output string
1027 */
1028 function wrapInCData($string) {
1029 $string = '/*<![CDATA[*/'.
1030 $string.
1031 '/*]]>*/';
1032
1033 return $string;
1034 }
1035
1036 /**
1037 * Wraps the input string in script tags.
1038 * Automatic re-identing of the JS code is done by using the first line as ident reference.
1039 * This is nice for identing JS code with PHP code on the same level.
1040 *
1041 * @param string Input string
1042 * @param boolean Wrap script element in linebreaks? Default is TRUE.
1043 * @return string Output string
1044 */
1045 function wrapScriptTags($string, $linebreak=TRUE) {
1046 if(trim($string)) {
1047 // <script wrapped in nl?
1048 $cr = $linebreak? "\n" : '';
1049
1050 // remove nl from the beginning
1051 $string = preg_replace ('/^\n+/', '', $string);
1052 // re-ident to one tab using the first line as reference
1053 if(preg_match('/^(\t+)/',$string,$match)) {
1054 $string = str_replace($match[1],"\t", $string);
1055 }
1056 $string = $cr.'<script type="text/javascript">
1057 /*<![CDATA[*/
1058 '.$string.'
1059 /*]]>*/
1060 </script>'.$cr;
1061 }
1062 return trim($string);
1063 }
1064
1065 // These vars defines the layout for the table produced by the table() function.
1066 // You can override these values from outside if you like.
1067 var $tableLayout = Array (
1068 'defRow' => Array (
1069 'defCol' => Array('<td valign="top">','</td>')
1070 )
1071 );
1072 var $table_TR = '<tr>';
1073 var $table_TABLE = '<table border="0" cellspacing="0" cellpadding="0" id="typo3-tmpltable">';
1074
1075 /**
1076 * Returns a table based on the input $arr
1077 *
1078 * @param array Multidim array with first levels = rows, second levels = cells
1079 * @return string The HTML table.
1080 * @internal
1081 */
1082 function table($arr) {
1083 if (is_array($arr)) {
1084 reset($arr);
1085 $code='';
1086 $rc=0;
1087 while(list(,$val)=each($arr)) {
1088 if ($rc % 2) {
1089 $layout = is_array($this->tableLayout['defRowOdd']) ? $this->tableLayout['defRowOdd'] : $this->tableLayout['defRow'];
1090 } else {
1091 $layout = is_array($this->tableLayout['defRowEven']) ? $this->tableLayout['defRowEven'] : $this->tableLayout['defRow'];
1092 }
1093 $layout = is_array($this->tableLayout[$rc]) ? $this->tableLayout[$rc] : $layout;
1094 $code_td='';
1095 if (is_array($val)) {
1096 $cc=0;
1097 while(list(,$content)=each($val)) {
1098 $wrap= is_array($layout[$cc]) ? $layout[$cc] : $layout['defCol'];
1099 $code_td.=$wrap[0].$content.$wrap[1];
1100 $cc++;
1101 }
1102 }
1103 $trWrap = is_array($layout['tr']) ? $layout['tr'] : array($this->table_TR, '</tr>');
1104 $code.=$trWrap[0].$code_td.$trWrap[1];
1105 $rc++;
1106 }
1107 $tableWrap = is_array($this->tableLayout['table']) ? $this->tableLayout['table'] : array($this->table_TABLE, '</table>');
1108 $code=$tableWrap[0].$code.$tableWrap[1];
1109 }
1110 return $code;
1111 }
1112
1113 /**
1114 * Constructs a table with content from the $arr1, $arr2 and $arr3.
1115 * Used in eg. ext/belog/mod/index.php - refer to that for examples
1116 *
1117 * @param array Menu elements on first level
1118 * @param array Secondary items
1119 * @param array Third-level items
1120 * @return string HTML content, <table>...</table>
1121 */
1122 function menuTable($arr1,$arr2=array(), $arr3=array()) {
1123 $rows = max(array(count($arr1),count($arr2),count($arr3)));
1124
1125 $menu='
1126 <table border="0" cellpadding="0" cellspacing="0" id="typo3-tablemenu">';
1127 for($a=0;$a<$rows;$a++) {
1128 $menu.='<tr>';
1129 $cls=array();
1130 $valign='middle';
1131 $cls[]='<td valign="'.$valign.'">'.$arr1[$a][0].'</td><td>'.$arr1[$a][1].'</td>';
1132 if (count($arr2)) {
1133 $cls[]='<td valign="'.$valign.'">'.$arr2[$a][0].'</td><td>'.$arr2[$a][1].'</td>';
1134 if (count($arr3)) {
1135 $cls[]='<td valign="'.$valign.'">'.$arr3[$a][0].'</td><td>'.$arr3[$a][1].'</td>';
1136 }
1137 }
1138 $menu.=implode($cls,'<td>&nbsp;&nbsp;</td>');
1139 $menu.='</tr>';
1140 }
1141 $menu.='
1142 </table>
1143 ';
1144 return $menu;
1145 }
1146
1147 /**
1148 * Returns a one-row/two-celled table with $content and $menu side by side.
1149 * The table is a 100% width table and each cell is aligned left / right
1150 *
1151 * @param string Content cell content (left)
1152 * @param string Menu cell content (right)
1153 * @return string HTML output
1154 */
1155 function funcMenu($content,$menu) {
1156 return '
1157 <table border="0" cellpadding="0" cellspacing="0" width="100%" id="typo3-funcmenu">
1158 <tr>
1159 <td valign="top" nowrap="nowrap">'.$content.'</td>
1160 <td valign="top" align="right" nowrap="nowrap">'.$menu.'</td>
1161 </tr>
1162 </table>';
1163 }
1164
1165 /**
1166 * Creates a selector box with clear-cache items.
1167 * Rather specialized functions - at least don't use it with $addSaveOptions unless you know what you do...
1168 *
1169 * @param integer The page uid of the "current page" - the one that will be cleared as "clear cache for this page".
1170 * @param boolean If $addSaveOptions is set, then also the array of save-options for TCE_FORMS will appear.
1171 * @return string <select> tag with content - a selector box for clearing the cache
1172 */
1173 function clearCacheMenu($id,$addSaveOptions=0) {
1174 global $BE_USER;
1175 $opt=$addOptions;
1176 if ($addSaveOptions) {
1177 $opt[]='<option value="">'.$GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:rm.menu',1).'</option>';
1178 $opt[]='<option value="TBE_EDITOR_checkAndDoSubmit(1);">'.$GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:rm.saveDoc',1).'</option>';
1179 $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>';
1180 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>';
1181 $opt[]='<option value="document.editform.closeDoc.value=2; document.editform.submit();">'.$GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:rm.closeDoc',1).'</option>';
1182 $opt[]='<option value="document.editform.closeDoc.value=3; document.editform.submit();">'.$GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:rm.closeAllDocs',1).'</option>';
1183 $opt[]='<option value=""></option>';
1184 }
1185 $opt[]='<option value="">[ '.$GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:rm.clearCache_clearCache',1).' ]</option>';
1186 if ($id) $opt[]='<option value="'.$id.'">'.$GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:rm.clearCache_thisPage',1).'</option>';
1187 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>';
1188 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>';
1189
1190 $onChange = 'if (!this.options[this.selectedIndex].value) {
1191 this.selectedIndex=0;
1192 } else if (this.options[this.selectedIndex].value.indexOf(\';\')!=-1) {
1193 eval(this.options[this.selectedIndex].value);
1194 }else{
1195 document.location=\''.$this->backPath.'tce_db.php?vC='.$BE_USER->veriCode().'&redirect='.rawurlencode(t3lib_div::getIndpEnv('REQUEST_URI')).'&cacheCmd=\'+this.options[this.selectedIndex].value;
1196 }';
1197 $af_content = '<select name="cacheCmd" onchange="'.htmlspecialchars($onChange).'">'.implode('',$opt).'</select>';
1198
1199 if (count($opt)>2) {
1200 return $af_content;
1201 }
1202 }
1203
1204 /**
1205 * Returns an array with parts (JavaScript, init-functions, <div>-layers) for use on pages which displays the clickmenu layers (context sensitive menus)
1206 *
1207 * @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
1208 */
1209 function getContextMenuCode() {
1210 if ($this->isCMlayers()) {
1211 $content='
1212 <script type="text/javascript">
1213 /*<![CDATA[*/
1214 var GLV_gap=10;
1215 var GLV_curLayerX=new Array(0,0);
1216 var GLV_curLayerY=new Array(0,0);
1217 var GLV_curLayerWidth=new Array(0,0);
1218 var GLV_curLayerHeight=new Array(0,0);
1219 var GLV_isVisible=new Array(0,0);
1220 var GLV_x=0;
1221 var GLV_y=0;
1222 var GLV_xRel=0;
1223 var GLV_yRel=0;
1224 var layerObj=new Array();
1225 var layerObjCss=new Array();
1226
1227 //browsercheck...
1228 function GL_checkBrowser(){ //
1229 this.dom= (document.getElementById);
1230 this.op= (navigator.userAgent.indexOf("Opera")>-1);
1231 this.op7= this.op && (navigator.appVersion.indexOf("7")>-1); // check for Opera version 7
1232 this.konq= (navigator.userAgent.indexOf("Konq")>-1);
1233 this.ie4= (document.all && !this.dom && !this.op && !this.konq);
1234 this.ie5= (document.all && this.dom && !this.op && !this.konq);
1235 this.ns4= (document.layers && !this.dom && !this.konq);
1236 this.ns5= (!document.all && this.dom && !this.op && !this.konq);
1237 this.ns6= (this.ns5);
1238 this.bw= (this.ie4 || this.ie5 || this.ns4 || this.ns6 || this.op || this.konq);
1239 return this;
1240 }
1241 bw= new GL_checkBrowser();
1242
1243 // GL_getObj(obj)
1244 function GL_getObj(obj){ //
1245 nest="";
1246 this.el= (bw.ie4||bw.op7)?document.all[obj]:bw.ns4?eval(nest+"document."+obj):document.getElementById(obj);
1247 this.css= bw.ns4?this.el:this.el.style;
1248 this.ref= bw.ns4?this.el.document:document;
1249 this.x= (bw.ns4||bw.op)?this.css.left:this.el.offsetLeft;
1250 this.y= (bw.ns4||bw.op)?this.css.top:this.el.offsetTop;
1251 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;
1252 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;
1253 return this;
1254 }
1255 // GL_getObjCss(obj)
1256 function GL_getObjCss(obj){ //
1257 return bw.dom? document.getElementById(obj).style:bw.ie4?document.all[obj].style:bw.ns4?document.layers[obj]:0;
1258 }
1259 // GL_getMouse(event)
1260 function GL_getMouse(event) { //
1261 if (layerObj) {
1262 // GLV_x= (bw.ns4||bw.ns5)?event.pageX:(bw.ie4||bw.op)?event.clientX:(event.clientX-2)+document.body.scrollLeft;
1263 // GLV_y= (bw.ns4||bw.ns5)?event.pageY:(bw.ie4||bw.op)?event.clientY:(event.clientY-2)+document.body.scrollTop;
1264 // 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:
1265
1266 GLV_xRel = event.clientX-2;
1267 GLV_yRel = event.clientY-2;
1268 GLV_x = GLV_xRel + (document.documentElement.scrollLeft ? document.documentElement.scrollLeft : document.body.scrollLeft);
1269 GLV_y = GLV_yRel + (document.documentElement.scrollTop ? document.documentElement.scrollTop : document.body.scrollTop);
1270
1271 // status = (GLV_x+GLV_gap-GLV_curLayerX[0]) + " | " + (GLV_y+GLV_gap-GLV_curLayerY[0]);
1272 if (GLV_isVisible[1]) {
1273 if (outsideLayer(1)) hideSpecific(1);
1274 } else if (GLV_isVisible[0]) {
1275 if (outsideLayer(0)) hideSpecific(0);
1276 }
1277 }
1278 }
1279 // outsideLayer(level)
1280 function outsideLayer(level) { //
1281 return GLV_x+GLV_gap-GLV_curLayerX[level] <0 ||
1282 GLV_y+GLV_gap-GLV_curLayerY[level] <0 ||
1283 GLV_curLayerX[level]+GLV_curLayerWidth[level]+GLV_gap-GLV_x <0 ||
1284 GLV_curLayerY[level]+GLV_curLayerHeight[level]+GLV_gap-GLV_y <0;
1285 }
1286 // setLayerObj(html,level)
1287 function setLayerObj(html,level) { //
1288 var tempLayerObj = GL_getObj("contentMenu"+level);
1289 var tempLayerObjCss = GL_getObjCss("contentMenu"+level);
1290
1291 if (tempLayerObj && (level==0 || GLV_isVisible[level-1])) {
1292 tempLayerObj.el.innerHTML = html;
1293 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;
1294 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;
1295
1296 // Adjusting the Y-height of the layer to fit it into the window frame if it goes under the window frame in the bottom:
1297 tempLayerObj.winHeight = document.documentElement.clientHeight && !bw.op7 ? document.documentElement.clientHeight : document.body.clientHeight;
1298 if (tempLayerObj.winHeight-tempLayerObj.height < GLV_yRel) {
1299 if (GLV_yRel < tempLayerObj.height) {
1300 GLV_y+= (tempLayerObj.winHeight-tempLayerObj.height-GLV_yRel); // Setting it so bottom is just above window height.
1301 } else {
1302 GLV_y-= tempLayerObj.height-8; // Showing the menu upwards
1303 }
1304 }
1305
1306 GLV_curLayerX[level] = GLV_x;
1307 GLV_curLayerY[level] = GLV_y;
1308 tempLayerObjCss.left = GLV_x+"px";
1309 tempLayerObjCss.top = GLV_y+"px";
1310 tempLayerObjCss.visibility = "visible";
1311 if (bw.ie5) showHideSelectorBoxes("hidden");
1312
1313 GLV_isVisible[level]=1;
1314 GLV_curLayerWidth[level] = tempLayerObj.width;
1315 GLV_curLayerHeight[level] = tempLayerObj.height;
1316 }
1317 }
1318 // hideEmpty()
1319 function hideEmpty() { //
1320 hideSpecific(0);
1321 hideSpecific(1);
1322 return false;
1323 }
1324 // hideSpecific(level)
1325 function hideSpecific(level) { //
1326 GL_getObjCss("contentMenu"+level).visibility = "hidden";
1327 GL_getObj("contentMenu"+level).el.innerHTML = "";
1328 GLV_isVisible[level]=0;
1329
1330 if (bw.ie5 && level==0) showHideSelectorBoxes("visible");
1331 }
1332 // debugObj(obj,name)
1333 function debugObj(obj,name) { //
1334 var acc;
1335 for (i in obj) {if (obj[i]) {acc+=i+": "+obj[i]+"\n";}}
1336 alert("Object: "+name+"\n\n"+acc);
1337 }
1338 // initLayer()
1339 function initLayer(){ //
1340 if (document.all) {
1341 window.onmousemove=GL_getMouse;
1342 }
1343 layerObj = GL_getObj("contentMenu1");
1344 layerObjCss = GL_getObjCss("contentMenu1");
1345 }
1346 function showHideSelectorBoxes(action) { // This function by Michiel van Leening
1347 for (i=0;i<document.forms.length;i++) {
1348 for (j=0;j<document.forms[i].elements.length;j++) {
1349 if(document.forms[i].elements[j].type=="select-one") {
1350 document.forms[i].elements[j].style.visibility=action;
1351 }
1352 }
1353 }
1354 }
1355 /*]]>*/
1356 </script>
1357 ';
1358 return array(
1359 $content,
1360 ' onmousemove="GL_getMouse(event);" onload="initLayer();"',
1361 '<div id="contentMenu0" style="z-index:1; position:absolute;visibility:hidden"></div><div id="contentMenu1" style="z-index:2; position:absolute;visibility:hidden"></div>'
1362 );
1363 } else return array('','','');
1364 }
1365
1366
1367
1368
1369 /**
1370 * creates a tab menu from an array definition
1371 *
1372 * Returns a tab menu for a module
1373 * Requires the JS function jumpToUrl() to be available
1374 *
1375 * @param string $id is the "&id=" parameter value to be sent to the module
1376 * @param string $elementName it the form elements name, probably something like "SET[...]"
1377 * @param string $currentValue is the value to be selected currently.
1378 * @param array $menuItems is an array with the menu items for the selector box
1379 * @param string $script is the script to send the &id to, if empty it's automatically found
1380 * @param string $addParams is additional parameters to pass to the script.
1381 * @return string HTML code for tab menu
1382 * @todo Update the HTML code to use the stylesheet.css instead.
1383 * @author René Fritz <r.fritz@colorcube.de>
1384 */
1385 function getTabMenu($id,$elementName,$currentValue,$menuItems,$script='',$addparams='') {
1386 $content='';
1387
1388 if (is_array($menuItems)) {
1389 if (!$script) {$script=basename(PATH_thisScript);}
1390 $options='';
1391
1392 $count = count($menuItems);
1393 $widthLeft = 1;
1394 $addToAct = 5;
1395
1396 $widthRight = max (1,floor(30-pow($count,1.72)));
1397 $widthTabs = 100 - $widthRight - $widthLeft;
1398 $widthNo = floor(($widthTabs - $addToAct)/$count);
1399 $addToAct = max ($addToAct,$widthTabs-($widthNo*$count));
1400 $widthAct = $widthNo + $addToAct;
1401 $widthRight = 100 - ($widthLeft + ($count*$widthNo) + $addToAct);
1402
1403 $first=true;
1404 foreach($menuItems as $value => $label) {
1405 $isActive = !strcmp($currentValue,$value);
1406 $class = $isActive ? "tabact" : "tab";
1407 $width = $isActive ? $widthAct : $widthNo;
1408
1409 $label = t3lib_div::deHSCentities(htmlspecialchars($label));
1410 $link = htmlspecialchars($script.'?id='.rawurlencode($id).$addparams.'&'.$elementName.'='.$value);
1411 if($first) {
1412 $options.= '
1413 <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>';
1414 } else {
1415 $options.='
1416 <td width="'.$width.'%" class="'.$class.'"><a href="'.$link.'" class="'.$class.'">'.$label.'</a></td>';
1417 }
1418 $first=false;
1419 }
1420
1421 if ($options) {
1422 $content .= '
1423 <!-- Tab menu -->
1424 <table cellpadding="0" cellspacing="0" border="0" width="100%" id="typo3-tabmenu">
1425 <tr>
1426 <td width="'.$widthLeft.'%">&nbsp;</td>
1427 '.$options.'
1428 <td width="'.$widthRight.'%">&nbsp;</td>
1429 </tr>
1430 </table>
1431 <div class="hr" style="display:block;margin:0px;padding:0px;"></div>';
1432 }
1433
1434 // include CSS
1435 $actBgColor = t3lib_div::modifyHTMLcolorAll($this->bgColor6,0);
1436 $lgBgColor = t3lib_div::modifyHTMLcolorAll($this->bgColor5,25);
1437 $hoverBgColor = t3lib_div::modifyHTMLcolorAll($this->bgColor6,15);
1438
1439 $this->inDocStylesArray['getTabMenu'] = '
1440 td.tabact {
1441 border: solid black 1px;
1442 background: '.$actBgColor.';
1443 color:#000;
1444 }
1445 td.tabact>a {
1446 color:#000;
1447 }
1448 td.tab {
1449 border: solid #555 1px;
1450 border-left: solid #aaa 3px;
1451 background: '.$lgBgColor.';
1452 color:grey;
1453 }
1454 td.tab, td.tabact {
1455 border-bottom: none;
1456 border-radius: 3px;
1457 -moz-border-radius: 3px;
1458 }
1459 a.tab, a.tabact {
1460 color:grey;
1461 text-decoration:none;
1462 display: block;
1463 width:auto;
1464 padding:2px;
1465 padding-left:3px;
1466 padding-right:5px;
1467 }
1468 a.tabact {
1469 padding-left:10px;
1470 padding-right:10px;
1471 }
1472 a.tab:hover,a.tabact:hover {
1473 color:black;
1474 background: '.$hoverBgColor.';
1475 text-decoration:none;
1476 cursor: pointer;
1477 }';
1478 }
1479 return $content;
1480 }
1481 }
1482
1483
1484
1485 // ******************************
1486 // Extension classes of the template class.
1487 // These are meant to provide backend screens with different widths.
1488 // They still do because of the different class-prefixes used for the <div>-sections
1489 // but obviously the final width is determined by the stylesheet used.
1490 // ******************************
1491
1492 /**
1493 * 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
1494 * The class were more significant in the past than today.
1495 *
1496 */
1497 class bigDoc extends template {
1498 var $divClass = 'typo3-bigDoc';
1499 }
1500
1501 /**
1502 * Extension class for "template" - used for backend pages without the "document" background image
1503 * The class were more significant in the past than today.
1504 *
1505 */
1506 class noDoc extends template {
1507 var $divClass = 'typo3-noDoc';
1508 }
1509
1510 /**
1511 * 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)
1512 * The class were more significant in the past than today.
1513 *
1514 */
1515 class smallDoc extends template {
1516 var $divClass = 'typo3-smallDoc';
1517 }
1518
1519 /**
1520 * 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.
1521 * The class were more significant in the past than today. But probably you should use this one for most modules you make.
1522 *
1523 */
1524 class mediumDoc extends template {
1525 var $divClass = 'typo3-mediumDoc';
1526 }
1527
1528
1529
1530 // Include extension to the template class?
1531 if (defined('TYPO3_MODE') && $TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['typo3/template.php']) {
1532 include_once($TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['typo3/template.php']);
1533 }
1534
1535
1536
1537 // ******************************************************
1538 // The backend language engine is started (ext: "lang")
1539 // ******************************************************
1540 require_once(PATH_typo3.'sysext/lang/lang.php');
1541 $LANG = t3lib_div::makeInstance('language');
1542 $LANG->init($BE_USER->uc['lang']);
1543
1544
1545
1546 // ******************************
1547 // The template is loaded
1548 // ******************************
1549 $TBE_TEMPLATE = t3lib_div::makeInstance('template');
1550 ?>