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