*/ if (!defined('TYPO3_MODE')) die("Can't include this file directly."); /** * TYPO3 Backend Template Class * * This class contains functions for starting and ending the HTML of backend modules * It also contains methods for outputting sections of content. * Further there are functions for making icons, links, setting form-field widths etc. * Color scheme and stylesheet definitions are also available here. * Finally this file includes the language class for TYPO3's backend. * * After this file $LANG and $TBE_TEMPLATE are global variables / instances of their respective classes. * This file is typically included right after the init.php file, * if language and layout is needed. * * Please refer to Inside TYPO3 for a discussion of how to use this API. * * @author Kasper Skårhøj * @package TYPO3 * @subpackage core */ class template { // Vars you typically might want to/should set from outside after making instance of this class: var $backPath = ''; // 'backPath' pointing back to the PATH_typo3 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. 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. ':''); } /** * Creates the bodyTag. * You can add to the bodyTag by $this->bodyTagAdditions * * @return string HTML body tag */ function docBodyTagBegin() { $bodyContent = 'body onclick="if (top.menuReset) top.menuReset();" '.trim($this->bodyTagAdditions.($this->bodyTagId ? ' id="'.$this->bodyTagId.'"' : '')); return '<'.trim($bodyContent).'>'; } /** * Outputting document style * * @return string HTML style section/link tags */ function docStyle() { // Request background image: if ($this->backGroundImage) { $this->inDocStylesArray[]=' BODY { background-image: url('.$this->backPath.$this->backGroundImage.'); }'; } // Add inDoc styles variables as well: $this->inDocStylesArray[] = $this->inDocStyles; $this->inDocStylesArray[] = $this->inDocStyles_TBEstyle; // Implode it all: $inDocStyles = implode(LF, $this->inDocStylesArray); if ($this->styleSheetFile) { $this->pageRenderer->addCssFile($this->backPath . $this->styleSheetFile); } if ($this->styleSheetFile2) { $this->pageRenderer->addCssFile($this->backPath . $this->styleSheetFile2); } $this->pageRenderer->addCssInlineBlock('inDocStyles', $inDocStyles . LF . '/*###POSTCSSMARKER###*/'); if ($this->styleSheetFile_post) { $this->pageRenderer->addCssFile($this->backPath . $this->styleSheetFile_post); } } /** * Insert additional style sheet link * * @param string $key some key identifying the style sheet * @param string $href uri to the style sheet file * @param string $title value for the title attribute of the link element * @param string $relation value for the rel attribute of the link element * @return void */ function addStyleSheet($key, $href, $title = '', $relation = 'stylesheet') { if (strpos($href, '://') !== FALSE || substr($href, 0, 1) === '/') { $file = $href; } else { $file = $this->backPath . $href; } $this->pageRenderer->addCssFile($file, $relation, 'screen', $title); } /** * Add all *.css files of the directory $path to the stylesheets * * @param string $path directory to add * @return void */ function addStyleSheetDirectory($path) { // calculation needed, when TYPO3 source is used via a symlink // absolute path to the stylesheets $filePath = dirname(t3lib_div::getIndpEnv('SCRIPT_FILENAME')) . '/' . $GLOBALS['BACK_PATH'] . $path; // clean the path $resolvedPath = t3lib_div::resolveBackPath($filePath); // read all files in directory and sort them alphabetically $files = t3lib_div::getFilesInDir($resolvedPath, 'css', FALSE, 1); foreach ($files as $file) { $this->pageRenderer->addCssFile($GLOBALS['BACK_PATH'] . $path . $file, 'stylesheet', 'all'); } } /** * Insert post rendering document style into already rendered content * This is needed for extobjbase * * @param string $content style-content to insert. * @return string content with inserted styles */ function insertStylesAndJS($content) { // insert accumulated CSS $this->inDocStylesArray[] = $this->inDocStyles; $styles = LF.implode(LF, $this->inDocStylesArray); $content = str_replace('/*###POSTCSSMARKER###*/',$styles,$content); // insert accumulated JS $jscode = $this->JScode.LF.$this->wrapScriptTags(implode(LF, $this->JScodeArray)); $content = str_replace('',$jscode,$content); return $content; } /** * Returns an array of all stylesheet directories belonging to core and skins * * @return array Stylesheet directories */ public function getSkinStylesheetDirectories() { $stylesheetDirectories = array(); // add default core stylesheets foreach ($this->stylesheetsCore as $stylesheetDir) { $stylesheetDirectories[] = $stylesheetDir; } // Stylesheets from skins // merge default css directories ($this->stylesheetsSkin) with additional ones and include them if (is_array($GLOBALS['TBE_STYLES']['skins'])) { // loop over all registered skins foreach ($GLOBALS['TBE_STYLES']['skins'] as $skinExtKey => $skin) { $skinStylesheetDirs = $this->stylesheetsSkins; // skins can add custom stylesheetDirectories using // $GLOBALS['TBE_STYLES']['skins'][$_EXTKEY]['stylesheetDirectories'] if (is_array($skin['stylesheetDirectories'])) { $skinStylesheetDirs = array_merge($skinStylesheetDirs, $skin['stylesheetDirectories']); } // add all registered directories foreach ($skinStylesheetDirs as $stylesheetDir) { // for EXT:myskin/stylesheets/ syntax if (substr($stylesheetDir, 0, 4) === 'EXT:') { list($extKey, $path) = explode('/', substr($stylesheetDir, 4), 2); if (strcmp($extKey, '') && t3lib_extMgm::isLoaded($extKey) && strcmp($path, '')) { $stylesheetDirectories[] = t3lib_extMgm::extRelPath($extKey) . $path; } } else { // for relative paths $stylesheetDirectories[] = t3lib_extMgm::extRelPath($skinExtKey) . $stylesheetDir; } } } } return $stylesheetDirectories; } /** * Initialize the charset. * Sets the internal $this->charset variable to the charset defined in $GLOBALS["LANG"] (or the default as set in this class) * Returns the meta-tag for the document header * * @return string tag with charset from $this->charset or $GLOBALS['LANG']->charSet */ function initCharset() { // Set charset to the charset provided by the current backend users language selection: $this->charset = $GLOBALS['LANG']->charSet ? $GLOBALS['LANG']->charSet : $this->charset; // Return meta tag: return ''; } /** * Returns generator meta tag * * @return string tag with name "generator" */ function generator() { $str = 'TYPO3 '.TYPO3_branch.', ' . TYPO3_URL_GENERAL . ', © Kasper Skårhøj ' . TYPO3_copyright_year . ', extensions are copyright of their respective owners.'; return ''; } /** * Returns X-UA-Compatible meta tag * * @param string $content Content of the compatible tag (default: IE-8) * @return string */ public function xUaCompatible($content = 'IE=8') { return ''; } /***************************************** * * OTHER ELEMENTS * Tables, buttons, formatting dimmed/red strings * ******************************************/ /** * Returns an image-tag with an 18x16 icon of the following types: * * $type: * -1: OK icon (Check-mark) * 1: Notice (Speach-bubble) * 2: Warning (Yellow triangle) * 3: Fatal error (Red stop sign) * * @param integer $type See description * @param string $styleAttribValue Value for style attribute * @return string HTML image tag (if applicable) */ function icons($type, $styleAttribValue = '') { switch($type) { case self::STATUS_ICON_ERROR: $icon = 'status-dialog-error'; break; case self::STATUS_ICON_WARNING: $icon = 'status-dialog-warning'; break; case self::STATUS_ICON_NOTIFICATION: $icon = 'status-dialog-notification'; break; case self::STATUS_ICON_OK: $icon = 'status-dialog-ok'; break; default: break; } if ($icon) { return t3lib_iconWorks::getSpriteIcon($icon); } } /** * Returns an button with the $onClick action and $label * * @param string $onClick The value of the onclick attribute of the input tag (submit type) * @param string $label The label for the button (which will be htmlspecialchar'ed) * @return string A tag of the type "submit" */ function t3Button($onClick, $label) { $button = ''; return $button; } /** * dimmed-fontwrap. Returns the string wrapped in a -tag defining the color to be gray/dimmed * * @param string $string Input string * @return string Output string */ function dfw($string) { return ''.$string.''; } /** * red-fontwrap. Returns the string wrapped in a -tag defining the color to be red * * @param string $string Input string * @return string Output string */ function rfw($string) { return ''.$string.''; } /** * Returns string wrapped in CDATA "tags" for XML / XHTML (wrap content of '.$cr; } return trim($string); } // These vars defines the layout for the table produced by the table() function. // You can override these values from outside if you like. var $tableLayout = array( 'defRow' => array( 'defCol' => array('','') ) ); var $table_TR = ''; var $table_TABLE = ''; /** * Returns a table based on the input $data * * @param array $data Multidim array with first levels = rows, second levels = cells * @param array $layout If set, then this provides an alternative layout array instead of $this->tableLayout * @return string The HTML table. * @internal */ function table($data, $layout = NULL) { $result = ''; if (is_array($data)) { $tableLayout = (is_array($layout) ? $layout : $this->tableLayout); $rowCount = 0; foreach ($data as $tableRow) { if ($rowCount % 2) { $layout = is_array($tableLayout['defRowOdd']) ? $tableLayout['defRowOdd'] : $tableLayout['defRow']; } else { $layout = is_array($tableLayout['defRowEven']) ? $tableLayout['defRowEven'] : $tableLayout['defRow']; } $rowLayout = is_array($tableLayout[$rowCount]) ? $tableLayout[$rowCount] : $layout; $rowResult = ''; if (is_array($tableRow)) { $cellCount = 0; foreach ($tableRow as $tableCell) { $cellWrap = (is_array($layout[$cellCount]) ? $layout[$cellCount] : $layout['defCol']); $cellWrap = (is_array($rowLayout['defCol']) ? $rowLayout['defCol'] : $cellWrap); $cellWrap = (is_array($rowLayout[$cellCount]) ? $rowLayout[$cellCount] : $cellWrap); $rowResult .= $cellWrap[0] . $tableCell . $cellWrap[1]; $cellCount++; } } $rowWrap = (is_array($layout['tr']) ? $layout['tr'] : array($this->table_TR, '')); $rowWrap = (is_array($rowLayout['tr']) ? $rowLayout['tr'] : $rowWrap); $result .= $rowWrap[0] . $rowResult . $rowWrap[1]; $rowCount++; } $tableWrap = is_array($tableLayout['table']) ? $tableLayout['table'] : array($this->table_TABLE, ''); $result = $tableWrap[0] . $result . $tableWrap[1]; } return $result; } /** * Constructs a table with content from the $arr1, $arr2 and $arr3. * Used in eg. ext/belog/mod/index.php - refer to that for examples * * @param array $arr1 Menu elements on first level * @param array $arr2 Secondary items * @param array $arr3 Third-level items * @return string HTML content, ... */ function menuTable($arr1,$arr2 = array(), $arr3 = array()) { $rows = max(array(count($arr1),count($arr2),count($arr3))); $menu=' '; for($a=0;$a<$rows;$a++) { $menu.=''; $cls=array(); $valign='middle'; $cls[]=''; if (count($arr2)) { $cls[]=''; if (count($arr3)) { $cls[]=''; } } $menu.=implode($cls,''); $menu.=''; } $menu.='

'.$arr1[$a][0].'

'.$arr1[$a][1].'

'.$arr2[$a][0].'

'.$arr2[$a][1].'

'.$arr3[$a][0].'

'.$arr3[$a][1].'

'; return $menu; } /** * Returns a one-row/two-celled table with $content and $menu side by side. * The table is a 100% width table and each cell is aligned left / right * * @param string $content Content cell content (left) * @param string $menu Menu cell content (right) * @return string HTML output */ function funcMenu($content, $menu) { return '

'.$content.'

'.$menu.'

'; } /** * Includes a javascript library that exists in the core /typo3/ directory. The * backpath is automatically applied * * @param string $lib: Library name. Call it with the full path like "contrib/prototype/prototype.js" to load it * @return void */ function loadJavascriptLib($lib) { $this->pageRenderer->addJsFile($this->backPath . $lib); } /** * Includes the necessary Javascript function for the clickmenu (context sensitive menus) in the document * @return void */ function getContextMenuCode() { $this->pageRenderer->loadPrototype(); $this->loadJavascriptLib('js/clickmenu.js'); $this->JScodeArray['clickmenu'] = ' Clickmenu.clickURL = "'.$this->backPath.'alt_clickmenu.php"; Clickmenu.ajax = '.($this->isCMLayers() ? 'true' : 'false' ).';'; } /** * Includes the necessary javascript file (tree.js) for use on pages which have the * drag and drop functionality (usually pages and folder display trees) * * @param string $table indicator of which table the drag and drop function should work on (pages or folders) * @return void */ function getDragDropCode($table) { $this->pageRenderer->loadPrototype(); $this->loadJavascriptLib('js/common.js'); $this->loadJavascriptLib('js/tree.js'); // setting prefs for drag & drop $this->JScodeArray['dragdrop'] = ' DragDrop.changeURL = "'.$this->backPath.'alt_clickmenu.php"; DragDrop.backPath = "'.t3lib_div::shortMD5(''.'|'.$GLOBALS['TYPO3_CONF_VARS']['SYS']['encryptionKey']).'"; DragDrop.table = "'.$table.'"; '; } /** * This loads everything needed for the Context Sensitive Help (CSH) * * @return void */ protected function loadCshJavascript() { $this->pageRenderer->loadExtJS(); $this->pageRenderer->addJsFile($this->backPath .'../t3lib/js/extjs/contexthelp.js'); $this->pageRenderer->addExtDirectCode(); } /** * Creates a tab menu from an array definition * * Returns a tab menu for a module * Requires the JS function jumpToUrl() to be available * * @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=... * @param string $elementName it the form elements name, probably something like "SET[...]" * @param string $currentValue is the value to be selected currently. * @param array $menuItems is an array with the menu items for the selector box * @param string $script is the script to send the &id to, if empty it's automatically found * @param string $addparams is additional parameters to pass to the script. * @return string HTML code for tab menu */ function getTabMenu($mainParams, $elementName, $currentValue, $menuItems, $script = '', $addparams = '') { $content=''; if (is_array($menuItems)) { if (!is_array($mainParams)) { $mainParams = array('id' => $mainParams); } $mainParams = t3lib_div::implodeArrayForUrl('',$mainParams); if (!$script) {$script=basename(PATH_thisScript);} $menuDef = array(); foreach($menuItems as $value => $label) { $menuDef[$value]['isActive'] = !strcmp($currentValue,$value); $menuDef[$value]['label'] = t3lib_div::deHSCentities(htmlspecialchars($label)); $menuDef[$value]['url'] = $script . '?' . $mainParams . $addparams . '&' . $elementName . '=' . $value; } $content = $this->getTabMenuRaw($menuDef); } return $content; } /** * Creates the HTML content for the tab menu * * @param array $menuItems Menu items for tabs * @return string Table HTML * @access private */ function getTabMenuRaw($menuItems) { $content=''; if (is_array($menuItems)) { $options=''; $count = count($menuItems); $widthLeft = 1; $addToAct = 5; $widthRight = max (1,floor(30-pow($count,1.72))); $widthTabs = 100 - $widthRight - $widthLeft; $widthNo = floor(($widthTabs - $addToAct)/$count); $addToAct = max ($addToAct,$widthTabs-($widthNo*$count)); $widthAct = $widthNo + $addToAct; $widthRight = 100 - ($widthLeft + ($count*$widthNo) + $addToAct); foreach($menuItems as $id => $def) { $isActive = $def['isActive']; $class = $isActive ? 'tabact' : 'tab'; $width = $isActive ? $widthAct : $widthNo; // @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. $label = $def['label']; $url = htmlspecialchars($def['url']); $params = $def['addParams']; $options .= '' . $label . ''; } if ($options) { $content .= ' '.$options.'

'; } } return $content; } /** * Creates a DYNAMIC tab-menu where the tabs are switched between with DHTML. * Should work in MSIE, Mozilla, Opera and Konqueror. On Konqueror I did find a serious problem: fields loose their content when you switch tabs! * * @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. * @param string $identString Identification string. This should be unique for every instance of a dynamic menu! * @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. * @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. * @param boolean $noWrap If set, tab table cells are not allowed to wrap their content * @param boolean $fullWidth If set, the tabs will span the full width of their position * @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. * @param integer $dividers2tabs If set to '1' empty tabs will be remove, If set to '2' empty tabs will be disabled * @return string JavaScript section for the HTML header. */ public function getDynTabMenu($menuItems, $identString, $toggle = 0, $foldout = FALSE, $noWrap = TRUE, $fullWidth = FALSE, $defaultTabIndex = 1, $dividers2tabs = 2) { // load the static code, if not already done with the function below $this->loadJavascriptLib('js/tabmenu.js'); $content = ''; if (is_array($menuItems)) { // Init: $options = array(array()); $divs = array(); $JSinit = array(); $id = $this->getDynTabMenuId($identString); $noWrap = $noWrap ? ' nowrap="nowrap"' : ''; // Traverse menu items $c=0; $tabRows=0; $titleLenCount = 0; foreach($menuItems as $index => $def) { // Need to add one so checking for first index in JavaScript // is different than if it is not set at all. $index += 1; // Switch to next tab row if needed if (!$foldout && ($def['newline'] === TRUE && $titleLenCount > 0)) { $titleLenCount=0; $tabRows++; $options[$tabRows] = array(); } if ($toggle==1) { $onclick = 'this.blur(); DTM_toggle("'.$id.'","'.$index.'"); return false;'; } else { $onclick = 'this.blur(); DTM_activate("'.$id.'","'.$index.'", '.($toggle<0?1:0).'); return false;'; } $isEmpty = !(strcmp(trim($def['content']),'') || strcmp(trim($def['icon']),'')); // "Removes" empty tabs if ($isEmpty && $dividers2tabs == 1) { continue; } $mouseOverOut = ' onmouseover="DTM_mouseOver(this);" onmouseout="DTM_mouseOut(this);"'; $requiredIcon = '<img name="' . $id . '-' . $index . '-REQ" src="' . $GLOBALS['BACK_PATH'] . 'gfx/clear.gif" class="t3-TCEforms-reqTabImg" alt="" />'; if (!$foldout) { // Create TAB cell: $options[$tabRows][] = ' <td class="'.($isEmpty ? 'disabled' : 'tab').'" id="'.$id.'-'.$index.'-MENU"'.$noWrap.$mouseOverOut.'>'. ($isEmpty ? '' : '<a href="#" onclick="'.htmlspecialchars($onclick).'"'.($def['linkTitle'] ? ' title="'.htmlspecialchars($def['linkTitle']).'"':'').'>'). $def['icon']. ($def['label'] ? htmlspecialchars($def['label']) : ' '). $requiredIcon. $this->icons($def['stateIcon'],'margin-left: 10px;'). ($isEmpty ? '' : '</a>'). '</td>'; $titleLenCount+= strlen($def['label']); } else { // Create DIV layer for content: $divs[] = ' <div class="'.($isEmpty ? 'disabled' : 'tab').'" id="'.$id.'-'.$index.'-MENU"'.$mouseOverOut.'>'. ($isEmpty ? '' : '<a href="#" onclick="'.htmlspecialchars($onclick).'"'.($def['linkTitle'] ? ' title="'.htmlspecialchars($def['linkTitle']).'"':'').'>'). $def['icon']. ($def['label'] ? htmlspecialchars($def['label']) : ' '). $requiredIcon. ($isEmpty ? '' : '</a>'). '</div>'; } // Create DIV layer for content: $divs[] = ' <div style="display: none;" id="'.$id.'-'.$index.'-DIV" class="c-tablayer">'. ($def['description'] ? '<p class="c-descr">'.nl2br(htmlspecialchars($def['description'])).'</p>' : ''). $def['content']. '</div>'; // Create initialization string: $JSinit[] = ' DTM_array["'.$id.'"]['.$c.'] = "'.$id.'-'.$index.'"; '; // If not empty and we have the toggle option on, check if the tab needs to be expanded if ($toggle == 1 && !$isEmpty) { $JSinit[] = ' if (top.DTM_currentTabs["'.$id.'-'.$index.'"]) { DTM_toggle("'.$id.'","'.$index.'",1); } '; } $c++; } // Render menu: if (count($options)) { // Tab menu is compiled: if (!$foldout) { $tabContent = ''; for($a=0;$a<=$tabRows;$a++) { $tabContent.= ' <!-- Tab menu --> <table cellpadding="0" cellspacing="0" border="0"'.($fullWidth ? ' width="100%"' : '').' class="typo3-dyntabmenu"> <tr> '.implode('',$options[$a]).' </tr> </table>'; } $content.= '<div class="typo3-dyntabmenu-tabs">'.$tabContent.'</div>'; } // Div layers are added: $content.= ' <!-- Div layers for tab menu: --> <div class="typo3-dyntabmenu-divs'.($foldout?'-foldout':'').'"> '.implode('',$divs).'</div>'; // Java Script section added: $content.= ' <!-- Initialization JavaScript for the menu --> <script type="text/javascript"> DTM_array["'.$id.'"] = new Array(); '.implode('',$JSinit).' '.($toggle<=0 ? 'DTM_activate("'.$id.'", top.DTM_currentTabs["'.$id.'"]?top.DTM_currentTabs["'.$id.'"]:'.intval($defaultTabIndex).', 0);' : '').' </script> '; } } return $content; } /** * Creates the id for dynTabMenus. * * @param string $identString Identification string. This should be unique for every instance of a dynamic menu! * @return string The id with a short MD5 of $identString and prefixed "DTM-", like "DTM-2e8791854a" */ function getDynTabMenuId($identString) { $id = 'DTM-'.t3lib_div::shortMD5($identString); return $id; } /** * Creates the version selector for the page id inputted. * Requires the core version management extension, "version" to be loaded. * * @param integer $id Page id to create selector for. * @param boolean $noAction If set, there will be no button for swapping page. * @return string */ public function getVersionSelector($id, $noAction = FALSE) { if (t3lib_extMgm::isLoaded('version')) { $versionGuiObj = t3lib_div::makeInstance('tx_version_gui'); return $versionGuiObj->getVersionSelector($id, $noAction); } } /** * Function to load a HTML template file with markers. * When calling from own extension, use syntax getHtmlTemplate('EXT:extkey/template.html') * * @param string $filename tmpl name, usually in the typo3/template/ directory * @return string HTML of template */ function getHtmlTemplate($filename) { // setting the name of the original HTML template $this->moduleTemplateFilename = $filename; if ($GLOBALS['TBE_STYLES']['htmlTemplates'][$filename]) { $filename = $GLOBALS['TBE_STYLES']['htmlTemplates'][$filename]; } if (t3lib_div::isFirstPartOfStr($filename, 'EXT:')) { $filename = t3lib_div::getFileAbsFileName($filename, TRUE, TRUE); } elseif (!t3lib_div::isAbsPath($filename)) { $filename = t3lib_div::resolveBackPath($this->backPath . $filename); } elseif (!t3lib_div::isAllowedAbsPath($filename)) { $filename = ''; } $htmlTemplate = ''; if ($filename !== '') { $htmlTemplate = t3lib_div::getUrl($filename); } return $htmlTemplate; } /** * Define the template for the module * * @param string $filename filename * @return void */ public function setModuleTemplate($filename) { // Load Prototype lib for IE event $this->pageRenderer->loadPrototype(); $this->loadJavascriptLib('js/iecompatibility.js'); $this->moduleTemplate = $this->getHtmlTemplate($filename); } /** * Put together the various elements for the module <body> using a static HTML * template * * @param array $pageRecord Record of the current page, used for page path and info * @param array $buttons HTML for all buttons * @param array $markerArray HTML for all other markers * @param array $subpartArray HTML for the subparts * @return string Composite HTML */ public function moduleBody($pageRecord = array(), $buttons = array(), $markerArray = array(), $subpartArray = array()) { // Get the HTML template for the module $moduleBody = t3lib_parsehtml::getSubpart($this->moduleTemplate, '###FULLDOC###'); // Add CSS $this->inDocStylesArray[] = 'html { overflow: hidden; }'; // Get the page path for the docheader $markerArray['PAGEPATH'] = $this->getPagePath($pageRecord); // Get the page info for the docheader $markerArray['PAGEINFO'] = $this->getPageInfo($pageRecord); // Get all the buttons for the docheader $docHeaderButtons = $this->getDocHeaderButtons($buttons); // Merge docheader buttons with the marker array $markerArray = array_merge($markerArray, $docHeaderButtons); // replacing subparts foreach ($subpartArray as $marker => $content) { $moduleBody = t3lib_parsehtml::substituteSubpart($moduleBody, $marker, $content); } // adding flash messages if ($this->showFlashMessages) { $flashMessages = t3lib_FlashMessageQueue::renderFlashMessages(); if (!empty($flashMessages)) { $markerArray['FLASHMESSAGES'] = '<div id="typo3-messages">' . $flashMessages . '</div>'; // if there is no dedicated marker for the messages present // then force them to appear before the content if (strpos($moduleBody, '###FLASHMESSAGES###') === FALSE) { $moduleBody = str_replace( '###CONTENT###', '###FLASHMESSAGES######CONTENT###', $moduleBody ); } } } // Hook for adding more markers/content to the page, like the version selector if (isset($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['typo3/template.php']['moduleBodyPostProcess'])) { $params = array( 'moduleTemplateFilename' => &$this->moduleTemplateFilename, 'moduleTemplate' => &$this->moduleTemplate, 'moduleBody' => &$moduleBody, 'markers' => &$markerArray, 'parentObject' => &$this ); foreach ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['typo3/template.php']['moduleBodyPostProcess'] as $funcRef) { t3lib_div::callUserFunction($funcRef, $params, $this); } } // replacing all markers with the finished markers and return the HTML content return t3lib_parsehtml::substituteMarkerArray($moduleBody, $markerArray, '###|###'); } /** * Fill the button lists with the defined HTML * * @param array $buttons HTML for all buttons * @return array Containing HTML for both buttonlists */ protected function getDocHeaderButtons($buttons) { $markers = array(); // Fill buttons for left and right float $floats = array('left', 'right'); foreach($floats as $key) { // Get the template for each float $buttonTemplate = t3lib_parsehtml::getSubpart($this->moduleTemplate, '###BUTTON_GROUPS_' . strtoupper($key) . '###'); // Fill the button markers in this float $buttonTemplate = t3lib_parsehtml::substituteMarkerArray($buttonTemplate, $buttons, '###|###', TRUE); // getting the wrap for each group $buttonWrap = t3lib_parsehtml::getSubpart($this->moduleTemplate, '###BUTTON_GROUP_WRAP###'); // looping through the groups (max 6) and remove the empty groups for ($groupNumber = 1; $groupNumber < 6; $groupNumber++) { $buttonMarker = '###BUTTON_GROUP' . $groupNumber . '###'; $buttonGroup = t3lib_parsehtml::getSubpart($buttonTemplate, $buttonMarker); if (trim($buttonGroup)) { if ($buttonWrap) { $buttonGroup = t3lib_parsehtml::substituteMarker($buttonWrap, '###BUTTONS###', $buttonGroup); } $buttonTemplate = t3lib_parsehtml::substituteSubpart($buttonTemplate, $buttonMarker, trim($buttonGroup)); } } // replace the marker with the template and remove all line breaks (for IE compat) $markers['BUTTONLIST_' . strtoupper($key)] = str_replace(LF, '', $buttonTemplate); } // Hook for manipulating docHeaderButtons if (isset($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['typo3/template.php']['docHeaderButtonsHook'])) { $params = array( 'buttons' => $buttons, 'markers' => &$markers, 'pObj' => &$this ); foreach($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['typo3/template.php']['docHeaderButtonsHook'] as $funcRef) { t3lib_div::callUserFunction($funcRef, $params, $this); } } return $markers; } /** * Generate the page path for docheader * * @param array $pageRecord Current page * @return string Page path */ protected function getPagePath($pageRecord) { // Is this a real page if ($pageRecord['uid']) { $title = substr($pageRecord['_thePathFull'], 0, -1); // remove current page title $pos = strrpos($title, '/'); if ($pos !== FALSE) { $title = substr($title, 0, $pos) . '/'; } } else { $title = ''; } // Setting the path of the page $pagePath = $GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.php:labels.path', 1) . ': <span class="typo3-docheader-pagePath">'; // crop the title to title limit (or 50, if not defined) $cropLength = (empty($GLOBALS['BE_USER']->uc['titleLen'])) ? 50 : $GLOBALS['BE_USER']->uc['titleLen']; $croppedTitle = t3lib_div::fixed_lgd_cs($title, -$cropLength); if ($croppedTitle !== $title) { $pagePath .= '<abbr title="' . htmlspecialchars($title) . '">' . htmlspecialchars($croppedTitle) . '</abbr>'; } else { $pagePath .= htmlspecialchars($title); } $pagePath .= '</span>'; return $pagePath; } /** * Setting page icon with clickmenu + uid for docheader * * @param array $pageRecord Current page * @return string Page info */ protected function getPageInfo($pageRecord) { // Add icon with clickmenu, etc: if ($pageRecord['uid']) { // If there IS a real page $alttext = t3lib_BEfunc::getRecordIconAltText($pageRecord, 'pages'); $iconImg = t3lib_iconWorks::getSpriteIconForRecord('pages', $pageRecord, array('title'=>$alttext)); // Make Icon: $theIcon = $GLOBALS['SOBE']->doc->wrapClickMenuOnIcon($iconImg, 'pages', $pageRecord['uid']); $uid = $pageRecord['uid']; $title = t3lib_BEfunc::getRecordTitle('pages', $pageRecord); } else { // On root-level of page tree // Make Icon $iconImg = t3lib_iconWorks::getSpriteIcon('apps-pagetree-root', array('title' => htmlspecialchars($GLOBALS['TYPO3_CONF_VARS']['SYS']['sitename']))); if ($GLOBALS['BE_USER']->user['admin']) { $theIcon = $GLOBALS['SOBE']->doc->wrapClickMenuOnIcon($iconImg, 'pages', 0); } else { $theIcon = $iconImg; } $uid = '0'; $title = $GLOBALS['TYPO3_CONF_VARS']['SYS']['sitename']; } // Setting icon with clickmenu + uid $pageInfo = $theIcon . '<strong>' . htmlspecialchars($title) . ' [' . $uid . ']</strong>'; return $pageInfo; } /** * Makes a collapseable section. See reports module for an example * * @param string $title * @param string $html * @param string $id * @param string $saveStatePointer * @return string */ public function collapseableSection($title, $html, $id, $saveStatePointer = '') { $hasSave = $saveStatePointer ? TRUE : FALSE; $collapsedStyle = $collapsedClass = ''; if ($hasSave) { /** @var $settings extDirect_DataProvider_BackendUserSettings */ $settings = t3lib_div::makeInstance('extDirect_DataProvider_BackendUserSettings'); $value = $settings->get($saveStatePointer . '.' . $id); if ($value) { $collapsedStyle = ' style="display: none"'; $collapsedClass = ' collapsed'; } else { $collapsedStyle = ''; $collapsedClass = ' expanded'; } } $this->pageRenderer->loadExtJS(); $this->pageRenderer->addExtOnReadyCode(' Ext.select("h2.section-header").each(function(element){ element.on("click", function(event, tag) { var state = 0, el = Ext.fly(tag), div = el.next("div"), saveKey = el.getAttribute("rel"); if (el.hasClass("collapsed")) { el.removeClass("collapsed").addClass("expanded"); div.slideIn("t", { easing: "easeIn", duration: .5 }); } else { el.removeClass("expanded").addClass("collapsed"); div.slideOut("t", { easing: "easeOut", duration: .5, remove: false, useDisplay: true }); state = 1; } if (saveKey) { try { top.TYPO3.BackendUserSettings.ExtDirect.set(saveKey + "." + tag.id, state, function(response) {}); } catch(e) {} } }); }); '); return ' <h2 id="' . $id . '" class="section-header' . $collapsedClass . '" rel="' . $saveStatePointer . '"> ' . $title . '</h2> <div' . $collapsedStyle . '>' . $html . '</div> '; } } // ****************************** // Extension classes of the template class. // These are meant to provide backend screens with different widths. // They still do because of the different class-prefixes used for the <div>-sections // but obviously the final width is determined by the stylesheet used. // ****************************** /** * 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 * The class were more significant in the past than today. * */ class bigDoc extends template { var $divClass = 'typo3-bigDoc'; } /** * Extension class for "template" - used for backend pages without the "document" background image * The class were more significant in the past than today. * */ class noDoc extends template { var $divClass = 'typo3-noDoc'; } /** * 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) * The class were more significant in the past than today. * */ class smallDoc extends template { var $divClass = 'typo3-smallDoc'; } /** * 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. * The class were more significant in the past than today. But probably you should use this one for most modules you make. * */ class mediumDoc extends template { var $divClass = 'typo3-mediumDoc'; } /** * Extension class for "template" - used in the context of frontend editing. */ class frontendDoc extends template { /** * Gets instance of PageRenderer * * @return t3lib_PageRenderer */ public function getPageRenderer() { if (!isset($this->pageRenderer)) { $this->pageRenderer = $GLOBALS['TSFE']->getPageRenderer(); } return $this->pageRenderer; } /** * Used in the frontend context to insert header data via TSFE->additionalHeaderData. * Mimics header inclusion from template->startPage(). * * @return void */ public function insertHeaderData() { $this->backPath = $GLOBALS['TSFE']->backPath = TYPO3_mainDir; $this->pageRenderer->setBackPath($this->backPath); $this->docStyle(); // add applied JS/CSS to $GLOBALS['TSFE'] if ($this->JScode) { $this->pageRenderer->addHeaderData($this->JScode); } if (count($this->JScodeArray)) { foreach ($this->JScodeArray as $name => $code) { $this->pageRenderer->addJsInlineCode($name, $code, FALSE); } } } } // ****************************** // The template is loaded // ****************************** $GLOBALS['TBE_TEMPLATE'] = t3lib_div::makeInstance('template'); ?>