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