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