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