Follow-up to #11684: Minor comments cleanup, switched popFlashMessages() to public...
[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 // internal flags for JS-libraries
208 protected $addPrototype = false;
209 protected $addScriptaculousModules = array(
210 'builder' => false,
211 'effects' => false,
212 'dragdrop' => false,
213 'controls' => false,
214 'slider' => false
215 );
216 protected $addExtJS = false;
217 protected $extJSadapter = 'ext/ext-base.js';
218 protected $enableExtJsDebug = false;
219
220 // available adapters for extJs
221 const EXTJS_ADAPTER_JQUERY = 'jquery';
222 const EXTJS_ADAPTER_PROTOTYPE = 'prototype';
223 const EXTJS_ADAPTER_YUI = 'yui';
224
225
226 /**
227 * Constructor
228 * Imports relevant parts from global $TBE_STYLES (colorscheme)
229 *
230 * @return void
231 */
232 function template() {
233 global $TBE_STYLES;
234
235 // Setting default scriptID:
236 if (($temp_M = (string) t3lib_div::_GET('M')) && $GLOBALS['TBE_MODULES']['_PATHS'][$temp_M]) {
237 $this->scriptID = preg_replace('/^.*\/(sysext|ext)\//', 'ext/', $GLOBALS['TBE_MODULES']['_PATHS'][$temp_M] . 'index.php');
238 } else {
239 $this->scriptID = preg_replace('/^.*\/(sysext|ext)\//', 'ext/', substr(PATH_thisScript, strlen(PATH_site)));
240 }
241 if (TYPO3_mainDir!='typo3/' && substr($this->scriptID,0,strlen(TYPO3_mainDir)) == TYPO3_mainDir) {
242 $this->scriptID = 'typo3/'.substr($this->scriptID,strlen(TYPO3_mainDir)); // This fixes if TYPO3_mainDir has been changed so the script ids are STILL "typo3/..."
243 }
244
245 $this->bodyTagId = preg_replace('/[^A-Za-z0-9-]/','-',$this->scriptID);
246
247 // Individual configuration per script? If so, make a recursive merge of the arrays:
248 if (is_array($TBE_STYLES['scriptIDindex'][$this->scriptID])) {
249 $ovr = $TBE_STYLES['scriptIDindex'][$this->scriptID]; // Make copy
250 $TBE_STYLES = t3lib_div::array_merge_recursive_overrule($TBE_STYLES,$ovr); // merge styles.
251 unset($TBE_STYLES['scriptIDindex'][$this->scriptID]); // Have to unset - otherwise the second instantiation will do it again!
252 }
253
254 // Color scheme:
255 if ($TBE_STYLES['mainColors']['bgColor']) $this->bgColor=$TBE_STYLES['mainColors']['bgColor'];
256 if ($TBE_STYLES['mainColors']['bgColor1']) $this->bgColor1=$TBE_STYLES['mainColors']['bgColor1'];
257 if ($TBE_STYLES['mainColors']['bgColor2']) $this->bgColor2=$TBE_STYLES['mainColors']['bgColor2'];
258 if ($TBE_STYLES['mainColors']['bgColor3']) $this->bgColor3=$TBE_STYLES['mainColors']['bgColor3'];
259 if ($TBE_STYLES['mainColors']['bgColor4']) $this->bgColor4=$TBE_STYLES['mainColors']['bgColor4'];
260 if ($TBE_STYLES['mainColors']['bgColor5']) $this->bgColor5=$TBE_STYLES['mainColors']['bgColor5'];
261 if ($TBE_STYLES['mainColors']['bgColor6']) $this->bgColor6=$TBE_STYLES['mainColors']['bgColor6'];
262 if ($TBE_STYLES['mainColors']['hoverColor']) $this->hoverColor=$TBE_STYLES['mainColors']['hoverColor'];
263
264 // Main Stylesheets:
265 if ($TBE_STYLES['stylesheet']) $this->styleSheetFile = $TBE_STYLES['stylesheet'];
266 if ($TBE_STYLES['stylesheet2']) $this->styleSheetFile2 = $TBE_STYLES['stylesheet2'];
267 if ($TBE_STYLES['styleSheetFile_post']) $this->styleSheetFile_post = $TBE_STYLES['styleSheetFile_post'];
268 if ($TBE_STYLES['inDocStyles_TBEstyle']) $this->inDocStyles_TBEstyle = $TBE_STYLES['inDocStyles_TBEstyle'];
269
270 // Background image
271 if ($TBE_STYLES['background']) $this->backGroundImage = $TBE_STYLES['background'];
272 }
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289 /*****************************************
290 *
291 * EVALUATION FUNCTIONS
292 * Various centralized processing
293 *
294 *****************************************/
295
296 /**
297 * Makes click menu link (context sensitive menu)
298 * 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)
299 * 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)
300 *
301 * @param string String to be wrapped in link, typ. image tag.
302 * @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
303 * @param integer If icon is for database record this is the UID for the record from $table
304 * @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.
305 * @param string Additional GET parameters for the link to alt_clickmenu.php
306 * @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.
307 * @param boolean If set, will return only the onclick JavaScript, not the whole link.
308 * @return string The link-wrapped input string.
309 */
310 function wrapClickMenuOnIcon($str,$table,$uid='',$listFr=1,$addParams='',$enDisItems='', $returnOnClick=FALSE) {
311 $backPath = rawurlencode($this->backPath).'|'.t3lib_div::shortMD5($this->backPath.'|'.$GLOBALS['TYPO3_CONF_VARS']['SYS']['encryptionKey']);
312 $onClick = 'showClickmenu("'.$table.'","'.$uid.'","'.$listFr.'","'.str_replace('+','%2B',$enDisItems).'","'.str_replace('&','&amp;',addcslashes($backPath,'"')).'","'.str_replace('&','&amp;',addcslashes($addParams,'"')).'");return false;';
313 return $returnOnClick ? $onClick : '<a href="#" onclick="'.htmlspecialchars($onClick).'"'.($GLOBALS['TYPO3_CONF_VARS']['BE']['useOnContextMenuHandler'] ? ' oncontextmenu="'.htmlspecialchars($onClick).'"' : '').'>'.$str.'</a>';
314 }
315
316 /**
317 * Makes link to page $id in frontend (view page)
318 * Returns an magnifier-glass icon which links to the frontend index.php document for viewing the page with id $id
319 * $id must be a page-uid
320 * If the BE_USER has access to Web>List then a link to that module is shown as well (with return-url)
321 *
322 * @param integer The page id
323 * @param string The current "BACK_PATH" (the back relative to the typo3/ directory)
324 * @param string Additional parameters for the image tag(s)
325 * @return string HTML string with linked icon(s)
326 */
327 function viewPageIcon($id,$backPath,$addParams='hspace="3"') {
328 global $BE_USER;
329 $str = '';
330 // If access to Web>List for user, then link to that module.
331 if ($BE_USER->check('modules','web_list')) {
332 $href=$backPath.'db_list.php?id='.$id.'&returnUrl='.rawurlencode(t3lib_div::getIndpEnv('REQUEST_URI'));
333 $str.= '<a href="'.htmlspecialchars($href).'">'.
334 '<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="" />'.
335 '</a>';
336 }
337 // Make link to view page
338 $str.= '<a href="#" onclick="'.htmlspecialchars(t3lib_BEfunc::viewOnClick($id,$backPath,t3lib_BEfunc::BEgetRootLine($id))).'">'.
339 '<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="" />'.
340 '</a>';
341 return $str;
342 }
343
344 /**
345 * Returns a URL with a command to TYPO3 Core Engine (tce_db.php)
346 * See description of the API elsewhere.
347 *
348 * @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"
349 * @param string Redirect URL if any other that t3lib_div::getIndpEnv('REQUEST_URI') is wished
350 * @return string URL to tce_db.php + parameters (backpath is taken from $this->backPath)
351 * @see t3lib_BEfunc::editOnClick()
352 */
353 function issueCommand($params,$rUrl='') {
354 $rUrl = $rUrl ? $rUrl : t3lib_div::getIndpEnv('REQUEST_URI');
355 return $this->backPath.'tce_db.php?'.
356 $params.
357 '&redirect='.($rUrl==-1?"'+T3_THIS_LOCATION+'":rawurlencode($rUrl)).
358 '&vC='.rawurlencode($GLOBALS['BE_USER']->veriCode()).
359 '&prErr=1&uPT=1';
360 }
361
362 /**
363 * Returns true if click-menu layers can be displayed for the current user/browser
364 * Use this to test if click-menus (context sensitive menus) can and should be displayed in the backend.
365 *
366 * @return boolean
367 */
368 function isCMlayers() {
369 return !$GLOBALS['BE_USER']->uc['disableCMlayers'] && $GLOBALS['CLIENT']['FORMSTYLE'] && !($GLOBALS['CLIENT']['SYSTEM']=='mac' && $GLOBALS['CLIENT']['BROWSER']=='Opera');
370 }
371
372 /**
373 * Returns 'this.blur();' if the client supports CSS styles
374 * Use this in links to remove the underlining after being clicked
375 *
376 * @return string
377 */
378 function thisBlur() {
379 return ($GLOBALS['CLIENT']['FORMSTYLE']?'this.blur();':'');
380 }
381
382 /**
383 * Returns ' style='cursor:help;'' if the client supports CSS styles
384 * Use for <a>-links to help texts
385 *
386 * @return string
387 */
388 function helpStyle() {
389 return $GLOBALS['CLIENT']['FORMSTYLE'] ? ' style="cursor:help;"':'';
390 }
391
392 /**
393 * Makes the header (icon+title) for a page (or other record). Used in most modules under Web>*
394 * $table and $row must be a tablename/record from that table
395 * $path will be shown as alt-text for the icon.
396 * The title will be truncated to 45 chars.
397 *
398 * @param string Table name
399 * @param array Record row
400 * @param string Alt text
401 * @param boolean Set $noViewPageIcon true if you don't want a magnifier-icon for viewing the page in the frontend
402 * @param array $tWrap is an array with indexes 0 and 1 each representing HTML-tags (start/end) which will wrap the title
403 * @return string HTML content
404 */
405 function getHeader($table,$row,$path,$noViewPageIcon=0,$tWrap=array('','')) {
406 global $TCA;
407 if (is_array($row) && $row['uid']) {
408 $iconImgTag=t3lib_iconWorks::getIconImage($table,$row,$this->backPath,'title="'.htmlspecialchars($path).'"');
409 $title= strip_tags($row[$TCA[$table]['ctrl']['label']]);
410 $viewPage = $noViewPageIcon ? '' : $this->viewPageIcon($row['uid'],$this->backPath,'');
411 if ($table=='pages') $path.=' - '.t3lib_BEfunc::titleAttribForPages($row,'',0);
412 } else {
413 $iconImgTag='<img'.t3lib_iconWorks::skinImg($this->backPath,'gfx/i/_icon_website.gif',$wHattribs='width="18" height="16"').' title="'.htmlspecialchars($path).'" alt="" />';
414 $title=$GLOBALS['TYPO3_CONF_VARS']['SYS']['sitename'];
415 }
416
417 return '<span class="typo3-moduleHeader">'.$this->wrapClickMenuOnIcon($iconImgTag,$table,$row['uid']).
418 $viewPage.
419 $tWrap[0].htmlspecialchars(t3lib_div::fixed_lgd_cs($title,45)).$tWrap[1].'</span>';
420 }
421
422 /**
423 * Like ->getHeader() but for files in the File>* main module/submodules
424 * Returns the file-icon with the path of the file set in the alt/title attribute. Shows the file-name after the icon.
425 *
426 * @param string Title string, expected to be the filepath
427 * @param string Alt text
428 * @param string The icon file (relative to TYPO3 dir)
429 * @return string HTML content
430 */
431 function getFileheader($title,$path,$iconfile) {
432 $fileInfo = t3lib_div::split_fileref($title);
433 $title = htmlspecialchars(t3lib_div::fixed_lgd_cs($fileInfo['path'],-35)).'<b>'.htmlspecialchars($fileInfo['file']).'</b>';
434 return '<span class="typo3-moduleHeader"><img'.t3lib_iconWorks::skinImg($this->backPath,$iconfile,'width="18" height="16"').' title="'.htmlspecialchars($path).'" alt="" />'.$title.'</span>';
435 }
436
437 /**
438 * Returns a linked shortcut-icon which will call the shortcut frame and set a shortcut there back to the calling page/module
439 *
440 * @param string Is the list of GET variables to store (if any)
441 * @param string Is the list of SET[] variables to store (if any) - SET[] variables a stored in $GLOBALS["SOBE"]->MOD_SETTINGS for backend modules
442 * @param string Module name string
443 * @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.
444 * @return string HTML content
445 */
446 function makeShortcutIcon($gvList,$setList,$modName,$motherModName="") {
447 $backPath=$this->backPath;
448 $storeUrl=$this->makeShortcutUrl($gvList,$setList);
449 $pathInfo = parse_url(t3lib_div::getIndpEnv('REQUEST_URI'));
450
451 // Add the module identifier automatically if typo3/mod.php is used:
452 if (preg_match('/typo3\/mod\.php$/', $pathInfo['path']) && isset($GLOBALS['TBE_MODULES']['_PATHS'][$modName])) {
453 $storeUrl = '&M='.$modName.$storeUrl;
454 }
455
456 if (!strcmp($motherModName,'1')) {
457 $mMN="&motherModName='+top.currentModuleLoaded+'";
458 } elseif ($motherModName) {
459 $mMN='&motherModName='.rawurlencode($motherModName);
460 } else $mMN='';
461
462 $onClick = 'top.ShortcutManager.createShortcut('
463 .$GLOBALS['LANG']->JScharCode($GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:labels.makeShortcut')).', '
464 .'\''.$backPath.'\', '
465 .'\''.rawurlencode($modName).'\', '
466 .'\''.rawurlencode($pathInfo['path']."?".$storeUrl).$mMN.'\''
467 .');return false;';
468
469 $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>';
470 return $sIcon;
471 }
472
473 /**
474 * MAKE url for storing
475 * Internal func
476 *
477 * @param string Is the list of GET variables to store (if any)
478 * @param string Is the list of SET[] variables to store (if any) - SET[] variables a stored in $GLOBALS["SOBE"]->MOD_SETTINGS for backend modules
479 * @return string
480 * @access private
481 * @see makeShortcutIcon()
482 */
483 function makeShortcutUrl($gvList,$setList) {
484 $GET = t3lib_div::_GET();
485 $storeArray = array_merge(
486 t3lib_div::compileSelectedGetVarsFromArray($gvList,$GET),
487 array('SET'=>t3lib_div::compileSelectedGetVarsFromArray($setList, (array)$GLOBALS['SOBE']->MOD_SETTINGS))
488 );
489 $storeUrl = t3lib_div::implodeArrayForUrl('',$storeArray);
490 return $storeUrl;
491 }
492
493 /**
494 * Returns <input> attributes to set the width of an text-type input field.
495 * For client browsers with no CSS support the cols/size attribute is returned.
496 * For CSS compliant browsers (recommended) a ' style="width: ...px;"' is returned.
497 *
498 * @param integer A relative number which multiplied with approx. 10 will lead to the width in pixels
499 * @param boolean A flag you can set for textareas - DEPRECATED, use ->formWidthText() for textareas!!!
500 * @param string A string which will be returned as attribute-value for style="" instead of the calculated width (if CSS is enabled)
501 * @return string Tag attributes for an <input> tag (regarding width)
502 * @see formWidthText()
503 */
504 function formWidth($size=48,$textarea=0,$styleOverride='') {
505 $wAttrib = $textarea?'cols':'size';
506 if (!$GLOBALS['CLIENT']['FORMSTYLE']) { // If not setting the width by style-attribute
507 $size = $size;
508 $retVal = ' '.$wAttrib.'="'.$size.'"';
509 } else { // Setting width by style-attribute. 'cols' MUST be avoided with NN6+
510 $pixels = ceil($size*$this->form_rowsToStylewidth);
511 $retVal = $styleOverride ? ' style="'.$styleOverride.'"' : ' style="width:'.$pixels.'px;"';
512 }
513 return $retVal;
514 }
515
516 /**
517 * This function is dedicated to textareas, which has the wrapping on/off option to observe.
518 * EXAMPLE:
519 * <textarea rows="10" wrap="off" '.$GLOBALS["TBE_TEMPLATE"]->formWidthText(48,"","off").'>
520 * or
521 * <textarea rows="10" wrap="virtual" '.$GLOBALS["TBE_TEMPLATE"]->formWidthText(48,"","virtual").'>
522 *
523 * @param integer A relative number which multiplied with approx. 10 will lead to the width in pixels
524 * @param string A string which will be returned as attribute-value for style="" instead of the calculated width (if CSS is enabled)
525 * @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.
526 * @return string Tag attributes for an <input> tag (regarding width)
527 * @see formWidth()
528 */
529 function formWidthText($size=48,$styleOverride='',$wrap='') {
530 $wTags = $this->formWidth($size,1,$styleOverride);
531 // 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...
532 if (strtolower(trim($wrap))!='off' && $GLOBALS['CLIENT']['BROWSER']=='net' && $GLOBALS['CLIENT']['VERSION']>=5) {
533 $wTags.=' cols="'.$size.'"';
534 }
535 return $wTags;
536 }
537
538 /**
539 * Returns JavaScript variables setting the returnUrl and thisScript location for use by JavaScript on the page.
540 * Used in fx. db_list.php (Web>List)
541 *
542 * @param string URL to "this location" / current script
543 * @return string
544 * @see typo3/db_list.php
545 */
546 function redirectUrls($thisLocation='') {
547 $thisLocation = $thisLocation?$thisLocation:t3lib_div::linkThisScript(
548 array(
549 'CB'=>'',
550 'SET'=>'',
551 'cmd' => '',
552 'popViewId'=>''
553 ));
554
555 $out ="
556 var T3_RETURN_URL = '".str_replace('%20','',rawurlencode(t3lib_div::_GP('returnUrl')))."';
557 var T3_THIS_LOCATION = '".str_replace('%20','',rawurlencode($thisLocation))."';
558 ";
559 return $out;
560 }
561
562 /**
563 * Returns a formatted string of $tstamp
564 * Uses $GLOBALS['TYPO3_CONF_VARS']['SYS']['hhmm'] and $GLOBALS['TYPO3_CONF_VARS']['SYS']['ddmmyy'] to format date and time
565 *
566 * @param integer UNIX timestamp, seconds since 1970
567 * @param integer How much data to show: $type = 1: hhmm, $type = 10: ddmmmyy
568 * @return string Formatted timestamp
569 */
570 function formatTime($tstamp,$type) {
571 $dateStr = '';
572 switch($type) {
573 case 1: $dateStr = date($GLOBALS['TYPO3_CONF_VARS']['SYS']['hhmm'],$tstamp);
574 break;
575 case 10: $dateStr = date($GLOBALS['TYPO3_CONF_VARS']['SYS']['ddmmyy'],$tstamp);
576 break;
577 }
578 return $dateStr;
579 }
580
581 /**
582 * Returns script parsetime IF ->parseTimeFlag is set and user is "admin"
583 * Automatically outputted in page end
584 *
585 * @return string
586 */
587 function parseTime() {
588 if ($this->parseTimeFlag && $GLOBALS['BE_USER']->isAdmin()) {
589 return '<p>(ParseTime: '.(t3lib_div::milliseconds()-$GLOBALS['PARSETIME_START']).' ms</p>
590 <p>REQUEST_URI-length: '.strlen(t3lib_div::getIndpEnv('REQUEST_URI')).')</p>';
591 }
592 }
593
594
595
596
597
598
599
600
601
602
603
604
605 /*****************************************
606 *
607 * PAGE BUILDING FUNCTIONS.
608 * Use this to build the HTML of your backend modules
609 *
610 *****************************************/
611
612 /**
613 * Returns page start
614 * This includes the proper header with charset, title, meta tag and beginning body-tag.
615 *
616 * @param string HTML Page title for the header
617 * @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)
618 * @see endPage()
619 */
620 function startPage($title) {
621 // hook pre start page
622 if (isset($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['typo3/template.php']['preStartPageHook'])) {
623 $preStartPageHook =& $GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['typo3/template.php']['preStartPageHook'];
624 if (is_array($preStartPageHook)) {
625 $hookParameters = array(
626 'title' => &$title,
627 );
628 foreach ($preStartPageHook as $hookFunction) {
629 t3lib_div::callUserFunction($hookFunction, $hookParameters, $this);
630 }
631 }
632 }
633
634 // Get META tag containing the currently selected charset for backend output. The function sets $this->charSet.
635 $charSet = $this->initCharset();
636 $generator = $this->generator();
637
638 // For debugging: If this outputs "QuirksMode"/"BackCompat" (IE) the browser runs in quirks-mode. Otherwise the value is "CSS1Compat"
639 # $this->JScodeArray[]='alert(document.compatMode);';
640
641 // Send HTTP header for selected charset. Added by Robert Lemke 23.10.2003
642 header ('Content-Type:text/html;charset='.$this->charset);
643
644 // Standard HTML tag
645 $htmlTag = '<html xmlns="http://www.w3.org/1999/xhtml">';
646
647 switch($this->docType) {
648 case 'html_3':
649 $headerStart = '<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">';
650 $htmlTag = '<html>';
651 break;
652 case 'xhtml_strict':
653 $headerStart = '<!DOCTYPE html
654 PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
655 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">';
656 break;
657 case 'xhtml_frames':
658 $headerStart = '<!DOCTYPE html
659 PUBLIC "-//W3C//DTD XHTML 1.0 Frameset//EN"
660 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd">';
661 break;
662 // The fallthrough is intended as XHTML 1.0 transitional is the default for the BE.
663 case 'xhtml_trans':
664 default:
665 $headerStart = '<!DOCTYPE html
666 PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
667 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">';
668 }
669
670 // This loads the tabulator-in-textarea feature. It automatically modifies
671 // every textarea which is found.
672 if (!$GLOBALS['BE_USER']->uc['disableTabInTextarea']) {
673 $this->loadJavascriptLib('tab.js');
674 }
675
676 // Get the browser info
677 $browserInfo = t3lib_utility_Client::getBrowserInfo(t3lib_div::getIndpEnv('HTTP_USER_AGENT'));
678
679 // Set the XML prologue
680 $xmlPrologue = '<?xml version="1.0" encoding="' . $this->charset . '"?>';
681
682 // Set the XML stylesheet
683 $xmlStylesheet = '<?xml-stylesheet href="#internalStyle" type="text/css"?>';
684
685 // Add the XML prologue for XHTML doctypes
686 if ($this->docType !== 'html_3') {
687 // Put the XML prologue before or after the doctype declaration according to browser
688 if ($browserInfo['browser'] === 'msie' && $browserInfo['version'] < 7) {
689 $headerStart = $headerStart . chr(10) . $xmlPrologue;
690 } else {
691 $headerStart = $xmlPrologue . chr(10) . $headerStart;
692 }
693
694 // Add the xml stylesheet according to doctype
695 if ($this->docType !== 'xhtml_frames') {
696 $headerStart = $headerStart . chr(10) . $xmlStylesheet;
697 }
698 }
699
700 // Construct page header.
701 $str = $headerStart . chr(10) . $htmlTag . '
702 <head>
703 <!-- TYPO3 Script ID: '.htmlspecialchars($this->scriptID).' -->
704 '.$charSet.'
705 '.$generator.'
706 <title>'.htmlspecialchars($title).'</title>
707 '.$this->docStyle().'
708 ' . $this->renderJSlibraries() . '
709 '.$this->JScode.'
710 '.$this->wrapScriptTags(implode("\n", $this->JScodeArray)).
711 ($this->extJScode ? $this->wrapScriptTags('Ext.onReady(function() {' . chr(10) . $this->extJScode . chr(10) . '});') : '') .
712 '
713 <!--###POSTJSMARKER###-->
714 </head>
715 ';
716 $this->JScodeLibArray = array();
717 $this->JScode = $this->extJScode = '';
718 $this->JScodeArray = array();
719
720 if ($this->docType=='xhtml_frames') {
721 return $str;
722 } else
723 $str.=$this->docBodyTagBegin().
724 ($this->divClass?'
725
726 <!-- Wrapping DIV-section for whole page BEGIN -->
727 <div class="'.$this->divClass.'">
728 ':'').trim($this->form);
729 return $str;
730 }
731
732 /**
733 * Returns page end; This includes finishing form, div, body and html tags.
734 *
735 * @return string The HTML end of a page
736 * @see startPage()
737 */
738 function endPage() {
739 $str = $this->sectionEnd().
740 $this->postCode.
741 $this->endPageJS().
742 $this->wrapScriptTags(t3lib_BEfunc::getUpdateSignalCode()).
743 $this->parseTime().
744 ($this->form?'
745 </form>':'');
746
747 if ($this->docType!='xhtml_frames') {
748
749 $str .= ($this->divClass?'
750
751 <!-- Wrapping DIV-section for whole page END -->
752 </div>':'').'
753 </body> ';
754
755 }
756
757 $str .= '</html>';
758
759 // Logging: Can't find better place to put it:
760 if (TYPO3_DLOG) t3lib_div::devLog('END of BACKEND session', 'template', 0, array('_FLUSH' => true));
761
762 return $str;
763 }
764
765 /**
766 * Returns the header-bar in the top of most backend modules
767 * Closes section if open.
768 *
769 * @param string The text string for the header
770 * @return string HTML content
771 */
772 function header($text) {
773 $str='
774
775 <!-- MAIN Header in page top -->
776 <h2>'.htmlspecialchars($text).'</h2>
777 ';
778 return $this->sectionEnd().$str;
779 }
780
781 /**
782 * Begins an output section and sets header and content
783 *
784 * @param string The header
785 * @param string The HTML-content
786 * @param boolean A flag that will prevent the header from being converted to uppercase
787 * @param boolean Defines the type of header (if set, "<h3>" rather than the default "h4")
788 * @param integer The number of an icon to show with the header (see the icon-function). -1,1,2,3
789 * @param boolean If set, HTML tags are allowed in $label (otherwise this value is by default htmlspecialchars()'ed)
790 * @return string HTML content
791 * @see icons(), sectionHeader()
792 */
793 function section($label,$text,$nostrtoupper=FALSE,$sH=FALSE,$type=0,$allowHTMLinHeader=FALSE) {
794 $str='';
795
796 // Setting header
797 if ($label) {
798 if (!$allowHTMLinHeader) $label = htmlspecialchars($label);
799 $str.=$this->sectionHeader($this->icons($type).$label, $sH, $nostrtoupper ? '' : ' class="uppercase"');
800 }
801 // Setting content
802 $str.='
803
804 <!-- Section content -->
805 '.$text;
806
807 return $this->sectionBegin().$str;
808 }
809
810 /**
811 * Inserts a divider image
812 * Ends a section (if open) before inserting the image
813 *
814 * @param integer The margin-top/-bottom of the <hr> ruler.
815 * @return string HTML content
816 */
817 function divider($dist) {
818 $dist = intval($dist);
819 $str='
820
821 <!-- DIVIDER -->
822 <hr style="margin-top: '.$dist.'px; margin-bottom: '.$dist.'px;" />
823 ';
824 return $this->sectionEnd().$str;
825 }
826
827 /**
828 * Returns a blank <div>-section with a height
829 *
830 * @param integer Padding-top for the div-section (should be margin-top but konqueror (3.1) doesn't like it :-(
831 * @return string HTML content
832 */
833 function spacer($dist) {
834 if ($dist>0) {
835 return '
836
837 <!-- Spacer element -->
838 <div style="padding-top: '.intval($dist).'px;"></div>
839 ';
840 }
841 }
842
843 /**
844 * Make a section header.
845 * Begins a section if not already open.
846 *
847 * @param string The label between the <h3> or <h4> tags. (Allows HTML)
848 * @param boolean If set, <h3> is used, otherwise <h4>
849 * @param string Additional attributes to h-tag, eg. ' class=""'
850 * @return string HTML content
851 */
852 function sectionHeader($label,$sH=FALSE,$addAttrib='') {
853 $tag = ($sH?'h3':'h4');
854 $str='
855
856 <!-- Section header -->
857 <'.$tag.$addAttrib.'>'.$label.'</'.$tag.'>
858 ';
859 return $this->sectionBegin().$str;
860 }
861
862 /**
863 * Begins an output section.
864 * Returns the <div>-begin tag AND sets the ->sectionFlag true (if the ->sectionFlag is not already set!)
865 * 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!
866 *
867 * @return string HTML content
868 */
869 function sectionBegin() {
870 if (!$this->sectionFlag) {
871 $this->sectionFlag=1;
872 $str='
873
874 <!-- ***********************
875 Begin output section.
876 *********************** -->
877 <div>
878 ';
879 return $str;
880 } else return '';
881 }
882
883 /**
884 * Ends and output section
885 * Returns the </div>-end tag AND clears the ->sectionFlag (but does so only IF the sectionFlag is set - that is a section is 'open')
886 * See sectionBegin() also.
887 *
888 * @return string HTML content
889 */
890 function sectionEnd() {
891 if ($this->sectionFlag) {
892 $this->sectionFlag=0;
893 return '
894 </div>
895 <!-- *********************
896 End output section.
897 ********************* -->
898 ';
899 } else return '';
900 }
901
902 /**
903 * Originally it printed a kind of divider.
904 * Deprecated. Just remove function calls to it or call the divider() function instead.
905 *
906 * @return void
907 * @internal
908 * @deprecated since TYPO3 3.6
909 */
910 function middle() {
911 }
912
913 /**
914 * If a form-tag is defined in ->form then and end-tag for that <form> element is outputted
915 * Further a JavaScript section is outputted which will update the top.busy session-expiry object (unless $this->endJS is set to false)
916 *
917 * @return string HTML content (<script> tag section)
918 */
919 function endPageJS() {
920 return ($this->endJS?'
921 <script type="text/javascript">
922 /*<![CDATA[*/
923 if (top.busy && top.busy.loginRefreshed) {
924 top.busy.loginRefreshed();
925 }
926 /*]]>*/
927 </script>':'');
928 }
929
930 /**
931 * Creates the bodyTag.
932 * You can add to the bodyTag by $this->bodyTagAdditions
933 *
934 * @return string HTML body tag
935 */
936 function docBodyTagBegin() {
937 $bodyContent = 'body onclick="if (top.menuReset) top.menuReset();" '.trim($this->bodyTagAdditions.($this->bodyTagId ? ' id="'.$this->bodyTagId.'"' : ''));
938 return '<'.trim($bodyContent).'>';
939 }
940
941 /**
942 * Outputting document style
943 *
944 * @return string HTML style section/link tags
945 */
946 function docStyle() {
947
948 // Request background image:
949 if ($this->backGroundImage) {
950 $this->inDocStylesArray[]=' BODY { background-image: url('.$this->backPath.$this->backGroundImage.'); }';
951 }
952
953 // Add inDoc styles variables as well:
954 $this->inDocStylesArray[] = $this->inDocStyles;
955 $this->inDocStylesArray[] = $this->inDocStyles_TBEstyle;
956
957 // Implode it all:
958 $inDocStyles = implode('
959 ',$this->inDocStylesArray);
960
961 // The default color scheme should also in full be represented in the stylesheet.
962 $style=trim('
963 '.($this->styleSheetFile?'<link rel="stylesheet" type="text/css" href="'.$this->backPath.$this->styleSheetFile.'" />':'').'
964 '.($this->styleSheetFile2?'<link rel="stylesheet" type="text/css" href="'.$this->backPath.$this->styleSheetFile2.'" />':'').'
965 <style type="text/css" id="internalStyle">
966 /*<![CDATA[*/
967 '.trim($inDocStyles).'
968 /*###POSTCSSMARKER###*/
969 /*]]>*/
970 </style>
971 '.($this->styleSheetFile_post?'<link rel="stylesheet" type="text/css" href="'.$this->backPath.$this->styleSheetFile_post.'" />':'').'
972 '.implode("\n", $this->additionalStyleSheets)
973 )
974 ;
975 $this->inDocStyles='';
976 $this->inDocStylesArray=array();
977
978 return '
979 '.$style;
980 }
981
982 /**
983 * Insert additional style sheet link
984 *
985 * @param string $key: some key identifying the style sheet
986 * @param string $href: uri to the style sheet file
987 * @param string $title: value for the title attribute of the link element
988 * @return string $relation: value for the rel attribute of the link element
989 * @return void
990 */
991 function addStyleSheet($key, $href, $title='', $relation='stylesheet') {
992 if (!isset($this->additionalStyleSheets[$key])) {
993 $this->additionalStyleSheets[$key] = '<link rel="' . $relation . '" type="text/css" href="' . $href . '"' . ($title ? (' title="' . $title . '"') : '') . ' />';
994 }
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 if (!isset($this->JScodeLibArray[$lib])) {
1322 $this->JScodeLibArray[$lib] = '<script type="text/javascript" src="' . $this->backPath . $lib . '"></script>';
1323 }
1324 }
1325
1326
1327 /**
1328 *
1329 * @param string $lib it will remove lib from general JScodeLibArray because lib is loaded already.
1330 */
1331 protected function removeJavascriptLib($lib) {
1332 if (count($this->JScodeLibArray)) {
1333 $scripts = array_keys($this->JScodeLibArray);
1334 foreach ($scripts as $script) {
1335 if (strpos($script, '/' . $lib . '/') !== false) {
1336 unset ($this->JScodeLibArray[$script]);
1337 }
1338 }
1339 }
1340 }
1341
1342 /**
1343 * Includes the necessary Javascript function for the clickmenu (context sensitive menus) in the document
1344 *
1345 * @return array Deprecated: Includes the code already in the doc, so the return array is always empty.
1346 * Please just call this function without expecting a return value for future calls
1347 */
1348 function getContextMenuCode() {
1349 $this->loadPrototype();
1350 $this->loadJavascriptLib('js/clickmenu.js');
1351
1352 $this->JScodeArray['clickmenu'] = '
1353 Clickmenu.clickURL = "'.$this->backPath.'alt_clickmenu.php";
1354 Clickmenu.ajax = '.($this->isCMLayers() ? 'true' : 'false' ).';';
1355
1356 // return array deprecated since 4.2
1357 return array('','','');
1358 }
1359
1360 /**
1361 * Includes the necessary javascript file (tree.js) for use on pages which have the
1362 * drag and drop functionality (usually pages and folder display trees)
1363 *
1364 * @param string indicator of which table the drag and drop function should work on (pages or folders)
1365 * @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
1366 */
1367 function getDragDropCode($table) {
1368 $this->loadPrototype();
1369 $this->loadJavascriptLib('js/common.js');
1370 $this->loadJavascriptLib('js/tree.js');
1371
1372 // setting prefs for drag & drop
1373 $this->JScodeArray['dragdrop'] = '
1374 DragDrop.changeURL = "'.$this->backPath.'alt_clickmenu.php";
1375 DragDrop.backPath = "'.t3lib_div::shortMD5(''.'|'.$GLOBALS['TYPO3_CONF_VARS']['SYS']['encryptionKey']).'";
1376 DragDrop.table = "'.$table.'";
1377 ';
1378
1379 // return array deprecated since 4.2
1380 return array('','','');
1381 }
1382
1383
1384 /**
1385 * Creates a tab menu from an array definition
1386 *
1387 * Returns a tab menu for a module
1388 * Requires the JS function jumpToUrl() to be available
1389 *
1390 * @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=...
1391 * @param string $elementName it the form elements name, probably something like "SET[...]"
1392 * @param string $currentValue is the value to be selected currently.
1393 * @param array $menuItems is an array with the menu items for the selector box
1394 * @param string $script is the script to send the &id to, if empty it's automatically found
1395 * @param string $addParams is additional parameters to pass to the script.
1396 * @return string HTML code for tab menu
1397 * @author Rene Fritz <r.fritz@colorcube.de>
1398 */
1399 function getTabMenu($mainParams,$elementName,$currentValue,$menuItems,$script='',$addparams='') {
1400 $content='';
1401
1402 if (is_array($menuItems)) {
1403 if (!is_array($mainParams)) {
1404 $mainParams = array('id' => $mainParams);
1405 }
1406 $mainParams = t3lib_div::implodeArrayForUrl('',$mainParams);
1407
1408 if (!$script) {$script=basename(PATH_thisScript);}
1409
1410 $menuDef = array();
1411 foreach($menuItems as $value => $label) {
1412 $menuDef[$value]['isActive'] = !strcmp($currentValue,$value);
1413 $menuDef[$value]['label'] = t3lib_div::deHSCentities(htmlspecialchars($label));
1414 $menuDef[$value]['url'] = $script . '?' . $mainParams . $addparams . '&' . $elementName . '=' . $value;
1415 }
1416 $content = $this->getTabMenuRaw($menuDef);
1417
1418 }
1419 return $content;
1420 }
1421
1422 /**
1423 * Creates the HTML content for the tab menu
1424 *
1425 * @param array Menu items for tabs
1426 * @return string Table HTML
1427 * @access private
1428 */
1429 function getTabMenuRaw($menuItems) {
1430 $content='';
1431
1432 if (is_array($menuItems)) {
1433 $options='';
1434
1435 $count = count($menuItems);
1436 $widthLeft = 1;
1437 $addToAct = 5;
1438
1439 $widthRight = max (1,floor(30-pow($count,1.72)));
1440 $widthTabs = 100 - $widthRight - $widthLeft;
1441 $widthNo = floor(($widthTabs - $addToAct)/$count);
1442 $addToAct = max ($addToAct,$widthTabs-($widthNo*$count));
1443 $widthAct = $widthNo + $addToAct;
1444 $widthRight = 100 - ($widthLeft + ($count*$widthNo) + $addToAct);
1445
1446 $first=true;
1447 foreach($menuItems as $id => $def) {
1448 $isActive = $def['isActive'];
1449 $class = $isActive ? 'tabact' : 'tab';
1450 $width = $isActive ? $widthAct : $widthNo;
1451
1452 // @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.
1453 $label = $def['label'];
1454 $url = htmlspecialchars($def['url']);
1455 $params = $def['addParams'];
1456
1457 if($first) {
1458 $options.= '
1459 <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>';
1460 } else {
1461 $options.='
1462 <td width="'.$width.'%" class="'.$class.'"><a href="'.$url.'" '.$params.'>'.$label.'</a></td>';
1463 }
1464 $first=false;
1465 }
1466
1467 if ($options) {
1468 $content .= '
1469 <!-- Tab menu -->
1470 <table cellpadding="0" cellspacing="0" border="0" width="100%" id="typo3-tabmenu">
1471 <tr>
1472 <td width="'.$widthLeft.'%">&nbsp;</td>
1473 '.$options.'
1474 <td width="'.$widthRight.'%">&nbsp;</td>
1475 </tr>
1476 </table>
1477 <div class="hr" style="margin:0px"></div>';
1478 }
1479
1480 }
1481 return $content;
1482 }
1483
1484 /**
1485 * Creates a DYNAMIC tab-menu where the tabs are switched between with DHTML.
1486 * 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!
1487 *
1488 * @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.
1489 * @param string Identification string. This should be unique for every instance of a dynamic menu!
1490 * @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.
1491 * @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.
1492 * @param integer Character limit for a new row.
1493 * @param boolean If set, tab table cells are not allowed to wrap their content
1494 * @param boolean If set, the tabs will span the full width of their position
1495 * @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.
1496 * @param integer If set to '1' empty tabs will be remove, If set to '2' empty tabs will be disabled
1497 * @return string JavaScript section for the HTML header.
1498 */
1499 function getDynTabMenu($menuItems,$identString,$toggle=0,$foldout=FALSE,$newRowCharLimit=50,$noWrap=1,$fullWidth=FALSE,$defaultTabIndex=1,$dividers2tabs=2) {
1500 // load the static code, if not already done with the function below
1501 $this->loadJavascriptLib('js/tabmenu.js');
1502
1503 $content = '';
1504
1505 if (is_array($menuItems)) {
1506
1507 // Init:
1508 $options = array(array());
1509 $divs = array();
1510 $JSinit = array();
1511 $id = $this->getDynTabMenuId($identString);
1512 $noWrap = $noWrap ? ' nowrap="nowrap"' : '';
1513
1514 // Traverse menu items
1515 $c=0;
1516 $tabRows=0;
1517 $titleLenCount = 0;
1518 foreach($menuItems as $index => $def) {
1519 $index+=1; // Need to add one so checking for first index in JavaScript is different than if it is not set at all.
1520
1521 // Switch to next tab row if needed
1522 if (!$foldout && ($titleLenCount>$newRowCharLimit | ($def['newline'] === true && $titleLenCount > 0))) {
1523 $titleLenCount=0;
1524 $tabRows++;
1525 $options[$tabRows] = array();
1526 }
1527
1528 if ($toggle==1) {
1529 $onclick = 'this.blur(); DTM_toggle("'.$id.'","'.$index.'"); return false;';
1530 } else {
1531 $onclick = 'this.blur(); DTM_activate("'.$id.'","'.$index.'", '.($toggle<0?1:0).'); return false;';
1532 }
1533
1534 $isEmpty = !(strcmp(trim($def['content']),'') || strcmp(trim($def['icon']),''));
1535
1536 // "Removes" empty tabs
1537 if ($isEmpty && $dividers2tabs == 1) {
1538 continue;
1539 }
1540
1541 $mouseOverOut = ' onmouseover="DTM_mouseOver(this);" onmouseout="DTM_mouseOut(this);"';
1542 $requiredIcon = '<img name="' . $id . '-' . $index . '-REQ" src="' . $GLOBALS['BACK_PATH'] . 'gfx/clear.gif" width="10" height="10" hspace="4" alt="" />';
1543
1544 if (!$foldout) {
1545 // Create TAB cell:
1546 $options[$tabRows][] = '
1547 <td class="'.($isEmpty ? 'disabled' : 'tab').'" id="'.$id.'-'.$index.'-MENU"'.$noWrap.$mouseOverOut.'>'.
1548 ($isEmpty ? '' : '<a href="#" onclick="'.htmlspecialchars($onclick).'"'.($def['linkTitle'] ? ' title="'.htmlspecialchars($def['linkTitle']).'"':'').'>').
1549 $def['icon'].
1550 ($def['label'] ? htmlspecialchars($def['label']) : '&nbsp;').
1551 $requiredIcon.
1552 $this->icons($def['stateIcon'],'margin-left: 10px;').
1553 ($isEmpty ? '' : '</a>').
1554 '</td>';
1555 $titleLenCount+= strlen($def['label']);
1556 } else {
1557 // Create DIV layer for content:
1558 $divs[] = '
1559 <div class="'.($isEmpty ? 'disabled' : 'tab').'" id="'.$id.'-'.$index.'-MENU"'.$mouseOverOut.'>'.
1560 ($isEmpty ? '' : '<a href="#" onclick="'.htmlspecialchars($onclick).'"'.($def['linkTitle'] ? ' title="'.htmlspecialchars($def['linkTitle']).'"':'').'>').
1561 $def['icon'].
1562 ($def['label'] ? htmlspecialchars($def['label']) : '&nbsp;').
1563 $requiredIcon.
1564 ($isEmpty ? '' : '</a>').
1565 '</div>';
1566 }
1567
1568 // Create DIV layer for content:
1569 $divs[] = '
1570 <div style="display: none;" id="'.$id.'-'.$index.'-DIV" class="c-tablayer">'.
1571 ($def['description'] ? '<p class="c-descr">'.nl2br(htmlspecialchars($def['description'])).'</p>' : '').
1572 $def['content'].
1573 '</div>';
1574 // Create initialization string:
1575 $JSinit[] = '
1576 DTM_array["'.$id.'"]['.$c.'] = "'.$id.'-'.$index.'";
1577 ';
1578 // If not empty and we have the toggle option on, check if the tab needs to be expanded
1579 if ($toggle == 1 && !$isEmpty) {
1580 $JSinit[] = '
1581 if (top.DTM_currentTabs["'.$id.'-'.$index.'"]) { DTM_toggle("'.$id.'","'.$index.'",1); }
1582 ';
1583 }
1584
1585 $c++;
1586 }
1587
1588 // Render menu:
1589 if (count($options)) {
1590
1591 // Tab menu is compiled:
1592 if (!$foldout) {
1593 $tabContent = '';
1594 for($a=0;$a<=$tabRows;$a++) {
1595 $tabContent.= '
1596
1597 <!-- Tab menu -->
1598 <table cellpadding="0" cellspacing="0" border="0"'.($fullWidth ? ' width="100%"' : '').' class="typo3-dyntabmenu">
1599 <tr>
1600 '.implode('',$options[$a]).'
1601 </tr>
1602 </table>';
1603 }
1604 $content.= '<div class="typo3-dyntabmenu-tabs">'.$tabContent.'</div>';
1605 }
1606
1607 // Div layers are added:
1608 $content.= '
1609 <!-- Div layers for tab menu: -->
1610 <div class="typo3-dyntabmenu-divs'.($foldout?'-foldout':'').'">
1611 '.implode('',$divs).'</div>';
1612
1613 // Java Script section added:
1614 $content.= '
1615 <!-- Initialization JavaScript for the menu -->
1616 <script type="text/javascript">
1617 DTM_array["'.$id.'"] = new Array();
1618 '.implode('',$JSinit).'
1619 '.($toggle<=0 ? 'DTM_activate("'.$id.'", top.DTM_currentTabs["'.$id.'"]?top.DTM_currentTabs["'.$id.'"]:'.intval($defaultTabIndex).', 0);' : '').'
1620 </script>
1621
1622 ';
1623 }
1624
1625 }
1626 return $content;
1627 }
1628
1629 /**
1630 * Creates the id for dynTabMenus.
1631 *
1632 * @param string $identString: Identification string. This should be unique for every instance of a dynamic menu!
1633 * @return string The id with a short MD5 of $identString and prefixed "DTM-", like "DTM-2e8791854a"
1634 */
1635 function getDynTabMenuId($identString) {
1636 $id = 'DTM-'.t3lib_div::shortMD5($identString);
1637 return $id;
1638 }
1639
1640 /**
1641 * Returns dynamic tab menu header JS code.
1642 * This is now incorporated automatically when the function template::getDynTabMenu is called
1643 * (as long as it is called before $this->startPage())
1644 * The return value is not needed anymore
1645 *
1646 * @return string JavaScript section for the HTML header. (return value is deprecated since TYPO3 4.3, will be removed in TYPO3 4.5)
1647 */
1648 function getDynTabMenuJScode() {
1649 $this->loadJavascriptLib('js/tabmenu.js');
1650 // return value deprecated since TYPO3 4.3
1651 return '';
1652 }
1653
1654 /**
1655 * Creates the version selector for the page id inputted.
1656 * Requires the core version management extension, "version" to be loaded.
1657 *
1658 * @param integer Page id to create selector for.
1659 * @param boolean If set, there will be no button for swapping page.
1660 * @return void
1661 */
1662 function getVersionSelector($id,$noAction=FALSE) {
1663
1664 if ($id>0) {
1665 if (t3lib_extMgm::isLoaded('version') && $GLOBALS['BE_USER']->workspace==0) {
1666
1667 // Get Current page record:
1668 $curPage = t3lib_BEfunc::getRecord('pages',$id);
1669 // If the selected page is not online, find the right ID
1670 $onlineId = ($curPage['pid']==-1 ? $curPage['t3ver_oid'] : $id);
1671 // Select all versions of online version:
1672 $versions = t3lib_BEfunc::selectVersionsOfRecord('pages', $onlineId, 'uid,pid,t3ver_label,t3ver_oid,t3ver_wsid,t3ver_id');
1673
1674 // If more than one was found...:
1675 if (count($versions)>1) {
1676
1677 // Create selector box entries:
1678 $opt = array();
1679 foreach($versions as $vRow) {
1680 $opt[] = '<option value="'.htmlspecialchars(t3lib_div::linkThisScript(array('id'=>$vRow['uid']))).'"'.($id==$vRow['uid']?' selected="selected"':'').'>'.
1681 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').'<=':'')).
1682 '</option>';
1683 }
1684
1685 // Add management link:
1686 $opt[] = '<option value="'.htmlspecialchars(t3lib_div::linkThisScript(array('id'=>$id))).'">---</option>';
1687 $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>';
1688
1689 // Create onchange handler:
1690 $onChange = "window.location.href=this.options[this.selectedIndex].value;";
1691
1692 // Controls:
1693 if ($id==$onlineId) {
1694 $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>';
1695 } elseif (!$noAction) {
1696 $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">'.
1697 '<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).'" />'.
1698 '<b>'.$GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:ver.swap',1).'</b></a>';
1699 }
1700
1701 // Write out HTML code:
1702 return '
1703
1704 <!--
1705 Version selector:
1706 -->
1707 <table border="0" cellpadding="0" cellspacing="0" id="typo3-versionSelector">
1708 <tr>
1709 <td>'.$GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:ver.selVer',1).'</td>
1710 <td>
1711 <select onchange="'.htmlspecialchars($onChange).'">
1712 '.implode('',$opt).'
1713 </select></td>
1714 <td>'.$controls.'</td>
1715 </tr>
1716 </table>
1717 ';
1718 }
1719 } elseif ($GLOBALS['BE_USER']->workspace!==0) {
1720
1721 // Write out HTML code:
1722 switch($GLOBALS['BE_USER']->workspace) {
1723 case 0:
1724 $wsTitle = 'LIVE';
1725 break;
1726 case -1:
1727 $wsTitle = 'Draft';
1728 break;
1729 default:
1730 $wsTitle = $GLOBALS['BE_USER']->workspaceRec['title'];
1731 break;
1732 }
1733
1734 if (t3lib_BEfunc::isPidInVersionizedBranch($id)=='branchpoint') {
1735 return '
1736
1737 <!--
1738 Version selector:
1739 -->
1740 <table border="0" cellpadding="0" cellspacing="0" id="typo3-versionSelector">
1741 <tr>
1742 <td>Workspace: "'.htmlspecialchars($wsTitle).'"</td>
1743 <td><em>Inside branch, no further versioning possible</em></td>
1744 </tr>
1745 </table>
1746 ';
1747 } else {
1748 // Get Current page record:
1749 $curPage = t3lib_BEfunc::getRecord('pages',$id);
1750 // If the selected page is not online, find the right ID
1751 $onlineId = ($curPage['pid']==-1 ? $curPage['t3ver_oid'] : $id);
1752 // The version of page:
1753 $verPage = t3lib_BEfunc::getWorkspaceVersionOfRecord($GLOBALS['BE_USER']->workspace, 'pages', $onlineId);
1754
1755 if (!$verPage) {
1756
1757 if (!count(t3lib_BEfunc::countVersionsOfRecordsOnPage($GLOBALS['BE_USER']->workspace, $onlineId))) {
1758 if ($GLOBALS['BE_USER']->workspaceVersioningTypeAccess(0)) {
1759
1760 $onClick = $this->issueCommand('&cmd[pages]['.$onlineId.'][version][action]=new&cmd[pages]['.$onlineId.'][version][treeLevels]=0',t3lib_div::linkThisScript(array('id'=>$onlineId)));
1761 $onClick = 'window.location.href=\''.$onClick.'\'; return false;';
1762 // Write out HTML code:
1763 return '
1764
1765 <!--
1766 No version yet, create one?
1767 -->
1768 <table border="0" cellpadding="0" cellspacing="0" id="typo3-versionSelector">
1769 <tr>
1770 <td>Workspace: "'.htmlspecialchars($wsTitle).'"</td>
1771 <td>
1772 <input type="submit" value="New version of page" name="_" onclick="'.htmlspecialchars($onClick).'" /></td>
1773 </tr>
1774 </table>
1775 ';
1776 }
1777 } else {
1778 return '
1779
1780 <!--
1781 Version selector:
1782 -->
1783 <table border="0" cellpadding="0" cellspacing="0" id="typo3-versionSelector">
1784 <tr>
1785 <td>Workspace: "'.htmlspecialchars($wsTitle).'"</td>
1786 <td><em>Versions found on page, no "Page" versioning possible</em></td>
1787 </tr>
1788 </table>
1789 ';
1790 }
1791 } elseif ($verPage['t3ver_swapmode']==0) {
1792 $onClick = $this->issueCommand('&cmd[pages]['.$onlineId.'][version][action]=swap&cmd[pages]['.$onlineId.'][version][swapWith]='.$verPage['uid'],t3lib_div::linkThisScript(array('id'=>$onlineId)));
1793 $onClick = 'window.location.href=\''.$onClick.'\'; return false;';
1794
1795 // Write out HTML code:
1796 return '
1797
1798 <!--
1799 Version selector:
1800 -->
1801 <table border="0" cellpadding="0" cellspacing="0" id="typo3-versionSelector">
1802 <tr>
1803 <td>Workspace: "'.htmlspecialchars($wsTitle).'"</td>
1804 <td>
1805 <input type="submit" value="Publish page" name="_" onclick="'.htmlspecialchars($onClick).'" /></td>
1806 </tr>
1807 </table>
1808 ';
1809 }
1810 }
1811 }
1812 }
1813 }
1814
1815 /**
1816 * Adds a flash message to the queue. It will live until the next call to
1817 * popFlashMessages() in the current session.
1818 *
1819 * @param t3lib_FlashMessage A flash message object.
1820 * @return void
1821 * @author Karsten Dambekalns <karsten@typo3.org>
1822 * @author Ingo Renner <ingo@typo3.org>
1823 */
1824 public function pushFlashMessage(t3lib_FlashMessage $message) {
1825 $queuedFlashMessages = $this->getFlashMessagesFromSession();
1826 $queuedFlashMessages[] = $message;
1827
1828 $GLOBALS['BE_USER']->setAndSaveSessionData(
1829 'core.template.flashMessages',
1830 $queuedFlashMessages
1831 );
1832 }
1833
1834 /**
1835 * Returns queued flash messages and clears the queue.
1836 *
1837 * @return array An array with t3lib_FlashMessage flash messages.
1838 * @author Karsten Dambekalns <karsten@typo3.org>
1839 * @author Ingo Renner <ingo@typo3.org>
1840 */
1841 public function popFlashMessages() {
1842 $queuedFlashMessages = $this->getFlashMessagesFromSession();
1843
1844 if (!empty($queuedFlashMessages)) {
1845 $GLOBALS['BE_USER']->setAndSaveSessionData(
1846 'core.template.flashMessages',
1847 null
1848 );
1849 }
1850
1851 return $queuedFlashMessages;
1852 }
1853
1854 /**
1855 * Returns current flash messages from the session, making sure to always
1856 * return an array.
1857 *
1858 * @return array An array of t3lib_FlashMessage flash messages.
1859 * @author Karsten Dambekalns <karsten@typo3.org>
1860 * @author Ingo Renner <ingo@typo3.org>
1861 */
1862 protected function getFlashMessagesFromSession() {
1863 $flashMessages = $GLOBALS['BE_USER']->getSessionData('core.template.flashMessages');
1864
1865 return is_array($flashMessages) ? $flashMessages : array();
1866 }
1867
1868 /**
1869 * Renders all available flash messages in the queue.
1870 *
1871 * @return string All flash messages in the queue rendered as HTML.
1872 * @author Ingo Renner <ingo@typo3.org>
1873 */
1874 public function renderFlashMessages() {
1875 $content = '';
1876 $flashMessages = $this->popFlashMessages();
1877
1878 foreach ($flashMessages as $flashMessage) {
1879 $content .= $flashMessage->render();
1880 }
1881
1882 return $content;
1883 }
1884
1885
1886 /**
1887 * Function to load a HTML template file with markers.
1888 * When calling from own extension, use syntax getHtmlTemplate('EXT:extkey/template.html')
1889 *
1890 * @param string tmpl name, usually in the typo3/template/ directory
1891 * @return string HTML of template
1892 */
1893 function getHtmlTemplate($filename) {
1894 if ($GLOBALS['TBE_STYLES']['htmlTemplates'][$filename]) {
1895 $filename = $GLOBALS['TBE_STYLES']['htmlTemplates'][$filename];
1896 }
1897 if (substr($filename,0,4) != 'EXT:') {
1898 $filename = t3lib_div::resolveBackPath($this->backPath . $filename);
1899 } else {
1900 $filename = t3lib_div::getFileAbsFileName($filename, true, true);
1901 }
1902 return t3lib_div::getURL($filename);
1903 }
1904
1905 /**
1906 * Define the template for the module
1907 *
1908 * @param string filename
1909 */
1910 function setModuleTemplate($filename) {
1911 // Load Prototype lib for IE event
1912 $this->loadPrototype();
1913 $this->loadJavascriptLib('js/iecompatibility.js');
1914 $this->moduleTemplate = $this->getHtmlTemplate($filename);
1915 }
1916
1917 /**
1918 * Put together the various elements for the module <body> using a static HTML
1919 * template
1920 *
1921 * @param array Record of the current page, used for page path and info
1922 * @param array HTML for all buttons
1923 * @param array HTML for all other markers
1924 * @return string Composite HTML
1925 */
1926 public function moduleBody($pageRecord = array(), $buttons = array(), $markerArray = array(), $subpartArray = array()) {
1927 // Get the HTML template for the module
1928 $moduleBody = t3lib_parsehtml::getSubpart($this->moduleTemplate, '###FULLDOC###');
1929 // Add CSS
1930 $this->inDocStylesArray[] = 'html { overflow: hidden; }';
1931 // Add JS code to the <head> for IE
1932 $this->JScode.= $this->wrapScriptTags('
1933 // workaround since IE6 cannot deal with relative height for scrolling elements
1934 function resizeDocBody() {
1935 $("typo3-docbody").style.height = (document.body.offsetHeight - parseInt($("typo3-docheader").getStyle("height")));
1936 }
1937 if (Prototype.Browser.IE) {
1938 var version = parseFloat(navigator.appVersion.split(\';\')[1].strip().split(\' \')[1]);
1939 if (version == 6) {
1940 Event.observe(window, "resize", resizeDocBody, false);
1941 Event.observe(window, "load", resizeDocBody, false);
1942 }
1943 }
1944 ');
1945 // Get the page path for the docheader
1946 $markerArray['PAGEPATH'] = $this->getPagePath($pageRecord);
1947 // Get the page info for the docheader
1948 $markerArray['PAGEINFO'] = $this->getPageInfo($pageRecord);
1949 // Get all the buttons for the docheader
1950 $docHeaderButtons = $this->getDocHeaderButtons($buttons);
1951 // Merge docheader buttons with the marker array
1952 $markerArray = array_merge($markerArray, $docHeaderButtons);
1953 // replacing subparts
1954 foreach ($subpartArray as $marker => $content) {
1955 $moduleBody = t3lib_parsehtml::substituteSubpart($moduleBody, $marker, $content);
1956 }
1957
1958 // adding flash messages
1959 $flashMessages = $this->renderFlashMessages();
1960 if (!empty($flashMessages)) {
1961 $flashMessages = '<div id="typo3-messages">' . $flashMessages . '</div>';
1962 }
1963
1964 if (strstr($moduleBody, '###FLASHMESSAGES###')) {
1965 // either replace a dedicated marker for the messages if present
1966 $moduleBody = str_replace(
1967 '###FLASHMESSAGES###',
1968 $flashMessages,
1969 $moduleBody
1970 );
1971 } else {
1972 // or force them to appear before the content
1973 $moduleBody = str_replace(
1974 '###CONTENT###',
1975 $flashMessages . '###CONTENT###',
1976 $moduleBody
1977 );
1978 }
1979
1980 // replacing all markers with the finished markers and return the HTML content
1981 return t3lib_parsehtml::substituteMarkerArray($moduleBody, $markerArray, '###|###');
1982
1983 }
1984
1985 /**
1986 * Fill the button lists with the defined HTML
1987 *
1988 * @param array HTML for all buttons
1989 * @return array Containing HTML for both buttonlists
1990 */
1991 protected function getDocHeaderButtons($buttons) {
1992 $markers = array();
1993 // Fill buttons for left and right float
1994 $floats = array('left', 'right');
1995 foreach($floats as $key) {
1996 // Get the template for each float
1997 $buttonTemplate = t3lib_parsehtml::getSubpart($this->moduleTemplate, '###BUTTON_GROUPS_' . strtoupper($key) . '###');
1998 // Fill the button markers in this float
1999 $buttonTemplate = t3lib_parsehtml::substituteMarkerArray($buttonTemplate, $buttons, '###|###', true);
2000 // getting the wrap for each group
2001 $buttonWrap = t3lib_parsehtml::getSubpart($this->moduleTemplate, '###BUTTON_GROUP_WRAP###');
2002 // looping through the groups (max 6) and remove the empty groups
2003 for ($groupNumber = 1; $groupNumber < 6; $groupNumber++) {
2004 $buttonMarker = '###BUTTON_GROUP' . $groupNumber . '###';
2005 $buttonGroup = t3lib_parsehtml::getSubpart($buttonTemplate, $buttonMarker);
2006 if (trim($buttonGroup)) {
2007 if ($buttonWrap) {
2008 $buttonGroup = t3lib_parsehtml::substituteMarker($buttonWrap, '###BUTTONS###', $buttonGroup);
2009 }
2010 $buttonTemplate = t3lib_parsehtml::substituteSubpart($buttonTemplate, $buttonMarker, trim($buttonGroup));
2011 }
2012 }
2013 // replace the marker with the template and remove all line breaks (for IE compat)
2014 $markers['BUTTONLIST_' . strtoupper($key)] = str_replace("\n", '', $buttonTemplate);
2015 }
2016
2017 // Hook for manipulating docHeaderButtons
2018 if (isset($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['typo3/template.php']['docHeaderButtonsHook'])) {
2019 $params = array(
2020 'buttons' => $buttons,
2021 'markers' => &$markers,
2022 'pObj' => &$this
2023 );
2024 foreach($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['typo3/template.php']['docHeaderButtonsHook'] as $funcRef) {
2025 t3lib_div::callUserFunction($funcRef, $params, $this);
2026 }
2027 }
2028
2029 return $markers;
2030 }
2031
2032 /**
2033 * Generate the page path for docheader
2034 *
2035 * @param array Current page
2036 * @return string Page path
2037 */
2038 protected function getPagePath($pageRecord) {
2039 // Is this a real page
2040 if ($pageRecord['uid']) {
2041 $title = $pageRecord['_thePathFull'];
2042 } else {
2043 $title = $GLOBALS['TYPO3_CONF_VARS']['SYS']['sitename'];
2044 }
2045 // Setting the path of the page
2046 $pagePath = $GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:labels.path', 1) . ': <span class="typo3-docheader-pagePath">';
2047
2048 // crop the title to title limit (or 50, if not defined)
2049 $cropLength = (empty($GLOBALS['BE_USER']->uc['titleLen'])) ? 50 : $GLOBALS['BE_USER']->uc['titleLen'];
2050 $croppedTitle = t3lib_div::fixed_lgd_cs($title, -$cropLength);
2051 if ($croppedTitle !== $title) {
2052 $pagePath .= '<abbr title="' . htmlspecialchars($title) . '">' . htmlspecialchars($croppedTitle) . '</abbr>';
2053 } else {
2054 $pagePath .= htmlspecialchars($title);
2055 }
2056 $pagePath .= '</span>';
2057 return $pagePath;
2058 }
2059
2060 /**
2061 * Setting page icon with clickmenu + uid for docheader
2062 *
2063 * @param array Current page
2064 * @return string Page info
2065 */
2066 protected function getPageInfo($pageRecord) {
2067 global $BE_USER;
2068 // Add icon with clickmenu, etc:
2069 if ($pageRecord['uid']) { // If there IS a real page
2070 $alttext = t3lib_BEfunc::getRecordIconAltText($pageRecord, 'pages');
2071 $iconImg = t3lib_iconWorks::getIconImage('pages', $pageRecord, $this->backPath, 'class="absmiddle" title="'. htmlspecialchars($alttext) . '"');
2072 // Make Icon:
2073 $theIcon = $GLOBALS['SOBE']->doc->wrapClickMenuOnIcon($iconImg, 'pages', $pageRecord['uid']);
2074 } else { // On root-level of page tree
2075 // Make Icon
2076 $iconImg = '<img' . t3lib_iconWorks::skinImg($this->backPath, 'gfx/i/_icon_website.gif') . ' alt="' . $GLOBALS['TYPO3_CONF_VARS']['SYS']['sitename'] . '" />';
2077 if($BE_USER->user['admin']) {
2078 $theIcon = $GLOBALS['SOBE']->doc->wrapClickMenuOnIcon($iconImg, 'pages', 0);
2079 } else {
2080 $theIcon = $iconImg;
2081 }
2082 }
2083
2084 // Setting icon with clickmenu + uid
2085 $pageInfo = $theIcon . '<em>[pid: ' . $pageRecord['uid'] . ']</em>';
2086 return $pageInfo;
2087 }
2088
2089
2090 /**
2091 * Following functions are help function for JS library include.
2092 * They enable loading the libraries prototype, scriptaculous and extJS from contrib-directory
2093 */
2094
2095
2096 /**
2097 * Function for render the JS-libraries in header
2098 * Load order is prototype / scriptaculous / extJS
2099 */
2100 protected function renderJSlibraries() {
2101 $libs = array();
2102
2103 // include prototype
2104 if ($this->addPrototype) {
2105 $libs[] = 'contrib/prototype/prototype.js';
2106 // remove prototype from JScodeLibArray
2107 $this->removeJavascriptLib('prototype');
2108 }
2109
2110 // include scriptaculous
2111 if ($this->addScriptaculous) {
2112 $mods = array();
2113 foreach ($this->addScriptaculousModules as $key => $value) {
2114 if ($this->addScriptaculousModules[$key]) {
2115 $mods[] = $key;
2116 }
2117 }
2118 // resolve dependencies
2119 if (in_array('dragdrop', $mods) || in_array('controls', $mods)) {
2120 $mods = array_merge(array('effects'), $mods);
2121 }
2122
2123 if (count($mods)) {
2124 $moduleLoadString = '?load=' . implode(',', $mods);
2125 }
2126 $libs[] = 'contrib/scriptaculous/scriptaculous.js' . $moduleLoadString;
2127 // remove scriptaculous from JScodeLibArray
2128 $this->removeJavascriptLib('scriptaculous');
2129 }
2130
2131 // include extJS
2132 if ($this->addExtJS) {
2133 // use the base adapter all the time
2134 $libs[] = 'contrib/extjs/adapter/' . ($this->enableExtJsDebug ? str_replace('.js', '-debug.js', $this->extJSadapter) : $this->extJSadapter);
2135 $libs[] = 'contrib/extjs/ext-all' . ($this->enableExtJsDebug ? '-debug' : '') . '.js';
2136
2137 // add extJS localization
2138 $localeMap = $GLOBAL['LANG']->csConvObj->isoArray; // load standard ISO mapping and modify for use with ExtJS
2139 $localeMap[''] = 'en';
2140 $localeMap['default'] = 'en';
2141 $localeMap['gr'] = 'el_GR'; // Greek
2142 $localeMap['no'] = 'no_BO'; // Norwegian Bokmaal
2143 $localeMap['se'] = 'se_SV'; // Swedish
2144 $extJsLang = isset($localeMap[$GLOBALS['BE_USER']->uc['lang']]) ? $localeMap[$GLOBALS['BE_USER']->uc['lang']] : $GLOBALS['BE_USER']->uc['lang'];
2145 // TODO autoconvert file from UTF8 to current BE charset if necessary!!!!
2146 $extJsLocaleFile = 'contrib/extjs/locale/ext-lang-' . $extJsLang . '-min.js';
2147 if (file_exists(PATH_typo3 . $extJsLocaleFile)) {
2148 $libs[] = $extJsLocaleFile;
2149 }
2150 // set clear.gif
2151 $this->extJScode .= 'Ext.BLANK_IMAGE_URL = "' . htmlspecialchars(t3lib_div::locationHeaderUrl('gfx/clear.gif')) . '";';
2152 // remove extjs from JScodeLibArray
2153 $this->removeJavascriptLib('contrib/extjs');
2154 }
2155
2156 foreach ($libs as &$lib) {
2157 $lib = '<script type="text/javascript" src="' . $this->backPath . $lib . '"></script>';
2158 }
2159
2160 // add other JavascriptLibs and return it
2161 $libs = array_merge($libs, $this->JScodeLibArray);
2162 return count($libs) ? chr(10) . chr(10) . implode(chr(10), $libs) . chr(10) . chr(10) : '';
2163 }
2164
2165 /**
2166 * call function if you need the prototype library
2167 */
2168 public function loadPrototype() {
2169 $this->addPrototype = true;
2170 }
2171
2172 /**
2173 * call function if you need the Scriptaculous library
2174 * @param string $modules add modules you need. use "all" if you need complete modules
2175 */
2176 public function loadScriptaculous($modules='') {
2177 // Scriptaculous require prototype, so load prototype too.
2178 $this->addPrototype = true;
2179 $this->addScriptaculous = true;
2180 if ($modules) {
2181 if ($modules == 'all') {
2182 foreach ($this->addScriptaculousModules as $key => $value) {
2183 $this->addScriptaculousModules[$key] = true;
2184 }
2185 } else {
2186 $mods = t3lib_div::trimExplode(',', $modules);
2187 foreach ($mods as $mod) {
2188 if (isset($this->addScriptaculousModules[strtolower($mod)])) {
2189 $this->addScriptaculousModules[strtolower($mod)] = true;
2190 }
2191 }
2192 }
2193 }
2194 }
2195
2196 /**
2197 * call this function if you need the extJS library
2198 * @param boolean $css flag, if set the ext-css will be loaded
2199 * @param boolean $theme flag, if set the ext-theme "grey" will be loaded
2200 * @param string $adapter choose alternative adapter, possible values: yui, prototype, jquery
2201 */
2202 public function loadExtJS($css = true, $theme = true, $adapter = '') {
2203 if ($adapter) {
2204 // empty $adapter will always load the ext adapter
2205 switch (t3lib_div::strtolower(trim($adapter))) {
2206 case template::EXTJS_ADAPTER_YUI:
2207 $this->extJSadapter = 'yui/ext-yui-adapter.js';
2208 break;
2209 case template::EXTJS_ADAPTER_PROTOTYPE:
2210 $this->extJSadapter = 'prototype/ext-prototype-adapter.js';
2211 break;
2212 case template::EXTJS_ADAPTER_JQUERY:
2213 $this->extJSadapter = 'jquery/ext-jquery-adapter.js';
2214 break;
2215 }
2216 }
2217 if (!$this->addExtJS) {
2218 $this->addExtJS = true;
2219 if ($css) {
2220 if (isset($GLOBALS['TBE_STYLES']['extJS']['all'])) {
2221 $this->addStyleSheet('ext-all', $this->backPath . $GLOBALS['TBE_STYLES']['extJS']['all']);
2222 } else {
2223 $this->addStyleSheet('ext-all', $this->backPath . 'contrib/extjs/resources/css/ext-all-notheme.css');
2224 }
2225 }
2226 if ($theme) {
2227 if (isset($GLOBALS['TBE_STYLES']['extJS']['theme'])) {
2228 $this->addStyleSheet('ext-theme', $this->backPath . $GLOBALS['TBE_STYLES']['extJS']['theme']);
2229 } else {
2230 $this->addStyleSheet('ext-theme', $this->backPath . 'contrib/extjs/resources/css/xtheme-blue.css');
2231 }
2232 }
2233 }
2234 }
2235
2236 /**
2237 * call this function to load debug version of extJS. Use this for development only
2238 */
2239 public function enableExtJsDebug() {
2240 $this->enableExtJsDebug = true;
2241 }
2242
2243
2244 }
2245
2246
2247 // ******************************
2248 // Extension classes of the template class.
2249 // These are meant to provide backend screens with different widths.
2250 // They still do because of the different class-prefixes used for the <div>-sections
2251 // but obviously the final width is determined by the stylesheet used.
2252 // ******************************
2253
2254 /**
2255 * 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
2256 * The class were more significant in the past than today.
2257 *
2258 */
2259 class bigDoc extends template {
2260 var $divClass = 'typo3-bigDoc';
2261 }
2262
2263 /**
2264 * Extension class for "template" - used for backend pages without the "document" background image
2265 * The class were more significant in the past than today.
2266 *
2267 */
2268 class noDoc extends template {
2269 var $divClass = 'typo3-noDoc';
2270 }
2271
2272 /**
2273 * 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)
2274 * The class were more significant in the past than today.
2275 *
2276 */
2277 class smallDoc extends template {
2278 var $divClass = 'typo3-smallDoc';
2279 }
2280
2281 /**
2282 * 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.
2283 * The class were more significant in the past than today. But probably you should use this one for most modules you make.
2284 *
2285 */
2286 class mediumDoc extends template {
2287 var $divClass = 'typo3-mediumDoc';
2288 }
2289
2290
2291 /**
2292 * Extension class for "template" - used in the context of frontend editing.
2293 */
2294 class frontendDoc extends template {
2295 var $backPath = 'typo3/';
2296
2297 /**
2298 * Used in the frontend context to insert header data via TSFE->additionalHeaderData.
2299 * Mimics header inclusion from template->startPage().
2300 *
2301 * @return void
2302 */
2303 public function insertHeaderData() {
2304 $GLOBALS['TSFE']->additionalHeaderData['docStyle'] = $this->docStyle();
2305 $GLOBALS['TSFE']->additionalHeaderData['JSLibraries'] = $this->renderJSlibraries();
2306 $GLOBALS['TSFE']->additionalHeaderData['JScode'] = $this->JScode;
2307 $GLOBALS['TSFE']->additionalHeaderData['JScodeArray'] = $this->wrapScriptTags(implode("\n", $this->JScodeArray));
2308
2309 if ($this->extJScode) {
2310 $GLOBALS['TSFE']->additionalHeaderData['extJScode'] = $this->wrapScriptTags('Ext.onReady(function() {' . chr(10) . $this->extJScode . chr(10) . '});');
2311 }
2312 }
2313 }
2314
2315
2316 if (defined('TYPO3_MODE') && $TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['typo3/template.php']) {
2317 include_once($TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['typo3/template.php']);
2318 }
2319
2320
2321
2322 // ******************************
2323 // The template is loaded
2324 // ******************************
2325 $GLOBALS['TBE_TEMPLATE'] = t3lib_div::makeInstance('template');
2326
2327 ?>