Fixed bug #12188: Double display of flashmessages
[Packages/TYPO3.CMS.git] / typo3 / template.php
1 <?php
2 /***************************************************************
3 * Copyright notice
4 *
5 * (c) 1999-2009 Kasper Skaarhoj (kasperYYYY@typo3.com)
6 * All rights reserved
7 *
8 * This script is part of the TYPO3 project. The TYPO3 project is
9 * free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
13 *
14 * The GNU General Public License can be found at
15 * http://www.gnu.org/copyleft/gpl.html.
16 * A copy is found in the textfile GPL.txt and important notices to the license
17 * from the author is found in LICENSE.txt distributed with these scripts.
18 *
19 *
20 * This script is distributed in the hope that it will be useful,
21 * but WITHOUT ANY WARRANTY; without even the implied warranty of
22 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23 * GNU General Public License for more details.
24 *
25 * This copyright notice MUST APPEAR in all copies of the script!
26 ***************************************************************/
27 /**
28 * 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 <kasperYYYY@typo3.com>
35 */
36 /**
37 * [CLASS/FUNCTION INDEX of SCRIPT]
38 *
39 * 145: function fw($str)
40 *
41 *
42 * 169: class template
43 * 224: function template()
44 *
45 * SECTION: EVALUATION FUNCTIONS
46 * 298: function wrapClickMenuOnIcon($str,$table,$uid='',$listFr=1,$addParams='',$enDisItems='', $returnOnClick=FALSE)
47 * 315: function viewPageIcon($id,$backPath,$addParams='hspace="3"')
48 * 341: function issueCommand($params,$rUrl='')
49 * 356: function isCMlayers()
50 * 366: function thisBlur()
51 * 376: function helpStyle()
52 * 393: function getHeader($table,$row,$path,$noViewPageIcon=0,$tWrap=array('',''))
53 * 419: function getFileheader($title,$path,$iconfile)
54 * 434: function makeShortcutIcon($gvList,$setList,$modName,$motherModName="")
55 * 467: function makeShortcutUrl($gvList,$setList)
56 * 488: function formWidth($size=48,$textarea=0,$styleOverride='')
57 * 513: function formWidthText($size=48,$styleOverride='',$wrap='')
58 * 530: function redirectUrls($thisLocation='')
59 * 554: function formatTime($tstamp,$type)
60 * 571: function parseTime()
61 *
62 * SECTION: PAGE BUILDING FUNCTIONS.
63 * 604: function startPage($title)
64 * 686: function endPage()
65 * 720: function header($text)
66 * 741: function section($label,$text,$nostrtoupper=FALSE,$sH=FALSE,$type=0,$allowHTMLinHeader=FALSE)
67 * 765: function divider($dist)
68 * 781: function spacer($dist)
69 * 800: function sectionHeader($label,$sH=FALSE,$addAttrib='')
70 * 817: function sectionBegin()
71 * 838: function sectionEnd()
72 * 858: function middle()
73 * 867: function endPageJS()
74 * 884: function docBodyTagBegin()
75 * 894: function docStyle()
76 * 936: function insertStylesAndJS($content)
77 * 956: function initCharset()
78 * 968: function generator()
79 *
80 * SECTION: OTHER ELEMENTS
81 * 1001: function icons($type, $styleAttribValue='')
82 * 1030: function t3Button($onClick,$label)
83 * 1041: function dfw($string)
84 * 1051: function rfw($string)
85 * 1061: function wrapInCData($string)
86 * 1078: function wrapScriptTags($string, $linebreak=TRUE)
87 * 1117: function table($arr, $layout='')
88 * 1159: function menuTable($arr1,$arr2=array(), $arr3=array())
89 * 1192: function funcMenu($content,$menu)
90 * 1210: function clearCacheMenu($id,$addSaveOptions=0)
91 * 1246: function getContextMenuCode()
92 * 1251: function showClickmenu(table, uid, listFr, enDisItems, backPath, addParams)
93 * 1280: function showClickmenu_noajax(url)
94 * 1287: function showClickmenu_ajax(t3ajax)
95 * 1472: function getDragDropCode($table)
96 * 1483: function cancelDragEvent(event)
97 * 1496: function mouseMoveEvent (event)
98 * 1509: function dragElement(id,elementID)
99 * 1528: function dropElement(id)
100 * 1577: function getTabMenu($mainParams,$elementName,$currentValue,$menuItems,$script='',$addparams='')
101 * 1607: function getTabMenuRaw($menuItems)
102 * 1676: function getDynTabMenu($menuItems,$identString,$toggle=0,$foldout=FALSE,$newRowCharLimit=50,$noWrap=1,$fullWidth=FALSE,$defaultTabIndex=1)
103 * 1801: function getDynTabMenuJScode()
104 * 1892: function getVersionSelector($id,$noAction=FALSE)
105 *
106 *
107 * 2060: class bigDoc extends template
108 *
109 *
110 * 2069: class noDoc extends template
111 *
112 *
113 * 2078: class smallDoc extends template
114 *
115 *
116 * 2087: class mediumDoc extends template
117 *
118 * TOTAL FUNCTIONS: 57
119 * (This index is automatically created/updated by the extension "extdeveval")
120 *
121 */
122
123
124
125 if (!defined('TYPO3_MODE')) die("Can't include this file directly.");
126
127
128 /**
129 * Deprecated fontwrap function. Is just transparent now.
130 *
131 * @param string Input string
132 * @return string Output string (in the old days this was wrapped in <font> tags)
133 * @deprecated since TYPO3 3.6
134 */
135 function fw($str) {
136 return $str;
137 }
138
139
140 /**
141 * TYPO3 Backend Template Class
142 *
143 * This class contains functions for starting and ending the HTML of backend modules
144 * It also contains methods for outputting sections of content.
145 * Further there are functions for making icons, links, setting form-field widths etc.
146 * Color scheme and stylesheet definitions are also available here.
147 * Finally this file includes the language class for TYPO3's backend.
148 *
149 * After this file $LANG and $TBE_TEMPLATE are global variables / instances of their respective classes.
150 * This file is typically included right after the init.php file,
151 * if language and layout is needed.
152 *
153 * Please refer to Inside TYPO3 for a discussion of how to use this API.
154 *
155 * @author Kasper Skaarhoj <kasperYYYY@typo3.com>
156 * @package TYPO3
157 * @subpackage core
158 */
159 class template {
160
161 // Vars you typically might want to/should set from outside after making instance of this class:
162 var $backPath = ''; // 'backPath' pointing back to the PATH_typo3
163 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.
164 var $JScodeLibArray = array(); // Similar to $JScode (see below) but used as an associative array to prevent double inclusion of JS code. This is used to include certain external Javascript libraries before the inline JS code. <script>-Tags are not wrapped around automatically
165 var $JScode=''; // Additional header code (eg. a JavaScript section) could be accommulated in this var. It will be directly outputted in the header.
166 var $extJScode = ''; // Additional header code for ExtJS. It will be included in document header and inserted in a Ext.onReady(function()
167 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.
168 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.
169 var $docType = ''; // Doc-type used in the header. Default is xhtml_trans. You can also set it to 'html_3', 'xhtml_strict' or 'xhtml_frames'.
170 var $moduleTemplate = ''; // HTML template with markers for module
171
172 // Other vars you can change, but less frequently used:
173 var $scriptID=''; // Script ID.
174 var $bodyTagId=''; // Id which can be set for the body tag. Default value is based on script ID
175 var $bodyTagAdditions=''; // You can add additional attributes to the body-tag through this variable.
176 var $inDocStyles=''; // Additional CSS styles which will be added to the <style> section in the header
177 var $inDocStylesArray=array(); // Like $inDocStyles but for use as array with associative keys to prevent double inclusion of css code
178 var $form_rowsToStylewidth = 9.58; // Multiplication factor for formWidth() input size (default is 48* this value).
179 var $form_largeComp = 1.33; // Compensation for large documents (used in class.t3lib_tceforms.php)
180 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.
181 protected $additionalStyleSheets=array(); // Links to additional style sheets
182
183 // TYPO3 Colorscheme.
184 // If you want to change this, please do so through a skin using the global var $TBE_STYLES
185 var $bgColor = '#F7F3EF'; // Light background color
186 var $bgColor2 = '#9BA1A8'; // Steel-blue
187 var $bgColor3 = '#F6F2E6'; // dok.color
188 var $bgColor4 = '#D9D5C9'; // light tablerow background, brownish
189 var $bgColor5 = '#ABBBB4'; // light tablerow background, greenish
190 var $bgColor6 = '#E7DBA8'; // light tablerow background, yellowish, for section headers. Light.
191 var $hoverColor = '#254D7B';
192 var $styleSheetFile = 'stylesheet.css'; // Filename of stylesheet (relative to PATH_typo3)
193 var $styleSheetFile2 = ''; // Filename of stylesheet #2 - linked to right after the $this->styleSheetFile script (relative to PATH_typo3)
194 var $styleSheetFile_post = ''; // Filename of a post-stylesheet - included right after all inline styles.
195 var $backGroundImage = ''; // Background image of page (relative to PATH_typo3)
196 var $inDocStyles_TBEstyle = ''; // Inline css styling set from TBE_STYLES array
197
198 // DEV:
199 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.
200
201 // INTERNAL
202 var $charset = 'iso-8859-1'; // Default charset. see function initCharset()
203
204 var $sectionFlag=0; // Internal: Indicates if a <div>-output section is open
205 var $divClass = ''; // (Default) Class for wrapping <DIV>-tag of page. Is set in class extensions.
206
207 var $pageHeaderBlock = '';
208 var $endOfPageJsBlock = '';
209
210 var $hasDocheader = true;
211
212 /**
213 * @var t3lib_PageRenderer
214 */
215 protected $pageRenderer;
216 protected $pageHeaderFooterTemplateFile = ''; // alternative template file
217
218 /**
219 * Whether flashmessages should be rendered or not
220 *
221 * @var $showFlashMessages
222 */
223 public $showFlashMessages = TRUE;
224
225 /**
226 * Constructor
227 * Imports relevant parts from global $TBE_STYLES (colorscheme)
228 *
229 * @return void
230 */
231 function template() {
232 global $TBE_STYLES;
233
234 // Initializes the page rendering object:
235 $this->getPageRenderer();
236
237 // Setting default scriptID:
238 if (($temp_M = (string) t3lib_div::_GET('M')) && $GLOBALS['TBE_MODULES']['_PATHS'][$temp_M]) {
239 $this->scriptID = preg_replace('/^.*\/(sysext|ext)\//', 'ext/', $GLOBALS['TBE_MODULES']['_PATHS'][$temp_M] . 'index.php');
240 } else {
241 $this->scriptID = preg_replace('/^.*\/(sysext|ext)\//', 'ext/', substr(PATH_thisScript, strlen(PATH_site)));
242 }
243 if (TYPO3_mainDir!='typo3/' && substr($this->scriptID,0,strlen(TYPO3_mainDir)) == TYPO3_mainDir) {
244 $this->scriptID = 'typo3/'.substr($this->scriptID,strlen(TYPO3_mainDir)); // This fixes if TYPO3_mainDir has been changed so the script ids are STILL "typo3/..."
245 }
246
247 $this->bodyTagId = preg_replace('/[^A-Za-z0-9-]/','-',$this->scriptID);
248
249 // Individual configuration per script? If so, make a recursive merge of the arrays:
250 if (is_array($TBE_STYLES['scriptIDindex'][$this->scriptID])) {
251 $ovr = $TBE_STYLES['scriptIDindex'][$this->scriptID]; // Make copy
252 $TBE_STYLES = t3lib_div::array_merge_recursive_overrule($TBE_STYLES,$ovr); // merge styles.
253 unset($TBE_STYLES['scriptIDindex'][$this->scriptID]); // Have to unset - otherwise the second instantiation will do it again!
254 }
255
256 // Color scheme:
257 if ($TBE_STYLES['mainColors']['bgColor']) $this->bgColor=$TBE_STYLES['mainColors']['bgColor'];
258 if ($TBE_STYLES['mainColors']['bgColor1']) $this->bgColor1=$TBE_STYLES['mainColors']['bgColor1'];
259 if ($TBE_STYLES['mainColors']['bgColor2']) $this->bgColor2=$TBE_STYLES['mainColors']['bgColor2'];
260 if ($TBE_STYLES['mainColors']['bgColor3']) $this->bgColor3=$TBE_STYLES['mainColors']['bgColor3'];
261 if ($TBE_STYLES['mainColors']['bgColor4']) $this->bgColor4=$TBE_STYLES['mainColors']['bgColor4'];
262 if ($TBE_STYLES['mainColors']['bgColor5']) $this->bgColor5=$TBE_STYLES['mainColors']['bgColor5'];
263 if ($TBE_STYLES['mainColors']['bgColor6']) $this->bgColor6=$TBE_STYLES['mainColors']['bgColor6'];
264 if ($TBE_STYLES['mainColors']['hoverColor']) $this->hoverColor=$TBE_STYLES['mainColors']['hoverColor'];
265
266 // Main Stylesheets:
267 if ($TBE_STYLES['stylesheet']) $this->styleSheetFile = $TBE_STYLES['stylesheet'];
268 if ($TBE_STYLES['stylesheet2']) $this->styleSheetFile2 = $TBE_STYLES['stylesheet2'];
269 if ($TBE_STYLES['styleSheetFile_post']) $this->styleSheetFile_post = $TBE_STYLES['styleSheetFile_post'];
270 if ($TBE_STYLES['inDocStyles_TBEstyle']) $this->inDocStyles_TBEstyle = $TBE_STYLES['inDocStyles_TBEstyle'];
271
272 // Background image
273 if ($TBE_STYLES['background']) $this->backGroundImage = $TBE_STYLES['background'];
274 }
275
276
277 /**
278 * Gets instance of PageRenderer
279 *
280 * @return t3lib_PageRenderer
281 */
282 public function getPageRenderer() {
283 if (!isset($this->pageRenderer)) {
284 $this->pageRenderer = t3lib_div::makeInstance('t3lib_PageRenderer');
285 $this->pageRenderer->setTemplateFile(
286 TYPO3_mainDir . 'templates/template_page_backend.html'
287 );
288 }
289 return $this->pageRenderer;
290 }
291
292
293
294
295
296
297
298
299
300
301
302
303
304 /*****************************************
305 *
306 * EVALUATION FUNCTIONS
307 * Various centralized processing
308 *
309 *****************************************/
310
311 /**
312 * Makes click menu link (context sensitive menu)
313 * 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)
314 * 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)
315 *
316 * @param string String to be wrapped in link, typ. image tag.
317 * @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
318 * @param integer If icon is for database record this is the UID for the record from $table
319 * @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.
320 * @param string Additional GET parameters for the link to alt_clickmenu.php
321 * @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.
322 * @param boolean If set, will return only the onclick JavaScript, not the whole link.
323 * @return string The link-wrapped input string.
324 */
325 function wrapClickMenuOnIcon($str,$table,$uid='',$listFr=1,$addParams='',$enDisItems='', $returnOnClick=FALSE) {
326 $backPath = rawurlencode($this->backPath).'|'.t3lib_div::shortMD5($this->backPath.'|'.$GLOBALS['TYPO3_CONF_VARS']['SYS']['encryptionKey']);
327 $onClick = 'showClickmenu("'.$table.'","'.$uid.'","'.$listFr.'","'.str_replace('+','%2B',$enDisItems).'","'.str_replace('&','&amp;',addcslashes($backPath,'"')).'","'.str_replace('&','&amp;',addcslashes($addParams,'"')).'");return false;';
328 return $returnOnClick ? $onClick : '<a href="#" onclick="'.htmlspecialchars($onClick).'"'.($GLOBALS['TYPO3_CONF_VARS']['BE']['useOnContextMenuHandler'] ? ' oncontextmenu="'.htmlspecialchars($onClick).'"' : '').'>'.$str.'</a>';
329 }
330
331 /**
332 * Makes link to page $id in frontend (view page)
333 * Returns an magnifier-glass icon which links to the frontend index.php document for viewing the page with id $id
334 * $id must be a page-uid
335 * If the BE_USER has access to Web>List then a link to that module is shown as well (with return-url)
336 *
337 * @param integer The page id
338 * @param string The current "BACK_PATH" (the back relative to the typo3/ directory)
339 * @param string Additional parameters for the image tag(s)
340 * @return string HTML string with linked icon(s)
341 */
342 function viewPageIcon($id,$backPath,$addParams='hspace="3"') {
343 global $BE_USER;
344 $str = '';
345 // If access to Web>List for user, then link to that module.
346 if ($BE_USER->check('modules','web_list')) {
347 $href=$backPath.'db_list.php?id='.$id.'&returnUrl='.rawurlencode(t3lib_div::getIndpEnv('REQUEST_URI'));
348 $str.= '<a href="'.htmlspecialchars($href).'">'.
349 '<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="" />'.
350 '</a>';
351 }
352 // Make link to view page
353 $str.= '<a href="#" onclick="'.htmlspecialchars(t3lib_BEfunc::viewOnClick($id,$backPath,t3lib_BEfunc::BEgetRootLine($id))).'">'.
354 '<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="" />'.
355 '</a>';
356 return $str;
357 }
358
359 /**
360 * Returns a URL with a command to TYPO3 Core Engine (tce_db.php)
361 * See description of the API elsewhere.
362 *
363 * @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"
364 * @param string Redirect URL if any other that t3lib_div::getIndpEnv('REQUEST_URI') is wished
365 * @return string URL to tce_db.php + parameters (backpath is taken from $this->backPath)
366 * @see t3lib_BEfunc::editOnClick()
367 */
368 function issueCommand($params,$rUrl='') {
369 $rUrl = $rUrl ? $rUrl : t3lib_div::getIndpEnv('REQUEST_URI');
370 return $this->backPath.'tce_db.php?'.
371 $params.
372 '&redirect='.($rUrl==-1?"'+T3_THIS_LOCATION+'":rawurlencode($rUrl)).
373 '&vC='.rawurlencode($GLOBALS['BE_USER']->veriCode()).
374 '&prErr=1&uPT=1';
375 }
376
377 /**
378 * Returns true if click-menu layers can be displayed for the current user/browser
379 * Use this to test if click-menus (context sensitive menus) can and should be displayed in the backend.
380 *
381 * @return boolean
382 */
383 function isCMlayers() {
384 return !$GLOBALS['BE_USER']->uc['disableCMlayers'] && $GLOBALS['CLIENT']['FORMSTYLE'] && !($GLOBALS['CLIENT']['SYSTEM']=='mac' && $GLOBALS['CLIENT']['BROWSER']=='Opera');
385 }
386
387 /**
388 * Returns 'this.blur();' if the client supports CSS styles
389 * Use this in links to remove the underlining after being clicked
390 *
391 * @return string
392 */
393 function thisBlur() {
394 return ($GLOBALS['CLIENT']['FORMSTYLE']?'this.blur();':'');
395 }
396
397 /**
398 * Returns ' style='cursor:help;'' if the client supports CSS styles
399 * Use for <a>-links to help texts
400 *
401 * @return string
402 */
403 function helpStyle() {
404 return $GLOBALS['CLIENT']['FORMSTYLE'] ? ' style="cursor:help;"':'';
405 }
406
407 /**
408 * Makes the header (icon+title) for a page (or other record). Used in most modules under Web>*
409 * $table and $row must be a tablename/record from that table
410 * $path will be shown as alt-text for the icon.
411 * The title will be truncated to 45 chars.
412 *
413 * @param string Table name
414 * @param array Record row
415 * @param string Alt text
416 * @param boolean Set $noViewPageIcon true if you don't want a magnifier-icon for viewing the page in the frontend
417 * @param array $tWrap is an array with indexes 0 and 1 each representing HTML-tags (start/end) which will wrap the title
418 * @return string HTML content
419 */
420 function getHeader($table,$row,$path,$noViewPageIcon=0,$tWrap=array('','')) {
421 global $TCA;
422 if (is_array($row) && $row['uid']) {
423 $iconImgTag=t3lib_iconWorks::getIconImage($table,$row,$this->backPath,'title="'.htmlspecialchars($path).'"');
424 $title= strip_tags($row[$TCA[$table]['ctrl']['label']]);
425 $viewPage = $noViewPageIcon ? '' : $this->viewPageIcon($row['uid'],$this->backPath,'');
426 if ($table=='pages') $path.=' - '.t3lib_BEfunc::titleAttribForPages($row,'',0);
427 } else {
428 $iconImgTag='<img'.t3lib_iconWorks::skinImg($this->backPath,'gfx/i/_icon_website.gif',$wHattribs='width="18" height="16"').' title="'.htmlspecialchars($path).'" alt="" />';
429 $title=$GLOBALS['TYPO3_CONF_VARS']['SYS']['sitename'];
430 }
431
432 return '<span class="typo3-moduleHeader">'.$this->wrapClickMenuOnIcon($iconImgTag,$table,$row['uid']).
433 $viewPage.
434 $tWrap[0].htmlspecialchars(t3lib_div::fixed_lgd_cs($title,45)).$tWrap[1].'</span>';
435 }
436
437 /**
438 * Like ->getHeader() but for files in the File>* main module/submodules
439 * Returns the file-icon with the path of the file set in the alt/title attribute. Shows the file-name after the icon.
440 *
441 * @param string Title string, expected to be the filepath
442 * @param string Alt text
443 * @param string The icon file (relative to TYPO3 dir)
444 * @return string HTML content
445 */
446 function getFileheader($title,$path,$iconfile) {
447 $fileInfo = t3lib_div::split_fileref($title);
448 $title = htmlspecialchars(t3lib_div::fixed_lgd_cs($fileInfo['path'],-35)).'<b>'.htmlspecialchars($fileInfo['file']).'</b>';
449 return '<span class="typo3-moduleHeader"><img'.t3lib_iconWorks::skinImg($this->backPath,$iconfile,'width="18" height="16"').' title="'.htmlspecialchars($path).'" alt="" />'.$title.'</span>';
450 }
451
452 /**
453 * Returns a linked shortcut-icon which will call the shortcut frame and set a shortcut there back to the calling page/module
454 *
455 * @param string Is the list of GET variables to store (if any)
456 * @param string Is the list of SET[] variables to store (if any) - SET[] variables a stored in $GLOBALS["SOBE"]->MOD_SETTINGS for backend modules
457 * @param string Module name string
458 * @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.
459 * @return string HTML content
460 */
461 function makeShortcutIcon($gvList,$setList,$modName,$motherModName="") {
462 $backPath=$this->backPath;
463 $storeUrl=$this->makeShortcutUrl($gvList,$setList);
464 $pathInfo = parse_url(t3lib_div::getIndpEnv('REQUEST_URI'));
465
466 // Add the module identifier automatically if typo3/mod.php is used:
467 if (preg_match('/typo3\/mod\.php$/', $pathInfo['path']) && isset($GLOBALS['TBE_MODULES']['_PATHS'][$modName])) {
468 $storeUrl = '&M='.$modName.$storeUrl;
469 }
470
471 if (!strcmp($motherModName,'1')) {
472 $mMN="&motherModName='+top.currentModuleLoaded+'";
473 } elseif ($motherModName) {
474 $mMN='&motherModName='.rawurlencode($motherModName);
475 } else $mMN='';
476
477 $onClick = 'top.ShortcutManager.createShortcut('
478 .$GLOBALS['LANG']->JScharCode($GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:labels.makeShortcut')).', '
479 .'\''.$backPath.'\', '
480 .'\''.rawurlencode($modName).'\', '
481 .'\''.rawurlencode($pathInfo['path']."?".$storeUrl).$mMN.'\''
482 .');return false;';
483
484 $sIcon = '<a href="#" onclick="'.htmlspecialchars($onClick).'"><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>';
485 return $sIcon;
486 }
487
488 /**
489 * MAKE url for storing
490 * Internal func
491 *
492 * @param string Is the list of GET variables to store (if any)
493 * @param string Is the list of SET[] variables to store (if any) - SET[] variables a stored in $GLOBALS["SOBE"]->MOD_SETTINGS for backend modules
494 * @return string
495 * @access private
496 * @see makeShortcutIcon()
497 */
498 function makeShortcutUrl($gvList,$setList) {
499 $GET = t3lib_div::_GET();
500 $storeArray = array_merge(
501 t3lib_div::compileSelectedGetVarsFromArray($gvList,$GET),
502 array('SET'=>t3lib_div::compileSelectedGetVarsFromArray($setList, (array)$GLOBALS['SOBE']->MOD_SETTINGS))
503 );
504 $storeUrl = t3lib_div::implodeArrayForUrl('',$storeArray);
505 return $storeUrl;
506 }
507
508 /**
509 * Returns <input> attributes to set the width of an text-type input field.
510 * For client browsers with no CSS support the cols/size attribute is returned.
511 * For CSS compliant browsers (recommended) a ' style="width: ...px;"' is returned.
512 *
513 * @param integer A relative number which multiplied with approx. 10 will lead to the width in pixels
514 * @param boolean A flag you can set for textareas - DEPRECATED, use ->formWidthText() for textareas!!!
515 * @param string A string which will be returned as attribute-value for style="" instead of the calculated width (if CSS is enabled)
516 * @return string Tag attributes for an <input> tag (regarding width)
517 * @see formWidthText()
518 */
519 function formWidth($size=48,$textarea=0,$styleOverride='') {
520 $wAttrib = $textarea?'cols':'size';
521 if (!$GLOBALS['CLIENT']['FORMSTYLE']) { // If not setting the width by style-attribute
522 $size = $size;
523 $retVal = ' '.$wAttrib.'="'.$size.'"';
524 } else { // Setting width by style-attribute. 'cols' MUST be avoided with NN6+
525 $pixels = ceil($size*$this->form_rowsToStylewidth);
526 $retVal = $styleOverride ? ' style="'.$styleOverride.'"' : ' style="width:'.$pixels.'px;"';
527 }
528 return $retVal;
529 }
530
531 /**
532 * This function is dedicated to textareas, which has the wrapping on/off option to observe.
533 * EXAMPLE:
534 * <textarea rows="10" wrap="off" '.$GLOBALS["TBE_TEMPLATE"]->formWidthText(48,"","off").'>
535 * or
536 * <textarea rows="10" wrap="virtual" '.$GLOBALS["TBE_TEMPLATE"]->formWidthText(48,"","virtual").'>
537 *
538 * @param integer A relative number which multiplied with approx. 10 will lead to the width in pixels
539 * @param string A string which will be returned as attribute-value for style="" instead of the calculated width (if CSS is enabled)
540 * @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.
541 * @return string Tag attributes for an <input> tag (regarding width)
542 * @see formWidth()
543 */
544 function formWidthText($size=48,$styleOverride='',$wrap='') {
545 $wTags = $this->formWidth($size,1,$styleOverride);
546 // 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...
547 if (strtolower(trim($wrap))!='off' && $GLOBALS['CLIENT']['BROWSER']=='net' && $GLOBALS['CLIENT']['VERSION']>=5) {
548 $wTags.=' cols="'.$size.'"';
549 }
550 return $wTags;
551 }
552
553 /**
554 * Returns JavaScript variables setting the returnUrl and thisScript location for use by JavaScript on the page.
555 * Used in fx. db_list.php (Web>List)
556 *
557 * @param string URL to "this location" / current script
558 * @return string
559 * @see typo3/db_list.php
560 */
561 function redirectUrls($thisLocation='') {
562 $thisLocation = $thisLocation?$thisLocation:t3lib_div::linkThisScript(
563 array(
564 'CB'=>'',
565 'SET'=>'',
566 'cmd' => '',
567 'popViewId'=>''
568 ));
569
570 $out ="
571 var T3_RETURN_URL = '".str_replace('%20','',rawurlencode(t3lib_div::_GP('returnUrl')))."';
572 var T3_THIS_LOCATION = '".str_replace('%20','',rawurlencode($thisLocation))."';
573 ";
574 return $out;
575 }
576
577 /**
578 * Returns a formatted string of $tstamp
579 * Uses $GLOBALS['TYPO3_CONF_VARS']['SYS']['hhmm'] and $GLOBALS['TYPO3_CONF_VARS']['SYS']['ddmmyy'] to format date and time
580 *
581 * @param integer UNIX timestamp, seconds since 1970
582 * @param integer How much data to show: $type = 1: hhmm, $type = 10: ddmmmyy
583 * @return string Formatted timestamp
584 */
585 function formatTime($tstamp,$type) {
586 $dateStr = '';
587 switch($type) {
588 case 1: $dateStr = date($GLOBALS['TYPO3_CONF_VARS']['SYS']['hhmm'],$tstamp);
589 break;
590 case 10: $dateStr = date($GLOBALS['TYPO3_CONF_VARS']['SYS']['ddmmyy'],$tstamp);
591 break;
592 }
593 return $dateStr;
594 }
595
596 /**
597 * Returns script parsetime IF ->parseTimeFlag is set and user is "admin"
598 * Automatically outputted in page end
599 *
600 * @return string
601 */
602 function parseTime() {
603 if ($this->parseTimeFlag && $GLOBALS['BE_USER']->isAdmin()) {
604 return '<p>(ParseTime: '.(t3lib_div::milliseconds()-$GLOBALS['PARSETIME_START']).' ms</p>
605 <p>REQUEST_URI-length: '.strlen(t3lib_div::getIndpEnv('REQUEST_URI')).')</p>';
606 }
607 }
608
609
610
611
612
613
614
615
616
617
618
619
620 /*****************************************
621 *
622 * PAGE BUILDING FUNCTIONS.
623 * Use this to build the HTML of your backend modules
624 *
625 *****************************************/
626
627 /**
628 * Returns page start
629 * This includes the proper header with charset, title, meta tag and beginning body-tag.
630 *
631 * @param string HTML Page title for the header
632 * @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)
633 * @see endPage()
634 */
635 function startPage($title) {
636 // hook pre start page
637 if (isset($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['typo3/template.php']['preStartPageHook'])) {
638 $preStartPageHook =& $GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['typo3/template.php']['preStartPageHook'];
639 if (is_array($preStartPageHook)) {
640 $hookParameters = array(
641 'title' => &$title,
642 );
643 foreach ($preStartPageHook as $hookFunction) {
644 t3lib_div::callUserFunction($hookFunction, $hookParameters, $this);
645 }
646 }
647 }
648
649 $this->pageRenderer->backPath = $this->backPath;
650
651 // alternative template for Header and Footer
652 if ($this->pageHeaderFooterTemplateFile) {
653 $file = t3lib_div::getFileAbsFileName($this->pageHeaderFooterTemplateFile, TRUE);
654 if ($file) {
655 $this->pageRenderer->setTemplateFile($file);
656 }
657 }
658 // For debugging: If this outputs "QuirksMode"/"BackCompat" (IE) the browser runs in quirks-mode. Otherwise the value is "CSS1Compat"
659 # $this->JScodeArray[]='alert(document.compatMode);';
660
661 // Send HTTP header for selected charset. Added by Robert Lemke 23.10.2003
662 $this->initCharset();
663 header ('Content-Type:text/html;charset='.$this->charset);
664
665 // Standard HTML tag
666 $this->pageRenderer->setHtmlTag('<html xmlns="http://www.w3.org/1999/xhtml">');
667
668 switch($this->docType) {
669 case 'html_3':
670 $headerStart = '<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">';
671 $htmlTag = '<html>';
672 break;
673 case 'xhtml_strict':
674 $headerStart = '<!DOCTYPE html
675 PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
676 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">';
677 break;
678 case 'xhtml_frames':
679 $headerStart = '<!DOCTYPE html
680 PUBLIC "-//W3C//DTD XHTML 1.0 Frameset//EN"
681 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd">';
682 break;
683 // The fallthrough is intended as XHTML 1.0 transitional is the default for the BE.
684 case 'xhtml_trans':
685 default:
686 $headerStart = '<!DOCTYPE html
687 PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
688 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">';
689 }
690
691 // This loads the tabulator-in-textarea feature. It automatically modifies
692 // every textarea which is found.
693 if (!$GLOBALS['BE_USER']->uc['disableTabInTextarea']) {
694 $this->loadJavascriptLib('tab.js');
695 }
696
697 // Get the browser info
698 $browserInfo = t3lib_utility_Client::getBrowserInfo(t3lib_div::getIndpEnv('HTTP_USER_AGENT'));
699
700 // Set the XML prologue
701 $xmlPrologue = '<?xml version="1.0" encoding="' . $this->charset . '"?>';
702
703 // Set the XML stylesheet
704 $xmlStylesheet = '<?xml-stylesheet href="#internalStyle" type="text/css"?>';
705
706 // Add the XML prologue for XHTML doctypes
707 if ($this->docType !== 'html_3') {
708 // Put the XML prologue before or after the doctype declaration according to browser
709 if ($browserInfo['browser'] === 'msie' && $browserInfo['version'] < 7) {
710 $headerStart = $headerStart . chr(10) . $xmlPrologue;
711 } else {
712 $headerStart = $xmlPrologue . chr(10) . $headerStart;
713 }
714
715 // Add the xml stylesheet according to doctype
716 if ($this->docType !== 'xhtml_frames') {
717 $headerStart = $headerStart . chr(10) . $xmlStylesheet;
718 }
719 }
720
721 $this->pageRenderer->setXmlPrologAndDocType($headerStart);
722 $this->pageRenderer->setHeadTag('<head>' . chr(10). '<!-- TYPO3 Script ID: '.htmlspecialchars($this->scriptID).' -->');
723 $this->pageRenderer->setCharSet($this->charset);
724 $this->pageRenderer->addMetaTag($this->generator());
725 $this->pageRenderer->setTitle($title);
726
727 // add docstyles
728 $this->docStyle();
729
730
731 // add jsCode - has to go to headerData as it may contain the script tags already
732 $this->pageRenderer->addHeaderData($this->JScode);
733
734 foreach ($this->JScodeArray as $name => $code) {
735 $this->pageRenderer->addJsInlineCode($name, $code);
736 }
737
738 if (count($this->JScodeLibArray)) {
739 foreach($this->JScodeLibArray as $library) {
740 $this->pageRenderer->addHeaderData($library);
741 }
742 }
743
744 if ($this->extJScode) {
745 $this->pageRenderer->addExtOnReadyCode($this->extJScode);
746 }
747
748 // Construct page header.
749 $str = $this->pageRenderer->render(t3lib_PageRenderer::PART_HEADER);
750
751 $this->JScodeLibArray = array();
752 $this->JScode = $this->extJScode = '';
753 $this->JScodeArray = array();
754
755 $this->endOfPageJsBlock = $this->pageRenderer->render(t3lib_PageRenderer::PART_FOOTER);
756
757 if ($this->docType=='xhtml_frames') {
758 return $str;
759 } else
760 $str.=$this->docBodyTagBegin().
761 ($this->divClass?'
762
763 <!-- Wrapping DIV-section for whole page BEGIN -->
764 <div class="'.$this->divClass.'">
765 ':'').trim($this->form);
766 return $str;
767 }
768
769 /**
770 * Returns page end; This includes finishing form, div, body and html tags.
771 *
772 * @return string The HTML end of a page
773 * @see startPage()
774 */
775 function endPage() {
776 $str = $this->sectionEnd().
777 $this->postCode.
778 $this->endPageJS().
779 $this->wrapScriptTags(t3lib_BEfunc::getUpdateSignalCode()).
780 $this->parseTime().
781 ($this->form?'
782 </form>':'');
783
784 if ($this->docType!='xhtml_frames') {
785
786 $str .= ($this->divClass?'
787
788 <!-- Wrapping DIV-section for whole page END -->
789 </div>':'') . $this->endOfPageJsBlock ;
790
791 }
792
793
794 // Logging: Can't find better place to put it:
795 if (TYPO3_DLOG) t3lib_div::devLog('END of BACKEND session', 'template', 0, array('_FLUSH' => true));
796
797 return $str;
798 }
799
800 /**
801 * Returns the header-bar in the top of most backend modules
802 * Closes section if open.
803 *
804 * @param string The text string for the header
805 * @return string HTML content
806 */
807 function header($text) {
808 $str='
809
810 <!-- MAIN Header in page top -->
811 <h2>'.htmlspecialchars($text).'</h2>
812 ';
813 return $this->sectionEnd().$str;
814 }
815
816 /**
817 * Begins an output section and sets header and content
818 *
819 * @param string The header
820 * @param string The HTML-content
821 * @param boolean A flag that will prevent the header from being converted to uppercase
822 * @param boolean Defines the type of header (if set, "<h3>" rather than the default "h4")
823 * @param integer The number of an icon to show with the header (see the icon-function). -1,1,2,3
824 * @param boolean If set, HTML tags are allowed in $label (otherwise this value is by default htmlspecialchars()'ed)
825 * @return string HTML content
826 * @see icons(), sectionHeader()
827 */
828 function section($label,$text,$nostrtoupper=FALSE,$sH=FALSE,$type=0,$allowHTMLinHeader=FALSE) {
829 $str='';
830
831 // Setting header
832 if ($label) {
833 if (!$allowHTMLinHeader) $label = htmlspecialchars($label);
834 $str.=$this->sectionHeader($this->icons($type).$label, $sH, $nostrtoupper ? '' : ' class="uppercase"');
835 }
836 // Setting content
837 $str.='
838
839 <!-- Section content -->
840 '.$text;
841
842 return $this->sectionBegin().$str;
843 }
844
845 /**
846 * Inserts a divider image
847 * Ends a section (if open) before inserting the image
848 *
849 * @param integer The margin-top/-bottom of the <hr> ruler.
850 * @return string HTML content
851 */
852 function divider($dist) {
853 $dist = intval($dist);
854 $str='
855
856 <!-- DIVIDER -->
857 <hr style="margin-top: '.$dist.'px; margin-bottom: '.$dist.'px;" />
858 ';
859 return $this->sectionEnd().$str;
860 }
861
862 /**
863 * Returns a blank <div>-section with a height
864 *
865 * @param integer Padding-top for the div-section (should be margin-top but konqueror (3.1) doesn't like it :-(
866 * @return string HTML content
867 */
868 function spacer($dist) {
869 if ($dist>0) {
870 return '
871
872 <!-- Spacer element -->
873 <div style="padding-top: '.intval($dist).'px;"></div>
874 ';
875 }
876 }
877
878 /**
879 * Make a section header.
880 * Begins a section if not already open.
881 *
882 * @param string The label between the <h3> or <h4> tags. (Allows HTML)
883 * @param boolean If set, <h3> is used, otherwise <h4>
884 * @param string Additional attributes to h-tag, eg. ' class=""'
885 * @return string HTML content
886 */
887 function sectionHeader($label, $sH=FALSE, $addAttrib='') {
888 $tag = ($sH ? 'h3' : 'h4');
889 if ($addAttrib && substr($addAttrib, 0, 1) !== ' ') {
890 $addAttrib = ' ' . $addAttrib;
891 }
892 $str='
893
894 <!-- Section header -->
895 <' . $tag . $addAttrib . '>' . $label . '</' . $tag . '>
896 ';
897 return $this->sectionBegin() . $str;
898 }
899
900 /**
901 * Begins an output section.
902 * Returns the <div>-begin tag AND sets the ->sectionFlag true (if the ->sectionFlag is not already set!)
903 * 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!
904 *
905 * @return string HTML content
906 */
907 function sectionBegin() {
908 if (!$this->sectionFlag) {
909 $this->sectionFlag=1;
910 $str='
911
912 <!-- ***********************
913 Begin output section.
914 *********************** -->
915 <div>
916 ';
917 return $str;
918 } else return '';
919 }
920
921 /**
922 * Ends and output section
923 * Returns the </div>-end tag AND clears the ->sectionFlag (but does so only IF the sectionFlag is set - that is a section is 'open')
924 * See sectionBegin() also.
925 *
926 * @return string HTML content
927 */
928 function sectionEnd() {
929 if ($this->sectionFlag) {
930 $this->sectionFlag=0;
931 return '
932 </div>
933 <!-- *********************
934 End output section.
935 ********************* -->
936 ';
937 } else return '';
938 }
939
940 /**
941 * Originally it printed a kind of divider.
942 * Deprecated. Just remove function calls to it or call the divider() function instead.
943 *
944 * @return void
945 * @internal
946 * @deprecated since TYPO3 3.6
947 */
948 function middle() {
949 }
950
951 /**
952 * If a form-tag is defined in ->form then and end-tag for that <form> element is outputted
953 * Further a JavaScript section is outputted which will update the top.busy session-expiry object (unless $this->endJS is set to false)
954 *
955 * @return string HTML content (<script> tag section)
956 */
957 function endPageJS() {
958 return ($this->endJS?'
959 <script type="text/javascript">
960 /*<![CDATA[*/
961 if (top.busy && top.busy.loginRefreshed) {
962 top.busy.loginRefreshed();
963 }
964 /*]]>*/
965 </script>':'');
966 }
967
968 /**
969 * Creates the bodyTag.
970 * You can add to the bodyTag by $this->bodyTagAdditions
971 *
972 * @return string HTML body tag
973 */
974 function docBodyTagBegin() {
975 $bodyContent = 'body onclick="if (top.menuReset) top.menuReset();" '.trim($this->bodyTagAdditions.($this->bodyTagId ? ' id="'.$this->bodyTagId.'"' : ''));
976 return '<'.trim($bodyContent).'>';
977 }
978
979 /**
980 * Outputting document style
981 *
982 * @return string HTML style section/link tags
983 */
984 function docStyle() {
985
986 // Request background image:
987 if ($this->backGroundImage) {
988 $this->inDocStylesArray[]=' BODY { background-image: url('.$this->backPath.$this->backGroundImage.'); }';
989 }
990
991 // Add inDoc styles variables as well:
992 $this->inDocStylesArray[] = $this->inDocStyles;
993 $this->inDocStylesArray[] = $this->inDocStyles_TBEstyle;
994
995 // Implode it all:
996 $inDocStyles = implode(chr(10), $this->inDocStylesArray);
997
998 if ($this->styleSheetFile) {
999 $this->pageRenderer->addCssFile($this->backPath . $this->styleSheetFile);
1000 }
1001 if ($this->styleSheetFile2) {
1002 $this->pageRenderer->addCssFile($this->backPath . $this->styleSheetFile2);
1003 }
1004
1005 $this->pageRenderer->addCssInlineBlock('inDocStyles', $inDocStyles . chr(10) . '/*###POSTCSSMARKER###*/');
1006 if ($this->styleSheetFile_post) {
1007 $this->pageRenderer->addCssFile($this->backPath . $this->styleSheetFile_post);
1008 }
1009
1010 }
1011
1012 /**
1013 * Insert additional style sheet link
1014 *
1015 * @param string $key: some key identifying the style sheet
1016 * @param string $href: uri to the style sheet file
1017 * @param string $title: value for the title attribute of the link element
1018 * @return string $relation: value for the rel attribute of the link element
1019 * @return void
1020 */
1021 function addStyleSheet($key, $href, $title='', $relation='stylesheet') {
1022 if (strpos($href, '://') !== FALSE || substr($href, 0, 1) === '/') {
1023 $file = $href;
1024 } else {
1025 $file = $this->backPath . $href;
1026 }
1027 $this->pageRenderer->addCssFile($file, $relation, $title);
1028 }
1029
1030 /**
1031 * Insert post rendering document style into already rendered content
1032 * This is needed for extobjbase
1033 *
1034 * @param string style-content to insert.
1035 * @return string content with inserted styles
1036 */
1037 function insertStylesAndJS($content) {
1038 // insert accumulated CSS
1039 $this->inDocStylesArray[] = $this->inDocStyles;
1040 $styles = "\n".implode("\n", $this->inDocStylesArray);
1041 $content = str_replace('/*###POSTCSSMARKER###*/',$styles,$content);
1042
1043 // insert accumulated JS
1044 $jscode = $this->JScode."\n".$this->wrapScriptTags(implode("\n", $this->JScodeArray));
1045 $content = str_replace('<!--###POSTJSMARKER###-->',$jscode,$content);
1046
1047 return $content;
1048 }
1049
1050 /**
1051 * Initialize the charset.
1052 * Sets the internal $this->charset variable to the charset defined in $GLOBALS["LANG"] (or the default as set in this class)
1053 * Returns the meta-tag for the document header
1054 *
1055 * @return string <meta> tag with charset from $this->charset or $GLOBALS['LANG']->charSet
1056 */
1057 function initCharset() {
1058 // Set charset to the charset provided by the current backend users language selection:
1059 $this->charset = $GLOBALS['LANG']->charSet ? $GLOBALS['LANG']->charSet : $this->charset;
1060 // Return meta tag:
1061 return '<meta http-equiv="Content-Type" content="text/html; charset='.$this->charset.'" />';
1062 }
1063
1064 /**
1065 * Returns generator meta tag
1066 *
1067 * @return string <meta> tag with name "generator"
1068 */
1069 function generator() {
1070 $str = 'TYPO3 '.TYPO3_branch.', http://typo3.com, &#169; Kasper Sk&#229;rh&#248;j 1998-2009, extensions are copyright of their respective owners.';
1071 return '<meta name="generator" content="'.$str .'" />';
1072 }
1073
1074
1075
1076
1077
1078
1079
1080
1081 /*****************************************
1082 *
1083 * OTHER ELEMENTS
1084 * Tables, buttons, formatting dimmed/red strings
1085 *
1086 ******************************************/
1087
1088
1089 /**
1090 * Returns an image-tag with an 18x16 icon of the following types:
1091 *
1092 * $type:
1093 * -1: OK icon (Check-mark)
1094 * 1: Notice (Speach-bubble)
1095 * 2: Warning (Yellow triangle)
1096 * 3: Fatal error (Red stop sign)
1097 *
1098 * @param integer See description
1099 * @param string Value for style attribute
1100 * @return string HTML image tag (if applicable)
1101 */
1102 function icons($type, $styleAttribValue='') {
1103 switch($type) {
1104 case '3':
1105 $icon = 'gfx/icon_fatalerror.gif';
1106 break;
1107 case '2':
1108 $icon = 'gfx/icon_warning.gif';
1109 break;
1110 case '1':
1111 $icon = 'gfx/icon_note.gif';
1112 break;
1113 case '-1':
1114 $icon = 'gfx/icon_ok.gif';
1115 break;
1116 default:
1117 break;
1118 }
1119 if ($icon) {
1120 return '<img'.t3lib_iconWorks::skinImg($this->backPath,$icon,'width="18" height="16"').' class="absmiddle"'.($styleAttribValue ? ' style="'.htmlspecialchars($styleAttribValue).'"' : '').' alt="" />';
1121 }
1122 }
1123
1124 /**
1125 * Returns an <input> button with the $onClick action and $label
1126 *
1127 * @param string The value of the onclick attribute of the input tag (submit type)
1128 * @param string The label for the button (which will be htmlspecialchar'ed)
1129 * @return string A <input> tag of the type "submit"
1130 */
1131 function t3Button($onClick,$label) {
1132 $button = '<input type="submit" onclick="'.htmlspecialchars($onClick).'; return false;" value="'.htmlspecialchars($label).'" />';
1133 return $button;
1134 }
1135
1136 /**
1137 * dimmed-fontwrap. Returns the string wrapped in a <span>-tag defining the color to be gray/dimmed
1138 *
1139 * @param string Input string
1140 * @return string Output string
1141 */
1142 function dfw($string) {
1143 return '<span class="typo3-dimmed">'.$string.'</span>';
1144 }
1145
1146 /**
1147 * red-fontwrap. Returns the string wrapped in a <span>-tag defining the color to be red
1148 *
1149 * @param string Input string
1150 * @return string Output string
1151 */
1152 function rfw($string) {
1153 return '<span class="typo3-red">'.$string.'</span>';
1154 }
1155
1156 /**
1157 * Returns string wrapped in CDATA "tags" for XML / XHTML (wrap content of <script> and <style> sections in those!)
1158 *
1159 * @param string Input string
1160 * @return string Output string
1161 */
1162 function wrapInCData($string) {
1163 $string = '/*<![CDATA[*/'.
1164 $string.
1165 '/*]]>*/';
1166
1167 return $string;
1168 }
1169
1170 /**
1171 * Wraps the input string in script tags.
1172 * Automatic re-identing of the JS code is done by using the first line as ident reference.
1173 * This is nice for identing JS code with PHP code on the same level.
1174 *
1175 * @param string Input string
1176 * @param boolean Wrap script element in linebreaks? Default is TRUE.
1177 * @return string Output string
1178 */
1179 function wrapScriptTags($string, $linebreak=TRUE) {
1180 if(trim($string)) {
1181 // <script wrapped in nl?
1182 $cr = $linebreak? "\n" : '';
1183
1184 // remove nl from the beginning
1185 $string = preg_replace ('/^\n+/', '', $string);
1186 // re-ident to one tab using the first line as reference
1187 $match = array();
1188 if(preg_match('/^(\t+)/',$string,$match)) {
1189 $string = str_replace($match[1],"\t", $string);
1190 }
1191 $string = $cr.'<script type="text/javascript">
1192 /*<![CDATA[*/
1193 '.$string.'
1194 /*]]>*/
1195 </script>'.$cr;
1196 }
1197 return trim($string);
1198 }
1199
1200 // These vars defines the layout for the table produced by the table() function.
1201 // You can override these values from outside if you like.
1202 var $tableLayout = array(
1203 'defRow' => array(
1204 'defCol' => array('<td valign="top">','</td>')
1205 )
1206 );
1207 var $table_TR = '<tr>';
1208 var $table_TABLE = '<table border="0" cellspacing="0" cellpadding="0" id="typo3-tmpltable">';
1209
1210 /**
1211 * Returns a table based on the input $data
1212 *
1213 * @param array Multidim array with first levels = rows, second levels = cells
1214 * @param array If set, then this provides an alternative layout array instead of $this->tableLayout
1215 * @return string The HTML table.
1216 * @internal
1217 */
1218 function table($data, $layout = '') {
1219 $result = '';
1220 if (is_array($data)) {
1221 $tableLayout = (is_array($layout) ? $layout : $this->tableLayout);
1222
1223 $rowCount = 0;
1224 foreach ($data as $tableRow) {
1225 if ($rowCount % 2) {
1226 $layout = is_array($tableLayout['defRowOdd']) ? $tableLayout['defRowOdd'] : $tableLayout['defRow'];
1227 } else {
1228 $layout = is_array($tableLayout['defRowEven']) ? $tableLayout['defRowEven'] : $tableLayout['defRow'];
1229 }
1230 $rowLayout = is_array($tableLayout[$rowCount]) ? $tableLayout[$rowCount] : $layout;
1231 $rowResult = '';
1232 if (is_array($tableRow)) {
1233 $cellCount = 0;
1234 foreach ($tableRow as $tableCell) {
1235 $cellWrap = (is_array($layout[$cellCount]) ? $layout[$cellCount] : $layout['defCol']);
1236 $cellWrap = (is_array($rowLayout['defCol']) ? $rowLayout['defCol'] : $cellWrap);
1237 $cellWrap = (is_array($rowLayout[$cellCount]) ? $rowLayout[$cellCount] : $cellWrap);
1238 $rowResult .= $cellWrap[0] . $tableCell . $cellWrap[1];
1239 $cellCount++;
1240 }
1241 }
1242 $rowWrap = (is_array($layout['tr']) ? $layout['tr'] : array($this->table_TR, '</tr>'));
1243 $rowWrap = (is_array($rowLayout['tr']) ? $rowLayout['tr'] : $rowWrap);
1244 $result .= $rowWrap[0] . $rowResult . $rowWrap[1];
1245 $rowCount++;
1246 }
1247 $tableWrap = is_array($tableLayout['table']) ? $tableLayout['table'] : array($this->table_TABLE, '</table>');
1248 $result = $tableWrap[0] . $result . $tableWrap[1];
1249 }
1250 return $result;
1251 }
1252
1253 /**
1254 * Constructs a table with content from the $arr1, $arr2 and $arr3.
1255 * Used in eg. ext/belog/mod/index.php - refer to that for examples
1256 *
1257 * @param array Menu elements on first level
1258 * @param array Secondary items
1259 * @param array Third-level items
1260 * @return string HTML content, <table>...</table>
1261 */
1262 function menuTable($arr1,$arr2=array(), $arr3=array()) {
1263 $rows = max(array(count($arr1),count($arr2),count($arr3)));
1264
1265 $menu='
1266 <table border="0" cellpadding="0" cellspacing="0" id="typo3-tablemenu">';
1267 for($a=0;$a<$rows;$a++) {
1268 $menu.='<tr>';
1269 $cls=array();
1270 $valign='middle';
1271 $cls[]='<td valign="'.$valign.'">'.$arr1[$a][0].'</td><td>'.$arr1[$a][1].'</td>';
1272 if (count($arr2)) {
1273 $cls[]='<td valign="'.$valign.'">'.$arr2[$a][0].'</td><td>'.$arr2[$a][1].'</td>';
1274 if (count($arr3)) {
1275 $cls[]='<td valign="'.$valign.'">'.$arr3[$a][0].'</td><td>'.$arr3[$a][1].'</td>';
1276 }
1277 }
1278 $menu.=implode($cls,'<td>&nbsp;&nbsp;</td>');
1279 $menu.='</tr>';
1280 }
1281 $menu.='
1282 </table>
1283 ';
1284 return $menu;
1285 }
1286
1287 /**
1288 * Returns a one-row/two-celled table with $content and $menu side by side.
1289 * The table is a 100% width table and each cell is aligned left / right
1290 *
1291 * @param string Content cell content (left)
1292 * @param string Menu cell content (right)
1293 * @return string HTML output
1294 */
1295 function funcMenu($content,$menu) {
1296 return '
1297 <table border="0" cellpadding="0" cellspacing="0" width="100%" id="typo3-funcmenu">
1298 <tr>
1299 <td valign="top" nowrap="nowrap">'.$content.'</td>
1300 <td valign="top" align="right" nowrap="nowrap">'.$menu.'</td>
1301 </tr>
1302 </table>';
1303 }
1304
1305 /**
1306 * Creates a selector box with clear-cache items.
1307 * Rather specialized functions - at least don't use it with $addSaveOptions unless you know what you do...
1308 *
1309 * @param integer The page uid of the "current page" - the one that will be cleared as "clear cache for this page".
1310 * @param boolean If $addSaveOptions is set, then also the array of save-options for TCE_FORMS will appear.
1311 * @return string <select> tag with content - a selector box for clearing the cache
1312 */
1313 function clearCacheMenu($id,$addSaveOptions=0) {
1314 global $BE_USER;
1315 $opt=array();
1316 if ($addSaveOptions) {
1317 $opt[]='<option value="">'.$GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:rm.menu',1).'</option>';
1318 $opt[]='<option value="TBE_EDITOR.checkAndDoSubmit(1);">'.$GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:rm.saveDoc',1).'</option>';
1319 $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>';
1320 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>';
1321 $opt[]='<option value="document.editform.closeDoc.value=2; document.editform.submit();">'.$GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:rm.closeDoc',1).'</option>';
1322 $opt[]='<option value="document.editform.closeDoc.value=3; document.editform.submit();">'.$GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:rm.closeAllDocs',1).'</option>';
1323 $opt[]='<option value=""></option>';
1324 }
1325 $opt[]='<option value="">[ '.$GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:rm.clearCache_clearCache',1).' ]</option>';
1326 if ($id) $opt[]='<option value="'.$id.'">'.$GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:rm.clearCache_thisPage',1).'</option>';
1327 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>';
1328 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>';
1329
1330 $onChange = 'if (!this.options[this.selectedIndex].value) {
1331 this.selectedIndex=0;
1332 } else if (this.options[this.selectedIndex].value.indexOf(\';\')!=-1) {
1333 eval(this.options[this.selectedIndex].value);
1334 }else{
1335 window.location.href=\''.$this->backPath.'tce_db.php?vC='.$BE_USER->veriCode().'&redirect='.rawurlencode(t3lib_div::getIndpEnv('REQUEST_URI')).'&cacheCmd=\'+this.options[this.selectedIndex].value;
1336 }';
1337 $af_content = '<select name="cacheCmd" onchange="'.htmlspecialchars($onChange).'">'.implode('',$opt).'</select>';
1338
1339 if (count($opt)>1) {
1340 return $af_content;
1341 }
1342 }
1343
1344
1345 /**
1346 * Includes a javascript library that exists in the core /typo3/ directory. The
1347 * backpath is automatically applied
1348 *
1349 * @param string $lib: Library name. Call it with the full path
1350 * like "contrib/prototype/prototype.js" to load it
1351 * @return void
1352 */
1353 function loadJavascriptLib($lib) {
1354 $this->pageRenderer->addJsFile($this->backPath . $lib);
1355 }
1356
1357
1358
1359 /**
1360 * Includes the necessary Javascript function for the clickmenu (context sensitive menus) in the document
1361 *
1362 * @return array Deprecated: Includes the code already in the doc, so the return array is always empty.
1363 * Please just call this function without expecting a return value for future calls
1364 */
1365 function getContextMenuCode() {
1366 $this->pageRenderer->loadPrototype();
1367 $this->loadJavascriptLib('js/clickmenu.js');
1368
1369 $this->JScodeArray['clickmenu'] = '
1370 Clickmenu.clickURL = "'.$this->backPath.'alt_clickmenu.php";
1371 Clickmenu.ajax = '.($this->isCMLayers() ? 'true' : 'false' ).';';
1372
1373 // return array deprecated since 4.2
1374 return array('','','');
1375 }
1376
1377 /**
1378 * Includes the necessary javascript file (tree.js) for use on pages which have the
1379 * drag and drop functionality (usually pages and folder display trees)
1380 *
1381 * @param string indicator of which table the drag and drop function should work on (pages or folders)
1382 * @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] = One empty <div> layer for the follow-mouse drag element
1383 */
1384 function getDragDropCode($table) {
1385 $this->pageRenderer->loadPrototype();
1386 $this->loadJavascriptLib('js/common.js');
1387 $this->loadJavascriptLib('js/tree.js');
1388
1389 // setting prefs for drag & drop
1390 $this->JScodeArray['dragdrop'] = '
1391 DragDrop.changeURL = "'.$this->backPath.'alt_clickmenu.php";
1392 DragDrop.backPath = "'.t3lib_div::shortMD5(''.'|'.$GLOBALS['TYPO3_CONF_VARS']['SYS']['encryptionKey']).'";
1393 DragDrop.table = "'.$table.'";
1394 ';
1395
1396 // return array deprecated since 4.2
1397 return array('','','');
1398 }
1399
1400
1401 /**
1402 * Creates a tab menu from an array definition
1403 *
1404 * Returns a tab menu for a module
1405 * Requires the JS function jumpToUrl() to be available
1406 *
1407 * @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=...
1408 * @param string $elementName it the form elements name, probably something like "SET[...]"
1409 * @param string $currentValue is the value to be selected currently.
1410 * @param array $menuItems is an array with the menu items for the selector box
1411 * @param string $script is the script to send the &id to, if empty it's automatically found
1412 * @param string $addParams is additional parameters to pass to the script.
1413 * @return string HTML code for tab menu
1414 * @author Rene Fritz <r.fritz@colorcube.de>
1415 */
1416 function getTabMenu($mainParams,$elementName,$currentValue,$menuItems,$script='',$addparams='') {
1417 $content='';
1418
1419 if (is_array($menuItems)) {
1420 if (!is_array($mainParams)) {
1421 $mainParams = array('id' => $mainParams);
1422 }
1423 $mainParams = t3lib_div::implodeArrayForUrl('',$mainParams);
1424
1425 if (!$script) {$script=basename(PATH_thisScript);}
1426
1427 $menuDef = array();
1428 foreach($menuItems as $value => $label) {
1429 $menuDef[$value]['isActive'] = !strcmp($currentValue,$value);
1430 $menuDef[$value]['label'] = t3lib_div::deHSCentities(htmlspecialchars($label));
1431 $menuDef[$value]['url'] = $script . '?' . $mainParams . $addparams . '&' . $elementName . '=' . $value;
1432 }
1433 $content = $this->getTabMenuRaw($menuDef);
1434
1435 }
1436 return $content;
1437 }
1438
1439 /**
1440 * Creates the HTML content for the tab menu
1441 *
1442 * @param array Menu items for tabs
1443 * @return string Table HTML
1444 * @access private
1445 */
1446 function getTabMenuRaw($menuItems) {
1447 $content='';
1448
1449 if (is_array($menuItems)) {
1450 $options='';
1451
1452 $count = count($menuItems);
1453 $widthLeft = 1;
1454 $addToAct = 5;
1455
1456 $widthRight = max (1,floor(30-pow($count,1.72)));
1457 $widthTabs = 100 - $widthRight - $widthLeft;
1458 $widthNo = floor(($widthTabs - $addToAct)/$count);
1459 $addToAct = max ($addToAct,$widthTabs-($widthNo*$count));
1460 $widthAct = $widthNo + $addToAct;
1461 $widthRight = 100 - ($widthLeft + ($count*$widthNo) + $addToAct);
1462
1463 $first=true;
1464 foreach($menuItems as $id => $def) {
1465 $isActive = $def['isActive'];
1466 $class = $isActive ? 'tabact' : 'tab';
1467 $width = $isActive ? $widthAct : $widthNo;
1468
1469 // @rene: Here you should probably wrap $label and $url in htmlspecialchars() in order to make sure its XHTML compatible! I did it for $url already since that is VERY likely to break.
1470 $label = $def['label'];
1471 $url = htmlspecialchars($def['url']);
1472 $params = $def['addParams'];
1473
1474 if($first) {
1475 $options.= '
1476 <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>';
1477 } else {
1478 $options.='
1479 <td width="'.$width.'%" class="'.$class.'"><a href="'.$url.'" '.$params.'>'.$label.'</a></td>';
1480 }
1481 $first=false;
1482 }
1483
1484 if ($options) {
1485 $content .= '
1486 <!-- Tab menu -->
1487 <table cellpadding="0" cellspacing="0" border="0" width="100%" id="typo3-tabmenu">
1488 <tr>
1489 <td width="'.$widthLeft.'%">&nbsp;</td>
1490 '.$options.'
1491 <td width="'.$widthRight.'%">&nbsp;</td>
1492 </tr>
1493 </table>
1494 <div class="hr" style="margin:0px"></div>';
1495 }
1496
1497 }
1498 return $content;
1499 }
1500
1501 /**
1502 * Creates a DYNAMIC tab-menu where the tabs are switched between with DHTML.
1503 * Should work in MSIE, Mozilla, Opera and Konqueror. On Konqueror I did find a serious problem: <textarea> fields loose their content when you switch tabs!
1504 *
1505 * @param array Numeric array where each entry is an array in itself with associative keys: "label" contains the label for the TAB, "content" contains the HTML content that goes into the div-layer of the tabs content. "description" contains description text to be shown in the layer. "linkTitle" is short text for the title attribute of the tab-menu link (mouse-over text of tab). "stateIcon" indicates a standard status icon (see ->icon(), values: -1, 1, 2, 3). "icon" is an image tag placed before the text.
1506 * @param string Identification string. This should be unique for every instance of a dynamic menu!
1507 * @param integer If "1", then enabling one tab does not hide the others - they simply toggles each sheet on/off. This makes most sense together with the $foldout option. If "-1" then it acts normally where only one tab can be active at a time BUT you can click a tab and it will close so you have no active tabs.
1508 * @param boolean If set, the tabs are rendered as headers instead over each sheet. Effectively this means there is no tab menu, but rather a foldout/foldin menu. Make sure to set $toggle as well for this option.
1509 * @param integer Character limit for a new row.
1510 * @param boolean If set, tab table cells are not allowed to wrap their content
1511 * @param boolean If set, the tabs will span the full width of their position
1512 * @param integer Default tab to open (for toggle <=0). Value corresponds to integer-array index + 1 (index zero is "1", index "1" is 2 etc.). A value of zero (or something non-existing) will result in no default tab open.
1513 * @param integer If set to '1' empty tabs will be remove, If set to '2' empty tabs will be disabled
1514 * @return string JavaScript section for the HTML header.
1515 */
1516 function getDynTabMenu($menuItems,$identString,$toggle=0,$foldout=FALSE,$newRowCharLimit=50,$noWrap=1,$fullWidth=FALSE,$defaultTabIndex=1,$dividers2tabs=2) {
1517 // load the static code, if not already done with the function below
1518 $this->loadJavascriptLib('js/tabmenu.js');
1519
1520 $content = '';
1521
1522 if (is_array($menuItems)) {
1523
1524 // Init:
1525 $options = array(array());
1526 $divs = array();
1527 $JSinit = array();
1528 $id = $this->getDynTabMenuId($identString);
1529 $noWrap = $noWrap ? ' nowrap="nowrap"' : '';
1530
1531 // Traverse menu items
1532 $c=0;
1533 $tabRows=0;
1534 $titleLenCount = 0;
1535 foreach($menuItems as $index => $def) {
1536 $index+=1; // Need to add one so checking for first index in JavaScript is different than if it is not set at all.
1537
1538 // Switch to next tab row if needed
1539 if (!$foldout && ($titleLenCount>$newRowCharLimit | ($def['newline'] === true && $titleLenCount > 0))) {
1540 $titleLenCount=0;
1541 $tabRows++;
1542 $options[$tabRows] = array();
1543 }
1544
1545 if ($toggle==1) {
1546 $onclick = 'this.blur(); DTM_toggle("'.$id.'","'.$index.'"); return false;';
1547 } else {
1548 $onclick = 'this.blur(); DTM_activate("'.$id.'","'.$index.'", '.($toggle<0?1:0).'); return false;';
1549 }
1550
1551 $isEmpty = !(strcmp(trim($def['content']),'') || strcmp(trim($def['icon']),''));
1552
1553 // "Removes" empty tabs
1554 if ($isEmpty && $dividers2tabs == 1) {
1555 continue;
1556 }
1557
1558 $mouseOverOut = ' onmouseover="DTM_mouseOver(this);" onmouseout="DTM_mouseOut(this);"';
1559 $requiredIcon = '<img name="' . $id . '-' . $index . '-REQ" src="' . $GLOBALS['BACK_PATH'] . 'gfx/clear.gif" width="10" height="10" hspace="4" alt="" />';
1560
1561 if (!$foldout) {
1562 // Create TAB cell:
1563 $options[$tabRows][] = '
1564 <td class="'.($isEmpty ? 'disabled' : 'tab').'" id="'.$id.'-'.$index.'-MENU"'.$noWrap.$mouseOverOut.'>'.
1565 ($isEmpty ? '' : '<a href="#" onclick="'.htmlspecialchars($onclick).'"'.($def['linkTitle'] ? ' title="'.htmlspecialchars($def['linkTitle']).'"':'').'>').
1566 $def['icon'].
1567 ($def['label'] ? htmlspecialchars($def['label']) : '&nbsp;').
1568 $requiredIcon.
1569 $this->icons($def['stateIcon'],'margin-left: 10px;').
1570 ($isEmpty ? '' : '</a>').
1571 '</td>';
1572 $titleLenCount+= strlen($def['label']);
1573 } else {
1574 // Create DIV layer for content:
1575 $divs[] = '
1576 <div class="'.($isEmpty ? 'disabled' : 'tab').'" id="'.$id.'-'.$index.'-MENU"'.$mouseOverOut.'>'.
1577 ($isEmpty ? '' : '<a href="#" onclick="'.htmlspecialchars($onclick).'"'.($def['linkTitle'] ? ' title="'.htmlspecialchars($def['linkTitle']).'"':'').'>').
1578 $def['icon'].
1579 ($def['label'] ? htmlspecialchars($def['label']) : '&nbsp;').
1580 $requiredIcon.
1581 ($isEmpty ? '' : '</a>').
1582 '</div>';
1583 }
1584
1585 // Create DIV layer for content:
1586 $divs[] = '
1587 <div style="display: none;" id="'.$id.'-'.$index.'-DIV" class="c-tablayer">'.
1588 ($def['description'] ? '<p class="c-descr">'.nl2br(htmlspecialchars($def['description'])).'</p>' : '').
1589 $def['content'].
1590 '</div>';
1591 // Create initialization string:
1592 $JSinit[] = '
1593 DTM_array["'.$id.'"]['.$c.'] = "'.$id.'-'.$index.'";
1594 ';
1595 // If not empty and we have the toggle option on, check if the tab needs to be expanded
1596 if ($toggle == 1 && !$isEmpty) {
1597 $JSinit[] = '
1598 if (top.DTM_currentTabs["'.$id.'-'.$index.'"]) { DTM_toggle("'.$id.'","'.$index.'",1); }
1599 ';
1600 }
1601
1602 $c++;
1603 }
1604
1605 // Render menu:
1606 if (count($options)) {
1607
1608 // Tab menu is compiled:
1609 if (!$foldout) {
1610 $tabContent = '';
1611 for($a=0;$a<=$tabRows;$a++) {
1612 $tabContent.= '
1613
1614 <!-- Tab menu -->
1615 <table cellpadding="0" cellspacing="0" border="0"'.($fullWidth ? ' width="100%"' : '').' class="typo3-dyntabmenu">
1616 <tr>
1617 '.implode('',$options[$a]).'
1618 </tr>
1619 </table>';
1620 }
1621 $content.= '<div class="typo3-dyntabmenu-tabs">'.$tabContent.'</div>';
1622 }
1623
1624 // Div layers are added:
1625 $content.= '
1626 <!-- Div layers for tab menu: -->
1627 <div class="typo3-dyntabmenu-divs'.($foldout?'-foldout':'').'">
1628 '.implode('',$divs).'</div>';
1629
1630 // Java Script section added:
1631 $content.= '
1632 <!-- Initialization JavaScript for the menu -->
1633 <script type="text/javascript">
1634 DTM_array["'.$id.'"] = new Array();
1635 '.implode('',$JSinit).'
1636 '.($toggle<=0 ? 'DTM_activate("'.$id.'", top.DTM_currentTabs["'.$id.'"]?top.DTM_currentTabs["'.$id.'"]:'.intval($defaultTabIndex).', 0);' : '').'
1637 </script>
1638
1639 ';
1640 }
1641
1642 }
1643 return $content;
1644 }
1645
1646 /**
1647 * Creates the id for dynTabMenus.
1648 *
1649 * @param string $identString: Identification string. This should be unique for every instance of a dynamic menu!
1650 * @return string The id with a short MD5 of $identString and prefixed "DTM-", like "DTM-2e8791854a"
1651 */
1652 function getDynTabMenuId($identString) {
1653 $id = 'DTM-'.t3lib_div::shortMD5($identString);
1654 return $id;
1655 }
1656
1657 /**
1658 * Returns dynamic tab menu header JS code.
1659 * This is now incorporated automatically when the function template::getDynTabMenu is called
1660 * (as long as it is called before $this->startPage())
1661 * The return value is not needed anymore
1662 *
1663 * @return string JavaScript section for the HTML header. (return value is deprecated since TYPO3 4.3, will be removed in TYPO3 4.5)
1664 */
1665 function getDynTabMenuJScode() {
1666 $this->loadJavascriptLib('js/tabmenu.js');
1667 // return value deprecated since TYPO3 4.3
1668 return '';
1669 }
1670
1671 /**
1672 * Creates the version selector for the page id inputted.
1673 * Requires the core version management extension, "version" to be loaded.
1674 *
1675 * @param integer Page id to create selector for.
1676 * @param boolean If set, there will be no button for swapping page.
1677 * @return void
1678 */
1679 function getVersionSelector($id,$noAction=FALSE) {
1680
1681 if ($id>0) {
1682 if (t3lib_extMgm::isLoaded('version') && $GLOBALS['BE_USER']->workspace==0) {
1683
1684 // Get Current page record:
1685 $curPage = t3lib_BEfunc::getRecord('pages',$id);
1686 // If the selected page is not online, find the right ID
1687 $onlineId = ($curPage['pid']==-1 ? $curPage['t3ver_oid'] : $id);
1688 // Select all versions of online version:
1689 $versions = t3lib_BEfunc::selectVersionsOfRecord('pages', $onlineId, 'uid,pid,t3ver_label,t3ver_oid,t3ver_wsid,t3ver_id');
1690
1691 // If more than one was found...:
1692 if (count($versions)>1) {
1693
1694 // Create selector box entries:
1695 $opt = array();
1696 foreach($versions as $vRow) {
1697 $opt[] = '<option value="'.htmlspecialchars(t3lib_div::linkThisScript(array('id'=>$vRow['uid']))).'"'.($id==$vRow['uid']?' selected="selected"':'').'>'.
1698 htmlspecialchars($vRow['t3ver_label'].' [v#'.$vRow['t3ver_id'].', WS:'.$vRow['t3ver_wsid'].']'.($vRow['uid']==$onlineId ? ' =>'.$GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:ver.online').'<=':'')).
1699 '</option>';
1700 }
1701
1702 // Add management link:
1703 $opt[] = '<option value="'.htmlspecialchars(t3lib_div::linkThisScript(array('id'=>$id))).'">---</option>';
1704 $opt[] = '<option value="'.htmlspecialchars($this->backPath.t3lib_extMgm::extRelPath('version').'cm1/index.php?table=pages&uid='.$onlineId).'">'.$GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:ver.mgm',1).'</option>';
1705
1706 // Create onchange handler:
1707 $onChange = "window.location.href=this.options[this.selectedIndex].value;";
1708
1709 // Controls:
1710 if ($id==$onlineId) {
1711 $controls = '<img'.t3lib_iconWorks::skinImg($this->backPath,'gfx/blinkarrow_left.gif','width="5" height="9"').' class="absmiddle" alt="" /> <b>'.$GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:ver.online',1).'</b>';
1712 } elseif (!$noAction) {
1713 $controls = '<a href="'.$this->issueCommand('&cmd[pages]['.$onlineId.'][version][swapWith]='.$id.'&cmd[pages]['.$onlineId.'][version][action]=swap',t3lib_div::linkThisScript(array('id'=>$onlineId))).'" class="nobr">'.
1714 '<img'.t3lib_iconWorks::skinImg($this->backPath,'gfx/insert1.gif','width="14" height="14"').' style="margin-right: 2px;" class="absmiddle" alt="" title="'.$GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:ver.swapPage',1).'" />'.
1715 '<b>'.$GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:ver.swap',1).'</b></a>';
1716 }
1717
1718 // Write out HTML code:
1719 return '
1720
1721 <!--
1722 Version selector:
1723 -->
1724 <table border="0" cellpadding="0" cellspacing="0" id="typo3-versionSelector">
1725 <tr>
1726 <td>'.$GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:ver.selVer',1).'</td>
1727 <td>
1728 <select onchange="'.htmlspecialchars($onChange).'">
1729 '.implode('',$opt).'
1730 </select></td>
1731 <td>'.$controls.'</td>
1732 </tr>
1733 </table>
1734 ';
1735 }
1736 } elseif ($GLOBALS['BE_USER']->workspace!==0) {
1737
1738 // Write out HTML code:
1739 switch($GLOBALS['BE_USER']->workspace) {
1740 case 0:
1741 $wsTitle = 'LIVE';
1742 break;
1743 case -1:
1744 $wsTitle = 'Draft';
1745 break;
1746 default:
1747 $wsTitle = $GLOBALS['BE_USER']->workspaceRec['title'];
1748 break;
1749 }
1750
1751 if (t3lib_BEfunc::isPidInVersionizedBranch($id)=='branchpoint') {
1752 return '
1753
1754 <!--
1755 Version selector:
1756 -->
1757 <table border="0" cellpadding="0" cellspacing="0" id="typo3-versionSelector">
1758 <tr>
1759 <td>Workspace: "'.htmlspecialchars($wsTitle).'"</td>
1760 <td><em>Inside branch, no further versioning possible</em></td>
1761 </tr>
1762 </table>
1763 ';
1764 } else {
1765 // Get Current page record:
1766 $curPage = t3lib_BEfunc::getRecord('pages',$id);
1767 // If the selected page is not online, find the right ID
1768 $onlineId = ($curPage['pid']==-1 ? $curPage['t3ver_oid'] : $id);
1769 // The version of page:
1770 $verPage = t3lib_BEfunc::getWorkspaceVersionOfRecord($GLOBALS['BE_USER']->workspace, 'pages', $onlineId);
1771
1772 if (!$verPage) {
1773
1774 if (!count(t3lib_BEfunc::countVersionsOfRecordsOnPage($GLOBALS['BE_USER']->workspace, $onlineId))) {
1775 if ($GLOBALS['BE_USER']->workspaceVersioningTypeAccess(0)) {
1776
1777 $onClick = $this->issueCommand('&cmd[pages]['.$onlineId.'][version][action]=new&cmd[pages]['.$onlineId.'][version][treeLevels]=0',t3lib_div::linkThisScript(array('id'=>$onlineId)));
1778 $onClick = 'window.location.href=\''.$onClick.'\'; return false;';
1779 // Write out HTML code:
1780 return '
1781
1782 <!--
1783 No version yet, create one?
1784 -->
1785 <table border="0" cellpadding="0" cellspacing="0" id="typo3-versionSelector">
1786 <tr>
1787 <td>Workspace: "'.htmlspecialchars($wsTitle).'"</td>
1788 <td>
1789 <input type="submit" value="New version of page" name="_" onclick="'.htmlspecialchars($onClick).'" /></td>
1790 </tr>
1791 </table>
1792 ';
1793 }
1794 } else {
1795 return '
1796
1797 <!--
1798 Version selector:
1799 -->
1800 <table border="0" cellpadding="0" cellspacing="0" id="typo3-versionSelector">
1801 <tr>
1802 <td>Workspace: "'.htmlspecialchars($wsTitle).'"</td>
1803 <td><em>Versions found on page, no "Page" versioning possible</em></td>
1804 </tr>
1805 </table>
1806 ';
1807 }
1808 } elseif ($verPage['t3ver_swapmode']==0) {
1809 $onClick = $this->issueCommand('&cmd[pages]['.$onlineId.'][version][action]=swap&cmd[pages]['.$onlineId.'][version][swapWith]='.$verPage['uid'],t3lib_div::linkThisScript(array('id'=>$onlineId)));
1810 $onClick = 'window.location.href=\''.$onClick.'\'; return false;';
1811
1812 // Write out HTML code:
1813 return '
1814
1815 <!--
1816 Version selector:
1817 -->
1818 <table border="0" cellpadding="0" cellspacing="0" id="typo3-versionSelector">
1819 <tr>
1820 <td>Workspace: "'.htmlspecialchars($wsTitle).'"</td>
1821 <td>
1822 <input type="submit" value="Publish page" name="_" onclick="'.htmlspecialchars($onClick).'" /></td>
1823 </tr>
1824 </table>
1825 ';
1826 }
1827 }
1828 }
1829 }
1830 }
1831
1832 /**
1833 * Function to load a HTML template file with markers.
1834 * When calling from own extension, use syntax getHtmlTemplate('EXT:extkey/template.html')
1835 *
1836 * @param string tmpl name, usually in the typo3/template/ directory
1837 * @return string HTML of template
1838 */
1839 function getHtmlTemplate($filename) {
1840 if ($GLOBALS['TBE_STYLES']['htmlTemplates'][$filename]) {
1841 $filename = $GLOBALS['TBE_STYLES']['htmlTemplates'][$filename];
1842 }
1843 if (substr($filename,0,4) != 'EXT:') {
1844 $filename = t3lib_div::resolveBackPath($this->backPath . $filename);
1845 } else {
1846 $filename = t3lib_div::getFileAbsFileName($filename, true, true);
1847 }
1848 return t3lib_div::getURL($filename);
1849 }
1850
1851 /**
1852 * Define the template for the module
1853 *
1854 * @param string filename
1855 */
1856 function setModuleTemplate($filename) {
1857 // Load Prototype lib for IE event
1858 $this->pageRenderer->loadPrototype();
1859 $this->loadJavascriptLib('js/iecompatibility.js');
1860 $this->moduleTemplate = $this->getHtmlTemplate($filename);
1861 }
1862
1863 /**
1864 * Put together the various elements for the module <body> using a static HTML
1865 * template
1866 *
1867 * @param array Record of the current page, used for page path and info
1868 * @param array HTML for all buttons
1869 * @param array HTML for all other markers
1870 * @return string Composite HTML
1871 */
1872 public function moduleBody($pageRecord = array(), $buttons = array(), $markerArray = array(), $subpartArray = array()) {
1873 // Get the HTML template for the module
1874 $moduleBody = t3lib_parsehtml::getSubpart($this->moduleTemplate, '###FULLDOC###');
1875 // Add CSS
1876 $this->inDocStylesArray[] = 'html { overflow: hidden; }';
1877 // Add JS code to the <head> for IE
1878 $this->JScode.= $this->wrapScriptTags('
1879 // workaround since IE6 cannot deal with relative height for scrolling elements
1880 function resizeDocBody() {
1881 $("typo3-docbody").style.height = (document.body.offsetHeight - parseInt($("typo3-docheader").getStyle("height")));
1882 }
1883 if (Prototype.Browser.IE) {
1884 var version = parseFloat(navigator.appVersion.split(\';\')[1].strip().split(\' \')[1]);
1885 if (version == 6) {
1886 Event.observe(window, "resize", resizeDocBody, false);
1887 Event.observe(window, "load", resizeDocBody, false);
1888 }
1889 }
1890 ');
1891 // Get the page path for the docheader
1892 $markerArray['PAGEPATH'] = $this->getPagePath($pageRecord);
1893 // Get the page info for the docheader
1894 $markerArray['PAGEINFO'] = $this->getPageInfo($pageRecord);
1895 // Get all the buttons for the docheader
1896 $docHeaderButtons = $this->getDocHeaderButtons($buttons);
1897 // Merge docheader buttons with the marker array
1898 $markerArray = array_merge($markerArray, $docHeaderButtons);
1899 // replacing subparts
1900 foreach ($subpartArray as $marker => $content) {
1901 $moduleBody = t3lib_parsehtml::substituteSubpart($moduleBody, $marker, $content);
1902 }
1903
1904 if ($this->showFlashMessages) {
1905 // adding flash messages
1906 $flashMessages = t3lib_FlashMessageQueue::renderFlashMessages();
1907 if (!empty($flashMessages)) {
1908 $flashMessages = '<div id="typo3-messages">' . $flashMessages . '</div>';
1909 }
1910
1911 if (strstr($moduleBody, '###FLASHMESSAGES###')) {
1912 // either replace a dedicated marker for the messages if present
1913 $moduleBody = str_replace(
1914 '###FLASHMESSAGES###',
1915 $flashMessages,
1916 $moduleBody
1917 );
1918 } else {
1919 // or force them to appear before the content
1920 $moduleBody = str_replace(
1921 '###CONTENT###',
1922 $flashMessages . '###CONTENT###',
1923 $moduleBody
1924 );
1925 }
1926 }
1927
1928 // replacing all markers with the finished markers and return the HTML content
1929 return t3lib_parsehtml::substituteMarkerArray($moduleBody, $markerArray, '###|###');
1930
1931 }
1932
1933 /**
1934 * Fill the button lists with the defined HTML
1935 *
1936 * @param array HTML for all buttons
1937 * @return array Containing HTML for both buttonlists
1938 */
1939 protected function getDocHeaderButtons($buttons) {
1940 $markers = array();
1941 // Fill buttons for left and right float
1942 $floats = array('left', 'right');
1943 foreach($floats as $key) {
1944 // Get the template for each float
1945 $buttonTemplate = t3lib_parsehtml::getSubpart($this->moduleTemplate, '###BUTTON_GROUPS_' . strtoupper($key) . '###');
1946 // Fill the button markers in this float
1947 $buttonTemplate = t3lib_parsehtml::substituteMarkerArray($buttonTemplate, $buttons, '###|###', true);
1948 // getting the wrap for each group
1949 $buttonWrap = t3lib_parsehtml::getSubpart($this->moduleTemplate, '###BUTTON_GROUP_WRAP###');
1950 // looping through the groups (max 6) and remove the empty groups
1951 for ($groupNumber = 1; $groupNumber < 6; $groupNumber++) {
1952 $buttonMarker = '###BUTTON_GROUP' . $groupNumber . '###';
1953 $buttonGroup = t3lib_parsehtml::getSubpart($buttonTemplate, $buttonMarker);
1954 if (trim($buttonGroup)) {
1955 if ($buttonWrap) {
1956 $buttonGroup = t3lib_parsehtml::substituteMarker($buttonWrap, '###BUTTONS###', $buttonGroup);
1957 }
1958 $buttonTemplate = t3lib_parsehtml::substituteSubpart($buttonTemplate, $buttonMarker, trim($buttonGroup));
1959 }
1960 }
1961 // replace the marker with the template and remove all line breaks (for IE compat)
1962 $markers['BUTTONLIST_' . strtoupper($key)] = str_replace("\n", '', $buttonTemplate);
1963 }
1964
1965 // Hook for manipulating docHeaderButtons
1966 if (isset($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['typo3/template.php']['docHeaderButtonsHook'])) {
1967 $params = array(
1968 'buttons' => $buttons,
1969 'markers' => &$markers,
1970 'pObj' => &$this
1971 );
1972 foreach($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['typo3/template.php']['docHeaderButtonsHook'] as $funcRef) {
1973 t3lib_div::callUserFunction($funcRef, $params, $this);
1974 }
1975 }
1976
1977 return $markers;
1978 }
1979
1980 /**
1981 * Generate the page path for docheader
1982 *
1983 * @param array Current page
1984 * @return string Page path
1985 */
1986 protected function getPagePath($pageRecord) {
1987 // Is this a real page
1988 if ($pageRecord['uid']) {
1989 $title = $pageRecord['_thePathFull'];
1990 } else {
1991 $title = $GLOBALS['TYPO3_CONF_VARS']['SYS']['sitename'];
1992 }
1993 // Setting the path of the page
1994 $pagePath = $GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:labels.path', 1) . ': <span class="typo3-docheader-pagePath">';
1995
1996 // crop the title to title limit (or 50, if not defined)
1997 $cropLength = (empty($GLOBALS['BE_USER']->uc['titleLen'])) ? 50 : $GLOBALS['BE_USER']->uc['titleLen'];
1998 $croppedTitle = t3lib_div::fixed_lgd_cs($title, -$cropLength);
1999 if ($croppedTitle !== $title) {
2000 $pagePath .= '<abbr title="' . htmlspecialchars($title) . '">' . htmlspecialchars($croppedTitle) . '</abbr>';
2001 } else {
2002 $pagePath .= htmlspecialchars($title);
2003 }
2004 $pagePath .= '</span>';
2005 return $pagePath;
2006 }
2007
2008 /**
2009 * Setting page icon with clickmenu + uid for docheader
2010 *
2011 * @param array Current page
2012 * @return string Page info
2013 */
2014 protected function getPageInfo($pageRecord) {
2015 global $BE_USER;
2016 // Add icon with clickmenu, etc:
2017 if ($pageRecord['uid']) { // If there IS a real page
2018 $alttext = t3lib_BEfunc::getRecordIconAltText($pageRecord, 'pages');
2019 $iconImg = t3lib_iconWorks::getIconImage('pages', $pageRecord, $this->backPath, 'class="absmiddle" title="'. htmlspecialchars($alttext) . '"');
2020 // Make Icon:
2021 $theIcon = $GLOBALS['SOBE']->doc->wrapClickMenuOnIcon($iconImg, 'pages', $pageRecord['uid']);
2022 } else { // On root-level of page tree
2023 // Make Icon
2024 $iconImg = '<img' . t3lib_iconWorks::skinImg($this->backPath, 'gfx/i/_icon_website.gif') . ' alt="' . $GLOBALS['TYPO3_CONF_VARS']['SYS']['sitename'] . '" />';
2025 if($BE_USER->user['admin']) {
2026 $theIcon = $GLOBALS['SOBE']->doc->wrapClickMenuOnIcon($iconImg, 'pages', 0);
2027 } else {
2028 $theIcon = $iconImg;
2029 }
2030 }
2031
2032 // Setting icon with clickmenu + uid
2033 $pageInfo = $theIcon . '<em>[pid: ' . $pageRecord['uid'] . ']</em>';
2034 return $pageInfo;
2035 }
2036
2037
2038
2039
2040
2041 }
2042
2043
2044 // ******************************
2045 // Extension classes of the template class.
2046 // These are meant to provide backend screens with different widths.
2047 // They still do because of the different class-prefixes used for the <div>-sections
2048 // but obviously the final width is determined by the stylesheet used.
2049 // ******************************
2050
2051 /**
2052 * 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
2053 * The class were more significant in the past than today.
2054 *
2055 */
2056 class bigDoc extends template {
2057 var $divClass = 'typo3-bigDoc';
2058 }
2059
2060 /**
2061 * Extension class for "template" - used for backend pages without the "document" background image
2062 * The class were more significant in the past than today.
2063 *
2064 */
2065 class noDoc extends template {
2066 var $divClass = 'typo3-noDoc';
2067 }
2068
2069 /**
2070 * 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)
2071 * The class were more significant in the past than today.
2072 *
2073 */
2074 class smallDoc extends template {
2075 var $divClass = 'typo3-smallDoc';
2076 }
2077
2078 /**
2079 * 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.
2080 * The class were more significant in the past than today. But probably you should use this one for most modules you make.
2081 *
2082 */
2083 class mediumDoc extends template {
2084 var $divClass = 'typo3-mediumDoc';
2085 }
2086
2087
2088 /**
2089 * Extension class for "template" - used in the context of frontend editing.
2090 */
2091 class frontendDoc extends template {
2092
2093 /**
2094 * Used in the frontend context to insert header data via TSFE->additionalHeaderData.
2095 * Mimics header inclusion from template->startPage().
2096 *
2097 * @return void
2098 */
2099 public function insertHeaderData() {
2100
2101 /** @var $pageRenderer t3lib_PageRenderer */
2102 $pageRenderer = $GLOBALS['TSFE']->getPageRenderer();
2103
2104 $this->backPath = $GLOBALS['TSFE']->backPath = TYPO3_mainDir;
2105 $this->pageRenderer->setBackPath($this->backPath);
2106 $this->docStyle();
2107
2108 // add applied JS/CSS to $GLOBALS['TSFE']
2109 if ($this->JScode) {
2110 $pageRenderer->addHeaderData($this->JScode);
2111 }
2112 if (count($this->JScodeArray)) {
2113 foreach ($this->JScodeArray as $name => $code) {
2114 $pageRenderer->addJsInlineCode($name, $code);
2115 }
2116 }
2117
2118 if ($this->addPrototype) {
2119 $pageRenderer->loadPrototype();
2120 }
2121 if ($this->addScriptaculous) {
2122 $pageRenderer->loadScriptaculous();
2123 }
2124 if ($this->addExtJS) {
2125 $pageRenderer->loadExtJs();
2126 }
2127 if ($this->inlineLanguageLabels) {
2128 $pageRenderer->addInlineLanguageLabelArray($this->inlineLanguageLabels);
2129 }
2130 if ($this->inlineSettings) {
2131 $pageRenderer->addInlineSettingArray($this->inlineSettings);
2132 }
2133 }
2134 }
2135
2136
2137 if (defined('TYPO3_MODE') && $TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['typo3/template.php']) {
2138 include_once($TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['typo3/template.php']);
2139 }
2140
2141
2142
2143 // ******************************
2144 // The template is loaded
2145 // ******************************
2146 $GLOBALS['TBE_TEMPLATE'] = t3lib_div::makeInstance('template');
2147
2148 ?>