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