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