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