Fixed bug #17592: ExtDirect API calls are splitted in single requests and slows down...
[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(
825 $this->backPath . 'ajax.php?ajaxID=ExtDirect::getAPI&namespace=TYPO3.ExtDirectStateProvider&' . TYPO3_version,
826 NULL,
827 FALSE
828 );
829 $this->pageRenderer->addJsFile($this->backPath . '../t3lib/js/extjs/ExtDirect.StateProvider.js');
830 }
831
832 // add jsCode for overriding the console with a debug panel connection
833 $this->pageRenderer->addJsInlineCode(
834 'consoleOverrideWithDebugPanel',
835 'if (typeof top.Ext === "object") {
836 top.Ext.onReady(function() {
837 if (typeof console === "undefined") {
838 if (top && top.TYPO3 && top.TYPO3.Backend && top.TYPO3.Backend.DebugConsole) {
839 console = top.TYPO3.Backend.DebugConsole;
840 } else {
841 console = {
842 log: Ext.log,
843 info: Ext.log,
844 warn: Ext.log,
845 error: Ext.log
846 };
847 }
848 }
849 });
850 }
851 ');
852
853 $this->pageRenderer->addHeaderData($this->JScode);
854
855 foreach ($this->JScodeArray as $name => $code) {
856 $this->pageRenderer->addJsInlineCode($name, $code);
857 }
858
859 if (count($this->JScodeLibArray)) {
860 foreach($this->JScodeLibArray as $library) {
861 $this->pageRenderer->addHeaderData($library);
862 }
863 }
864
865 if ($this->extJScode) {
866 $this->pageRenderer->addExtOnReadyCode($this->extJScode);
867 }
868
869 // hook for additional headerData
870 if (isset($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['typo3/template.php']['preHeaderRenderHook'])) {
871 $preHeaderRenderHook =& $GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['typo3/template.php']['preHeaderRenderHook'];
872 if (is_array($preHeaderRenderHook)) {
873 $hookParameters = array(
874 'pageRenderer' => &$this->pageRenderer,
875 );
876 foreach ($preHeaderRenderHook as $hookFunction) {
877 t3lib_div::callUserFunction($hookFunction, $hookParameters, $this);
878 }
879 }
880 }
881
882 // Construct page header.
883 $str = $this->pageRenderer->render(t3lib_PageRenderer::PART_HEADER);
884
885 $this->JScodeLibArray = array();
886 $this->JScode = $this->extJScode = '';
887 $this->JScodeArray = array();
888
889 $this->endOfPageJsBlock = $this->pageRenderer->render(t3lib_PageRenderer::PART_FOOTER);
890
891 if ($this->docType=='xhtml_frames') {
892 return $str;
893 } else
894 $str.=$this->docBodyTagBegin().
895 ($this->divClass?'
896
897 <!-- Wrapping DIV-section for whole page BEGIN -->
898 <div class="' . $this->divClass . '">
899 ' : '' ) . trim($this->form);
900 return $str;
901 }
902
903 /**
904 * Returns page end; This includes finishing form, div, body and html tags.
905 *
906 * @return string The HTML end of a page
907 * @see startPage()
908 */
909 function endPage() {
910 $str = $this->sectionEnd().
911 $this->postCode.
912 $this->endPageJS().
913 $this->wrapScriptTags(t3lib_BEfunc::getUpdateSignalCode()).
914 $this->parseTime().
915 ($this->form?'
916 </form>':'');
917 // if something is in buffer like debug, put it to end of page
918 if (ob_get_contents()) {
919 $str .= ob_get_clean();
920 header('Content-Encoding: None');
921 }
922
923 if ($this->docType !== 'xhtml_frames') {
924
925 $str .= ($this->divClass?'
926
927 <!-- Wrapping DIV-section for whole page END -->
928 </div>':'') . $this->endOfPageJsBlock ;
929 t3lib_formprotection_Factory::get()->persistTokens();
930 }
931
932
933 // Logging: Can't find better place to put it:
934 if (TYPO3_DLOG) t3lib_div::devLog('END of BACKEND session', 'template', 0, array('_FLUSH' => true));
935
936 return $str;
937 }
938
939 /**
940 * Shortcut for render the complete page of a module
941 *
942 * @param $title page title
943 * @param $content page content
944 * @param bool $includeCsh flag for including csh code
945 * @return string complete page
946 */
947 public function render($title, $content, $includeCsh = TRUE) {
948 $pageContent = $this->startPage($title, $includeCsh);
949 $pageContent .= $content;
950 $pageContent .= $this->endPage();
951
952 return $this->insertStylesAndJS($pageContent);
953 }
954
955 /**
956 * Returns the header-bar in the top of most backend modules
957 * Closes section if open.
958 *
959 * @param string The text string for the header
960 * @return string HTML content
961 */
962 function header($text) {
963 $str='
964
965 <!-- MAIN Header in page top -->
966 <h2>'.htmlspecialchars($text).'</h2>
967 ';
968 return $this->sectionEnd().$str;
969 }
970
971 /**
972 * Begins an output section and sets header and content
973 *
974 * @param string The header
975 * @param string The HTML-content
976 * @param boolean A flag that will prevent the header from being converted to uppercase
977 * @param boolean Defines the type of header (if set, "<h3>" rather than the default "h4")
978 * @param integer The number of an icon to show with the header (see the icon-function). -1,1,2,3
979 * @param boolean If set, HTML tags are allowed in $label (otherwise this value is by default htmlspecialchars()'ed)
980 * @return string HTML content
981 * @see icons(), sectionHeader()
982 */
983 function section($label,$text,$nostrtoupper=FALSE,$sH=FALSE,$type=0,$allowHTMLinHeader=FALSE) {
984 $str='';
985
986 // Setting header
987 if ($label) {
988 if (!$allowHTMLinHeader) $label = htmlspecialchars($label);
989 $str.=$this->sectionHeader($this->icons($type).$label, $sH, $nostrtoupper ? '' : ' class="uppercase"');
990 }
991 // Setting content
992 $str.='
993
994 <!-- Section content -->
995 '.$text;
996
997 return $this->sectionBegin().$str;
998 }
999
1000 /**
1001 * Inserts a divider image
1002 * Ends a section (if open) before inserting the image
1003 *
1004 * @param integer The margin-top/-bottom of the <hr> ruler.
1005 * @return string HTML content
1006 */
1007 function divider($dist) {
1008 $dist = intval($dist);
1009 $str='
1010
1011 <!-- DIVIDER -->
1012 <hr style="margin-top: '.$dist.'px; margin-bottom: '.$dist.'px;" />
1013 ';
1014 return $this->sectionEnd().$str;
1015 }
1016
1017 /**
1018 * Returns a blank <div>-section with a height
1019 *
1020 * @param integer Padding-top for the div-section (should be margin-top but konqueror (3.1) doesn't like it :-(
1021 * @return string HTML content
1022 */
1023 function spacer($dist) {
1024 if ($dist>0) {
1025 return '
1026
1027 <!-- Spacer element -->
1028 <div style="padding-top: '.intval($dist).'px;"></div>
1029 ';
1030 }
1031 }
1032
1033 /**
1034 * Make a section header.
1035 * Begins a section if not already open.
1036 *
1037 * @param string The label between the <h3> or <h4> tags. (Allows HTML)
1038 * @param boolean If set, <h3> is used, otherwise <h4>
1039 * @param string Additional attributes to h-tag, eg. ' class=""'
1040 * @return string HTML content
1041 */
1042 function sectionHeader($label, $sH=FALSE, $addAttrib='') {
1043 $tag = ($sH ? 'h3' : 'h4');
1044 if ($addAttrib && substr($addAttrib, 0, 1) !== ' ') {
1045 $addAttrib = ' ' . $addAttrib;
1046 }
1047 $str='
1048
1049 <!-- Section header -->
1050 <' . $tag . $addAttrib . '>' . $label . '</' . $tag . '>
1051 ';
1052 return $this->sectionBegin() . $str;
1053 }
1054
1055 /**
1056 * Begins an output section.
1057 * Returns the <div>-begin tag AND sets the ->sectionFlag true (if the ->sectionFlag is not already set!)
1058 * 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!
1059 *
1060 * @return string HTML content
1061 */
1062 function sectionBegin() {
1063 if (!$this->sectionFlag) {
1064 $this->sectionFlag=1;
1065 $str='
1066
1067 <!-- ***********************
1068 Begin output section.
1069 *********************** -->
1070 <div>
1071 ';
1072 return $str;
1073 } else return '';
1074 }
1075
1076 /**
1077 * Ends and output section
1078 * Returns the </div>-end tag AND clears the ->sectionFlag (but does so only IF the sectionFlag is set - that is a section is 'open')
1079 * See sectionBegin() also.
1080 *
1081 * @return string HTML content
1082 */
1083 function sectionEnd() {
1084 if ($this->sectionFlag) {
1085 $this->sectionFlag=0;
1086 return '
1087 </div>
1088 <!-- *********************
1089 End output section.
1090 ********************* -->
1091 ';
1092 } else return '';
1093 }
1094
1095 /**
1096 * Originally it printed a kind of divider.
1097 * Deprecated. Just remove function calls to it or call the divider() function instead.
1098 *
1099 * @return void
1100 * @internal
1101 * @deprecated since TYPO3 3.6, will be removed in TYPO3 4.6
1102 */
1103 function middle() {
1104 t3lib_div::logDeprecatedFunction();
1105 }
1106
1107 /**
1108 * If a form-tag is defined in ->form then and end-tag for that <form> element is outputted
1109 * Further a JavaScript section is outputted which will update the top.busy session-expiry object (unless $this->endJS is set to false)
1110 *
1111 * @return string HTML content (<script> tag section)
1112 */
1113 function endPageJS() {
1114 return ($this->endJS?'
1115 <script type="text/javascript">
1116 /*<![CDATA[*/
1117 if (top.busy && top.busy.loginRefreshed) {
1118 top.busy.loginRefreshed();
1119 }
1120 /*]]>*/
1121 </script>':'');
1122 }
1123
1124 /**
1125 * Creates the bodyTag.
1126 * You can add to the bodyTag by $this->bodyTagAdditions
1127 *
1128 * @return string HTML body tag
1129 */
1130 function docBodyTagBegin() {
1131 $bodyContent = 'body onclick="if (top.menuReset) top.menuReset();" '.trim($this->bodyTagAdditions.($this->bodyTagId ? ' id="'.$this->bodyTagId.'"' : ''));
1132 return '<'.trim($bodyContent).'>';
1133 }
1134
1135 /**
1136 * Outputting document style
1137 *
1138 * @return string HTML style section/link tags
1139 */
1140 function docStyle() {
1141
1142 // Request background image:
1143 if ($this->backGroundImage) {
1144 $this->inDocStylesArray[]=' BODY { background-image: url('.$this->backPath.$this->backGroundImage.'); }';
1145 }
1146
1147 // Add inDoc styles variables as well:
1148 $this->inDocStylesArray[] = $this->inDocStyles;
1149 $this->inDocStylesArray[] = $this->inDocStyles_TBEstyle;
1150
1151 // Implode it all:
1152 $inDocStyles = implode(LF, $this->inDocStylesArray);
1153
1154 if ($this->styleSheetFile) {
1155 $this->pageRenderer->addCssFile($this->backPath . $this->styleSheetFile);
1156 }
1157 if ($this->styleSheetFile2) {
1158 $this->pageRenderer->addCssFile($this->backPath . $this->styleSheetFile2);
1159 }
1160
1161 $this->pageRenderer->addCssInlineBlock('inDocStyles', $inDocStyles . LF . '/*###POSTCSSMARKER###*/');
1162 if ($this->styleSheetFile_post) {
1163 $this->pageRenderer->addCssFile($this->backPath . $this->styleSheetFile_post);
1164 }
1165
1166 }
1167
1168 /**
1169 * Insert additional style sheet link
1170 *
1171 * @param string $key: some key identifying the style sheet
1172 * @param string $href: uri to the style sheet file
1173 * @param string $title: value for the title attribute of the link element
1174 * @return string $relation: value for the rel attribute of the link element
1175 * @return void
1176 */
1177 function addStyleSheet($key, $href, $title='', $relation='stylesheet') {
1178 if (strpos($href, '://') !== FALSE || substr($href, 0, 1) === '/') {
1179 $file = $href;
1180 } else {
1181 $file = $this->backPath . $href;
1182 }
1183 $this->pageRenderer->addCssFile($file, $relation, 'screen', $title);
1184 }
1185
1186 /**
1187 * Add all *.css files of the directory $path to the stylesheets
1188 *
1189 * @param string directory to add
1190 * @return void
1191 */
1192 function addStyleSheetDirectory($path) {
1193 // calculation needed, when TYPO3 source is used via a symlink
1194 // absolute path to the stylesheets
1195 $filePath = dirname(t3lib_div::getIndpEnv('SCRIPT_FILENAME')) . '/' . $GLOBALS['BACK_PATH'] . $path;
1196 // clean the path
1197 $resolvedPath = t3lib_div::resolveBackPath($filePath);
1198 // read all files in directory and sort them alphabetically
1199 $files = t3lib_div::getFilesInDir($resolvedPath, 'css', FALSE, 1);
1200 foreach ($files as $file) {
1201 $this->pageRenderer->addCssFile($GLOBALS['BACK_PATH'] . $path . $file, 'stylesheet', 'all');
1202 }
1203 }
1204
1205 /**
1206 * Insert post rendering document style into already rendered content
1207 * This is needed for extobjbase
1208 *
1209 * @param string style-content to insert.
1210 * @return string content with inserted styles
1211 */
1212 function insertStylesAndJS($content) {
1213 // insert accumulated CSS
1214 $this->inDocStylesArray[] = $this->inDocStyles;
1215 $styles = LF.implode(LF, $this->inDocStylesArray);
1216 $content = str_replace('/*###POSTCSSMARKER###*/',$styles,$content);
1217
1218 // insert accumulated JS
1219 $jscode = $this->JScode.LF.$this->wrapScriptTags(implode(LF, $this->JScodeArray));
1220 $content = str_replace('<!--###POSTJSMARKER###-->',$jscode,$content);
1221
1222 return $content;
1223 }
1224
1225 /**
1226 * Returns an array of all stylesheet directories belonging to core and skins
1227 *
1228 * @return array Stylesheet directories
1229 */
1230 public function getSkinStylesheetDirectories() {
1231 $stylesheetDirectories = array();
1232
1233 // add default core stylesheets
1234 foreach ($this->stylesheetsCore as $stylesheetDir) {
1235 $stylesheetDirectories[] = $stylesheetDir;
1236 }
1237
1238 // Stylesheets from skins
1239 // merge default css directories ($this->stylesheetsSkin) with additional ones and include them
1240 if (is_array($GLOBALS['TBE_STYLES']['skins'])) {
1241 // loop over all registered skins
1242 foreach ($GLOBALS['TBE_STYLES']['skins'] as $skinExtKey => $skin) {
1243 $skinStylesheetDirs = $this->stylesheetsSkins;
1244
1245 // skins can add custom stylesheetDirectories using
1246 // $TBE_STYLES['skins'][$_EXTKEY]['stylesheetDirectories']
1247 if (is_array($skin['stylesheetDirectories'])) {
1248 $skinStylesheetDirs = array_merge($skinStylesheetDirs, $skin['stylesheetDirectories']);
1249 }
1250
1251 // add all registered directories
1252 foreach ($skinStylesheetDirs as $stylesheetDir) {
1253 // for EXT:myskin/stylesheets/ syntax
1254 if (substr($stylesheetDir, 0, 4) === 'EXT:') {
1255 list($extKey, $path) = explode('/', substr($stylesheetDir, 4), 2);
1256 if (strcmp($extKey, '') && t3lib_extMgm::isLoaded($extKey) && strcmp($path, '')) {
1257 $stylesheetDirectories[] = t3lib_extMgm::extRelPath($extKey) . $path;
1258 }
1259 } else {
1260 // for relative paths
1261 $stylesheetDirectories[] = t3lib_extMgm::extRelPath($skinExtKey) . $stylesheetDir;
1262 }
1263 }
1264 }
1265 }
1266 return $stylesheetDirectories;
1267 }
1268
1269 /**
1270 * Initialize the charset.
1271 * Sets the internal $this->charset variable to the charset defined in $GLOBALS["LANG"] (or the default as set in this class)
1272 * Returns the meta-tag for the document header
1273 *
1274 * @return string <meta> tag with charset from $this->charset or $GLOBALS['LANG']->charSet
1275 */
1276 function initCharset() {
1277 // Set charset to the charset provided by the current backend users language selection:
1278 $this->charset = $GLOBALS['LANG']->charSet ? $GLOBALS['LANG']->charSet : $this->charset;
1279 // Return meta tag:
1280 return '<meta http-equiv="Content-Type" content="text/html; charset='.$this->charset.'" />';
1281 }
1282
1283 /**
1284 * Returns generator meta tag
1285 *
1286 * @return string <meta> tag with name "generator"
1287 */
1288 function generator() {
1289 $str = 'TYPO3 '.TYPO3_branch.', ' . TYPO3_URL_GENERAL . ', &#169; Kasper Sk&#229;rh&#248;j 1998-2009, extensions are copyright of their respective owners.';
1290 return '<meta name="generator" content="'.$str .'" />';
1291 }
1292
1293 /**
1294 * Returns X-UA-Compatible meta tag
1295 *
1296 * @param string $content Content of the compatible tag (default: IE-8)
1297 * @return string <meta http-equiv="X-UA-Compatible" content="???" />
1298 */
1299 public function xUaCompatible($content = 'IE=8') {
1300 return '<meta http-equiv="X-UA-Compatible" content="' . $content . '" />';
1301 }
1302
1303
1304
1305
1306
1307
1308
1309 /*****************************************
1310 *
1311 * OTHER ELEMENTS
1312 * Tables, buttons, formatting dimmed/red strings
1313 *
1314 ******************************************/
1315
1316
1317 /**
1318 * Returns an image-tag with an 18x16 icon of the following types:
1319 *
1320 * $type:
1321 * -1: OK icon (Check-mark)
1322 * 1: Notice (Speach-bubble)
1323 * 2: Warning (Yellow triangle)
1324 * 3: Fatal error (Red stop sign)
1325 *
1326 * @param integer See description
1327 * @param string Value for style attribute
1328 * @return string HTML image tag (if applicable)
1329 */
1330 function icons($type, $styleAttribValue='') {
1331 switch($type) {
1332 case '3':
1333 $icon = 'status-dialog-error';
1334 break;
1335 case '2':
1336 $icon = 'status-dialog-warning';
1337 break;
1338 case '1':
1339 $icon = 'status-dialog-notification';
1340 break;
1341 case '-1':
1342 $icon = 'status-dialog-ok';
1343 break;
1344 default:
1345 break;
1346 }
1347 if ($icon) {
1348 return t3lib_iconWorks::getSpriteIcon($icon);
1349 }
1350 }
1351
1352 /**
1353 * Returns an <input> button with the $onClick action and $label
1354 *
1355 * @param string The value of the onclick attribute of the input tag (submit type)
1356 * @param string The label for the button (which will be htmlspecialchar'ed)
1357 * @return string A <input> tag of the type "submit"
1358 */
1359 function t3Button($onClick,$label) {
1360 $button = '<input type="submit" onclick="'.htmlspecialchars($onClick).'; return false;" value="'.htmlspecialchars($label).'" />';
1361 return $button;
1362 }
1363
1364 /**
1365 * dimmed-fontwrap. Returns the string wrapped in a <span>-tag defining the color to be gray/dimmed
1366 *
1367 * @param string Input string
1368 * @return string Output string
1369 */
1370 function dfw($string) {
1371 return '<span class="typo3-dimmed">'.$string.'</span>';
1372 }
1373
1374 /**
1375 * red-fontwrap. Returns the string wrapped in a <span>-tag defining the color to be red
1376 *
1377 * @param string Input string
1378 * @return string Output string
1379 */
1380 function rfw($string) {
1381 return '<span class="typo3-red">'.$string.'</span>';
1382 }
1383
1384 /**
1385 * Returns string wrapped in CDATA "tags" for XML / XHTML (wrap content of <script> and <style> sections in those!)
1386 *
1387 * @param string Input string
1388 * @return string Output string
1389 */
1390 function wrapInCData($string) {
1391 $string = '/*<![CDATA[*/'.
1392 $string.
1393 '/*]]>*/';
1394
1395 return $string;
1396 }
1397
1398 /**
1399 * Wraps the input string in script tags.
1400 * Automatic re-identing of the JS code is done by using the first line as ident reference.
1401 * This is nice for identing JS code with PHP code on the same level.
1402 *
1403 * @param string Input string
1404 * @param boolean Wrap script element in linebreaks? Default is TRUE.
1405 * @return string Output string
1406 */
1407 function wrapScriptTags($string, $linebreak=TRUE) {
1408 if(trim($string)) {
1409 // <script wrapped in nl?
1410 $cr = $linebreak? LF : '';
1411
1412 // remove nl from the beginning
1413 $string = preg_replace ('/^\n+/', '', $string);
1414 // re-ident to one tab using the first line as reference
1415 $match = array();
1416 if(preg_match('/^(\t+)/',$string,$match)) {
1417 $string = str_replace($match[1],TAB, $string);
1418 }
1419 $string = $cr.'<script type="text/javascript">
1420 /*<![CDATA[*/
1421 '.$string.'
1422 /*]]>*/
1423 </script>'.$cr;
1424 }
1425 return trim($string);
1426 }
1427
1428 // These vars defines the layout for the table produced by the table() function.
1429 // You can override these values from outside if you like.
1430 var $tableLayout = array(
1431 'defRow' => array(
1432 'defCol' => array('<td valign="top">','</td>')
1433 )
1434 );
1435 var $table_TR = '<tr>';
1436 var $table_TABLE = '<table border="0" cellspacing="0" cellpadding="0" class="typo3-dblist" id="typo3-tmpltable">';
1437
1438 /**
1439 * Returns a table based on the input $data
1440 *
1441 * @param array Multidim array with first levels = rows, second levels = cells
1442 * @param array If set, then this provides an alternative layout array instead of $this->tableLayout
1443 * @return string The HTML table.
1444 * @internal
1445 */
1446 function table($data, $layout = '') {
1447 $result = '';
1448 if (is_array($data)) {
1449 $tableLayout = (is_array($layout) ? $layout : $this->tableLayout);
1450
1451 $rowCount = 0;
1452 foreach ($data as $tableRow) {
1453 if ($rowCount % 2) {
1454 $layout = is_array($tableLayout['defRowOdd']) ? $tableLayout['defRowOdd'] : $tableLayout['defRow'];
1455 } else {
1456 $layout = is_array($tableLayout['defRowEven']) ? $tableLayout['defRowEven'] : $tableLayout['defRow'];
1457 }
1458 $rowLayout = is_array($tableLayout[$rowCount]) ? $tableLayout[$rowCount] : $layout;
1459 $rowResult = '';
1460 if (is_array($tableRow)) {
1461 $cellCount = 0;
1462 foreach ($tableRow as $tableCell) {
1463 $cellWrap = (is_array($layout[$cellCount]) ? $layout[$cellCount] : $layout['defCol']);
1464 $cellWrap = (is_array($rowLayout['defCol']) ? $rowLayout['defCol'] : $cellWrap);
1465 $cellWrap = (is_array($rowLayout[$cellCount]) ? $rowLayout[$cellCount] : $cellWrap);
1466 $rowResult .= $cellWrap[0] . $tableCell . $cellWrap[1];
1467 $cellCount++;
1468 }
1469 }
1470 $rowWrap = (is_array($layout['tr']) ? $layout['tr'] : array($this->table_TR, '</tr>'));
1471 $rowWrap = (is_array($rowLayout['tr']) ? $rowLayout['tr'] : $rowWrap);
1472 $result .= $rowWrap[0] . $rowResult . $rowWrap[1];
1473 $rowCount++;
1474 }
1475 $tableWrap = is_array($tableLayout['table']) ? $tableLayout['table'] : array($this->table_TABLE, '</table>');
1476 $result = $tableWrap[0] . $result . $tableWrap[1];
1477 }
1478 return $result;
1479 }
1480
1481 /**
1482 * Constructs a table with content from the $arr1, $arr2 and $arr3.
1483 * Used in eg. ext/belog/mod/index.php - refer to that for examples
1484 *
1485 * @param array Menu elements on first level
1486 * @param array Secondary items
1487 * @param array Third-level items
1488 * @return string HTML content, <table>...</table>
1489 */
1490 function menuTable($arr1,$arr2=array(), $arr3=array()) {
1491 $rows = max(array(count($arr1),count($arr2),count($arr3)));
1492
1493 $menu='
1494 <table border="0" cellpadding="0" cellspacing="0" id="typo3-tablemenu">';
1495 for($a=0;$a<$rows;$a++) {
1496 $menu.='<tr>';
1497 $cls=array();
1498 $valign='middle';
1499 $cls[]='<td valign="'.$valign.'">'.$arr1[$a][0].'</td><td>'.$arr1[$a][1].'</td>';
1500 if (count($arr2)) {
1501 $cls[]='<td valign="'.$valign.'">'.$arr2[$a][0].'</td><td>'.$arr2[$a][1].'</td>';
1502 if (count($arr3)) {
1503 $cls[]='<td valign="'.$valign.'">'.$arr3[$a][0].'</td><td>'.$arr3[$a][1].'</td>';
1504 }
1505 }
1506 $menu.=implode($cls,'<td>&nbsp;&nbsp;</td>');
1507 $menu.='</tr>';
1508 }
1509 $menu.='
1510 </table>
1511 ';
1512 return $menu;
1513 }
1514
1515 /**
1516 * Returns a one-row/two-celled table with $content and $menu side by side.
1517 * The table is a 100% width table and each cell is aligned left / right
1518 *
1519 * @param string Content cell content (left)
1520 * @param string Menu cell content (right)
1521 * @return string HTML output
1522 */
1523 function funcMenu($content,$menu) {
1524 return '
1525 <table border="0" cellpadding="0" cellspacing="0" width="100%" id="typo3-funcmenu">
1526 <tr>
1527 <td valign="top" nowrap="nowrap">'.$content.'</td>
1528 <td valign="top" align="right" nowrap="nowrap">'.$menu.'</td>
1529 </tr>
1530 </table>';
1531 }
1532
1533 /**
1534 * Creates a selector box with clear-cache items.
1535 * Rather specialized functions - at least don't use it with $addSaveOptions unless you know what you do...
1536 *
1537 * @param integer The page uid of the "current page" - the one that will be cleared as "clear cache for this page".
1538 * @param boolean If $addSaveOptions is set, then also the array of save-options for TCE_FORMS will appear.
1539 * @return string <select> tag with content - a selector box for clearing the cache
1540 */
1541 function clearCacheMenu($id,$addSaveOptions=0) {
1542 global $BE_USER;
1543 $opt=array();
1544 if ($addSaveOptions) {
1545 $opt[]='<option value="">'.$GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:rm.menu',1).'</option>';
1546 $opt[]='<option value="TBE_EDITOR.checkAndDoSubmit(1);">'.$GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:rm.saveDoc',1).'</option>';
1547 $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>';
1548 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>';
1549 $opt[]='<option value="document.editform.closeDoc.value=2; document.editform.submit();">'.$GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:rm.closeDoc',1).'</option>';
1550 $opt[]='<option value="document.editform.closeDoc.value=3; document.editform.submit();">'.$GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:rm.closeAllDocs',1).'</option>';
1551 $opt[]='<option value=""></option>';
1552 }
1553 $opt[]='<option value="">[ '.$GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:rm.clearCache_clearCache',1).' ]</option>';
1554 if ($id) $opt[]='<option value="'.$id.'">'.$GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:rm.clearCache_thisPage',1).'</option>';
1555 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>';
1556 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>';
1557
1558 $onChange = 'if (!this.options[this.selectedIndex].value) {
1559 this.selectedIndex=0;
1560 } else if (this.options[this.selectedIndex].value.indexOf(\';\')!=-1) {
1561 eval(this.options[this.selectedIndex].value);
1562 } else {
1563 window.location.href=\'' . $this->backPath .
1564 'tce_db.php?vC=' . $BE_USER->veriCode() .
1565 t3lib_BEfunc::getUrlToken('tceAction') .
1566 '&redirect=' . rawurlencode(t3lib_div::getIndpEnv('REQUEST_URI')) .
1567 '&cacheCmd=\'+this.options[this.selectedIndex].value;
1568 }';
1569 $af_content = '<select name="cacheCmd" onchange="'.htmlspecialchars($onChange).'">'.implode('',$opt).'</select>';
1570
1571 if (count($opt)>1) {
1572 return $af_content;
1573 }
1574 }
1575
1576
1577 /**
1578 * Includes a javascript library that exists in the core /typo3/ directory. The
1579 * backpath is automatically applied
1580 *
1581 * @param string $lib: Library name. Call it with the full path
1582 * like "contrib/prototype/prototype.js" to load it
1583 * @return void
1584 */
1585 function loadJavascriptLib($lib) {
1586 $this->pageRenderer->addJsFile($this->backPath . $lib);
1587 }
1588
1589
1590
1591 /**
1592 * Includes the necessary Javascript function for the clickmenu (context sensitive menus) in the document
1593 *
1594 * @return array Deprecated: Includes the code already in the doc, so the return array is always empty.
1595 * Please just call this function without expecting a return value for future calls
1596 */
1597 function getContextMenuCode() {
1598 $this->pageRenderer->loadPrototype();
1599 $this->loadJavascriptLib('js/clickmenu.js');
1600
1601 $this->JScodeArray['clickmenu'] = '
1602 Clickmenu.clickURL = "'.$this->backPath.'alt_clickmenu.php";
1603 Clickmenu.ajax = '.($this->isCMLayers() ? 'true' : 'false' ).';';
1604
1605 // return array deprecated since 4.2
1606 return array('','','');
1607 }
1608
1609 /**
1610 * Includes the necessary javascript file (tree.js) for use on pages which have the
1611 * drag and drop functionality (usually pages and folder display trees)
1612 *
1613 * @param string indicator of which table the drag and drop function should work on (pages or folders)
1614 * @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
1615 */
1616 function getDragDropCode($table) {
1617 $this->pageRenderer->loadPrototype();
1618 $this->loadJavascriptLib('js/common.js');
1619 $this->loadJavascriptLib('js/tree.js');
1620
1621 // setting prefs for drag & drop
1622 $this->JScodeArray['dragdrop'] = '
1623 DragDrop.changeURL = "'.$this->backPath.'alt_clickmenu.php";
1624 DragDrop.backPath = "'.t3lib_div::shortMD5(''.'|'.$GLOBALS['TYPO3_CONF_VARS']['SYS']['encryptionKey']).'";
1625 DragDrop.table = "'.$table.'";
1626 ';
1627
1628 // return array deprecated since 4.2
1629 return array('','','');
1630 }
1631
1632 /**
1633 * This loads everything needed for the Context Sensitive Help (CSH)
1634 *
1635 * @return void
1636 */
1637 protected function loadCshJavascript() {
1638 $this->pageRenderer->loadExtJS();
1639 $this->pageRenderer->addJsFile($this->backPath .'../t3lib/js/extjs/contexthelp.js');
1640 $this->pageRenderer->addExtDirectCode();
1641 }
1642
1643 /**
1644 * Creates a tab menu from an array definition
1645 *
1646 * Returns a tab menu for a module
1647 * Requires the JS function jumpToUrl() to be available
1648 *
1649 * @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=...
1650 * @param string $elementName it the form elements name, probably something like "SET[...]"
1651 * @param string $currentValue is the value to be selected currently.
1652 * @param array $menuItems is an array with the menu items for the selector box
1653 * @param string $script is the script to send the &id to, if empty it's automatically found
1654 * @param string $addParams is additional parameters to pass to the script.
1655 * @return string HTML code for tab menu
1656 * @author René Fritz <r.fritz@colorcube.de>
1657 */
1658 function getTabMenu($mainParams,$elementName,$currentValue,$menuItems,$script='',$addparams='') {
1659 $content='';
1660
1661 if (is_array($menuItems)) {
1662 if (!is_array($mainParams)) {
1663 $mainParams = array('id' => $mainParams);
1664 }
1665 $mainParams = t3lib_div::implodeArrayForUrl('',$mainParams);
1666
1667 if (!$script) {$script=basename(PATH_thisScript);}
1668
1669 $menuDef = array();
1670 foreach($menuItems as $value => $label) {
1671 $menuDef[$value]['isActive'] = !strcmp($currentValue,$value);
1672 $menuDef[$value]['label'] = t3lib_div::deHSCentities(htmlspecialchars($label));
1673 $menuDef[$value]['url'] = $script . '?' . $mainParams . $addparams . '&' . $elementName . '=' . $value;
1674 }
1675 $content = $this->getTabMenuRaw($menuDef);
1676
1677 }
1678 return $content;
1679 }
1680
1681 /**
1682 * Creates the HTML content for the tab menu
1683 *
1684 * @param array Menu items for tabs
1685 * @return string Table HTML
1686 * @access private
1687 */
1688 function getTabMenuRaw($menuItems) {
1689 $content='';
1690
1691 if (is_array($menuItems)) {
1692 $options='';
1693
1694 $count = count($menuItems);
1695 $widthLeft = 1;
1696 $addToAct = 5;
1697
1698 $widthRight = max (1,floor(30-pow($count,1.72)));
1699 $widthTabs = 100 - $widthRight - $widthLeft;
1700 $widthNo = floor(($widthTabs - $addToAct)/$count);
1701 $addToAct = max ($addToAct,$widthTabs-($widthNo*$count));
1702 $widthAct = $widthNo + $addToAct;
1703 $widthRight = 100 - ($widthLeft + ($count*$widthNo) + $addToAct);
1704
1705 foreach($menuItems as $id => $def) {
1706 $isActive = $def['isActive'];
1707 $class = $isActive ? 'tabact' : 'tab';
1708 $width = $isActive ? $widthAct : $widthNo;
1709
1710 // @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.
1711 $label = $def['label'];
1712 $url = htmlspecialchars($def['url']);
1713 $params = $def['addParams'];
1714
1715 $options .= '<td width="' . $width . '%" class="' . $class . '"><a href="' . $url . '" ' . $params . '>' . $label . '</a></td>';
1716 }
1717
1718 if ($options) {
1719 $content .= '
1720 <!-- Tab menu -->
1721 <table cellpadding="0" cellspacing="0" border="0" width="100%" id="typo3-tabmenu">
1722 <tr>
1723 <td width="'.$widthLeft.'%">&nbsp;</td>
1724 '.$options.'
1725 <td width="'.$widthRight.'%">&nbsp;</td>
1726 </tr>
1727 </table>
1728 <div class="hr" style="margin:0px"></div>';
1729 }
1730
1731 }
1732 return $content;
1733 }
1734
1735 /**
1736 * Creates a DYNAMIC tab-menu where the tabs are switched between with DHTML.
1737 * 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!
1738 *
1739 * @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.
1740 * @param string Identification string. This should be unique for every instance of a dynamic menu!
1741 * @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.
1742 * @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.
1743 * @param integer Character limit for a new row, 0 by default, because this parameter is deprecated since TYPO3 4.5
1744 * @param boolean If set, tab table cells are not allowed to wrap their content
1745 * @param boolean If set, the tabs will span the full width of their position
1746 * @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.
1747 * @param integer If set to '1' empty tabs will be remove, If set to '2' empty tabs will be disabled
1748 * @return string JavaScript section for the HTML header.
1749 */
1750 public function getDynTabMenu($menuItems, $identString, $toggle = 0, $foldout = FALSE, $newRowCharLimit = 0, $noWrap = 1, $fullWidth = FALSE, $defaultTabIndex = 1, $dividers2tabs = 2) {
1751 // load the static code, if not already done with the function below
1752 $this->loadJavascriptLib('js/tabmenu.js');
1753
1754 $content = '';
1755
1756 if (is_array($menuItems)) {
1757
1758 // Init:
1759 $options = array(array());
1760 $divs = array();
1761 $JSinit = array();
1762 $id = $this->getDynTabMenuId($identString);
1763 $noWrap = $noWrap ? ' nowrap="nowrap"' : '';
1764
1765 // Traverse menu items
1766 $c=0;
1767 $tabRows=0;
1768 $titleLenCount = 0;
1769 foreach($menuItems as $index => $def) {
1770 // Need to add one so checking for first index in JavaScript
1771 // is different than if it is not set at all.
1772 $index += 1;
1773
1774 // Switch to next tab row if needed
1775 if (!$foldout && (($newRowCharLimit > 0 && $titleLenCount > $newRowCharLimit) | ($def['newline'] === TRUE && $titleLenCount > 0))) {
1776 $titleLenCount=0;
1777 $tabRows++;
1778 $options[$tabRows] = array();
1779 }
1780
1781 if ($toggle==1) {
1782 $onclick = 'this.blur(); DTM_toggle("'.$id.'","'.$index.'"); return false;';
1783 } else {
1784 $onclick = 'this.blur(); DTM_activate("'.$id.'","'.$index.'", '.($toggle<0?1:0).'); return false;';
1785 }
1786
1787 $isEmpty = !(strcmp(trim($def['content']),'') || strcmp(trim($def['icon']),''));
1788
1789 // "Removes" empty tabs
1790 if ($isEmpty && $dividers2tabs == 1) {
1791 continue;
1792 }
1793
1794 $mouseOverOut = ' onmouseover="DTM_mouseOver(this);" onmouseout="DTM_mouseOut(this);"';
1795 $requiredIcon = '<img name="' . $id . '-' . $index . '-REQ" src="' . $GLOBALS['BACK_PATH'] . 'gfx/clear.gif" class="t3-TCEforms-reqTabImg" alt="" />';
1796
1797 if (!$foldout) {
1798 // Create TAB cell:
1799 $options[$tabRows][] = '
1800 <td class="'.($isEmpty ? 'disabled' : 'tab').'" id="'.$id.'-'.$index.'-MENU"'.$noWrap.$mouseOverOut.'>'.
1801 ($isEmpty ? '' : '<a href="#" onclick="'.htmlspecialchars($onclick).'"'.($def['linkTitle'] ? ' title="'.htmlspecialchars($def['linkTitle']).'"':'').'>').
1802 $def['icon'].
1803 ($def['label'] ? htmlspecialchars($def['label']) : '&nbsp;').
1804 $requiredIcon.
1805 $this->icons($def['stateIcon'],'margin-left: 10px;').
1806 ($isEmpty ? '' : '</a>').
1807 '</td>';
1808 $titleLenCount+= strlen($def['label']);
1809 } else {
1810 // Create DIV layer for content:
1811 $divs[] = '
1812 <div class="'.($isEmpty ? 'disabled' : 'tab').'" id="'.$id.'-'.$index.'-MENU"'.$mouseOverOut.'>'.
1813 ($isEmpty ? '' : '<a href="#" onclick="'.htmlspecialchars($onclick).'"'.($def['linkTitle'] ? ' title="'.htmlspecialchars($def['linkTitle']).'"':'').'>').
1814 $def['icon'].
1815 ($def['label'] ? htmlspecialchars($def['label']) : '&nbsp;').
1816 $requiredIcon.
1817 ($isEmpty ? '' : '</a>').
1818 '</div>';
1819 }
1820
1821 // Create DIV layer for content:
1822 $divs[] = '
1823 <div style="display: none;" id="'.$id.'-'.$index.'-DIV" class="c-tablayer">'.
1824 ($def['description'] ? '<p class="c-descr">'.nl2br(htmlspecialchars($def['description'])).'</p>' : '').
1825 $def['content'].
1826 '</div>';
1827 // Create initialization string:
1828 $JSinit[] = '
1829 DTM_array["'.$id.'"]['.$c.'] = "'.$id.'-'.$index.'";
1830 ';
1831 // If not empty and we have the toggle option on, check if the tab needs to be expanded
1832 if ($toggle == 1 && !$isEmpty) {
1833 $JSinit[] = '
1834 if (top.DTM_currentTabs["'.$id.'-'.$index.'"]) { DTM_toggle("'.$id.'","'.$index.'",1); }
1835 ';
1836 }
1837
1838 $c++;
1839 }
1840
1841 // Render menu:
1842 if (count($options)) {
1843
1844 // Tab menu is compiled:
1845 if (!$foldout) {
1846 $tabContent = '';
1847 for($a=0;$a<=$tabRows;$a++) {
1848 $tabContent.= '
1849
1850 <!-- Tab menu -->
1851 <table cellpadding="0" cellspacing="0" border="0"'.($fullWidth ? ' width="100%"' : '').' class="typo3-dyntabmenu">
1852 <tr>
1853 '.implode('',$options[$a]).'
1854 </tr>
1855 </table>';
1856 }
1857 $content.= '<div class="typo3-dyntabmenu-tabs">'.$tabContent.'</div>';
1858 }
1859
1860 // Div layers are added:
1861 $content.= '
1862 <!-- Div layers for tab menu: -->
1863 <div class="typo3-dyntabmenu-divs'.($foldout?'-foldout':'').'">
1864 '.implode('',$divs).'</div>';
1865
1866 // Java Script section added:
1867 $content.= '
1868 <!-- Initialization JavaScript for the menu -->
1869 <script type="text/javascript">
1870 DTM_array["'.$id.'"] = new Array();
1871 '.implode('',$JSinit).'
1872 '.($toggle<=0 ? 'DTM_activate("'.$id.'", top.DTM_currentTabs["'.$id.'"]?top.DTM_currentTabs["'.$id.'"]:'.intval($defaultTabIndex).', 0);' : '').'
1873 </script>
1874
1875 ';
1876 }
1877
1878 }
1879 return $content;
1880 }
1881
1882 /**
1883 * Creates the id for dynTabMenus.
1884 *
1885 * @param string $identString: Identification string. This should be unique for every instance of a dynamic menu!
1886 * @return string The id with a short MD5 of $identString and prefixed "DTM-", like "DTM-2e8791854a"
1887 */
1888 function getDynTabMenuId($identString) {
1889 $id = 'DTM-'.t3lib_div::shortMD5($identString);
1890 return $id;
1891 }
1892
1893 /**
1894 * Returns dynamic tab menu header JS code.
1895 * This is now incorporated automatically when the function template::getDynTabMenu is called
1896 * (as long as it is called before $this->startPage())
1897 * The return value is not needed anymore
1898 *
1899 * @deprecated since TYPO3 4.5, as the getDynTabMenu() function includes the function automatically since TYPO3 4.3
1900 * @return string JavaScript section for the HTML header. (return value is deprecated since TYPO3 4.3, will be removed in TYPO3 4.5)
1901 */
1902 function getDynTabMenuJScode() {
1903 t3lib_div::logDeprecatedFunction();
1904 $this->loadJavascriptLib('js/tabmenu.js');
1905 // return value deprecated since TYPO3 4.3
1906 return '';
1907 }
1908
1909 /**
1910 * Creates the version selector for the page id inputted.
1911 * Requires the core version management extension, "version" to be loaded.
1912 *
1913 * @param integer Page id to create selector for.
1914 * @param boolean If set, there will be no button for swapping page.
1915 * @return void
1916 */
1917 public function getVersionSelector($id, $noAction = FALSE) {
1918 if (t3lib_extMgm::isLoaded('version')) {
1919 $versionGuiObj = t3lib_div::makeInstance('tx_version_gui');
1920 return $versionGuiObj->getVersionSelector($id, $noAction);
1921 }
1922 }
1923
1924 /**
1925 * Function to load a HTML template file with markers.
1926 * When calling from own extension, use syntax getHtmlTemplate('EXT:extkey/template.html')
1927 *
1928 * @param string tmpl name, usually in the typo3/template/ directory
1929 * @return string HTML of template
1930 */
1931 function getHtmlTemplate($filename) {
1932 // setting the name of the original HTML template
1933 $this->moduleTemplateFilename = $filename;
1934
1935 if ($GLOBALS['TBE_STYLES']['htmlTemplates'][$filename]) {
1936 $filename = $GLOBALS['TBE_STYLES']['htmlTemplates'][$filename];
1937 }
1938 if (t3lib_div::isFirstPartOfStr($filename, 'EXT:')) {
1939 $filename = t3lib_div::getFileAbsFileName($filename, TRUE, TRUE);
1940 } else if (!t3lib_div::isAbsPath($filename)) {
1941 $filename = t3lib_div::resolveBackPath($this->backPath . $filename);
1942 } else if (!t3lib_div::isAllowedAbsPath($filename)) {
1943 $filename = '';
1944 }
1945 $htmlTemplate = '';
1946 if ($filename !== '') {
1947 $htmlTemplate = t3lib_div::getURL($filename);
1948 }
1949 return $htmlTemplate;
1950 }
1951
1952 /**
1953 * Define the template for the module
1954 *
1955 * @param string filename
1956 */
1957 public function setModuleTemplate($filename) {
1958 // Load Prototype lib for IE event
1959 $this->pageRenderer->loadPrototype();
1960 $this->loadJavascriptLib('js/iecompatibility.js');
1961 $this->moduleTemplate = $this->getHtmlTemplate($filename);
1962 }
1963
1964 /**
1965 * Put together the various elements for the module <body> using a static HTML
1966 * template
1967 *
1968 * @param array Record of the current page, used for page path and info
1969 * @param array HTML for all buttons
1970 * @param array HTML for all other markers
1971 * @return string Composite HTML
1972 */
1973 public function moduleBody($pageRecord = array(), $buttons = array(), $markerArray = array(), $subpartArray = array()) {
1974 // Get the HTML template for the module
1975 $moduleBody = t3lib_parsehtml::getSubpart($this->moduleTemplate, '###FULLDOC###');
1976 // Add CSS
1977 $this->inDocStylesArray[] = 'html { overflow: hidden; }';
1978 // Add JS code to the <head> for IE
1979 $this->JScode.= $this->wrapScriptTags('
1980 // workaround since IE6 cannot deal with relative height for scrolling elements
1981 function resizeDocBody() {
1982 $("typo3-docbody").style.height = (document.body.offsetHeight - parseInt($("typo3-docheader").getStyle("height")));
1983 }
1984 if (Prototype.Browser.IE) {
1985 var version = parseFloat(navigator.appVersion.split(\';\')[1].strip().split(\' \')[1]);
1986 if (version == 6) {
1987 Event.observe(window, "resize", resizeDocBody, false);
1988 Event.observe(window, "load", resizeDocBody, false);
1989 }
1990 }
1991 ');
1992
1993 // Get the page path for the docheader
1994 $markerArray['PAGEPATH'] = $this->getPagePath($pageRecord);
1995 // Get the page info for the docheader
1996 $markerArray['PAGEINFO'] = $this->getPageInfo($pageRecord);
1997 // Get all the buttons for the docheader
1998 $docHeaderButtons = $this->getDocHeaderButtons($buttons);
1999 // Merge docheader buttons with the marker array
2000 $markerArray = array_merge($markerArray, $docHeaderButtons);
2001 // replacing subparts
2002 foreach ($subpartArray as $marker => $content) {
2003 $moduleBody = t3lib_parsehtml::substituteSubpart($moduleBody, $marker, $content);
2004 }
2005
2006 // adding flash messages
2007 if ($this->showFlashMessages) {
2008 $flashMessages = t3lib_FlashMessageQueue::renderFlashMessages();
2009 if (!empty($flashMessages)) {
2010 $markerArray['FLASHMESSAGES'] = '<div id="typo3-messages">' . $flashMessages . '</div>';
2011
2012 // if there is no dedicated marker for the messages present
2013 // then force them to appear before the content
2014 if (strpos($moduleBody, '###FLASHMESSAGES###') === FALSE) {
2015 $moduleBody = str_replace(
2016 '###CONTENT###',
2017 '###FLASHMESSAGES######CONTENT###',
2018 $moduleBody
2019 );
2020 }
2021 }
2022 }
2023
2024 // Hook for adding more markers/content to the page, like the version selector
2025 if (isset($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['typo3/template.php']['moduleBodyPostProcess'])) {
2026 $params = array(
2027 'moduleTemplateFilename' => &$this->moduleTemplateFilename,
2028 'moduleTemplate' => &$this->moduleTemplate,
2029 'moduleBody' => &$moduleBody,
2030 'markers' => &$markerArray,
2031 'parentObject' => &$this
2032 );
2033 foreach ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['typo3/template.php']['moduleBodyPostProcess'] as $funcRef) {
2034 t3lib_div::callUserFunction($funcRef, $params, $this);
2035 }
2036 }
2037
2038 // replacing all markers with the finished markers and return the HTML content
2039 return t3lib_parsehtml::substituteMarkerArray($moduleBody, $markerArray, '###|###');
2040
2041 }
2042
2043 /**
2044 * Fill the button lists with the defined HTML
2045 *
2046 * @param array HTML for all buttons
2047 * @return array Containing HTML for both buttonlists
2048 */
2049 protected function getDocHeaderButtons($buttons) {
2050 $markers = array();
2051 // Fill buttons for left and right float
2052 $floats = array('left', 'right');
2053 foreach($floats as $key) {
2054 // Get the template for each float
2055 $buttonTemplate = t3lib_parsehtml::getSubpart($this->moduleTemplate, '###BUTTON_GROUPS_' . strtoupper($key) . '###');
2056 // Fill the button markers in this float
2057 $buttonTemplate = t3lib_parsehtml::substituteMarkerArray($buttonTemplate, $buttons, '###|###', true);
2058 // getting the wrap for each group
2059 $buttonWrap = t3lib_parsehtml::getSubpart($this->moduleTemplate, '###BUTTON_GROUP_WRAP###');
2060 // looping through the groups (max 6) and remove the empty groups
2061 for ($groupNumber = 1; $groupNumber < 6; $groupNumber++) {
2062 $buttonMarker = '###BUTTON_GROUP' . $groupNumber . '###';
2063 $buttonGroup = t3lib_parsehtml::getSubpart($buttonTemplate, $buttonMarker);
2064 if (trim($buttonGroup)) {
2065 if ($buttonWrap) {
2066 $buttonGroup = t3lib_parsehtml::substituteMarker($buttonWrap, '###BUTTONS###', $buttonGroup);
2067 }
2068 $buttonTemplate = t3lib_parsehtml::substituteSubpart($buttonTemplate, $buttonMarker, trim($buttonGroup));
2069 }
2070 }
2071 // replace the marker with the template and remove all line breaks (for IE compat)
2072 $markers['BUTTONLIST_' . strtoupper($key)] = str_replace(LF, '', $buttonTemplate);
2073 }
2074
2075 // Hook for manipulating docHeaderButtons
2076 if (isset($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['typo3/template.php']['docHeaderButtonsHook'])) {
2077 $params = array(
2078 'buttons' => $buttons,
2079 'markers' => &$markers,
2080 'pObj' => &$this
2081 );
2082 foreach($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['typo3/template.php']['docHeaderButtonsHook'] as $funcRef) {
2083 t3lib_div::callUserFunction($funcRef, $params, $this);
2084 }
2085 }
2086
2087 return $markers;
2088 }
2089
2090 /**
2091 * Generate the page path for docheader
2092 *
2093 * @param array Current page
2094 * @return string Page path
2095 */
2096 protected function getPagePath($pageRecord) {
2097 // Is this a real page
2098 if ($pageRecord['uid']) {
2099 $title = substr($pageRecord['_thePathFull'], 0, -1);
2100 // remove current page title
2101 $pos = strrpos($title, '/');
2102 if ($pos !== FALSE) {
2103 $title = substr($title, 0, $pos) . '/';
2104 }
2105 } else {
2106 $title = '';
2107 }
2108
2109 // Setting the path of the page
2110 $pagePath = $GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:labels.path', 1) . ': <span class="typo3-docheader-pagePath">';
2111
2112 // crop the title to title limit (or 50, if not defined)
2113 $cropLength = (empty($GLOBALS['BE_USER']->uc['titleLen'])) ? 50 : $GLOBALS['BE_USER']->uc['titleLen'];
2114 $croppedTitle = t3lib_div::fixed_lgd_cs($title, -$cropLength);
2115 if ($croppedTitle !== $title) {
2116 $pagePath .= '<abbr title="' . htmlspecialchars($title) . '">' . htmlspecialchars($croppedTitle) . '</abbr>';
2117 } else {
2118 $pagePath .= htmlspecialchars($title);
2119 }
2120 $pagePath .= '</span>';
2121 return $pagePath;
2122 }
2123
2124 /**
2125 * Setting page icon with clickmenu + uid for docheader
2126 *
2127 * @param array Current page
2128 * @return string Page info
2129 */
2130 protected function getPageInfo($pageRecord) {
2131 global $BE_USER;
2132 // Add icon with clickmenu, etc:
2133 if ($pageRecord['uid']) { // If there IS a real page
2134 $alttext = t3lib_BEfunc::getRecordIconAltText($pageRecord, 'pages');
2135 $iconImg = t3lib_iconWorks::getSpriteIconForRecord('pages', $pageRecord, array('title'=>$alttext));
2136 // Make Icon:
2137 $theIcon = $GLOBALS['SOBE']->doc->wrapClickMenuOnIcon($iconImg, 'pages', $pageRecord['uid']);
2138 $uid = $pageRecord['uid'];
2139 $title = t3lib_BEfunc::getRecordTitle('pages', $pageRecord);
2140 } else { // On root-level of page tree
2141 // Make Icon
2142 $iconImg = t3lib_iconWorks::getSpriteIcon('apps-pagetree-root', array('title' => htmlspecialchars($GLOBALS['TYPO3_CONF_VARS']['SYS']['sitename'])));
2143 if($BE_USER->user['admin']) {
2144 $theIcon = $GLOBALS['SOBE']->doc->wrapClickMenuOnIcon($iconImg, 'pages', 0);
2145 } else {
2146 $theIcon = $iconImg;
2147 }
2148 $uid = '0';
2149 $title = $GLOBALS['TYPO3_CONF_VARS']['SYS']['sitename'];
2150 }
2151
2152 // Setting icon with clickmenu + uid
2153 $pageInfo = $theIcon . '<strong>' . htmlspecialchars($title) . '&nbsp;[' . $uid . ']</strong>';
2154 return $pageInfo;
2155 }
2156
2157 /**
2158 * Makes a collapseable section. See reports module for an example
2159 *
2160 * @param string $title
2161 * @param string $html
2162 * @param string $id
2163 * @param string $saveStatePointer
2164 * @return string
2165 */
2166 public function collapseableSection($title, $html, $id, $saveStatePointer = '') {
2167 $hasSave = $saveStatePointer ? TRUE : FALSE;
2168 $collapsedStyle = $collapsedClass = '';
2169
2170 if ($hasSave) {
2171 /** @var $settings extDirect_DataProvider_BackendUserSettings */
2172 $settings = t3lib_div::makeInstance('extDirect_DataProvider_BackendUserSettings');
2173 $value = $settings->get($saveStatePointer . '.' . $id);
2174 if ($value) {
2175 $collapsedStyle = ' style="display: none"';
2176 $collapsedClass = ' collapsed';
2177 } else {
2178 $collapsedStyle = '';
2179 $collapsedClass = ' expanded';
2180 }
2181 }
2182
2183 $this->pageRenderer->loadExtJS();
2184 $this->pageRenderer->addExtOnReadyCode('
2185 Ext.select("h2.section-header").each(function(element){
2186 element.on("click", function(event, tag) {
2187 var state = 0,
2188 el = Ext.fly(tag),
2189 div = el.next("div"),
2190 saveKey = el.getAttribute("rel");
2191 if (el.hasClass("collapsed")) {
2192 el.removeClass("collapsed").addClass("expanded");
2193 div.slideIn("t", {
2194 easing: "easeIn",
2195 duration: .5
2196 });
2197 } else {
2198 el.removeClass("expanded").addClass("collapsed");
2199 div.slideOut("t", {
2200 easing: "easeOut",
2201 duration: .5,
2202 remove: false,
2203 useDisplay: true
2204 });
2205 state = 1;
2206 }
2207 if (saveKey) {
2208 try {
2209 top.TYPO3.BackendUserSettings.ExtDirect.set(saveKey + "." + tag.id, state, function(response) {});
2210 } catch(e) {}
2211 }
2212 });
2213 });
2214 ');
2215 return '
2216 <h2 id="' . $id . '" class="section-header' . $collapsedClass . '" rel="' . $saveStatePointer . '"> ' . $title . '</h2>
2217 <div' . $collapsedStyle . '>' . $html . '</div>
2218 ';
2219
2220 }
2221
2222
2223 }
2224
2225
2226 // ******************************
2227 // Extension classes of the template class.
2228 // These are meant to provide backend screens with different widths.
2229 // They still do because of the different class-prefixes used for the <div>-sections
2230 // but obviously the final width is determined by the stylesheet used.
2231 // ******************************
2232
2233 /**
2234 * 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
2235 * The class were more significant in the past than today.
2236 *
2237 */
2238 class bigDoc extends template {
2239 var $divClass = 'typo3-bigDoc';
2240 }
2241
2242 /**
2243 * Extension class for "template" - used for backend pages without the "document" background image
2244 * The class were more significant in the past than today.
2245 *
2246 */
2247 class noDoc extends template {
2248 var $divClass = 'typo3-noDoc';
2249 }
2250
2251 /**
2252 * 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)
2253 * The class were more significant in the past than today.
2254 *
2255 */
2256 class smallDoc extends template {
2257 var $divClass = 'typo3-smallDoc';
2258 }
2259
2260 /**
2261 * 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.
2262 * The class were more significant in the past than today. But probably you should use this one for most modules you make.
2263 *
2264 */
2265 class mediumDoc extends template {
2266 var $divClass = 'typo3-mediumDoc';
2267 }
2268
2269
2270 /**
2271 * Extension class for "template" - used in the context of frontend editing.
2272 */
2273 class frontendDoc extends template {
2274
2275 /**
2276 * Gets instance of PageRenderer
2277 *
2278 * @return t3lib_PageRenderer
2279 */
2280 public function getPageRenderer() {
2281 if (!isset($this->pageRenderer)) {
2282 $this->pageRenderer = $GLOBALS['TSFE']->getPageRenderer();
2283 }
2284 return $this->pageRenderer;
2285 }
2286
2287 /**
2288 * Used in the frontend context to insert header data via TSFE->additionalHeaderData.
2289 * Mimics header inclusion from template->startPage().
2290 *
2291 * @return void
2292 */
2293 public function insertHeaderData() {
2294
2295 $this->backPath = $GLOBALS['TSFE']->backPath = TYPO3_mainDir;
2296 $this->pageRenderer->setBackPath($this->backPath);
2297 $this->docStyle();
2298
2299 // add applied JS/CSS to $GLOBALS['TSFE']
2300 if ($this->JScode) {
2301 $this->pageRenderer->addHeaderData($this->JScode);
2302 }
2303 if (count($this->JScodeArray)) {
2304 foreach ($this->JScodeArray as $name => $code) {
2305 $this->pageRenderer->addJsInlineCode($name, $code);
2306 }
2307 }
2308 }
2309 }
2310
2311
2312 if (defined('TYPO3_MODE') && isset($GLOBALS['TYPO3_CONF_VARS'][TYPO3_MODE]['XCLASS']['typo3/template.php'])) {
2313 include_once($GLOBALS['TYPO3_CONF_VARS'][TYPO3_MODE]['XCLASS']['typo3/template.php']);
2314 }
2315
2316
2317
2318 // ******************************
2319 // The template is loaded
2320 // ******************************
2321 $GLOBALS['TBE_TEMPLATE'] = t3lib_div::makeInstance('template');
2322
2323
2324 ?>