2 /***************************************************************
5 * (c) 1999-2009 Kasper Skaarhoj (kasperYYYY@typo3.com)
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.
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.
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.
25 * This copyright notice MUST APPEAR in all copies of the script!
26 ***************************************************************/
28 * Contains class with layout/output function for TYPO3 Backend Scripts
31 * Revised for TYPO3 3.6 2/2003 by Kasper Skaarhoj
32 * XHTML-trans compliant
34 * @author Kasper Skaarhoj <kasperYYYY@typo3.com>
37 * [CLASS/FUNCTION INDEX of SCRIPT]
39 * 145: function fw($str)
43 * 224: function template()
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()
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()
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)
107 * 2060: class bigDoc extends template
110 * 2069: class noDoc extends template
113 * 2078: class smallDoc extends template
116 * 2087: class mediumDoc extends template
118 * TOTAL FUNCTIONS: 57
119 * (This index is automatically created/updated by the extension "extdeveval")
125 if (!defined('TYPO3_MODE')) die("Can't include this file directly.");
129 * Deprecated fontwrap function. Is just transparent now.
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
136 t3lib_div
::logDeprecatedFunction();
142 * TYPO3 Backend Template Class
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.
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.
154 * Please refer to Inside TYPO3 for a discussion of how to use this API.
156 * @author Kasper Skaarhoj <kasperYYYY@typo3.com>
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
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.
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 $styleSheetFile_print = 'stylesheet_print.css'; // Filename of a print-stylesheet - included after all styles.
196 var $backGroundImage = ''; // Background image of page (relative to PATH_typo3)
197 var $inDocStyles_TBEstyle = ''; // Inline css styling set from TBE_STYLES array
200 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.
203 var $charset = 'iso-8859-1'; // Default charset. see function initCharset()
205 var $sectionFlag=0; // Internal: Indicates if a <div>-output section is open
206 var $divClass = ''; // (Default) Class for wrapping <DIV>-tag of page. Is set in class extensions.
208 var $pageHeaderBlock = '';
209 var $endOfPageJsBlock = '';
211 var $hasDocheader = true;
214 * @var t3lib_PageRenderer
216 protected $pageRenderer;
217 protected $pageHeaderFooterTemplateFile = ''; // alternative template file
220 * Whether flashmessages should be rendered or not
222 * @var $showFlashMessages
224 public $showFlashMessages = TRUE;
228 * Imports relevant parts from global $TBE_STYLES (colorscheme)
232 function template() {
235 // Initializes the page rendering object:
236 $this->getPageRenderer();
238 // Setting default scriptID:
239 if (($temp_M = (string) t3lib_div
::_GET('M')) && $GLOBALS['TBE_MODULES']['_PATHS'][$temp_M]) {
240 $this->scriptID
= preg_replace('/^.*\/(sysext|ext)\//', 'ext/', $GLOBALS['TBE_MODULES']['_PATHS'][$temp_M] . 'index.php');
242 $this->scriptID
= preg_replace('/^.*\/(sysext|ext)\//', 'ext/', substr(PATH_thisScript
, strlen(PATH_site
)));
244 if (TYPO3_mainDir
!='typo3/' && substr($this->scriptID
,0,strlen(TYPO3_mainDir
)) == TYPO3_mainDir
) {
245 $this->scriptID
= 'typo3/'.substr($this->scriptID
,strlen(TYPO3_mainDir
)); // This fixes if TYPO3_mainDir has been changed so the script ids are STILL "typo3/..."
248 $this->bodyTagId
= preg_replace('/[^A-Za-z0-9-]/','-',$this->scriptID
);
250 // Individual configuration per script? If so, make a recursive merge of the arrays:
251 if (is_array($TBE_STYLES['scriptIDindex'][$this->scriptID
])) {
252 $ovr = $TBE_STYLES['scriptIDindex'][$this->scriptID
]; // Make copy
253 $TBE_STYLES = t3lib_div
::array_merge_recursive_overrule($TBE_STYLES,$ovr); // merge styles.
254 unset($TBE_STYLES['scriptIDindex'][$this->scriptID
]); // Have to unset - otherwise the second instantiation will do it again!
258 if ($TBE_STYLES['mainColors']['bgColor']) $this->bgColor
=$TBE_STYLES['mainColors']['bgColor'];
259 if ($TBE_STYLES['mainColors']['bgColor1']) $this->bgColor1
=$TBE_STYLES['mainColors']['bgColor1'];
260 if ($TBE_STYLES['mainColors']['bgColor2']) $this->bgColor2
=$TBE_STYLES['mainColors']['bgColor2'];
261 if ($TBE_STYLES['mainColors']['bgColor3']) $this->bgColor3
=$TBE_STYLES['mainColors']['bgColor3'];
262 if ($TBE_STYLES['mainColors']['bgColor4']) $this->bgColor4
=$TBE_STYLES['mainColors']['bgColor4'];
263 if ($TBE_STYLES['mainColors']['bgColor5']) $this->bgColor5
=$TBE_STYLES['mainColors']['bgColor5'];
264 if ($TBE_STYLES['mainColors']['bgColor6']) $this->bgColor6
=$TBE_STYLES['mainColors']['bgColor6'];
265 if ($TBE_STYLES['mainColors']['hoverColor']) $this->hoverColor
=$TBE_STYLES['mainColors']['hoverColor'];
268 if ($TBE_STYLES['stylesheet']) $this->styleSheetFile
= $TBE_STYLES['stylesheet'];
269 if ($TBE_STYLES['stylesheet2']) $this->styleSheetFile2
= $TBE_STYLES['stylesheet2'];
270 if ($TBE_STYLES['styleSheetFile_post']) $this->styleSheetFile_post
= $TBE_STYLES['styleSheetFile_post'];
271 if ($TBE_STYLES['styleSheetFile_print']) $this->styleSheetFile_print
= $TBE_STYLES['styleSheetFile_print'];
272 if ($TBE_STYLES['inDocStyles_TBEstyle']) $this->inDocStyles_TBEstyle
= $TBE_STYLES['inDocStyles_TBEstyle'];
274 // Stylesheets from skins:
275 // stylesheet directories have to be registered this way in ext_tables.php:
276 // $TBE_STYLES['stylesheetDirectories'][$_EXTKEY][] = 'EXT:myext/stylesheets/visual/'
277 if (is_array($TBE_STYLES['stylesheetDirectories'])) {
278 // loop over all extensions registering stylesheetDirectories
279 foreach ($TBE_STYLES['stylesheetDirectories'] as $key => $directories) {
280 // loop over all stylesheetDirectories of this extension
281 foreach ($directories as $directory) {
282 // we expect EXT:myext/.../ here
283 $extKey = substr($directory, 4, strpos($directory, '/') - 4);
284 $styleDirectory = substr($directory, strpos($directory, '/') +
1);
285 // ensure that we have a trailing /
286 $styleDirectory = rtrim($styleDirectory, '/') . '/';
288 if (is_readable(t3lib_extMgm
::extPath($extKey) . $styleDirectory)) {
289 $this->addStyleSheetDirectory(t3lib_extMgm
::extRelPath($extKey) . $styleDirectory);
296 if ($TBE_STYLES['background']) $this->backGroundImage
= $TBE_STYLES['background'];
301 * Gets instance of PageRenderer
303 * @return t3lib_PageRenderer
305 public function getPageRenderer() {
306 if (!isset($this->pageRenderer
)) {
307 $this->pageRenderer
= t3lib_div
::makeInstance('t3lib_PageRenderer');
308 $this->pageRenderer
->setTemplateFile(
309 TYPO3_mainDir
. 'templates/template_page_backend.html'
311 $this->pageRenderer
->setLanguage($GLOBALS['LANG']->lang
);
313 return $this->pageRenderer
;
328 /*****************************************
330 * EVALUATION FUNCTIONS
331 * Various centralized processing
333 *****************************************/
336 * Makes click menu link (context sensitive menu)
337 * 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)
338 * 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)
340 * @param string String to be wrapped in link, typ. image tag.
341 * @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
342 * @param integer If icon is for database record this is the UID for the record from $table
343 * @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.
344 * @param string Additional GET parameters for the link to alt_clickmenu.php
345 * @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.
346 * @param boolean If set, will return only the onclick JavaScript, not the whole link.
347 * @return string The link-wrapped input string.
349 function wrapClickMenuOnIcon($str,$table,$uid='',$listFr=1,$addParams='',$enDisItems='', $returnOnClick=FALSE) {
350 $backPath = rawurlencode($this->backPath
).'|'.t3lib_div
::shortMD5($this->backPath
.'|'.$GLOBALS['TYPO3_CONF_VARS']['SYS']['encryptionKey']);
351 $onClick = 'showClickmenu("'.$table.'","'.$uid.'","'.$listFr.'","'.str_replace('+','%2B',$enDisItems).'","'.str_replace('&','&',addcslashes($backPath,'"')).'","'.str_replace('&','&',addcslashes($addParams,'"')).'");return false;';
352 return $returnOnClick ?
$onClick : '<a href="#" onclick="'.htmlspecialchars($onClick).'"'.($GLOBALS['TYPO3_CONF_VARS']['BE']['useOnContextMenuHandler'] ?
' oncontextmenu="'.htmlspecialchars($onClick).'"' : '').'>'.$str.'</a>';
356 * Makes link to page $id in frontend (view page)
357 * Returns an magnifier-glass icon which links to the frontend index.php document for viewing the page with id $id
358 * $id must be a page-uid
359 * If the BE_USER has access to Web>List then a link to that module is shown as well (with return-url)
361 * @param integer The page id
362 * @param string The current "BACK_PATH" (the back relative to the typo3/ directory)
363 * @param string Additional parameters for the image tag(s)
364 * @return string HTML string with linked icon(s)
366 function viewPageIcon($id,$backPath,$addParams='hspace="3"') {
369 // If access to Web>List for user, then link to that module.
370 if ($BE_USER->check('modules','web_list')) {
371 $href=$backPath.'db_list.php?id='.$id.'&returnUrl='.rawurlencode(t3lib_div
::getIndpEnv('REQUEST_URI'));
372 $str.= '<a href="'.htmlspecialchars($href).'">'.
373 '<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="" />'.
376 // Make link to view page
377 $str.= '<a href="#" onclick="'.htmlspecialchars(t3lib_BEfunc
::viewOnClick($id,$backPath,t3lib_BEfunc
::BEgetRootLine($id))).'">'.
378 '<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 * Returns a URL with a command to TYPO3 Core Engine (tce_db.php)
385 * See description of the API elsewhere.
387 * @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"
388 * @param string Redirect URL if any other that t3lib_div::getIndpEnv('REQUEST_URI') is wished
389 * @return string URL to tce_db.php + parameters (backpath is taken from $this->backPath)
390 * @see t3lib_BEfunc::editOnClick()
392 function issueCommand($params,$rUrl='') {
393 $rUrl = $rUrl ?
$rUrl : t3lib_div
::getIndpEnv('REQUEST_URI');
394 return $this->backPath
.'tce_db.php?'.
396 '&redirect='.($rUrl==-1?
"'+T3_THIS_LOCATION+'":rawurlencode($rUrl)).
397 '&vC='.rawurlencode($GLOBALS['BE_USER']->veriCode()).
402 * Returns true if click-menu layers can be displayed for the current user/browser
403 * Use this to test if click-menus (context sensitive menus) can and should be displayed in the backend.
407 function isCMlayers() {
408 return !$GLOBALS['BE_USER']->uc
['disableCMlayers'] && $GLOBALS['CLIENT']['FORMSTYLE'] && !($GLOBALS['CLIENT']['SYSTEM']=='mac' && $GLOBALS['CLIENT']['BROWSER']=='Opera');
412 * Returns 'this.blur();' if the client supports CSS styles
413 * Use this in links to remove the underlining after being clicked
417 function thisBlur() {
418 return ($GLOBALS['CLIENT']['FORMSTYLE']?
'this.blur();':'');
422 * Returns ' style='cursor:help;'' if the client supports CSS styles
423 * Use for <a>-links to help texts
427 function helpStyle() {
428 return $GLOBALS['CLIENT']['FORMSTYLE'] ?
' style="cursor:help;"':'';
432 * Makes the header (icon+title) for a page (or other record). Used in most modules under Web>*
433 * $table and $row must be a tablename/record from that table
434 * $path will be shown as alt-text for the icon.
435 * The title will be truncated to 45 chars.
437 * @param string Table name
438 * @param array Record row
439 * @param string Alt text
440 * @param boolean Set $noViewPageIcon true if you don't want a magnifier-icon for viewing the page in the frontend
441 * @param array $tWrap is an array with indexes 0 and 1 each representing HTML-tags (start/end) which will wrap the title
442 * @return string HTML content
444 function getHeader($table,$row,$path,$noViewPageIcon=0,$tWrap=array('','')) {
446 if (is_array($row) && $row['uid']) {
447 $iconImgTag=t3lib_iconWorks
::getIconImage($table,$row,$this->backPath
,'title="'.htmlspecialchars($path).'"');
448 $title= strip_tags($row[$TCA[$table]['ctrl']['label']]);
449 $viewPage = $noViewPageIcon ?
'' : $this->viewPageIcon($row['uid'],$this->backPath
,'');
450 if ($table=='pages') $path.=' - '.t3lib_BEfunc
::titleAttribForPages($row,'',0);
452 $iconImgTag='<img'.t3lib_iconWorks
::skinImg($this->backPath
,'gfx/i/_icon_website.gif',$wHattribs='width="18" height="16"').' title="'.htmlspecialchars($path).'" alt="" />';
453 $title=$GLOBALS['TYPO3_CONF_VARS']['SYS']['sitename'];
456 return '<span class="typo3-moduleHeader">'.$this->wrapClickMenuOnIcon($iconImgTag,$table,$row['uid']).
458 $tWrap[0].htmlspecialchars(t3lib_div
::fixed_lgd_cs($title,45)).$tWrap[1].'</span>';
462 * Like ->getHeader() but for files in the File>* main module/submodules
463 * Returns the file-icon with the path of the file set in the alt/title attribute. Shows the file-name after the icon.
465 * @param string Title string, expected to be the filepath
466 * @param string Alt text
467 * @param string The icon file (relative to TYPO3 dir)
468 * @return string HTML content
470 function getFileheader($title,$path,$iconfile) {
471 $fileInfo = t3lib_div
::split_fileref($title);
472 $title = htmlspecialchars(t3lib_div
::fixed_lgd_cs($fileInfo['path'],-35)).'<b>'.htmlspecialchars($fileInfo['file']).'</b>';
473 return '<span class="typo3-moduleHeader"><img'.t3lib_iconWorks
::skinImg($this->backPath
,$iconfile,'width="18" height="16"').' title="'.htmlspecialchars($path).'" alt="" />'.$title.'</span>';
477 * Returns a linked shortcut-icon which will call the shortcut frame and set a shortcut there back to the calling page/module
479 * @param string Is the list of GET variables to store (if any)
480 * @param string Is the list of SET[] variables to store (if any) - SET[] variables a stored in $GLOBALS["SOBE"]->MOD_SETTINGS for backend modules
481 * @param string Module name string
482 * @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.
483 * @return string HTML content
485 function makeShortcutIcon($gvList,$setList,$modName,$motherModName="") {
486 $backPath=$this->backPath
;
487 $storeUrl=$this->makeShortcutUrl($gvList,$setList);
488 $pathInfo = parse_url(t3lib_div
::getIndpEnv('REQUEST_URI'));
490 // Add the module identifier automatically if typo3/mod.php is used:
491 if (preg_match('/typo3\/mod\.php$/', $pathInfo['path']) && isset($GLOBALS['TBE_MODULES']['_PATHS'][$modName])) {
492 $storeUrl = '&M='.$modName.$storeUrl;
495 if (!strcmp($motherModName,'1')) {
496 $mMN="&motherModName='+top.currentModuleLoaded+'";
497 } elseif ($motherModName) {
498 $mMN='&motherModName='.rawurlencode($motherModName);
501 $onClick = 'top.ShortcutManager.createShortcut('
502 .$GLOBALS['LANG']->JScharCode($GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:labels.makeShortcut')).', '
503 .'\''.$backPath.'\', '
504 .'\''.rawurlencode($modName).'\', '
505 .'\''.rawurlencode($pathInfo['path']."?".$storeUrl).$mMN.'\''
508 $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>';
513 * MAKE url for storing
516 * @param string Is the list of GET variables to store (if any)
517 * @param string Is the list of SET[] variables to store (if any) - SET[] variables a stored in $GLOBALS["SOBE"]->MOD_SETTINGS for backend modules
520 * @see makeShortcutIcon()
522 function makeShortcutUrl($gvList,$setList) {
523 $GET = t3lib_div
::_GET();
524 $storeArray = array_merge(
525 t3lib_div
::compileSelectedGetVarsFromArray($gvList,$GET),
526 array('SET'=>t3lib_div
::compileSelectedGetVarsFromArray($setList, (array)$GLOBALS['SOBE']->MOD_SETTINGS
))
528 $storeUrl = t3lib_div
::implodeArrayForUrl('',$storeArray);
533 * Returns <input> attributes to set the width of an text-type input field.
534 * For client browsers with no CSS support the cols/size attribute is returned.
535 * For CSS compliant browsers (recommended) a ' style="width: ...px;"' is returned.
537 * @param integer A relative number which multiplied with approx. 10 will lead to the width in pixels
538 * @param boolean A flag you can set for textareas - DEPRECATED, use ->formWidthText() for textareas!!!
539 * @param string A string which will be returned as attribute-value for style="" instead of the calculated width (if CSS is enabled)
540 * @return string Tag attributes for an <input> tag (regarding width)
541 * @see formWidthText()
543 function formWidth($size=48,$textarea=0,$styleOverride='') {
544 $wAttrib = $textarea?
'cols':'size';
545 if (!$GLOBALS['CLIENT']['FORMSTYLE']) { // If not setting the width by style-attribute
547 $retVal = ' '.$wAttrib.'="'.$size.'"';
548 } else { // Setting width by style-attribute. 'cols' MUST be avoided with NN6+
549 $pixels = ceil($size*$this->form_rowsToStylewidth
);
550 $retVal = $styleOverride ?
' style="'.$styleOverride.'"' : ' style="width:'.$pixels.'px;"';
556 * This function is dedicated to textareas, which has the wrapping on/off option to observe.
558 * <textarea rows="10" wrap="off" '.$GLOBALS["TBE_TEMPLATE"]->formWidthText(48,"","off").'>
560 * <textarea rows="10" wrap="virtual" '.$GLOBALS["TBE_TEMPLATE"]->formWidthText(48,"","virtual").'>
562 * @param integer A relative number which multiplied with approx. 10 will lead to the width in pixels
563 * @param string A string which will be returned as attribute-value for style="" instead of the calculated width (if CSS is enabled)
564 * @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.
565 * @return string Tag attributes for an <input> tag (regarding width)
568 function formWidthText($size=48,$styleOverride='',$wrap='') {
569 $wTags = $this->formWidth($size,1,$styleOverride);
570 // 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...
571 if (strtolower(trim($wrap))!='off' && $GLOBALS['CLIENT']['BROWSER']=='net' && $GLOBALS['CLIENT']['VERSION']>=5) {
572 $wTags.=' cols="'.$size.'"';
578 * Returns JavaScript variables setting the returnUrl and thisScript location for use by JavaScript on the page.
579 * Used in fx. db_list.php (Web>List)
581 * @param string URL to "this location" / current script
583 * @see typo3/db_list.php
585 function redirectUrls($thisLocation='') {
586 $thisLocation = $thisLocation?
$thisLocation:t3lib_div
::linkThisScript(
595 var T3_RETURN_URL = '".str_replace('%20','',rawurlencode(t3lib_div
::_GP('returnUrl')))."';
596 var T3_THIS_LOCATION = '".str_replace('%20','',rawurlencode($thisLocation))."';
602 * Returns a formatted string of $tstamp
603 * Uses $GLOBALS['TYPO3_CONF_VARS']['SYS']['hhmm'] and $GLOBALS['TYPO3_CONF_VARS']['SYS']['ddmmyy'] to format date and time
605 * @param integer UNIX timestamp, seconds since 1970
606 * @param integer How much data to show: $type = 1: hhmm, $type = 10: ddmmmyy
607 * @return string Formatted timestamp
609 function formatTime($tstamp,$type) {
612 case 1: $dateStr = date($GLOBALS['TYPO3_CONF_VARS']['SYS']['hhmm'],$tstamp);
614 case 10: $dateStr = date($GLOBALS['TYPO3_CONF_VARS']['SYS']['ddmmyy'],$tstamp);
621 * Returns script parsetime IF ->parseTimeFlag is set and user is "admin"
622 * Automatically outputted in page end
626 function parseTime() {
627 if ($this->parseTimeFlag
&& $GLOBALS['BE_USER']->isAdmin()) {
628 return '<p>(ParseTime: '.(t3lib_div
::milliseconds()-$GLOBALS['PARSETIME_START']).' ms</p>
629 <p>REQUEST_URI-length: '.strlen(t3lib_div
::getIndpEnv('REQUEST_URI')).')</p>';
644 /*****************************************
646 * PAGE BUILDING FUNCTIONS.
647 * Use this to build the HTML of your backend modules
649 *****************************************/
653 * This includes the proper header with charset, title, meta tag and beginning body-tag.
655 * @param string HTML Page title for the header
656 * @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)
659 function startPage($title) {
660 // hook pre start page
661 if (isset($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['typo3/template.php']['preStartPageHook'])) {
662 $preStartPageHook =& $GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['typo3/template.php']['preStartPageHook'];
663 if (is_array($preStartPageHook)) {
664 $hookParameters = array(
667 foreach ($preStartPageHook as $hookFunction) {
668 t3lib_div
::callUserFunction($hookFunction, $hookParameters, $this);
673 $this->pageRenderer
->backPath
= $this->backPath
;
675 // alternative template for Header and Footer
676 if ($this->pageHeaderFooterTemplateFile
) {
677 $file = t3lib_div
::getFileAbsFileName($this->pageHeaderFooterTemplateFile
, TRUE);
679 $this->pageRenderer
->setTemplateFile($file);
682 // For debugging: If this outputs "QuirksMode"/"BackCompat" (IE) the browser runs in quirks-mode. Otherwise the value is "CSS1Compat"
683 # $this->JScodeArray[]='alert(document.compatMode);';
685 // Send HTTP header for selected charset. Added by Robert Lemke 23.10.2003
686 $this->initCharset();
687 header ('Content-Type:text/html;charset='.$this->charset
);
690 $this->pageRenderer
->setHtmlTag('<html xmlns="http://www.w3.org/1999/xhtml">');
692 switch($this->docType
) {
694 $headerStart = '<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">';
698 $headerStart = '<!DOCTYPE html
699 PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
700 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">';
703 $headerStart = '<!DOCTYPE html
704 PUBLIC "-//W3C//DTD XHTML 1.0 Frameset//EN"
705 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd">';
707 // The fallthrough is intended as XHTML 1.0 transitional is the default for the BE.
710 $headerStart = '<!DOCTYPE html
711 PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
712 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">';
715 // This loads the tabulator-in-textarea feature. It automatically modifies
716 // every textarea which is found.
717 if (!$GLOBALS['BE_USER']->uc
['disableTabInTextarea']) {
718 $this->loadJavascriptLib('tab.js');
721 // Get the browser info
722 $browserInfo = t3lib_utility_Client
::getBrowserInfo(t3lib_div
::getIndpEnv('HTTP_USER_AGENT'));
724 // Set the XML prologue
725 $xmlPrologue = '<?xml version="1.0" encoding="' . $this->charset
. '"?>';
727 // Set the XML stylesheet
728 $xmlStylesheet = '<?xml-stylesheet href="#internalStyle" type="text/css"?>';
730 // Add the XML prologue for XHTML doctypes
731 if ($this->docType
!== 'html_3') {
732 // Put the XML prologue before or after the doctype declaration according to browser
733 if ($browserInfo['browser'] === 'msie' && $browserInfo['version'] < 7) {
734 $headerStart = $headerStart . chr(10) . $xmlPrologue;
736 $headerStart = $xmlPrologue . chr(10) . $headerStart;
739 // Add the xml stylesheet according to doctype
740 if ($this->docType
!== 'xhtml_frames') {
741 $headerStart = $headerStart . chr(10) . $xmlStylesheet;
745 $this->pageRenderer
->setXmlPrologAndDocType($headerStart);
746 $this->pageRenderer
->setHeadTag('<head>' . chr(10). '<!-- TYPO3 Script ID: '.htmlspecialchars($this->scriptID
).' -->');
747 $this->pageRenderer
->setCharSet($this->charset
);
748 $this->pageRenderer
->addMetaTag($this->generator());
749 $this->pageRenderer
->addMetaTag($this->xUaCompatible());
750 $this->pageRenderer
->setTitle($title);
756 // add jsCode - has to go to headerData as it may contain the script tags already
757 $this->pageRenderer
->addHeaderData($this->JScode
);
759 foreach ($this->JScodeArray
as $name => $code) {
760 $this->pageRenderer
->addJsInlineCode($name, $code);
763 if (count($this->JScodeLibArray
)) {
764 foreach($this->JScodeLibArray
as $library) {
765 $this->pageRenderer
->addHeaderData($library);
769 if ($this->extJScode
) {
770 $this->pageRenderer
->addExtOnReadyCode($this->extJScode
);
773 // Construct page header.
774 $str = $this->pageRenderer
->render(t3lib_PageRenderer
::PART_HEADER
);
776 $this->JScodeLibArray
= array();
777 $this->JScode
= $this->extJScode
= '';
778 $this->JScodeArray
= array();
780 $this->endOfPageJsBlock
= $this->pageRenderer
->render(t3lib_PageRenderer
::PART_FOOTER
);
782 if ($this->docType
=='xhtml_frames') {
785 $str.=$this->docBodyTagBegin().
788 <!-- Wrapping DIV-section for whole page BEGIN -->
789 <div class="'.$this->divClass
.'">
790 ':'').trim($this->form
);
795 * Returns page end; This includes finishing form, div, body and html tags.
797 * @return string The HTML end of a page
801 $str = $this->sectionEnd().
804 $this->wrapScriptTags(t3lib_BEfunc
::getUpdateSignalCode()).
809 if ($this->docType
!='xhtml_frames') {
811 $str .= ($this->divClass?
'
813 <!-- Wrapping DIV-section for whole page END -->
814 </div>':'') . $this->endOfPageJsBlock
;
819 // Logging: Can't find better place to put it:
820 if (TYPO3_DLOG
) t3lib_div
::devLog('END of BACKEND session', 'template', 0, array('_FLUSH' => true));
826 * Returns the header-bar in the top of most backend modules
827 * Closes section if open.
829 * @param string The text string for the header
830 * @return string HTML content
832 function header($text) {
835 <!-- MAIN Header in page top -->
836 <h2>'.htmlspecialchars($text).'</h2>
838 return $this->sectionEnd().$str;
842 * Begins an output section and sets header and content
844 * @param string The header
845 * @param string The HTML-content
846 * @param boolean A flag that will prevent the header from being converted to uppercase
847 * @param boolean Defines the type of header (if set, "<h3>" rather than the default "h4")
848 * @param integer The number of an icon to show with the header (see the icon-function). -1,1,2,3
849 * @param boolean If set, HTML tags are allowed in $label (otherwise this value is by default htmlspecialchars()'ed)
850 * @return string HTML content
851 * @see icons(), sectionHeader()
853 function section($label,$text,$nostrtoupper=FALSE,$sH=FALSE,$type=0,$allowHTMLinHeader=FALSE) {
858 if (!$allowHTMLinHeader) $label = htmlspecialchars($label);
859 $str.=$this->sectionHeader($this->icons($type).$label, $sH, $nostrtoupper ?
'' : ' class="uppercase"');
864 <!-- Section content -->
867 return $this->sectionBegin().$str;
871 * Inserts a divider image
872 * Ends a section (if open) before inserting the image
874 * @param integer The margin-top/-bottom of the <hr> ruler.
875 * @return string HTML content
877 function divider($dist) {
878 $dist = intval($dist);
882 <hr style="margin-top: '.$dist.'px; margin-bottom: '.$dist.'px;" />
884 return $this->sectionEnd().$str;
888 * Returns a blank <div>-section with a height
890 * @param integer Padding-top for the div-section (should be margin-top but konqueror (3.1) doesn't like it :-(
891 * @return string HTML content
893 function spacer($dist) {
897 <!-- Spacer element -->
898 <div style="padding-top: '.intval($dist).'px;"></div>
904 * Make a section header.
905 * Begins a section if not already open.
907 * @param string The label between the <h3> or <h4> tags. (Allows HTML)
908 * @param boolean If set, <h3> is used, otherwise <h4>
909 * @param string Additional attributes to h-tag, eg. ' class=""'
910 * @return string HTML content
912 function sectionHeader($label, $sH=FALSE, $addAttrib='') {
913 $tag = ($sH ?
'h3' : 'h4');
914 if ($addAttrib && substr($addAttrib, 0, 1) !== ' ') {
915 $addAttrib = ' ' . $addAttrib;
919 <!-- Section header -->
920 <' . $tag . $addAttrib . '>' . $label . '</' . $tag . '>
922 return $this->sectionBegin() . $str;
926 * Begins an output section.
927 * Returns the <div>-begin tag AND sets the ->sectionFlag true (if the ->sectionFlag is not already set!)
928 * 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!
930 * @return string HTML content
932 function sectionBegin() {
933 if (!$this->sectionFlag
) {
934 $this->sectionFlag
=1;
937 <!-- ***********************
938 Begin output section.
939 *********************** -->
947 * Ends and output section
948 * Returns the </div>-end tag AND clears the ->sectionFlag (but does so only IF the sectionFlag is set - that is a section is 'open')
949 * See sectionBegin() also.
951 * @return string HTML content
953 function sectionEnd() {
954 if ($this->sectionFlag
) {
955 $this->sectionFlag
=0;
958 <!-- *********************
960 ********************* -->
966 * Originally it printed a kind of divider.
967 * Deprecated. Just remove function calls to it or call the divider() function instead.
971 * @deprecated since TYPO3 3.6
977 * If a form-tag is defined in ->form then and end-tag for that <form> element is outputted
978 * Further a JavaScript section is outputted which will update the top.busy session-expiry object (unless $this->endJS is set to false)
980 * @return string HTML content (<script> tag section)
982 function endPageJS() {
983 return ($this->endJS?
'
984 <script type="text/javascript">
986 if (top.busy && top.busy.loginRefreshed) {
987 top.busy.loginRefreshed();
994 * Creates the bodyTag.
995 * You can add to the bodyTag by $this->bodyTagAdditions
997 * @return string HTML body tag
999 function docBodyTagBegin() {
1000 $bodyContent = 'body onclick="if (top.menuReset) top.menuReset();" '.trim($this->bodyTagAdditions
.($this->bodyTagId ?
' id="'.$this->bodyTagId
.'"' : ''));
1001 return '<'.trim($bodyContent).'>';
1005 * Outputting document style
1007 * @return string HTML style section/link tags
1009 function docStyle() {
1011 // Request background image:
1012 if ($this->backGroundImage
) {
1013 $this->inDocStylesArray
[]=' BODY { background-image: url('.$this->backPath
.$this->backGroundImage
.'); }';
1016 // Add inDoc styles variables as well:
1017 $this->inDocStylesArray
[] = $this->inDocStyles
;
1018 $this->inDocStylesArray
[] = $this->inDocStyles_TBEstyle
;
1021 $inDocStyles = implode(chr(10), $this->inDocStylesArray
);
1023 if ($this->styleSheetFile
) {
1024 $this->pageRenderer
->addCssFile($this->backPath
. $this->styleSheetFile
);
1026 if ($this->styleSheetFile2
) {
1027 $this->pageRenderer
->addCssFile($this->backPath
. $this->styleSheetFile2
);
1030 $this->pageRenderer
->addCssInlineBlock('inDocStyles', $inDocStyles . chr(10) . '/*###POSTCSSMARKER###*/');
1031 if ($this->styleSheetFile_post
) {
1032 $this->pageRenderer
->addCssFile($this->backPath
. $this->styleSheetFile_post
);
1034 if ($this->styleSheetFile_print
) {
1035 $this->pageRenderer
->addCssFile($this->backPath
. $this->styleSheetFile_print
, 'stylesheet', 'print');
1041 * Insert additional style sheet link
1043 * @param string $key: some key identifying the style sheet
1044 * @param string $href: uri to the style sheet file
1045 * @param string $title: value for the title attribute of the link element
1046 * @return string $relation: value for the rel attribute of the link element
1049 function addStyleSheet($key, $href, $title='', $relation='stylesheet') {
1050 if (strpos($href, '://') !== FALSE ||
substr($href, 0, 1) === '/') {
1053 $file = $this->backPath
. $href;
1055 $this->pageRenderer
->addCssFile($file, $relation, 'screen', $title);
1059 * Add all *.css files of the directory $path to the stylesheets
1061 * @param string directory to add
1064 function addStyleSheetDirectory($path) {
1065 // calculation needed, when TYPO3 source is used via a symlink
1066 // absolute path to the stylesheets
1067 $filePath = dirname(t3lib_div
::getIndpEnv('SCRIPT_FILENAME')) . '/' . $GLOBALS['BACK_PATH'] . $path;
1069 $resolvedPath = t3lib_div
::resolveBackPath($filePath);
1070 // read all files in directory and sort them alphabetically
1071 $files = t3lib_div
::getFilesInDir($resolvedPath, 'css', FALSE, 1);
1072 foreach ($files as $file) {
1073 $this->pageRenderer
->addCssFile($GLOBALS['BACK_PATH'] . $path . $file, 'stylesheet', 'all');
1078 * Insert post rendering document style into already rendered content
1079 * This is needed for extobjbase
1081 * @param string style-content to insert.
1082 * @return string content with inserted styles
1084 function insertStylesAndJS($content) {
1085 // insert accumulated CSS
1086 $this->inDocStylesArray
[] = $this->inDocStyles
;
1087 $styles = "\n".implode("\n", $this->inDocStylesArray
);
1088 $content = str_replace('/*###POSTCSSMARKER###*/',$styles,$content);
1090 // insert accumulated JS
1091 $jscode = $this->JScode
."\n".$this->wrapScriptTags(implode("\n", $this->JScodeArray
));
1092 $content = str_replace('<!--###POSTJSMARKER###-->',$jscode,$content);
1098 * Initialize the charset.
1099 * Sets the internal $this->charset variable to the charset defined in $GLOBALS["LANG"] (or the default as set in this class)
1100 * Returns the meta-tag for the document header
1102 * @return string <meta> tag with charset from $this->charset or $GLOBALS['LANG']->charSet
1104 function initCharset() {
1105 // Set charset to the charset provided by the current backend users language selection:
1106 $this->charset
= $GLOBALS['LANG']->charSet ?
$GLOBALS['LANG']->charSet
: $this->charset
;
1108 return '<meta http-equiv="Content-Type" content="text/html; charset='.$this->charset
.'" />';
1112 * Returns generator meta tag
1114 * @return string <meta> tag with name "generator"
1116 function generator() {
1117 $str = 'TYPO3 '.TYPO3_branch
.', http://typo3.com, © Kasper Skårhøj 1998-2009, extensions are copyright of their respective owners.';
1118 return '<meta name="generator" content="'.$str .'" />';
1122 * Returns X-UA-Compatible meta tag
1124 * @return string <meta http-equiv="X-UA-Compatible" content="???" />
1126 function xUaCompatible() {
1127 // the most recent version if Internet Explorer, in which the Backend works
1129 return '<meta http-equiv="X-UA-Compatible" content="' . $str . '" />';
1138 /*****************************************
1141 * Tables, buttons, formatting dimmed/red strings
1143 ******************************************/
1147 * Returns an image-tag with an 18x16 icon of the following types:
1150 * -1: OK icon (Check-mark)
1151 * 1: Notice (Speach-bubble)
1152 * 2: Warning (Yellow triangle)
1153 * 3: Fatal error (Red stop sign)
1155 * @param integer See description
1156 * @param string Value for style attribute
1157 * @return string HTML image tag (if applicable)
1159 function icons($type, $styleAttribValue='') {
1162 $icon = 'gfx/icon_fatalerror.gif';
1165 $icon = 'gfx/icon_warning.gif';
1168 $icon = 'gfx/icon_note.gif';
1171 $icon = 'gfx/icon_ok.gif';
1177 return '<img'.t3lib_iconWorks
::skinImg($this->backPath
,$icon,'width="18" height="16"').' class="absmiddle"'.($styleAttribValue ?
' style="'.htmlspecialchars($styleAttribValue).'"' : '').' alt="" />';
1182 * Returns an <input> button with the $onClick action and $label
1184 * @param string The value of the onclick attribute of the input tag (submit type)
1185 * @param string The label for the button (which will be htmlspecialchar'ed)
1186 * @return string A <input> tag of the type "submit"
1188 function t3Button($onClick,$label) {
1189 $button = '<input type="submit" onclick="'.htmlspecialchars($onClick).'; return false;" value="'.htmlspecialchars($label).'" />';
1194 * dimmed-fontwrap. Returns the string wrapped in a <span>-tag defining the color to be gray/dimmed
1196 * @param string Input string
1197 * @return string Output string
1199 function dfw($string) {
1200 return '<span class="typo3-dimmed">'.$string.'</span>';
1204 * red-fontwrap. Returns the string wrapped in a <span>-tag defining the color to be red
1206 * @param string Input string
1207 * @return string Output string
1209 function rfw($string) {
1210 return '<span class="typo3-red">'.$string.'</span>';
1214 * Returns string wrapped in CDATA "tags" for XML / XHTML (wrap content of <script> and <style> sections in those!)
1216 * @param string Input string
1217 * @return string Output string
1219 function wrapInCData($string) {
1220 $string = '/*<![CDATA[*/'.
1228 * Wraps the input string in script tags.
1229 * Automatic re-identing of the JS code is done by using the first line as ident reference.
1230 * This is nice for identing JS code with PHP code on the same level.
1232 * @param string Input string
1233 * @param boolean Wrap script element in linebreaks? Default is TRUE.
1234 * @return string Output string
1236 function wrapScriptTags($string, $linebreak=TRUE) {
1238 // <script wrapped in nl?
1239 $cr = $linebreak?
"\n" : '';
1241 // remove nl from the beginning
1242 $string = preg_replace ('/^\n+/', '', $string);
1243 // re-ident to one tab using the first line as reference
1245 if(preg_match('/^(\t+)/',$string,$match)) {
1246 $string = str_replace($match[1],"\t", $string);
1248 $string = $cr.'<script type="text/javascript">
1254 return trim($string);
1257 // These vars defines the layout for the table produced by the table() function.
1258 // You can override these values from outside if you like.
1259 var $tableLayout = array(
1261 'defCol' => array('<td valign="top">','</td>')
1264 var $table_TR = '<tr>';
1265 var $table_TABLE = '<table border="0" cellspacing="0" cellpadding="0" id="typo3-tmpltable">';
1268 * Returns a table based on the input $data
1270 * @param array Multidim array with first levels = rows, second levels = cells
1271 * @param array If set, then this provides an alternative layout array instead of $this->tableLayout
1272 * @return string The HTML table.
1275 function table($data, $layout = '') {
1277 if (is_array($data)) {
1278 $tableLayout = (is_array($layout) ?
$layout : $this->tableLayout
);
1281 foreach ($data as $tableRow) {
1282 if ($rowCount %
2) {
1283 $layout = is_array($tableLayout['defRowOdd']) ?
$tableLayout['defRowOdd'] : $tableLayout['defRow'];
1285 $layout = is_array($tableLayout['defRowEven']) ?
$tableLayout['defRowEven'] : $tableLayout['defRow'];
1287 $rowLayout = is_array($tableLayout[$rowCount]) ?
$tableLayout[$rowCount] : $layout;
1289 if (is_array($tableRow)) {
1291 foreach ($tableRow as $tableCell) {
1292 $cellWrap = (is_array($layout[$cellCount]) ?
$layout[$cellCount] : $layout['defCol']);
1293 $cellWrap = (is_array($rowLayout['defCol']) ?
$rowLayout['defCol'] : $cellWrap);
1294 $cellWrap = (is_array($rowLayout[$cellCount]) ?
$rowLayout[$cellCount] : $cellWrap);
1295 $rowResult .= $cellWrap[0] . $tableCell . $cellWrap[1];
1299 $rowWrap = (is_array($layout['tr']) ?
$layout['tr'] : array($this->table_TR
, '</tr>'));
1300 $rowWrap = (is_array($rowLayout['tr']) ?
$rowLayout['tr'] : $rowWrap);
1301 $result .= $rowWrap[0] . $rowResult . $rowWrap[1];
1304 $tableWrap = is_array($tableLayout['table']) ?
$tableLayout['table'] : array($this->table_TABLE
, '</table>');
1305 $result = $tableWrap[0] . $result . $tableWrap[1];
1311 * Constructs a table with content from the $arr1, $arr2 and $arr3.
1312 * Used in eg. ext/belog/mod/index.php - refer to that for examples
1314 * @param array Menu elements on first level
1315 * @param array Secondary items
1316 * @param array Third-level items
1317 * @return string HTML content, <table>...</table>
1319 function menuTable($arr1,$arr2=array(), $arr3=array()) {
1320 $rows = max(array(count($arr1),count($arr2),count($arr3)));
1323 <table border="0" cellpadding="0" cellspacing="0" id="typo3-tablemenu">';
1324 for($a=0;$a<$rows;$a++
) {
1328 $cls[]='<td valign="'.$valign.'">'.$arr1[$a][0].'</td><td>'.$arr1[$a][1].'</td>';
1330 $cls[]='<td valign="'.$valign.'">'.$arr2[$a][0].'</td><td>'.$arr2[$a][1].'</td>';
1332 $cls[]='<td valign="'.$valign.'">'.$arr3[$a][0].'</td><td>'.$arr3[$a][1].'</td>';
1335 $menu.=implode($cls,'<td> </td>');
1345 * Returns a one-row/two-celled table with $content and $menu side by side.
1346 * The table is a 100% width table and each cell is aligned left / right
1348 * @param string Content cell content (left)
1349 * @param string Menu cell content (right)
1350 * @return string HTML output
1352 function funcMenu($content,$menu) {
1354 <table border="0" cellpadding="0" cellspacing="0" width="100%" id="typo3-funcmenu">
1356 <td valign="top" nowrap="nowrap">'.$content.'</td>
1357 <td valign="top" align="right" nowrap="nowrap">'.$menu.'</td>
1363 * Creates a selector box with clear-cache items.
1364 * Rather specialized functions - at least don't use it with $addSaveOptions unless you know what you do...
1366 * @param integer The page uid of the "current page" - the one that will be cleared as "clear cache for this page".
1367 * @param boolean If $addSaveOptions is set, then also the array of save-options for TCE_FORMS will appear.
1368 * @return string <select> tag with content - a selector box for clearing the cache
1370 function clearCacheMenu($id,$addSaveOptions=0) {
1373 if ($addSaveOptions) {
1374 $opt[]='<option value="">'.$GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:rm.menu',1).'</option>';
1375 $opt[]='<option value="TBE_EDITOR.checkAndDoSubmit(1);">'.$GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:rm.saveDoc',1).'</option>';
1376 $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>';
1377 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>';
1378 $opt[]='<option value="document.editform.closeDoc.value=2; document.editform.submit();">'.$GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:rm.closeDoc',1).'</option>';
1379 $opt[]='<option value="document.editform.closeDoc.value=3; document.editform.submit();">'.$GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:rm.closeAllDocs',1).'</option>';
1380 $opt[]='<option value=""></option>';
1382 $opt[]='<option value="">[ '.$GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:rm.clearCache_clearCache',1).' ]</option>';
1383 if ($id) $opt[]='<option value="'.$id.'">'.$GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:rm.clearCache_thisPage',1).'</option>';
1384 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>';
1385 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>';
1387 $onChange = 'if (!this.options[this.selectedIndex].value) {
1388 this.selectedIndex=0;
1389 } else if (this.options[this.selectedIndex].value.indexOf(\';\')!=-1) {
1390 eval(this.options[this.selectedIndex].value);
1392 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;
1394 $af_content = '<select name="cacheCmd" onchange="'.htmlspecialchars($onChange).'">'.implode('',$opt).'</select>';
1396 if (count($opt)>1) {
1403 * Includes a javascript library that exists in the core /typo3/ directory. The
1404 * backpath is automatically applied
1406 * @param string $lib: Library name. Call it with the full path
1407 * like "contrib/prototype/prototype.js" to load it
1410 function loadJavascriptLib($lib) {
1411 $this->pageRenderer
->addJsFile($this->backPath
. $lib);
1417 * Includes the necessary Javascript function for the clickmenu (context sensitive menus) in the document
1419 * @return array Deprecated: Includes the code already in the doc, so the return array is always empty.
1420 * Please just call this function without expecting a return value for future calls
1422 function getContextMenuCode() {
1423 $this->pageRenderer
->loadPrototype();
1424 $this->loadJavascriptLib('js/clickmenu.js');
1426 $this->JScodeArray
['clickmenu'] = '
1427 Clickmenu.clickURL = "'.$this->backPath
.'alt_clickmenu.php";
1428 Clickmenu.ajax = '.($this->isCMLayers() ?
'true' : 'false' ).';';
1430 // return array deprecated since 4.2
1431 return array('','','');
1435 * Includes the necessary javascript file (tree.js) for use on pages which have the
1436 * drag and drop functionality (usually pages and folder display trees)
1438 * @param string indicator of which table the drag and drop function should work on (pages or folders)
1439 * @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
1441 function getDragDropCode($table) {
1442 $this->pageRenderer
->loadPrototype();
1443 $this->loadJavascriptLib('js/common.js');
1444 $this->loadJavascriptLib('js/tree.js');
1446 // setting prefs for drag & drop
1447 $this->JScodeArray
['dragdrop'] = '
1448 DragDrop.changeURL = "'.$this->backPath
.'alt_clickmenu.php";
1449 DragDrop.backPath = "'.t3lib_div
::shortMD5(''.'|'.$GLOBALS['TYPO3_CONF_VARS']['SYS']['encryptionKey']).'";
1450 DragDrop.table = "'.$table.'";
1453 // return array deprecated since 4.2
1454 return array('','','');
1459 * Creates a tab menu from an array definition
1461 * Returns a tab menu for a module
1462 * Requires the JS function jumpToUrl() to be available
1464 * @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=...
1465 * @param string $elementName it the form elements name, probably something like "SET[...]"
1466 * @param string $currentValue is the value to be selected currently.
1467 * @param array $menuItems is an array with the menu items for the selector box
1468 * @param string $script is the script to send the &id to, if empty it's automatically found
1469 * @param string $addParams is additional parameters to pass to the script.
1470 * @return string HTML code for tab menu
1471 * @author Rene Fritz <r.fritz@colorcube.de>
1473 function getTabMenu($mainParams,$elementName,$currentValue,$menuItems,$script='',$addparams='') {
1476 if (is_array($menuItems)) {
1477 if (!is_array($mainParams)) {
1478 $mainParams = array('id' => $mainParams);
1480 $mainParams = t3lib_div
::implodeArrayForUrl('',$mainParams);
1482 if (!$script) {$script=basename(PATH_thisScript
);}
1485 foreach($menuItems as $value => $label) {
1486 $menuDef[$value]['isActive'] = !strcmp($currentValue,$value);
1487 $menuDef[$value]['label'] = t3lib_div
::deHSCentities(htmlspecialchars($label));
1488 $menuDef[$value]['url'] = $script . '?' . $mainParams . $addparams . '&' . $elementName . '=' . $value;
1490 $content = $this->getTabMenuRaw($menuDef);
1497 * Creates the HTML content for the tab menu
1499 * @param array Menu items for tabs
1500 * @return string Table HTML
1503 function getTabMenuRaw($menuItems) {
1506 if (is_array($menuItems)) {
1509 $count = count($menuItems);
1513 $widthRight = max (1,floor(30-pow($count,1.72)));
1514 $widthTabs = 100 - $widthRight - $widthLeft;
1515 $widthNo = floor(($widthTabs - $addToAct)/$count);
1516 $addToAct = max ($addToAct,$widthTabs-($widthNo*$count));
1517 $widthAct = $widthNo +
$addToAct;
1518 $widthRight = 100 - ($widthLeft +
($count*$widthNo) +
$addToAct);
1521 foreach($menuItems as $id => $def) {
1522 $isActive = $def['isActive'];
1523 $class = $isActive ?
'tabact' : 'tab';
1524 $width = $isActive ?
$widthAct : $widthNo;
1526 // @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.
1527 $label = $def['label'];
1528 $url = htmlspecialchars($def['url']);
1529 $params = $def['addParams'];
1533 <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>';
1536 <td width="'.$width.'%" class="'.$class.'"><a href="'.$url.'" '.$params.'>'.$label.'</a></td>';
1544 <table cellpadding="0" cellspacing="0" border="0" width="100%" id="typo3-tabmenu">
1546 <td width="'.$widthLeft.'%"> </td>
1548 <td width="'.$widthRight.'%"> </td>
1551 <div class="hr" style="margin:0px"></div>';
1559 * Creates a DYNAMIC tab-menu where the tabs are switched between with DHTML.
1560 * 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!
1562 * @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.
1563 * @param string Identification string. This should be unique for every instance of a dynamic menu!
1564 * @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.
1565 * @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.
1566 * @param integer Character limit for a new row.
1567 * @param boolean If set, tab table cells are not allowed to wrap their content
1568 * @param boolean If set, the tabs will span the full width of their position
1569 * @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.
1570 * @param integer If set to '1' empty tabs will be remove, If set to '2' empty tabs will be disabled
1571 * @return string JavaScript section for the HTML header.
1573 function getDynTabMenu($menuItems,$identString,$toggle=0,$foldout=FALSE,$newRowCharLimit=50,$noWrap=1,$fullWidth=FALSE,$defaultTabIndex=1,$dividers2tabs=2) {
1574 // load the static code, if not already done with the function below
1575 $this->loadJavascriptLib('js/tabmenu.js');
1579 if (is_array($menuItems)) {
1582 $options = array(array());
1585 $id = $this->getDynTabMenuId($identString);
1586 $noWrap = $noWrap ?
' nowrap="nowrap"' : '';
1588 // Traverse menu items
1592 foreach($menuItems as $index => $def) {
1593 $index+
=1; // Need to add one so checking for first index in JavaScript is different than if it is not set at all.
1595 // Switch to next tab row if needed
1596 if (!$foldout && ($titleLenCount>$newRowCharLimit |
($def['newline'] === true && $titleLenCount > 0))) {
1599 $options[$tabRows] = array();
1603 $onclick = 'this.blur(); DTM_toggle("'.$id.'","'.$index.'"); return false;';
1605 $onclick = 'this.blur(); DTM_activate("'.$id.'","'.$index.'", '.($toggle<0?
1:0).'); return false;';
1608 $isEmpty = !(strcmp(trim($def['content']),'') ||
strcmp(trim($def['icon']),''));
1610 // "Removes" empty tabs
1611 if ($isEmpty && $dividers2tabs == 1) {
1615 $mouseOverOut = ' onmouseover="DTM_mouseOver(this);" onmouseout="DTM_mouseOut(this);"';
1616 $requiredIcon = '<img name="' . $id . '-' . $index . '-REQ" src="' . $GLOBALS['BACK_PATH'] . 'gfx/clear.gif" class="t3-TCEforms-reqTabImg" alt="" />';
1620 $options[$tabRows][] = '
1621 <td class="'.($isEmpty ?
'disabled' : 'tab').'" id="'.$id.'-'.$index.'-MENU"'.$noWrap.$mouseOverOut.'>'.
1622 ($isEmpty ?
'' : '<a href="#" onclick="'.htmlspecialchars($onclick).'"'.($def['linkTitle'] ?
' title="'.htmlspecialchars($def['linkTitle']).'"':'').'>').
1624 ($def['label'] ?
htmlspecialchars($def['label']) : ' ').
1626 $this->icons($def['stateIcon'],'margin-left: 10px;').
1627 ($isEmpty ?
'' : '</a>').
1629 $titleLenCount+
= strlen($def['label']);
1631 // Create DIV layer for content:
1633 <div class="'.($isEmpty ?
'disabled' : 'tab').'" id="'.$id.'-'.$index.'-MENU"'.$mouseOverOut.'>'.
1634 ($isEmpty ?
'' : '<a href="#" onclick="'.htmlspecialchars($onclick).'"'.($def['linkTitle'] ?
' title="'.htmlspecialchars($def['linkTitle']).'"':'').'>').
1636 ($def['label'] ?
htmlspecialchars($def['label']) : ' ').
1638 ($isEmpty ?
'' : '</a>').
1642 // Create DIV layer for content:
1644 <div style="display: none;" id="'.$id.'-'.$index.'-DIV" class="c-tablayer">'.
1645 ($def['description'] ?
'<p class="c-descr">'.nl2br(htmlspecialchars($def['description'])).'</p>' : '').
1648 // Create initialization string:
1650 DTM_array["'.$id.'"]['.$c.'] = "'.$id.'-'.$index.'";
1652 // If not empty and we have the toggle option on, check if the tab needs to be expanded
1653 if ($toggle == 1 && !$isEmpty) {
1655 if (top.DTM_currentTabs["'.$id.'-'.$index.'"]) { DTM_toggle("'.$id.'","'.$index.'",1); }
1663 if (count($options)) {
1665 // Tab menu is compiled:
1668 for($a=0;$a<=$tabRows;$a++
) {
1672 <table cellpadding="0" cellspacing="0" border="0"'.($fullWidth ?
' width="100%"' : '').' class="typo3-dyntabmenu">
1674 '.implode('',$options[$a]).'
1678 $content.= '<div class="typo3-dyntabmenu-tabs">'.$tabContent.'</div>';
1681 // Div layers are added:
1683 <!-- Div layers for tab menu: -->
1684 <div class="typo3-dyntabmenu-divs'.($foldout?
'-foldout':'').'">
1685 '.implode('',$divs).'</div>';
1687 // Java Script section added:
1689 <!-- Initialization JavaScript for the menu -->
1690 <script type="text/javascript">
1691 DTM_array["'.$id.'"] = new Array();
1692 '.implode('',$JSinit).'
1693 '.($toggle<=0 ?
'DTM_activate("'.$id.'", top.DTM_currentTabs["'.$id.'"]?top.DTM_currentTabs["'.$id.'"]:'.intval($defaultTabIndex).', 0);' : '').'
1704 * Creates the id for dynTabMenus.
1706 * @param string $identString: Identification string. This should be unique for every instance of a dynamic menu!
1707 * @return string The id with a short MD5 of $identString and prefixed "DTM-", like "DTM-2e8791854a"
1709 function getDynTabMenuId($identString) {
1710 $id = 'DTM-'.t3lib_div
::shortMD5($identString);
1715 * Returns dynamic tab menu header JS code.
1716 * This is now incorporated automatically when the function template::getDynTabMenu is called
1717 * (as long as it is called before $this->startPage())
1718 * The return value is not needed anymore
1720 * @return string JavaScript section for the HTML header. (return value is deprecated since TYPO3 4.3, will be removed in TYPO3 4.5)
1722 function getDynTabMenuJScode() {
1723 $this->loadJavascriptLib('js/tabmenu.js');
1724 // return value deprecated since TYPO3 4.3
1729 * Creates the version selector for the page id inputted.
1730 * Requires the core version management extension, "version" to be loaded.
1732 * @param integer Page id to create selector for.
1733 * @param boolean If set, there will be no button for swapping page.
1736 function getVersionSelector($id,$noAction=FALSE) {
1739 if (t3lib_extMgm
::isLoaded('version') && $GLOBALS['BE_USER']->workspace
==0) {
1741 // Get Current page record:
1742 $curPage = t3lib_BEfunc
::getRecord('pages',$id);
1743 // If the selected page is not online, find the right ID
1744 $onlineId = ($curPage['pid']==-1 ?
$curPage['t3ver_oid'] : $id);
1745 // Select all versions of online version:
1746 $versions = t3lib_BEfunc
::selectVersionsOfRecord('pages', $onlineId, 'uid,pid,t3ver_label,t3ver_oid,t3ver_wsid,t3ver_id');
1748 // If more than one was found...:
1749 if (count($versions)>1) {
1751 // Create selector box entries:
1753 foreach($versions as $vRow) {
1754 $opt[] = '<option value="'.htmlspecialchars(t3lib_div
::linkThisScript(array('id'=>$vRow['uid']))).'"'.($id==$vRow['uid']?
' selected="selected"':'').'>'.
1755 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').'<=':'')).
1759 // Add management link:
1760 $opt[] = '<option value="'.htmlspecialchars(t3lib_div
::linkThisScript(array('id'=>$id))).'">---</option>';
1761 $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>';
1763 // Create onchange handler:
1764 $onChange = "window.location.href=this.options[this.selectedIndex].value;";
1767 if ($id==$onlineId) {
1768 $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>';
1769 } elseif (!$noAction) {
1770 $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">'.
1771 '<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).'" />'.
1772 '<b>'.$GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:ver.swap',1).'</b></a>';
1775 // Write out HTML code:
1781 <table border="0" cellpadding="0" cellspacing="0" id="typo3-versionSelector">
1783 <td>'.$GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:ver.selVer',1).'</td>
1785 <select onchange="'.htmlspecialchars($onChange).'">
1786 '.implode('',$opt).'
1788 <td>'.$controls.'</td>
1793 } elseif ($GLOBALS['BE_USER']->workspace
!==0) {
1795 // Write out HTML code:
1796 switch($GLOBALS['BE_USER']->workspace
) {
1804 $wsTitle = $GLOBALS['BE_USER']->workspaceRec
['title'];
1808 if (t3lib_BEfunc
::isPidInVersionizedBranch($id)=='branchpoint') {
1814 <table border="0" cellpadding="0" cellspacing="0" id="typo3-versionSelector">
1816 <td>Workspace: "'.htmlspecialchars($wsTitle).'"</td>
1817 <td><em>Inside branch, no further versioning possible</em></td>
1822 // Get Current page record:
1823 $curPage = t3lib_BEfunc
::getRecord('pages',$id);
1824 // If the selected page is not online, find the right ID
1825 $onlineId = ($curPage['pid']==-1 ?
$curPage['t3ver_oid'] : $id);
1826 // The version of page:
1827 $verPage = t3lib_BEfunc
::getWorkspaceVersionOfRecord($GLOBALS['BE_USER']->workspace
, 'pages', $onlineId);
1831 if (!count(t3lib_BEfunc
::countVersionsOfRecordsOnPage($GLOBALS['BE_USER']->workspace
, $onlineId))) {
1832 if ($GLOBALS['BE_USER']->workspaceVersioningTypeAccess(0)) {
1834 $onClick = $this->issueCommand('&cmd[pages]['.$onlineId.'][version][action]=new&cmd[pages]['.$onlineId.'][version][treeLevels]=0',t3lib_div
::linkThisScript(array('id'=>$onlineId)));
1835 $onClick = 'window.location.href=\''.$onClick.'\'; return false;';
1836 // Write out HTML code:
1840 No version yet, create one?
1842 <table border="0" cellpadding="0" cellspacing="0" id="typo3-versionSelector">
1844 <td>Workspace: "'.htmlspecialchars($wsTitle).'"</td>
1846 <input type="submit" value="New version of page" name="_" onclick="'.htmlspecialchars($onClick).'" /></td>
1857 <table border="0" cellpadding="0" cellspacing="0" id="typo3-versionSelector">
1859 <td>Workspace: "'.htmlspecialchars($wsTitle).'"</td>
1860 <td><em>Versions found on page, no "Page" versioning possible</em></td>
1865 } elseif ($verPage['t3ver_swapmode']==0) {
1866 $onClick = $this->issueCommand('&cmd[pages]['.$onlineId.'][version][action]=swap&cmd[pages]['.$onlineId.'][version][swapWith]='.$verPage['uid'],t3lib_div
::linkThisScript(array('id'=>$onlineId)));
1867 $onClick = 'window.location.href=\''.$onClick.'\'; return false;';
1869 // Write out HTML code:
1875 <table border="0" cellpadding="0" cellspacing="0" id="typo3-versionSelector">
1877 <td>Workspace: "'.htmlspecialchars($wsTitle).'"</td>
1879 <input type="submit" value="Publish page" name="_" onclick="'.htmlspecialchars($onClick).'" /></td>
1890 * Function to load a HTML template file with markers.
1891 * When calling from own extension, use syntax getHtmlTemplate('EXT:extkey/template.html')
1893 * @param string tmpl name, usually in the typo3/template/ directory
1894 * @return string HTML of template
1896 function getHtmlTemplate($filename) {
1897 if ($GLOBALS['TBE_STYLES']['htmlTemplates'][$filename]) {
1898 $filename = $GLOBALS['TBE_STYLES']['htmlTemplates'][$filename];
1900 if (substr($filename,0,4) != 'EXT:') {
1901 $filename = t3lib_div
::resolveBackPath($this->backPath
. $filename);
1903 $filename = t3lib_div
::getFileAbsFileName($filename, true, true);
1905 return t3lib_div
::getURL($filename);
1909 * Define the template for the module
1911 * @param string filename
1913 function setModuleTemplate($filename) {
1914 // Load Prototype lib for IE event
1915 $this->pageRenderer
->loadPrototype();
1916 $this->loadJavascriptLib('js/iecompatibility.js');
1917 $this->moduleTemplate
= $this->getHtmlTemplate($filename);
1921 * Put together the various elements for the module <body> using a static HTML
1924 * @param array Record of the current page, used for page path and info
1925 * @param array HTML for all buttons
1926 * @param array HTML for all other markers
1927 * @return string Composite HTML
1929 public function moduleBody($pageRecord = array(), $buttons = array(), $markerArray = array(), $subpartArray = array()) {
1930 // Get the HTML template for the module
1931 $moduleBody = t3lib_parsehtml
::getSubpart($this->moduleTemplate
, '###FULLDOC###');
1933 $this->inDocStylesArray
[] = 'html { overflow: hidden; }';
1934 // Add JS code to the <head> for IE
1935 $this->JScode
.= $this->wrapScriptTags('
1936 // workaround since IE6 cannot deal with relative height for scrolling elements
1937 function resizeDocBody() {
1938 $("typo3-docbody").style.height = (document.body.offsetHeight - parseInt($("typo3-docheader").getStyle("height")));
1940 if (Prototype.Browser.IE) {
1941 var version = parseFloat(navigator.appVersion.split(\';\')[1].strip().split(\' \')[1]);
1943 Event.observe(window, "resize", resizeDocBody, false);
1944 Event.observe(window, "load", resizeDocBody, false);
1948 // Get the page path for the docheader
1949 $markerArray['PAGEPATH'] = $this->getPagePath($pageRecord);
1950 // Get the page info for the docheader
1951 $markerArray['PAGEINFO'] = $this->getPageInfo($pageRecord);
1952 // Get all the buttons for the docheader
1953 $docHeaderButtons = $this->getDocHeaderButtons($buttons);
1954 // Merge docheader buttons with the marker array
1955 $markerArray = array_merge($markerArray, $docHeaderButtons);
1956 // replacing subparts
1957 foreach ($subpartArray as $marker => $content) {
1958 $moduleBody = t3lib_parsehtml
::substituteSubpart($moduleBody, $marker, $content);
1961 if ($this->showFlashMessages
) {
1962 // adding flash messages
1963 $flashMessages = t3lib_FlashMessageQueue
::renderFlashMessages();
1964 if (!empty($flashMessages)) {
1965 $flashMessages = '<div id="typo3-messages">' . $flashMessages . '</div>';
1968 if (strstr($moduleBody, '###FLASHMESSAGES###')) {
1969 // either replace a dedicated marker for the messages if present
1970 $moduleBody = str_replace(
1971 '###FLASHMESSAGES###',
1976 // or force them to appear before the content
1977 $moduleBody = str_replace(
1979 $flashMessages . '###CONTENT###',
1985 // replacing all markers with the finished markers and return the HTML content
1986 return t3lib_parsehtml
::substituteMarkerArray($moduleBody, $markerArray, '###|###');
1991 * Fill the button lists with the defined HTML
1993 * @param array HTML for all buttons
1994 * @return array Containing HTML for both buttonlists
1996 protected function getDocHeaderButtons($buttons) {
1998 // Fill buttons for left and right float
1999 $floats = array('left', 'right');
2000 foreach($floats as $key) {
2001 // Get the template for each float
2002 $buttonTemplate = t3lib_parsehtml
::getSubpart($this->moduleTemplate
, '###BUTTON_GROUPS_' . strtoupper($key) . '###');
2003 // Fill the button markers in this float
2004 $buttonTemplate = t3lib_parsehtml
::substituteMarkerArray($buttonTemplate, $buttons, '###|###', true);
2005 // getting the wrap for each group
2006 $buttonWrap = t3lib_parsehtml
::getSubpart($this->moduleTemplate
, '###BUTTON_GROUP_WRAP###');
2007 // looping through the groups (max 6) and remove the empty groups
2008 for ($groupNumber = 1; $groupNumber < 6; $groupNumber++
) {
2009 $buttonMarker = '###BUTTON_GROUP' . $groupNumber . '###';
2010 $buttonGroup = t3lib_parsehtml
::getSubpart($buttonTemplate, $buttonMarker);
2011 if (trim($buttonGroup)) {
2013 $buttonGroup = t3lib_parsehtml
::substituteMarker($buttonWrap, '###BUTTONS###', $buttonGroup);
2015 $buttonTemplate = t3lib_parsehtml
::substituteSubpart($buttonTemplate, $buttonMarker, trim($buttonGroup));
2018 // replace the marker with the template and remove all line breaks (for IE compat)
2019 $markers['BUTTONLIST_' . strtoupper($key)] = str_replace("\n", '', $buttonTemplate);
2022 // Hook for manipulating docHeaderButtons
2023 if (isset($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['typo3/template.php']['docHeaderButtonsHook'])) {
2025 'buttons' => $buttons,
2026 'markers' => &$markers,
2029 foreach($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['typo3/template.php']['docHeaderButtonsHook'] as $funcRef) {
2030 t3lib_div
::callUserFunction($funcRef, $params, $this);
2038 * Generate the page path for docheader
2040 * @param array Current page
2041 * @return string Page path
2043 protected function getPagePath($pageRecord) {
2044 // Is this a real page
2045 if ($pageRecord['uid']) {
2046 $title = $pageRecord['_thePathFull'];
2048 $title = $GLOBALS['TYPO3_CONF_VARS']['SYS']['sitename'];
2050 // Setting the path of the page
2051 $pagePath = $GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:labels.path', 1) . ': <span class="typo3-docheader-pagePath">';
2053 // crop the title to title limit (or 50, if not defined)
2054 $cropLength = (empty($GLOBALS['BE_USER']->uc
['titleLen'])) ?
50 : $GLOBALS['BE_USER']->uc
['titleLen'];
2055 $croppedTitle = t3lib_div
::fixed_lgd_cs($title, -$cropLength);
2056 if ($croppedTitle !== $title) {
2057 $pagePath .= '<abbr title="' . htmlspecialchars($title) . '">' . htmlspecialchars($croppedTitle) . '</abbr>';
2059 $pagePath .= htmlspecialchars($title);
2061 $pagePath .= '</span>';
2066 * Setting page icon with clickmenu + uid for docheader
2068 * @param array Current page
2069 * @return string Page info
2071 protected function getPageInfo($pageRecord) {
2073 // Add icon with clickmenu, etc:
2074 if ($pageRecord['uid']) { // If there IS a real page
2075 $alttext = t3lib_BEfunc
::getRecordIconAltText($pageRecord, 'pages');
2076 $iconImg = t3lib_iconWorks
::getIconImage('pages', $pageRecord, $this->backPath
, 'class="absmiddle" title="'. htmlspecialchars($alttext) . '"');
2078 $theIcon = $GLOBALS['SOBE']->doc
->wrapClickMenuOnIcon($iconImg, 'pages', $pageRecord['uid']);
2079 $pid = $pageRecord['uid'];
2080 } else { // On root-level of page tree
2082 $iconImg = '<img' . t3lib_iconWorks
::skinImg($this->backPath
, 'gfx/i/_icon_website.gif') . ' alt="' . $GLOBALS['TYPO3_CONF_VARS']['SYS']['sitename'] . '" />';
2083 if($BE_USER->user
['admin']) {
2084 $theIcon = $GLOBALS['SOBE']->doc
->wrapClickMenuOnIcon($iconImg, 'pages', 0);
2086 $theIcon = $iconImg;
2091 // Setting icon with clickmenu + uid
2092 $pageInfo = $theIcon . '<em>[pid: ' . $pid . ']</em>';
2103 // ******************************
2104 // Extension classes of the template class.
2105 // These are meant to provide backend screens with different widths.
2106 // They still do because of the different class-prefixes used for the <div>-sections
2107 // but obviously the final width is determined by the stylesheet used.
2108 // ******************************
2111 * 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
2112 * The class were more significant in the past than today.
2115 class bigDoc
extends template
{
2116 var $divClass = 'typo3-bigDoc';
2120 * Extension class for "template" - used for backend pages without the "document" background image
2121 * The class were more significant in the past than today.
2124 class noDoc
extends template
{
2125 var $divClass = 'typo3-noDoc';
2129 * 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)
2130 * The class were more significant in the past than today.
2133 class smallDoc
extends template
{
2134 var $divClass = 'typo3-smallDoc';
2138 * 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.
2139 * The class were more significant in the past than today. But probably you should use this one for most modules you make.
2142 class mediumDoc
extends template
{
2143 var $divClass = 'typo3-mediumDoc';
2148 * Extension class for "template" - used in the context of frontend editing.
2150 class frontendDoc
extends template
{
2153 * Gets instance of PageRenderer
2155 * @return t3lib_PageRenderer
2157 public function getPageRenderer() {
2158 if (!isset($this->pageRenderer
)) {
2159 $this->pageRenderer
= $GLOBALS['TSFE']->getPageRenderer();
2161 return $this->pageRenderer
;
2165 * Used in the frontend context to insert header data via TSFE->additionalHeaderData.
2166 * Mimics header inclusion from template->startPage().
2170 public function insertHeaderData() {
2172 $this->backPath
= $GLOBALS['TSFE']->backPath
= TYPO3_mainDir
;
2173 $this->pageRenderer
->setBackPath($this->backPath
);
2176 // add applied JS/CSS to $GLOBALS['TSFE']
2177 if ($this->JScode
) {
2178 $this->pageRenderer
->addHeaderData($this->JScode
);
2180 if (count($this->JScodeArray
)) {
2181 foreach ($this->JScodeArray
as $name => $code) {
2182 $this->pageRenderer
->addJsInlineCode($name, $code);
2189 if (defined('TYPO3_MODE') && $TYPO3_CONF_VARS[TYPO3_MODE
]['XCLASS']['typo3/template.php']) {
2190 include_once($TYPO3_CONF_VARS[TYPO3_MODE
]['XCLASS']['typo3/template.php']);
2195 // ******************************
2196 // The template is loaded
2197 // ******************************
2198 $GLOBALS['TBE_TEMPLATE'] = t3lib_div
::makeInstance('template');