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