See my changelog comment from 2004-06-28 + locallang-XML changes (done to german...
[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 * @param string Enable / Disable click menu items. Example: "+new,view" will display ONLY these two items (and any spacers in between), "new,view" will display all BUT these two items.
283 * @param boolean If set, will return only the onclick JavaScript, not the whole link.
284 * @return string The link-wrapped input string.
285 */
286 function wrapClickMenuOnIcon($str,$table,$uid='',$listFr=1,$addParams='',$enDisItems='', $returnOnClick=FALSE) {
287 $backPath = '&backPath='.rawurlencode($this->backPath).'|'.t3lib_div::shortMD5($this->backPath.'|'.$GLOBALS['TYPO3_CONF_VARS']['SYS']['encryptionKey']);
288 $onClick = 'top.loadTopMenu(\''.$this->backPath.'alt_clickmenu.php?item='.rawurlencode($table.'|'.$uid.'|'.$listFr.'|'.$enDisItems).$backPath.$addParams.'\');'.$this->thisBlur().'return false;';
289 return $returnOnClick ? $onClick : '<a href="#" onclick="'.htmlspecialchars($onClick).'">'.$str.'</a>';
290 }
291
292 /**
293 * Makes link to page $id in frontend (view page)
294 * Returns an magnifier-glass icon which links to the frontend index.php document for viewing the page with id $id
295 * $id must be a page-uid
296 * If the BE_USER has access to Web>List then a link to that module is shown as well (with return-url)
297 *
298 * @param integer The page id
299 * @param string The current "BACK_PATH" (the back relative to the typo3/ directory)
300 * @param string Additional parameters for the image tag(s)
301 * @return string HTML string with linked icon(s)
302 */
303 function viewPageIcon($id,$backPath,$addParams='hspace="3"') {
304 global $BE_USER;
305 $str = '';
306 // If access to Web>List for user, then link to that module.
307 if ($BE_USER->check('modules','web_list')) {
308 $href=$backPath.'db_list.php?id='.$id.'&returnUrl='.rawurlencode(t3lib_div::getIndpEnv('REQUEST_URI'));
309 $str.= '<a href="'.htmlspecialchars($href).'">'.
310 '<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="" />'.
311 '</a>';
312 }
313 // Make link to view page
314 $str.= '<a href="#" onclick="'.htmlspecialchars(t3lib_BEfunc::viewOnClick($id,$backPath,t3lib_BEfunc::BEgetRootLine($id))).'">'.
315 '<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="" />'.
316 '</a>';
317 return $str;
318 }
319
320 /**
321 * Returns a URL with a command to TYPO3 Core Engine (tce_db.php)
322 * See description of the API elsewhere.
323 *
324 * @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"
325 * @param string Redirect URL if any other that t3lib_div::getIndpEnv('REQUEST_URI') is wished
326 * @return string URL to tce_db.php + parameters (backpath is taken from $this->backPath)
327 */
328 function issueCommand($params,$rUrl='') {
329 $rUrl = $rUrl ? $rUrl : t3lib_div::getIndpEnv('REQUEST_URI');
330 return $this->backPath.'tce_db.php?'.
331 $params.
332 '&redirect='.($rUrl==-1?"'+T3_THIS_LOCATION+'":rawurlencode($rUrl)).
333 '&vC='.rawurlencode($GLOBALS['BE_USER']->veriCode()).
334 '&prErr=1&uPT=1';
335 }
336
337 /**
338 * Returns true if click-menu layers can be displayed for the current user/browser
339 * Use this to test if click-menus (context sensitive menus) can and should be displayed in the backend.
340 *
341 * @return boolean
342 */
343 function isCMlayers() {
344 return !$GLOBALS['BE_USER']->uc['disableCMlayers'] && $GLOBALS['CLIENT']['FORMSTYLE'] && $GLOBALS['CLIENT']['SYSTEM']!='mac';
345 }
346
347 /**
348 * Returns 'this.blur();' if the client supports CSS styles
349 * Use this in links to remove the underlining after being clicked
350 *
351 * @return string
352 */
353 function thisBlur() {
354 return ($GLOBALS['CLIENT']['FORMSTYLE']?'this.blur();':'');
355 }
356
357 /**
358 * Returns ' style='cursor:help;'' if the client supports CSS styles
359 * Use for <a>-links to help texts
360 *
361 * @return string
362 */
363 function helpStyle() {
364 return $GLOBALS['CLIENT']['FORMSTYLE'] ? ' style="cursor:help;"':'';
365 }
366
367 /**
368 * Makes the header (icon+title) for a page (or other record). Used in most modules under Web>*
369 * $table and $row must be a tablename/record from that table
370 * $path will be shown as alt-text for the icon.
371 * The title will be truncated to 45 chars.
372 *
373 * @param string Table name
374 * @param array Record row
375 * @param string Alt text
376 * @param boolean Set $noViewPageIcon true if you don't want a magnifier-icon for viewing the page in the frontend
377 * @param array $tWrap is an array with indexes 0 and 1 each representing HTML-tags (start/end) which will wrap the title
378 * @return string HTML content
379 */
380 function getHeader($table,$row,$path,$noViewPageIcon=0,$tWrap=array('','')) {
381 global $TCA;
382 if (is_array($row) && $row['uid']) {
383 $iconImgTag=t3lib_iconWorks::getIconImage($table,$row,$this->backPath,'title="'.htmlspecialchars($path).'"');
384 $title= strip_tags($row[$TCA[$table]['ctrl']['label']]);
385 $viewPage = $noViewPageIcon ? '' : $this->viewPageIcon($row['uid'],$this->backPath,'');
386 if ($table=='pages') $path.=' - '.t3lib_BEfunc::titleAttribForPages($row,'',0);
387 } else {
388 $iconImgTag='<img'.t3lib_iconWorks::skinImg($this->backPath,'gfx/i/_icon_website.gif',$wHattribs='width="18" height="16"').' title="'.htmlspecialchars($path).'" alt="" />';
389 $title=$GLOBALS['TYPO3_CONF_VARS']['SYS']['sitename'];
390 }
391
392 return '<span class="typo3-moduleHeader">'.$this->wrapClickMenuOnIcon($iconImgTag,$table,$row['uid']).
393 $viewPage.
394 $tWrap[0].htmlspecialchars(t3lib_div::fixed_lgd_cs($title,45)).$tWrap[1].'</span>';
395 }
396
397 /**
398 * Like ->getHeader() but for files in the File>* main module/submodules
399 * Returns the file-icon with the path of the file set in the alt/title attribute. Shows the file-name after the icon.
400 *
401 * @param string Title string, expected to be the filepath
402 * @param string Alt text
403 * @param string The icon file (relative to TYPO3 dir)
404 * @return string HTML content
405 */
406 function getFileheader($title,$path,$iconfile) {
407 $fileInfo = t3lib_div::split_fileref($title);
408 $title = htmlspecialchars(t3lib_div::fixed_lgd_cs($fileInfo['path'],-35)).'<b>'.htmlspecialchars($fileInfo['file']).'</b>';
409 return '<span class="typo3-moduleHeader"><img'.t3lib_iconWorks::skinImg($this->backPath,$iconfile,'width="18" height="16"').' title="'.htmlspecialchars($path).'" alt="" />'.$title.'</span>';
410 }
411
412 /**
413 * Returns a linked shortcut-icon which will call the shortcut frame and set a shortcut there back to the calling page/module
414 *
415 * @param string Is the list of GET variables to store (if any)
416 * @param string Is the list of SET[] variables to store (if any) - SET[] variables a stored in $GLOBALS["SOBE"]->MOD_SETTINGS for backend modules
417 * @param string Module name string
418 * @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.
419 * @return string HTML content
420 */
421 function makeShortcutIcon($gvList,$setList,$modName,$motherModName="") {
422 $backPath=$this->backPath;
423 $storeUrl=$this->makeShortcutUrl($gvList,$setList);
424 $pathInfo = parse_url(t3lib_div::getIndpEnv('REQUEST_URI'));
425
426 if (!strcmp($motherModName,'1')) {
427 $mMN="&motherModName='+top.currentModuleLoaded+'";
428 } elseif ($motherModName) {
429 $mMN='&motherModName='.rawurlencode($motherModName);
430 } else $mMN="";
431
432 $onClick = 'if (top.shortcutFrame && confirm('.
433 $GLOBALS['LANG']->JScharCode($GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:labels.makeShortcut')).
434 ')){top.shortcutFrame.document.location=\''.$backPath.'alt_shortcut.php?modName='.rawurlencode($modName).
435 '&URL='.rawurlencode($pathInfo['path']."?".$storeUrl).
436 $mMN.
437 '\';}return false;';
438
439 $sIcon = '<a href="#" onclick="'.htmlspecialchars($onClick).'">
440 <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>';
441 return $sIcon;
442 }
443
444 /**
445 * MAKE url for storing
446 * Internal func
447 *
448 * @param string Is the list of GET variables to store (if any)
449 * @param string Is the list of SET[] variables to store (if any) - SET[] variables a stored in $GLOBALS["SOBE"]->MOD_SETTINGS for backend modules
450 * @return string
451 * @access private
452 * @see makeShortcutIcon()
453 */
454 function makeShortcutUrl($gvList,$setList) {
455 $GET = t3lib_div::_GET();
456 $storeArray = array_merge(
457 t3lib_div::compileSelectedGetVarsFromArray($gvList,$GET),
458 array('SET'=>t3lib_div::compileSelectedGetVarsFromArray($setList,$GLOBALS['SOBE']->MOD_SETTINGS))
459 );
460 $storeUrl = t3lib_div::implodeArrayForUrl('',$storeArray);
461 return $storeUrl;
462 }
463
464 /**
465 * Returns <input> attributes to set the width of an text-type input field.
466 * For client browsers with no CSS support the cols/size attribute is returned.
467 * For CSS compliant browsers (recommended) a ' style="width: ...px;"' is returned.
468 *
469 * @param integer A relative number which multiplied with approx. 10 will lead to the width in pixels
470 * @param boolean A flag you can set for textareas - DEPRECIATED, use ->formWidthText() for textareas!!!
471 * @param string A string which will be returned as attribute-value for style="" instead of the calculated width (if CSS is enabled)
472 * @return string Tag attributes for an <input> tag (regarding width)
473 * @see formWidthText()
474 */
475 function formWidth($size=48,$textarea=0,$styleOverride='') {
476 $wAttrib = $textarea?'cols':'size';
477 if (!$GLOBALS['CLIENT']['FORMSTYLE']) { // If not setting the width by style-attribute
478 $size = $size;
479 $retVal = ' '.$wAttrib.'="'.$size.'"';
480 } else { // Setting width by style-attribute. 'cols' MUST be avoided with NN6+
481 $pixels = ceil($size*$this->form_rowsToStylewidth);
482 $retVal = $styleOverride ? ' style="'.$styleOverride.'"' : ' style="width:'.$pixels.'px;"';
483 }
484 return $retVal;
485 }
486
487 /**
488 * This function is dedicated to textareas, which has the wrapping on/off option to observe.
489 * EXAMPLE:
490 * <textarea rows="10" wrap="off" '.$GLOBALS["TBE_TEMPLATE"]->formWidthText(48,"","off").'>
491 * or
492 * <textarea rows="10" wrap="virtual" '.$GLOBALS["TBE_TEMPLATE"]->formWidthText(48,"","virtual").'>
493 *
494 * @param integer A relative number which multiplied with approx. 10 will lead to the width in pixels
495 * @param string A string which will be returned as attribute-value for style="" instead of the calculated width (if CSS is enabled)
496 * @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.
497 * @return string Tag attributes for an <input> tag (regarding width)
498 * @see formWidth()
499 */
500 function formWidthText($size=48,$styleOverride='',$wrap='') {
501 $wTags = $this->formWidth($size,1,$styleOverride);
502 // 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...
503 if (strtolower(trim($wrap))!='off' && $GLOBALS['CLIENT']['BROWSER']=='net' && $GLOBALS['CLIENT']['VERSION']>=5) {
504 $wTags.=' cols="'.$size.'"';
505 }
506 return $wTags;
507 }
508
509 /**
510 * Returns JavaScript variables setting the returnUrl and thisScript location for use by JavaScript on the page.
511 * Used in fx. db_list.php (Web>List)
512 *
513 * @param string URL to "this location" / current script
514 * @return string
515 * @see typo3/db_list.php
516 */
517 function redirectUrls($thisLocation='') {
518 $thisLocation = $thisLocation?$thisLocation:t3lib_div::linkThisScript(
519 array(
520 'CB'=>'',
521 'SET'=>'',
522 'cmd' => '',
523 'popViewId'=>''
524 ));
525
526 $out ="
527 var T3_RETURN_URL = '".str_replace('%20','',rawurlencode(t3lib_div::_GP('returnUrl')))."';
528 var T3_THIS_LOCATION = '".str_replace('%20','',rawurlencode($thisLocation))."';
529 ";
530 return $out;
531 }
532
533 /**
534 * Returns a formatted string of $tstamp
535 * Uses $GLOBALS['TYPO3_CONF_VARS']['SYS']['hhmm'] and $GLOBALS['TYPO3_CONF_VARS']['SYS']['ddmmyy'] to format date and time
536 *
537 * @param integer UNIX timestamp, seconds since 1970
538 * @param integer How much data to show: $type = 1: hhmm, $type = 10: ddmmmyy
539 * @return string Formatted timestamp
540 */
541 function formatTime($tstamp,$type) {
542 switch($type) {
543 case 1: return date($GLOBALS['TYPO3_CONF_VARS']['SYS']['hhmm'],$tstamp); break;
544 case 10: return date($GLOBALS['TYPO3_CONF_VARS']['SYS']['ddmmyy'],$tstamp); break;
545 }
546 }
547
548 /**
549 * Returns script parsetime IF ->parseTimeFlag is set and user is "admin"
550 * Automatically outputted in page end
551 *
552 * @return string
553 */
554 function parseTime() {
555 if ($this->parseTimeFlag && $GLOBALS['BE_USER']->isAdmin()) {
556 return '<p>(ParseTime: '.(t3lib_div::milliseconds()-$GLOBALS['PARSETIME_START']).' ms</p>
557 <p>REQUEST_URI-length: '.strlen(t3lib_div::getIndpEnv('REQUEST_URI')).')</p>';
558 }
559 }
560
561
562
563
564
565
566
567
568
569
570
571
572 /*****************************************
573 *
574 * PAGE BUILDING FUNCTIONS.
575 * Use this to build the HTML of your backend modules
576 *
577 *****************************************/
578
579 /**
580 * Returns page start
581 * This includes the proper header with charset, title, meta tag and beginning body-tag.
582 *
583 * @param string HTML Page title for the header
584 * @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)
585 * @see endPage()
586 */
587 function startPage($title) {
588 // Get META tag containing the currently selected charset for backend output. The function sets $this->charSet.
589 $charSet = $this->initCharset();
590 $generator = $this->generator();
591
592 // For debugging: If this outputs "QuirksMode"/"BackCompat" (IE) the browser runs in quirks-mode. Otherwise the value is "CSS1Compat"
593 # $this->JScodeArray[]='alert(document.compatMode);';
594
595 // Send HTTP header for selected charset. Added by Robert Lemke 23.10.2003
596 header ('Content-Type:text/html;charset='.$this->charset);
597
598 switch($this->docType) {
599 case 'xhtml_strict':
600 $headerStart= '<!DOCTYPE html
601 PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
602 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
603 <?xml version="1.0" encoding="'.$this->charset.'"?>
604 <?xml-stylesheet href="#internalStyle" type="text/css"?>
605 ';
606 break;
607 case 'xhtml_trans':
608 $headerStart= '<!DOCTYPE html
609 PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
610 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
611 <?xml version="1.0" encoding="'.$this->charset.'"?>
612 <?xml-stylesheet href="#internalStyle" type="text/css"?>
613 ';
614 break;
615 case 'xhtml_frames':
616 $headerStart= '<!DOCTYPE html
617 PUBLIC "-//W3C//DTD XHTML 1.0 Frameset//EN"
618 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd">
619 <?xml version="1.0" encoding="'.$this->charset.'"?>
620 ';
621 break;
622 default:
623 $headerStart='<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">';
624 break;
625 }
626
627 // Construct page header.
628 $str = $headerStart.'
629 <html>
630 <head>
631 <!-- TYPO3 Script ID: '.htmlspecialchars($this->scriptID).' -->
632 '.$charSet.'
633 '.$generator.'
634 <title>'.htmlspecialchars($title).'</title>
635 '.$this->docStyle().'
636 '.$this->JScode.'
637 '.$this->wrapScriptTags(implode("\n", $this->JScodeArray)).'
638 <!--###POSTJSMARKER###-->
639 </head>
640 ';
641 $this->JScode='';
642 $this->JScodeArray=array();
643
644 if ($this->docType=='xhtml_frames') {
645 return $str;
646 } else
647 $str.=$this->docBodyTagBegin().
648 ($this->divClass?'
649
650 <!-- Wrapping DIV-section for whole page BEGIN -->
651 <div class="'.$this->divClass.'">
652 ':'').trim($this->form);
653 return $str;
654 }
655
656 /**
657 * Returns page end; This includes finishing form, div, body and html tags.
658 *
659 * @return string The HTML end of a page
660 * @see startPage()
661 */
662 function endPage() {
663 $str = $this->sectionEnd().
664 $this->postCode.
665 $this->endPageJS().
666 t3lib_BEfunc::getSetUpdateSignal().
667 $this->parseTime().
668 ($this->form?'
669 </form>':'').
670 ($this->divClass?'
671
672 <!-- Wrapping DIV-section for whole page END -->
673 </div>':'').
674 '
675 </body>
676 </html> ';
677
678 // Logging: Can't find better place to put it:
679 if (TYPO3_DLOG) t3lib_div::devLog('END of BACKEND session','',0,array('_FLUSH'=>TRUE));
680
681 return $str;
682 }
683
684 /**
685 * Returns the header-bar in the top of most backend modules
686 * Closes section if open.
687 *
688 * @param string The text string for the header
689 * @return string HTML content
690 */
691 function header($text) {
692 $str='
693
694 <!-- MAIN Header in page top -->
695 <h2>'.htmlspecialchars($text).'</h2>
696 ';
697 return $this->sectionEnd().$str;
698 }
699
700 /**
701 * Begins an output section and sets header and content
702 *
703 * @param string The header
704 * @param string The HTML-content
705 * @param boolean A flag that will prevent the header from being converted to uppercase
706 * @param boolean Defines the type of header (if set, "<h3>" rather than the default "h4")
707 * @param integer The number of an icon to show with the header (see the icon-function). -1,1,2,3
708 * @param boolean If set, HTML tags are allowed in $label (otherwise this value is by default htmlspecialchars()'ed)
709 * @return string HTML content
710 * @see icons(), sectionHeader()
711 */
712 function section($label,$text,$nostrtoupper=FALSE,$sH=FALSE,$type=0,$allowHTMLinHeader=FALSE) {
713 $str='';
714
715 // Setting header
716 if ($label) {
717 if (!$allowHTMLinHeader) $label = htmlspecialchars($label);
718 $str.=$this->sectionHeader($this->icons($type).$label, $sH, $nostrtoupper ? '' : ' class="uppercase"');
719 }
720 // Setting content
721 $str.='
722
723 <!-- Section content -->
724 '.$text;
725
726 return $this->sectionBegin().$str;
727 }
728
729 /**
730 * Inserts a divider image
731 * Ends a section (if open) before inserting the image
732 *
733 * @param integer The margin-top/-bottom of the <hr> ruler.
734 * @return string HTML content
735 */
736 function divider($dist) {
737 $dist = intval($dist);
738 $str='
739
740 <!-- DIVIDER -->
741 <hr style="margin-top: '.$dist.'px; margin-bottom: '.$dist.'px;" />
742 ';
743 return $this->sectionEnd().$str;
744 }
745
746 /**
747 * Returns a blank <div>-section with a height
748 *
749 * @param integer Padding-top for the div-section (should be margin-top but konquorer (3.1) don't like it :-(
750 * @return string HTML content
751 */
752 function spacer($dist) {
753 if ($dist>0) {
754 return '
755
756 <!-- Spacer element -->
757 <div style="padding-top: '.intval($dist).'px;"></div>
758 ';
759 }
760 }
761
762 /**
763 * Make a section header.
764 * Begins a section if not already open.
765 *
766 * @param string The label between the <h3> or <h4> tags. (Allows HTML)
767 * @param boolean If set, <h3> is used, otherwise <h4>
768 * @param string Additional attributes to h-tag, eg. ' class=""'
769 * @return string HTML content
770 */
771 function sectionHeader($label,$sH=FALSE,$addAttrib='') {
772 $tag = ($sH?'h3':'h4');
773 $str='
774
775 <!-- Section header -->
776 <'.$tag.$addAttrib.'>'.$label.'</'.$tag.'>
777 ';
778 return $this->sectionBegin().$str;
779 }
780
781 /**
782 * Begins an output section.
783 * Returns the <div>-begin tag AND sets the ->sectionFlag true (if the ->sectionFlag is not already set!)
784 * 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!
785 *
786 * @return string HTML content
787 */
788 function sectionBegin() {
789 if (!$this->sectionFlag) {
790 $this->sectionFlag=1;
791 $str='
792
793 <!-- ***********************
794 Begin output section.
795 *********************** -->
796 <div>
797 ';
798 return $str;
799 } else return '';
800 }
801
802 /**
803 * Ends and output section
804 * Returns the </div>-end tag AND clears the ->sectionFlag (but does so only IF the sectionFlag is set - that is a section is 'open')
805 * See sectionBegin() also.
806 *
807 * @return string HTML content
808 */
809 function sectionEnd() {
810 if ($this->sectionFlag) {
811 $this->sectionFlag=0;
812 return '
813 </div>
814 <!-- *********************
815 End output section.
816 ********************* -->
817 ';
818 } else return '';
819 }
820
821 /**
822 * Originally it printed a kind of divider.
823 * Depreciated. Just remove function calls to it or call the divider() function instead.
824 *
825 * @return void
826 * @internal
827 * @depreciated
828 */
829 function middle() {
830 }
831
832 /**
833 * If a form-tag is defined in ->form then and end-tag for that <form> element is outputted
834 * Further a JavaScript section is outputted which will update the top.busy session-expiry object (unless $this->endJS is set to false)
835 *
836 * @return string HTML content (<script> tag section)
837 */
838 function endPageJS() {
839 return ($this->endJS?'
840 <script type="text/javascript">
841 /*<![CDATA[*/
842 if (top.busy && top.busy.loginRefreshed) {
843 top.busy.loginRefreshed();
844 }
845 /*]]>*/
846 </script>':'');
847 }
848
849 /**
850 * Creates the bodyTag.
851 * You can add to the bodyTag by $this->bodyTagAdditions
852 *
853 * @return string HTML body tag
854 */
855 function docBodyTagBegin() {
856 $bodyContent = 'body '.trim($this->bodyTagAdditions.($this->bodyTagId ? ' id="'.$this->bodyTagId.'"' : ''));
857 return '<'.trim($bodyContent).'>';
858 }
859
860 /**
861 * Outputting document style
862 *
863 * @return string HTML style section/link tags
864 */
865 function docStyle() {
866
867 // Request background image:
868 if ($this->backGroundImage) {
869 $this->inDocStylesArray[]=' BODY { background-image: url('.$this->backPath.$this->backGroundImage.'); }';
870 }
871
872 // Add inDoc styles variables as well:
873 $this->inDocStylesArray[] = $this->inDocStyles;
874 $this->inDocStylesArray[] = $this->inDocStyles_TBEstyle;
875
876 // Implode it all:
877 $inDocStyles = implode('
878 ',$this->inDocStylesArray);
879
880 // The default color scheme should also in full be represented in the stylesheet.
881 $style=trim('
882 '.($this->styleSheetFile?'<link rel="stylesheet" type="text/css" href="'.$this->backPath.$this->styleSheetFile.'" />':'').'
883 '.($this->styleSheetFile2?'<link rel="stylesheet" type="text/css" href="'.$this->backPath.$this->styleSheetFile2.'" />':'').'
884 <style type="text/css" id="internalStyle">
885 /*<![CDATA[*/
886 '.trim($inDocStyles).'
887 /*###POSTCSSMARKER###*/
888 /*]]>*/
889 </style>
890 '.($this->styleSheetFile_post?'<link rel="stylesheet" type="text/css" href="'.$this->backPath.$this->styleSheetFile_post.'" />':'')
891 )
892 ;
893 $this->inDocStyles='';
894 $this->inDocStylesArray=array();
895
896 return '
897 '.$style;
898 }
899
900 /**
901 * Insert post rendering document style into already rendered content
902 * This is needed for extobjbase
903 *
904 * @param string style-content to insert.
905 * @return string content with inserted styles
906 */
907 function insertStylesAndJS($content) {
908 // insert accumulated CSS
909 $this->inDocStylesArray[] = $this->inDocStyles;
910 $styles = "\n".implode("\n", $this->inDocStylesArray);
911 $content = str_replace('/*###POSTCSSMARKER###*/',$styles,$content);
912
913 // insert accumulated JS
914 $jscode = $this->JScode."\n".$this->wrapScriptTags(implode("\n", $this->JScodeArray));
915 $content = str_replace('<!--###POSTJSMARKER###-->',$jscode,$content);
916
917 return $content;
918 }
919
920 /**
921 * Initialize the charset.
922 * Sets the internal $this->charset variable to the charset defined in $GLOBALS["LANG"] (or the default as set in this class)
923 * Returns the meta-tag for the document header
924 *
925 * @return string <meta> tag with charset from $this->charset or $GLOBALS['LANG']->charSet
926 */
927 function initCharset() {
928 // Set charset to the charset provided by the current backend users language selection:
929 $this->charset = $GLOBALS['LANG']->charSet ? $GLOBALS['LANG']->charSet : $this->charset;
930 // Return meta tag:
931 return '<meta http-equiv="Content-Type" content="text/html; charset='.$this->charset.'" />';
932 }
933
934 /**
935 * Returns generator meta tag
936 *
937 * @return string <meta> tag with name "GENERATOR"
938 */
939 function generator() {
940 $str = 'TYPO3 '.$GLOBALS['TYPO_VERSION'].', http://typo3.com, &#169; Kasper Sk&#229;rh&#248;j 1998-2004, extensions are copyright of their respective owners.';
941 return '<meta name="GENERATOR" content="'.$str .'" />';
942 }
943
944
945
946
947
948
949
950
951 /*****************************************
952 *
953 * OTHER ELEMENTS
954 * Tables, buttons, formatting dimmed/red strings
955 *
956 ******************************************/
957
958
959 /**
960 * Returns an image-tag with an 18x16 icon of the following types:
961 *
962 * $type:
963 * -1: OK icon (Check-mark)
964 * 1: Notice (Speach-bubble)
965 * 2: Warning (Yellow triangle)
966 * 3: Fatal error (Red stop sign)
967 *
968 * @param integer See description
969 * @return string HTML image tag (if applicable)
970 */
971 function icons($type) {
972 switch($type) {
973 case '3':
974 $icon = 'gfx/icon_fatalerror.gif';
975 break;
976 case '2':
977 $icon = 'gfx/icon_warning.gif';
978 break;
979 case '1':
980 $icon = 'gfx/icon_note.gif';
981 break;
982 case '-1':
983 $icon = 'gfx/icon_ok.gif';
984 break;
985 default:
986 break;
987 }
988 if ($icon) {
989 return '<img'.t3lib_iconWorks::skinImg($this->backPath,$icon,'width="18" height="16"').' class="absmiddle" alt="" />';
990 }
991 }
992
993 /**
994 * Returns an <input> button with the $onClick action and $label
995 *
996 * @param string The value of the onclick attribute of the input tag (submit type)
997 * @param string The label for the button (which will be htmlspecialchar'ed)
998 * @return string A <input> tag of the type "submit"
999 */
1000 function t3Button($onClick,$label) {
1001 $button = '<input type="submit" onclick="'.htmlspecialchars($onClick).'; return false;" value="'.htmlspecialchars($label).'" />';
1002 return $button;
1003 }
1004
1005 /**
1006 * dimmed-fontwrap. Returns the string wrapped in a <span>-tag defining the color to be gray/dimmed
1007 *
1008 * @param string Input string
1009 * @return string Output string
1010 */
1011 function dfw($string) {
1012 return '<span class="typo3-dimmed">'.$string.'</span>';
1013 }
1014
1015 /**
1016 * red-fontwrap. Returns the string wrapped in a <span>-tag defining the color to be red
1017 *
1018 * @param string Input string
1019 * @return string Output string
1020 */
1021 function rfw($string) {
1022 return '<span class="typo3-red">'.$string.'</span>';
1023 }
1024
1025 /**
1026 * Returns string wrapped in CDATA "tags" for XML / XHTML (wrap content of <script> and <style> sections in those!)
1027 *
1028 * @param string Input string
1029 * @return string Output string
1030 */
1031 function wrapInCData($string) {
1032 $string = '/*<![CDATA[*/'.
1033 $string.
1034 '/*]]>*/';
1035
1036 return $string;
1037 }
1038
1039 /**
1040 * Wraps the input string in script tags.
1041 * Automatic re-identing of the JS code is done by using the first line as ident reference.
1042 * This is nice for identing JS code with PHP code on the same level.
1043 *
1044 * @param string Input string
1045 * @param boolean Wrap script element in linebreaks? Default is TRUE.
1046 * @return string Output string
1047 */
1048 function wrapScriptTags($string, $linebreak=TRUE) {
1049 if(trim($string)) {
1050 // <script wrapped in nl?
1051 $cr = $linebreak? "\n" : '';
1052
1053 // remove nl from the beginning
1054 $string = preg_replace ('/^\n+/', '', $string);
1055 // re-ident to one tab using the first line as reference
1056 if(preg_match('/^(\t+)/',$string,$match)) {
1057 $string = str_replace($match[1],"\t", $string);
1058 }
1059 $string = $cr.'<script type="text/javascript">
1060 /*<![CDATA[*/
1061 '.$string.'
1062 /*]]>*/
1063 </script>'.$cr;
1064 }
1065 return trim($string);
1066 }
1067
1068 // These vars defines the layout for the table produced by the table() function.
1069 // You can override these values from outside if you like.
1070 var $tableLayout = Array (
1071 'defRow' => Array (
1072 'defCol' => Array('<td valign="top">','</td>')
1073 )
1074 );
1075 var $table_TR = '<tr>';
1076 var $table_TABLE = '<table border="0" cellspacing="0" cellpadding="0" id="typo3-tmpltable">';
1077
1078 /**
1079 * Returns a table based on the input $arr
1080 *
1081 * @param array Multidim array with first levels = rows, second levels = cells
1082 * @return string The HTML table.
1083 * @internal
1084 */
1085 function table($arr, $layout='') {
1086 if (is_array($arr)) {
1087 $tableLayout = (is_array($layout)) ? $layout : $this->tableLayout;
1088
1089 reset($arr);
1090 $code='';
1091 $rc=0;
1092 while(list(,$val)=each($arr)) {
1093 if ($rc % 2) {
1094 $layout = is_array($tableLayout['defRowOdd']) ? $tableLayout['defRowOdd'] : $tableLayout['defRow'];
1095 } else {
1096 $layout = is_array($tableLayout['defRowEven']) ? $tableLayout['defRowEven'] : $tableLayout['defRow'];
1097 }
1098 $layoutRow = is_array($tableLayout[$rc]) ? $tableLayout[$rc] : $layout;
1099 $code_td='';
1100 if (is_array($val)) {
1101 $cc=0;
1102 while(list(,$content)=each($val)) {
1103 $wrap= is_array($layoutRow[$cc]) ? $layoutRow[$cc] : (is_array($layoutRow['defCol']) ? $layoutRow['defCol'] : (is_array($layout[$cc]) ? $layout[$cc] : $layout['defCol']));
1104 $code_td.=$wrap[0].$content.$wrap[1];
1105 $cc++;
1106 }
1107 }
1108 $trWrap = is_array($layoutRow['tr']) ? $layoutRow['tr'] : (is_array($layout['tr']) ? $layout['tr'] : array($this->table_TR, '</tr>'));
1109 $code.=$trWrap[0].$code_td.$trWrap[1];
1110 $rc++;
1111 }
1112 $tableWrap = is_array($tableLayout['table']) ? $tableLayout['table'] : array($this->table_TABLE, '</table>');
1113 $code=$tableWrap[0].$code.$tableWrap[1];
1114 }
1115 return $code;
1116 }
1117
1118 /**
1119 * Constructs a table with content from the $arr1, $arr2 and $arr3.
1120 * Used in eg. ext/belog/mod/index.php - refer to that for examples
1121 *
1122 * @param array Menu elements on first level
1123 * @param array Secondary items
1124 * @param array Third-level items
1125 * @return string HTML content, <table>...</table>
1126 */
1127 function menuTable($arr1,$arr2=array(), $arr3=array()) {
1128 $rows = max(array(count($arr1),count($arr2),count($arr3)));
1129
1130 $menu='
1131 <table border="0" cellpadding="0" cellspacing="0" id="typo3-tablemenu">';
1132 for($a=0;$a<$rows;$a++) {
1133 $menu.='<tr>';
1134 $cls=array();
1135 $valign='middle';
1136 $cls[]='<td valign="'.$valign.'">'.$arr1[$a][0].'</td><td>'.$arr1[$a][1].'</td>';
1137 if (count($arr2)) {
1138 $cls[]='<td valign="'.$valign.'">'.$arr2[$a][0].'</td><td>'.$arr2[$a][1].'</td>';
1139 if (count($arr3)) {
1140 $cls[]='<td valign="'.$valign.'">'.$arr3[$a][0].'</td><td>'.$arr3[$a][1].'</td>';
1141 }
1142 }
1143 $menu.=implode($cls,'<td>&nbsp;&nbsp;</td>');
1144 $menu.='</tr>';
1145 }
1146 $menu.='
1147 </table>
1148 ';
1149 return $menu;
1150 }
1151
1152 /**
1153 * Returns a one-row/two-celled table with $content and $menu side by side.
1154 * The table is a 100% width table and each cell is aligned left / right
1155 *
1156 * @param string Content cell content (left)
1157 * @param string Menu cell content (right)
1158 * @return string HTML output
1159 */
1160 function funcMenu($content,$menu) {
1161 return '
1162 <table border="0" cellpadding="0" cellspacing="0" width="100%" id="typo3-funcmenu">
1163 <tr>
1164 <td valign="top" nowrap="nowrap">'.$content.'</td>
1165 <td valign="top" align="right" nowrap="nowrap">'.$menu.'</td>
1166 </tr>
1167 </table>';
1168 }
1169
1170 /**
1171 * Creates a selector box with clear-cache items.
1172 * Rather specialized functions - at least don't use it with $addSaveOptions unless you know what you do...
1173 *
1174 * @param integer The page uid of the "current page" - the one that will be cleared as "clear cache for this page".
1175 * @param boolean If $addSaveOptions is set, then also the array of save-options for TCE_FORMS will appear.
1176 * @return string <select> tag with content - a selector box for clearing the cache
1177 */
1178 function clearCacheMenu($id,$addSaveOptions=0) {
1179 global $BE_USER;
1180 $opt=$addOptions;
1181 if ($addSaveOptions) {
1182 $opt[]='<option value="">'.$GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:rm.menu',1).'</option>';
1183 $opt[]='<option value="TBE_EDITOR_checkAndDoSubmit(1);">'.$GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:rm.saveDoc',1).'</option>';
1184 $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>';
1185 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>';
1186 $opt[]='<option value="document.editform.closeDoc.value=2; document.editform.submit();">'.$GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:rm.closeDoc',1).'</option>';
1187 $opt[]='<option value="document.editform.closeDoc.value=3; document.editform.submit();">'.$GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:rm.closeAllDocs',1).'</option>';
1188 $opt[]='<option value=""></option>';
1189 }
1190 $opt[]='<option value="">[ '.$GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:rm.clearCache_clearCache',1).' ]</option>';
1191 if ($id) $opt[]='<option value="'.$id.'">'.$GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:rm.clearCache_thisPage',1).'</option>';
1192 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>';
1193 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>';
1194
1195 $onChange = 'if (!this.options[this.selectedIndex].value) {
1196 this.selectedIndex=0;
1197 } else if (this.options[this.selectedIndex].value.indexOf(\';\')!=-1) {
1198 eval(this.options[this.selectedIndex].value);
1199 }else{
1200 document.location=\''.$this->backPath.'tce_db.php?vC='.$BE_USER->veriCode().'&redirect='.rawurlencode(t3lib_div::getIndpEnv('REQUEST_URI')).'&cacheCmd=\'+this.options[this.selectedIndex].value;
1201 }';
1202 $af_content = '<select name="cacheCmd" onchange="'.htmlspecialchars($onChange).'">'.implode('',$opt).'</select>';
1203
1204 if (count($opt)>2) {
1205 return $af_content;
1206 }
1207 }
1208
1209 /**
1210 * Returns an array with parts (JavaScript, init-functions, <div>-layers) for use on pages which displays the clickmenu layers (context sensitive menus)
1211 *
1212 * @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
1213 */
1214 function getContextMenuCode() {
1215 if ($this->isCMlayers()) {
1216 $content='
1217 <script type="text/javascript">
1218 /*<![CDATA[*/
1219 var GLV_gap=10;
1220 var GLV_curLayerX=new Array(0,0);
1221 var GLV_curLayerY=new Array(0,0);
1222 var GLV_curLayerWidth=new Array(0,0);
1223 var GLV_curLayerHeight=new Array(0,0);
1224 var GLV_isVisible=new Array(0,0);
1225 var GLV_x=0;
1226 var GLV_y=0;
1227 var GLV_xRel=0;
1228 var GLV_yRel=0;
1229 var layerObj=new Array();
1230 var layerObjCss=new Array();
1231
1232 //browsercheck...
1233 function GL_checkBrowser(){ //
1234 this.dom= (document.getElementById);
1235 this.op= (navigator.userAgent.indexOf("Opera")>-1);
1236 this.op7= this.op && (navigator.appVersion.indexOf("7")>-1); // check for Opera version 7
1237 this.konq= (navigator.userAgent.indexOf("Konq")>-1);
1238 this.ie4= (document.all && !this.dom && !this.op && !this.konq);
1239 this.ie5= (document.all && this.dom && !this.op && !this.konq);
1240 this.ns4= (document.layers && !this.dom && !this.konq);
1241 this.ns5= (!document.all && this.dom && !this.op && !this.konq);
1242 this.ns6= (this.ns5);
1243 this.bw= (this.ie4 || this.ie5 || this.ns4 || this.ns6 || this.op || this.konq);
1244 return this;
1245 }
1246 bw= new GL_checkBrowser();
1247
1248 // GL_getObj(obj)
1249 function GL_getObj(obj){ //
1250 nest="";
1251 this.el= (bw.ie4||bw.op7)?document.all[obj]:bw.ns4?eval(nest+"document."+obj):document.getElementById(obj);
1252 this.css= bw.ns4?this.el:this.el.style;
1253 this.ref= bw.ns4?this.el.document:document;
1254 this.x= (bw.ns4||bw.op)?this.css.left:this.el.offsetLeft;
1255 this.y= (bw.ns4||bw.op)?this.css.top:this.el.offsetTop;
1256 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;
1257 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;
1258 return this;
1259 }
1260 // GL_getObjCss(obj)
1261 function GL_getObjCss(obj){ //
1262 return bw.dom? document.getElementById(obj).style:bw.ie4?document.all[obj].style:bw.ns4?document.layers[obj]:0;
1263 }
1264 // GL_getMouse(event)
1265 function GL_getMouse(event) { //
1266 if (layerObj) {
1267 // GLV_x= (bw.ns4||bw.ns5)?event.pageX:(bw.ie4||bw.op)?event.clientX:(event.clientX-2)+document.body.scrollLeft;
1268 // GLV_y= (bw.ns4||bw.ns5)?event.pageY:(bw.ie4||bw.op)?event.clientY:(event.clientY-2)+document.body.scrollTop;
1269 // 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:
1270
1271 GLV_xRel = event.clientX-2;
1272 GLV_yRel = event.clientY-2;
1273 GLV_x = GLV_xRel + (document.documentElement.scrollLeft ? document.documentElement.scrollLeft : document.body.scrollLeft);
1274 GLV_y = GLV_yRel + (document.documentElement.scrollTop ? document.documentElement.scrollTop : document.body.scrollTop);
1275
1276 // status = (GLV_x+GLV_gap-GLV_curLayerX[0]) + " | " + (GLV_y+GLV_gap-GLV_curLayerY[0]);
1277 if (GLV_isVisible[1]) {
1278 if (outsideLayer(1)) hideSpecific(1);
1279 } else if (GLV_isVisible[0]) {
1280 if (outsideLayer(0)) hideSpecific(0);
1281 }
1282 }
1283 }
1284 // outsideLayer(level)
1285 function outsideLayer(level) { //
1286 return GLV_x+GLV_gap-GLV_curLayerX[level] <0 ||
1287 GLV_y+GLV_gap-GLV_curLayerY[level] <0 ||
1288 GLV_curLayerX[level]+GLV_curLayerWidth[level]+GLV_gap-GLV_x <0 ||
1289 GLV_curLayerY[level]+GLV_curLayerHeight[level]+GLV_gap-GLV_y <0;
1290 }
1291 // setLayerObj(html,level)
1292 function setLayerObj(html,level) { //
1293 var winHeight = document.documentElement.clientHeight && !bw.op7 ? document.documentElement.clientHeight : document.body.clientHeight;
1294 var winWidth = document.documentElement.clientWidth && !bw.op7 ? document.documentElement.clientWidth : document.body.clientWidth;
1295 var tempLayerObj = GL_getObj("contentMenu"+level);
1296 var tempLayerObjCss = GL_getObjCss("contentMenu"+level);
1297
1298 if (tempLayerObj && (level==0 || GLV_isVisible[level-1])) {
1299 tempLayerObj.el.innerHTML = html;
1300 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;
1301 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;
1302
1303 // konqueror (3.2.2) workaround
1304 winHeight = (bw.konq)?window.innerHeight:winHeight;
1305 winWidth = (bw.konq)?window.innerWidth:winWidth;
1306
1307 // Adjusting the Y-height of the layer to fit it into the window frame if it goes under the window frame in the bottom:
1308 if (winHeight-tempLayerObj.height < GLV_yRel) {
1309 if (GLV_yRel < tempLayerObj.height) {
1310 GLV_y+= (winHeight-tempLayerObj.height-GLV_yRel); // Setting it so bottom is just above window height.
1311 } else {
1312 GLV_y-= tempLayerObj.height-8; // Showing the menu upwards
1313 }
1314 }
1315 // Adjusting the X position like Y above
1316 if (winWidth-tempLayerObj.width < GLV_xRel) {
1317 if (GLV_xRel < tempLayerObj.width) {
1318 GLV_x+= (winWidth-tempLayerObj.width-GLV_xRel);
1319 } else {
1320 GLV_x-= tempLayerObj.width-8;
1321 }
1322 }
1323 GLV_x = Math.max(GLV_x,1);
1324 GLV_y = Math.max(GLV_y,1);
1325
1326 GLV_curLayerX[level] = GLV_x;
1327 GLV_curLayerY[level] = GLV_y;
1328 tempLayerObjCss.left = GLV_x+"px";
1329 tempLayerObjCss.top = GLV_y+"px";
1330 tempLayerObjCss.visibility = "visible";
1331 if (bw.ie5) showHideSelectorBoxes("hidden");
1332
1333 GLV_isVisible[level]=1;
1334 GLV_curLayerWidth[level] = tempLayerObj.width;
1335 GLV_curLayerHeight[level] = tempLayerObj.height;
1336 }
1337 }
1338 // hideEmpty()
1339 function hideEmpty() { //
1340 hideSpecific(0);
1341 hideSpecific(1);
1342 return false;
1343 }
1344 // hideSpecific(level)
1345 function hideSpecific(level) { //
1346 GL_getObjCss("contentMenu"+level).visibility = "hidden";
1347 GL_getObj("contentMenu"+level).el.innerHTML = "";
1348 GLV_isVisible[level]=0;
1349
1350 if (bw.ie5 && level==0) showHideSelectorBoxes("visible");
1351 }
1352 // debugObj(obj,name)
1353 function debugObj(obj,name) { //
1354 var acc;
1355 for (i in obj) {if (obj[i]) {acc+=i+": "+obj[i]+"\n";}}
1356 alert("Object: "+name+"\n\n"+acc);
1357 }
1358 // initLayer()
1359 function initLayer(){ //
1360 if (document.all) {
1361 window.onmousemove=GL_getMouse;
1362 }
1363 layerObj = GL_getObj("contentMenu1");
1364 layerObjCss = GL_getObjCss("contentMenu1");
1365 }
1366 function showHideSelectorBoxes(action) { // This function by Michiel van Leening
1367 for (i=0;i<document.forms.length;i++) {
1368 for (j=0;j<document.forms[i].elements.length;j++) {
1369 if(document.forms[i].elements[j].type=="select-one") {
1370 document.forms[i].elements[j].style.visibility=action;
1371 }
1372 }
1373 }
1374 }
1375 /*]]>*/
1376 </script>
1377 ';
1378 return array(
1379 $content,
1380 ' onmousemove="GL_getMouse(event);" onload="initLayer();"',
1381 '<div id="contentMenu0" style="z-index:1; position:absolute;visibility:hidden"></div><div id="contentMenu1" style="z-index:2; position:absolute;visibility:hidden"></div>'
1382 );
1383 } else return array('','','');
1384 }
1385
1386
1387
1388
1389 /**
1390 * creates a tab menu from an array definition
1391 *
1392 * Returns a tab menu for a module
1393 * Requires the JS function jumpToUrl() to be available
1394 *
1395 * @param mixed $id is the "&id=" parameter value to be sent to the module, but it can be also a parameter array which will be passed instead of the &id=...
1396 * @param string $elementName it the form elements name, probably something like "SET[...]"
1397 * @param string $currentValue is the value to be selected currently.
1398 * @param array $menuItems is an array with the menu items for the selector box
1399 * @param string $script is the script to send the &id to, if empty it's automatically found
1400 * @param string $addParams is additional parameters to pass to the script.
1401 * @return string HTML code for tab menu
1402 * @author René Fritz <r.fritz@colorcube.de>
1403 */
1404 function getTabMenu($mainParams,$elementName,$currentValue,$menuItems,$script='',$addparams='') {
1405 $content='';
1406
1407 if (is_array($menuItems)) {
1408 if (!is_array($mainParams)) {
1409 $mainParams = array('id' => $mainParams);
1410 }
1411 $mainParams = t3lib_div::implodeArrayForUrl('',$mainParams);
1412
1413 if (!$script) {$script=basename(PATH_thisScript);}
1414
1415 $menuDef = array();
1416 foreach($menuItems as $value => $label) {
1417 $menuDef[$value]['isActive'] = !strcmp($currentValue,$value);
1418 $menuDef[$value]['label'] = t3lib_div::deHSCentities(htmlspecialchars($label));
1419 $menuDef[$value]['url'] = htmlspecialchars($script.'?'.$mainParams.$addparams.'&'.$elementName.'='.$value);
1420 }
1421 $content = $this->getTabMenuRaw($menuDef);
1422
1423 }
1424 return $content;
1425 }
1426
1427 function getTabMenuRaw($menuItems) {
1428 $content='';
1429
1430 if (is_array($menuItems)) {
1431 $options='';
1432
1433 $count = count($menuItems);
1434 $widthLeft = 1;
1435 $addToAct = 5;
1436
1437 $widthRight = max (1,floor(30-pow($count,1.72)));
1438 $widthTabs = 100 - $widthRight - $widthLeft;
1439 $widthNo = floor(($widthTabs - $addToAct)/$count);
1440 $addToAct = max ($addToAct,$widthTabs-($widthNo*$count));
1441 $widthAct = $widthNo + $addToAct;
1442 $widthRight = 100 - ($widthLeft + ($count*$widthNo) + $addToAct);
1443
1444 $first=true;
1445 foreach($menuItems as $id => $def) {
1446 $isActive = $def['isActive'];
1447 $class = $isActive ? 'tabact' : 'tab';
1448 $width = $isActive ? $widthAct : $widthNo;
1449
1450 $label = $def['label'];
1451 $url = $def['url'];
1452 $params = $def['addParams'];
1453
1454 if($first) {
1455 $options.= '
1456 <td width="'.$width.'%" class="'.$class.'" style="border-left: solid #000 1px;"><a href="'.$url.'" style="padding-left:5px;padding-right:2px;" '.$params.'>'.$label.'</a></td>';
1457 } else {
1458 $options.='
1459 <td width="'.$width.'%" class="'.$class.'"><a href="'.$url.'" '.$params.'>'.$label.'</a></td>';
1460 }
1461 $first=false;
1462 }
1463
1464 if ($options) {
1465 $content .= '
1466 <!-- Tab menu -->
1467 <table cellpadding="0" cellspacing="0" border="0" width="100%" id="typo3-tabmenu">
1468 <tr>
1469 <td width="'.$widthLeft.'%">&nbsp;</td>
1470 '.$options.'
1471 <td width="'.$widthRight.'%">&nbsp;</td>
1472 </tr>
1473 </table>
1474 <div class="hr" style="margin:0px"></div>';
1475 }
1476
1477 }
1478 return $content;
1479 }
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 ?>