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