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