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