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