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