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