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