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