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