TYPO3 CMS  TYPO3_6-2
TYPO3\CMS\Backend\Template\DocumentTemplate Class Reference
Inheritance diagram for TYPO3\CMS\Backend\Template\DocumentTemplate:
template TYPO3\CMS\Backend\Template\BigDocumentTemplate TYPO3\CMS\Backend\Template\FrontendDocumentTemplate TYPO3\CMS\Backend\Template\MediumDocumentTemplate TYPO3\CMS\Backend\Template\SmallDocumentTemplate TYPO3\CMS\Backend\Template\StandardDocumentTemplate bigDoc frontendDoc mediumDoc smallDoc noDoc

Public Member Functions

 __construct ()
 
 getPageRenderer ()
 
 setExtDirectStateProvider ()
 
 wrapClickMenuOnIcon ($str, $table, $uid=0, $listFr=TRUE, $addParams='', $enDisItems='', $returnOnClick=FALSE)
 
 viewPageIcon ($id, $backPath, $addParams='hspace="3"')
 
 issueCommand ($params, $redirectUrl='')
 
 isCMlayers ()
 
 getHeader ($table, $row, $path, $noViewPageIcon=FALSE, $tWrap=array('', ''), $enableClickMenu=TRUE)
 
 getResourceHeader (\TYPO3\CMS\Core\Resource\ResourceInterface $resource, $tWrap=array('', ''), $enableClickMenu=TRUE)
 
 getFileheader ($title, $path, $iconfile)
 
 makeShortcutIcon ($gvList, $setList, $modName, $motherModName='')
 
 makeShortcutUrl ($gvList, $setList)
 
 formWidth ($size=48, $textarea=FALSE, $styleOverride='')
 
 formWidthText ($size=48, $styleOverride='', $wrap='')
 
 redirectUrls ($thisLocation='')
 
 formatTime ($tstamp, $type)
 
 parseTime ()
 
 useCompatibilityTag ($useCompatibilityTag=TRUE)
 
 startPage ($title, $includeCsh=TRUE)
 
 endPage ()
 
 render ($title, $content, $includeCsh=TRUE)
 
 header ($text)
 
 section ($label, $text, $nostrtoupper=FALSE, $sH=FALSE, $type=0, $allowHTMLinHeader=FALSE)
 
 divider ($dist)
 
 spacer ($dist)
 
 sectionHeader ($label, $sH=FALSE, $addAttrib='')
 
 sectionBegin ()
 
 sectionEnd ()
 
 endPageJS ()
 
 docBodyTagBegin ()
 
 docStyle ()
 
 addStyleSheet ($key, $href, $title='', $relation='stylesheet')
 
 addStyleSheetDirectory ($path)
 
 insertStylesAndJS ($content)
 
 getSkinStylesheetDirectories ()
 
 generator ()
 
 xUaCompatible ($content='IE=8')
 
 icons ($type, $styleAttribValue='')
 
 t3Button ($onClick, $label)
 
 dfw ($string)
 
 rfw ($string)
 
 wrapInCData ($string)
 
 wrapScriptTags ($string, $linebreak=TRUE)
 
 table ($data, $layout=NULL)
 
 menuTable ($arr1, $arr2=array(), $arr3=array())
 
 funcMenu ($content, $menu)
 
 loadJavascriptLib ($lib)
 
 getContextMenuCode ()
 
 getDragDropCode ($table)
 
 getTabMenu ($mainParams, $elementName, $currentValue, $menuItems, $script='', $addparams='')
 
 getTabMenuRaw ($menuItems)
 
 getDynTabMenu ($menuItems, $identString, $toggle=0, $foldout=FALSE, $noWrap=TRUE, $fullWidth=FALSE, $defaultTabIndex=1, $dividers2tabs=2)
 
 getDynTabMenuId ($identString)
 
 getVersionSelector ($id, $noAction=FALSE)
 
 getHtmlTemplate ($filename)
 
 setModuleTemplate ($filename)
 
 moduleBody ($pageRecord=array(), $buttons=array(), $markerArray=array(), $subpartArray=array())
 
 renderFlashMessages (array $params, \TYPO3\CMS\Core\Http\AjaxRequestHandler $ajaxObj)
 

Public Attributes

 $backPath = ''
 
 $form = ''
 
 $JScodeLibArray = array()
 
 $JScode = ''
 
 $extJScode = ''
 
 $JScodeArray
 
 $postCode = ''
 
 $docType = ''
 
 $moduleTemplate = ''
 
 $scriptID = ''
 
 $bodyTagId = ''
 
 $bodyTagAdditions = ''
 
 $inDocStyles = ''
 
 $inDocStylesArray = array()
 
 $form_largeComp = 1.33
 
 $endJS = 1
 
 $bgColor = '#F7F3EF'
 
 $bgColor2 = '#9BA1A8'
 
 $bgColor3 = '#F6F2E6'
 
 $bgColor4 = '#D9D5C9'
 
 $bgColor5 = '#ABBBB4'
 
 $bgColor6 = '#E7DBA8'
 
 $hoverColor = '#254D7B'
 
 $styleSheetFile = ''
 
 $styleSheetFile2 = ''
 
 $styleSheetFile_post = ''
 
 $backGroundImage = ''
 
 $inDocStyles_TBEstyle = ''
 
 $parseTimeFlag = 0
 
 $sectionFlag = 0
 
 $divClass = ''
 
 $pageHeaderBlock = ''
 
 $endOfPageJsBlock = ''
 
 $hasDocheader = TRUE
 
 $showFlashMessages = TRUE
 
const STATUS_ICON_ERROR = 3
 
const STATUS_ICON_WARNING = 2
 
const STATUS_ICON_NOTIFICATION = 1
 
const STATUS_ICON_OK = -1
 
 $tableLayout
 
 $table_TR = '<tr>'
 
 $table_TABLE = '<table border="0" cellspacing="0" cellpadding="0" class="typo3-dblist" id="typo3-tmpltable">'
 

Protected Member Functions

 loadCshJavascript ()
 
 getDocHeaderButtons ($buttons)
 
 getPagePath ($pageRecord)
 
 getPageInfo ($pageRecord)
 
 getBackendFavicon ()
 

Protected Attributes

 $moduleTemplateFilename = ''
 
 $useCompatibilityTag = TRUE
 
 $xUaCompatibilityVersion = 'IE=10'
 
 $stylesheetsCore
 
 $stylesheetsSkins
 
 $jsFiles
 
 $jsFilesNoConcatenation
 
 $charset = 'utf-8'
 
 $pageRenderer
 
 $pageHeaderFooterTemplateFile = ''
 
 $extDirectStateProvider = FALSE
 

Detailed Description

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 kaspe.nosp@m.rYYY.nosp@m.Y@typ.nosp@m.o3.c.nosp@m.om

Definition at line 41 of file DocumentTemplate.php.

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addStyleSheet()

TYPO3\CMS\Backend\Template\DocumentTemplate::addStyleSheet (   $key,
  $href,
  $title = '',
  $relation = 'stylesheet' 
)

Insert additional style sheet link

Parameters
string$keysome key identifying the style sheet
string$hrefuri to the style sheet file
string$titlevalue for the title attribute of the link element
string$relationvalue for the rel attribute of the link element
Returns
void
Todo:
Define visibility

Definition at line 1205 of file DocumentTemplate.php.

◆ addStyleSheetDirectory()

TYPO3\CMS\Backend\Template\DocumentTemplate::addStyleSheetDirectory (   $path)

Add all *.css files of the directory $path to the stylesheets

Parameters
string$pathdirectory to add
Returns
void
Todo:
Define visibility

Definition at line 1221 of file DocumentTemplate.php.

References $GLOBALS, TYPO3\CMS\Core\Utility\GeneralUtility\getFilesInDir(), TYPO3\CMS\Core\Utility\GeneralUtility\getIndpEnv(), and TYPO3\CMS\Core\Utility\GeneralUtility\resolveBackPath().

◆ dfw()

TYPO3\CMS\Backend\Template\DocumentTemplate::dfw (   $string)

Dimmed-fontwrap. Returns the string wrapped in a -tag defining the color to be gray/dimmed

Parameters
string$stringInput string
Returns
string Output string
Todo:
Define visibility

Definition at line 1379 of file DocumentTemplate.php.

◆ divider()

TYPO3\CMS\Backend\Template\DocumentTemplate::divider (   $dist)

Inserts a divider image Ends a section (if open) before inserting the image

Parameters
integer$distThe margin-top/-bottom of the
ruler.
Returns
string HTML content
Todo:
Define visibility

Definition at line 1035 of file DocumentTemplate.php.

References TYPO3\CMS\Backend\Template\DocumentTemplate\sectionEnd().

◆ docBodyTagBegin()

TYPO3\CMS\Backend\Template\DocumentTemplate::docBodyTagBegin ( )

Creates the bodyTag. You can add to the bodyTag by $this->bodyTagAdditions

Returns
string HTML body tag
Todo:
Define visibility

Definition at line 1156 of file DocumentTemplate.php.

◆ docStyle()

TYPO3\CMS\Backend\Template\DocumentTemplate::docStyle ( )

Outputting document style

Returns
string HTML style section/link tags
Todo:
Define visibility

Definition at line 1167 of file DocumentTemplate.php.

References TYPO3\CMS\Backend\Template\DocumentTemplate\$inDocStyles, and TYPO3\CMS\Backend\Template\DocumentTemplate\$inDocStyles_TBEstyle.

Referenced by TYPO3\CMS\Backend\Template\FrontendDocumentTemplate\insertHeaderData().

◆ endPage()

TYPO3\CMS\Backend\Template\DocumentTemplate::endPage ( )

Returns page end; This includes finishing form, div, body and html tags.

Returns
string The HTML end of a page
See also
startPage()
Todo:
Define visibility

Definition at line 942 of file DocumentTemplate.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\devLog().

Referenced by TYPO3\CMS\Backend\Template\DocumentTemplate\render().

◆ endPageJS()

TYPO3\CMS\Backend\Template\DocumentTemplate::endPageJS ( )

If a form-tag is defined in ->form then and end-tag for that <form> element is outputted Further a JavaScript section is outputted which will update the top.busy session-expiry object (unless $this->endJS is set to FALSE)

Returns
string HTML content (<script> tag section)
Todo:
Define visibility

Definition at line 1138 of file DocumentTemplate.php.

◆ formatTime()

TYPO3\CMS\Backend\Template\DocumentTemplate::formatTime (   $tstamp,
  $type 
)

Returns a formatted string of $tstamp Uses $GLOBALS['TYPO3_CONF_VARS']['SYS']['hhmm'] and $GLOBALS['TYPO3_CONF_VARS']['SYS']['ddmmyy'] to format date and time

Parameters
integer$tstampUNIX timestamp, seconds since 1970
integer$typeHow much data to show: $type = 1: hhmm, $type = 10: ddmmmyy
Returns
string Formatted timestamp
Todo:
Define visibility

Definition at line 722 of file DocumentTemplate.php.

◆ formWidth()

TYPO3\CMS\Backend\Template\DocumentTemplate::formWidth (   $size = 48,
  $textarea = FALSE,
  $styleOverride = '' 
)

Returns <input> attributes to set the width of an text-type input field. For client browsers with no CSS support the cols/size attribute is returned. For CSS compliant browsers (recommended) a ' style="width: ...px;"' is returned.

Parameters
integer$sizeA relative number which multiplied with approx. 10 will lead to the width in pixels
boolean$textareaA flag you can set for textareas - DEPRECATED as there is no difference any more between the two
string$styleOverrideA string which will be returned as attribute-value for style="" instead of the calculated width (if CSS is enabled)
Returns
string Tag attributes for an <input> tag (regarding width)
Todo:
Define visibility

Definition at line 666 of file DocumentTemplate.php.

Referenced by TYPO3\CMS\Backend\Template\DocumentTemplate\formWidthText().

◆ formWidthText()

TYPO3\CMS\Backend\Template\DocumentTemplate::formWidthText (   $size = 48,
  $styleOverride = '',
  $wrap = '' 
)

This function is dedicated to textareas, which has the wrapping on/off option to observe. EXAMPLE: <textarea rows="10" wrap="off" '.$GLOBALS["TBE_TEMPLATE"]->formWidthText(48, "", "off").'> or <textarea rows="10" wrap="virtual" '.$GLOBALS["TBE_TEMPLATE"]->formWidthText(48, "", "virtual").'>

Parameters
integer$sizeA relative number which multiplied with approx. 10 will lead to the width in pixels
string$styleOverrideA string which will be returned as attribute-value for style="" instead of the calculated width (if CSS is enabled)
string$wrapPass on the wrap-attribute value you use in your <textarea>! This will be used to make sure that some browsers will detect wrapping alright.
Returns
string Tag attributes for an <input> tag (regarding width)
See also
formWidth()
Deprecated:
since TYPO3 CMS 6.2, remove two versions later, as this is function is not needed anymore, use formWidth()
Todo:
Define visibility

Definition at line 685 of file DocumentTemplate.php.

References TYPO3\CMS\Backend\Template\DocumentTemplate\formWidth(), and TYPO3\CMS\Core\Utility\GeneralUtility\logDeprecatedFunction().

◆ funcMenu()

TYPO3\CMS\Backend\Template\DocumentTemplate::funcMenu (   $content,
  $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

Parameters
string$contentContent cell content (left)
string$menuMenu cell content (right)
Returns
string HTML output
Todo:
Define visibility

Definition at line 1543 of file DocumentTemplate.php.

◆ generator()

TYPO3\CMS\Backend\Template\DocumentTemplate::generator ( )

Returns generator meta tag

Returns
string <meta> tag with name "generator
Todo:
Define visibility

Definition at line 1302 of file DocumentTemplate.php.

◆ getBackendFavicon()

TYPO3\CMS\Backend\Template\DocumentTemplate::getBackendFavicon ( )
protected

Retrieves configured favicon for backend (with fallback)

Returns
string

Definition at line 2138 of file DocumentTemplate.php.

References TYPO3\CMS\Backend\Utility\IconUtility\skinImg().

◆ getContextMenuCode()

TYPO3\CMS\Backend\Template\DocumentTemplate::getContextMenuCode ( )

Includes the necessary Javascript function for the clickmenu (context sensitive menus) in the document

Returns
void
Todo:
Define visibility

Definition at line 1571 of file DocumentTemplate.php.

References TYPO3\CMS\Backend\Template\DocumentTemplate\loadJavascriptLib().

◆ getDocHeaderButtons()

TYPO3\CMS\Backend\Template\DocumentTemplate::getDocHeaderButtons (   $buttons)
protected

◆ getDragDropCode()

TYPO3\CMS\Backend\Template\DocumentTemplate::getDragDropCode (   $table)

Includes the necessary javascript file (tree.js) for use on pages which have the drag and drop functionality (usually pages and folder display trees)

Parameters
string$tableindicator of which table the drag and drop function should work on (pages or folders)
Returns
void
Todo:
Define visibility

Definition at line 1587 of file DocumentTemplate.php.

References $GLOBALS, TYPO3\CMS\Backend\Template\DocumentTemplate\loadJavascriptLib(), and TYPO3\CMS\Core\Utility\GeneralUtility\shortMD5().

◆ getDynTabMenu()

TYPO3\CMS\Backend\Template\DocumentTemplate::getDynTabMenu (   $menuItems,
  $identString,
  $toggle = 0,
  $foldout = FALSE,
  $noWrap = TRUE,
  $fullWidth = FALSE,
  $defaultTabIndex = 1,
  $dividers2tabs = 2 
)

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: <textarea> fields loose their content when you switch tabs!

Parameters
array$menuItemsNumeric 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.
string$identStringIdentification string. This should be unique for every instance of a dynamic menu!
integer$toggleIf "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.
boolean$foldoutIf 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.
boolean$noWrapIf set, tab table cells are not allowed to wrap their content
boolean$fullWidthIf set, the tabs will span the full width of their position
integer$defaultTabIndexDefault 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.
integer$dividers2tabsIf set to '1' empty tabs will be remove, If set to '2' empty tabs will be disabled
Returns
string JavaScript section for the HTML header.

Definition at line 1707 of file DocumentTemplate.php.

References $GLOBALS, TYPO3\CMS\Backend\Template\DocumentTemplate\getDynTabMenuId(), TYPO3\CMS\Backend\Template\DocumentTemplate\icons(), and TYPO3\CMS\Backend\Template\DocumentTemplate\loadJavascriptLib().

◆ getDynTabMenuId()

TYPO3\CMS\Backend\Template\DocumentTemplate::getDynTabMenuId (   $identString)

Creates the id for dynTabMenus.

Parameters
string$identStringIdentification string. This should be unique for every instance of a dynamic menu!
Returns
string The id with a short MD5 of $identString and prefixed "DTM-", like "DTM-2e8791854a
Todo:
Define visibility

Definition at line 1812 of file DocumentTemplate.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\shortMD5().

Referenced by TYPO3\CMS\Backend\Template\DocumentTemplate\getDynTabMenu().

◆ getFileheader()

TYPO3\CMS\Backend\Template\DocumentTemplate::getFileheader (   $title,
  $path,
  $iconfile 
)

Like ->getHeader() but for files in the File>* main module/submodules Returns the file-icon with the path of the file set in the alt/title attribute. Shows the file-name after the icon.

Parameters
string$titleTitle string, expected to be the filepath
string$pathAlt text
string$iconfileThe icon file (relative to TYPO3 dir)
Returns
string HTML content
Deprecated:
since 6.2 remove 2 version later use getResourceHeader() instead

Definition at line 596 of file DocumentTemplate.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\fixed_lgd_cs(), TYPO3\CMS\Core\Utility\GeneralUtility\logDeprecatedFunction(), TYPO3\CMS\Backend\Utility\IconUtility\skinImg(), and TYPO3\CMS\Core\Utility\GeneralUtility\split_fileref().

◆ getHeader()

TYPO3\CMS\Backend\Template\DocumentTemplate::getHeader (   $table,
  $row,
  $path,
  $noViewPageIcon = FALSE,
  $tWrap = array('', ''),
  $enableClickMenu = TRUE 
)

Makes the header (icon+title) for a page (or other record). Used in most modules under Web>* $table and $row must be a tablename/record from that table $path will be shown as alt-text for the icon. The title will be truncated to 45 chars.

Parameters
string$tableTable name
array$rowRecord row
string$pathAlt text
boolean$noViewPageIconSet $noViewPageIcon TRUE if you don't want a magnifier-icon for viewing the page in the frontend
array$tWrapis an array with indexes 0 and 1 each representing HTML-tags (start/end) which will wrap the title
bool$enableClickMenuIf TRUE, render click menu code around icon image
Returns
string HTML content
Todo:
Define visibility

Definition at line 540 of file DocumentTemplate.php.

References $GLOBALS, TYPO3\CMS\Core\Utility\GeneralUtility\fixed_lgd_cs(), TYPO3\CMS\Backend\Utility\BackendUtility\getRecordTitle(), TYPO3\CMS\Backend\Utility\IconUtility\getSpriteIcon(), TYPO3\CMS\Backend\Utility\IconUtility\getSpriteIconForRecord(), TYPO3\CMS\Backend\Utility\BackendUtility\titleAttribForPages(), TYPO3\CMS\Backend\Template\DocumentTemplate\viewPageIcon(), and TYPO3\CMS\Backend\Template\DocumentTemplate\wrapClickMenuOnIcon().

◆ getHtmlTemplate()

TYPO3\CMS\Backend\Template\DocumentTemplate::getHtmlTemplate (   $filename)

Function to load a HTML template file with markers. When calling from own extension, use syntax getHtmlTemplate('EXT:extkey/template.html')

Parameters
string$filenametmpl name, usually in the typo3/template/ directory
Returns
string HTML of template
Todo:
Define visibility

Definition at line 1843 of file DocumentTemplate.php.

References $GLOBALS, TYPO3\CMS\Core\Utility\GeneralUtility\getFileAbsFileName(), TYPO3\CMS\Core\Utility\GeneralUtility\getUrl(), TYPO3\CMS\Core\Utility\GeneralUtility\isAbsPath(), TYPO3\CMS\Core\Utility\GeneralUtility\isAllowedAbsPath(), TYPO3\CMS\Core\Utility\GeneralUtility\isFirstPartOfStr(), and TYPO3\CMS\Core\Utility\GeneralUtility\resolveBackPath().

Referenced by TYPO3\CMS\Backend\Template\DocumentTemplate\setModuleTemplate().

◆ getPageInfo()

TYPO3\CMS\Backend\Template\DocumentTemplate::getPageInfo (   $pageRecord)
protected

◆ getPagePath()

TYPO3\CMS\Backend\Template\DocumentTemplate::getPagePath (   $pageRecord)
protected

Generate the page path for docheader

Parameters
array$pageRecordCurrent page
Returns
string Page path

Definition at line 2012 of file DocumentTemplate.php.

References $GLOBALS, and TYPO3\CMS\Core\Utility\GeneralUtility\fixed_lgd_cs().

Referenced by TYPO3\CMS\Backend\Template\DocumentTemplate\moduleBody().

◆ getPageRenderer()

TYPO3\CMS\Backend\Template\DocumentTemplate::getPageRenderer ( )

Gets instance of PageRenderer configured with the current language, file references and debug settings

Returns

Definition at line 407 of file DocumentTemplate.php.

References $GLOBALS, TYPO3\CMS\Backend\Template\DocumentTemplate\$pageRenderer, and TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance().

Referenced by TYPO3\CMS\Backend\Template\DocumentTemplate\__construct().

◆ getResourceHeader()

TYPO3\CMS\Backend\Template\DocumentTemplate::getResourceHeader ( \TYPO3\CMS\Core\Resource\ResourceInterface  $resource,
  $tWrap = array('', ''),
  $enableClickMenu = TRUE 
)

Like ->getHeader() but for files and folders Returns the icon with the path of the file/folder set in the alt/title attribute. Shows the name after the icon.

Parameters
\TYPO3\CMS\Core\Resource\ResourceInterface$resource
array$tWrapis an array with indexes 0 and 1 each representing HTML-tags (start/end) which will wrap the title
bool$enableClickMenuIf TRUE, render click menu code around icon image
Returns
string

Definition at line 570 of file DocumentTemplate.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\fixed_lgd_cs(), TYPO3\CMS\Backend\Utility\IconUtility\getSpriteIconForResource(), and TYPO3\CMS\Backend\Template\DocumentTemplate\wrapClickMenuOnIcon().

◆ getSkinStylesheetDirectories()

TYPO3\CMS\Backend\Template\DocumentTemplate::getSkinStylesheetDirectories ( )

◆ getTabMenu()

TYPO3\CMS\Backend\Template\DocumentTemplate::getTabMenu (   $mainParams,
  $elementName,
  $currentValue,
  $menuItems,
  $script = '',
  $addparams = '' 
)

Creates a tab menu from an array definition

Returns a tab menu for a module Requires the JS function jumpToUrl() to be available

Parameters
mixed$mainParamsis 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=...
string$elementNameit the form elements name, probably something like "SET[...]
string$currentValueis the value to be selected currently.
array$menuItemsis an array with the menu items for the selector box
string$scriptis the script to send the &id to, if empty it's automatically found
string$addparamsis additional parameters to pass to the script.
Returns
string HTML code for tab menu
Todo:
Define visibility

Definition at line 1625 of file DocumentTemplate.php.

References TYPO3\CMS\Backend\Template\DocumentTemplate\getTabMenuRaw(), and TYPO3\CMS\Core\Utility\GeneralUtility\implodeArrayForUrl().

◆ getTabMenuRaw()

TYPO3\CMS\Backend\Template\DocumentTemplate::getTabMenuRaw (   $menuItems)

Creates the HTML content for the tab menu

Parameters
array$menuItemsMenu items for tabs
Returns
string Table HTML private
Todo:
Define visibility

Definition at line 1654 of file DocumentTemplate.php.

Referenced by TYPO3\CMS\Backend\Template\DocumentTemplate\getTabMenu().

◆ getVersionSelector()

TYPO3\CMS\Backend\Template\DocumentTemplate::getVersionSelector (   $id,
  $noAction = FALSE 
)

Creates the version selector for the page id inputted. Requires the core version management extension, "version" to be loaded.

Parameters
integer$idPage id to create selector for.
boolean$noActionIf set, there will be no button for swapping page.
Returns
string

Definition at line 1825 of file DocumentTemplate.php.

References TYPO3\CMS\Core\Utility\ExtensionManagementUtility\isLoaded(), and TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance().

◆ header()

TYPO3\CMS\Backend\Template\DocumentTemplate::header (   $text)

Returns the header-bar in the top of most backend modules Closes section if open.

Parameters
string$textThe text string for the header
Returns
string HTML content
Todo:
Define visibility

Definition at line 988 of file DocumentTemplate.php.

References TYPO3\CMS\Backend\Template\DocumentTemplate\sectionEnd().

◆ icons()

TYPO3\CMS\Backend\Template\DocumentTemplate::icons (   $type,
  $styleAttribValue = '' 
)

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)

Parameters
integer$typeSee description
string$styleAttribValueValue for style attribute
Returns
string HTML image tag (if applicable)
Todo:
Define visibility

Definition at line 1337 of file DocumentTemplate.php.

References TYPO3\CMS\Backend\Utility\IconUtility\getSpriteIcon().

Referenced by TYPO3\CMS\Backend\Template\DocumentTemplate\getDynTabMenu(), and TYPO3\CMS\Backend\Template\DocumentTemplate\section().

◆ insertStylesAndJS()

TYPO3\CMS\Backend\Template\DocumentTemplate::insertStylesAndJS (   $content)

Insert post rendering document style into already rendered content This is needed for extobjbase

Parameters
string$contentstyle-content to insert.
Returns
string content with inserted styles
Todo:
Define visibility

Definition at line 1242 of file DocumentTemplate.php.

References TYPO3\CMS\Backend\Template\DocumentTemplate\$inDocStyles, and TYPO3\CMS\Backend\Template\DocumentTemplate\wrapScriptTags().

Referenced by TYPO3\CMS\Backend\Template\DocumentTemplate\render().

◆ isCMlayers()

TYPO3\CMS\Backend\Template\DocumentTemplate::isCMlayers ( )

Returns TRUE if click-menu layers can be displayed for the current user/browser Use this to test if click-menus (context sensitive menus) can and should be displayed in the backend.

Returns
boolean
Deprecated:
since TYPO3 4.7, will be removed in TYPO3 6.1 - This function makes no sense anymore
Todo:
Define visibility

Definition at line 520 of file DocumentTemplate.php.

References $GLOBALS, and TYPO3\CMS\Core\Utility\GeneralUtility\logDeprecatedFunction().

◆ issueCommand()

TYPO3\CMS\Backend\Template\DocumentTemplate::issueCommand (   $params,
  $redirectUrl = '' 
)

Returns a URL with a command to TYPO3 Core Engine (tce_db.php) See description of the API elsewhere.

Parameters
string$paramsis 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
string$redirectUrlRedirect URL if any other that ::getIndpEnv('REQUEST_URI') is wished
Returns
string URL to tce_db.php + parameters (backpath is taken from $this->backPath)
See also
::editOnClick()
Todo:
Define visibility

Definition at line 506 of file DocumentTemplate.php.

References $GLOBALS, TYPO3\CMS\Core\Utility\GeneralUtility\getIndpEnv(), and TYPO3\CMS\Backend\Utility\BackendUtility\getUrlToken().

◆ loadCshJavascript()

TYPO3\CMS\Backend\Template\DocumentTemplate::loadCshJavascript ( )
protected

This loads everything needed for the Context Sensitive Help (CSH)

Returns
void

Definition at line 1604 of file DocumentTemplate.php.

◆ loadJavascriptLib()

TYPO3\CMS\Backend\Template\DocumentTemplate::loadJavascriptLib (   $lib)

Includes a javascript library that exists in the core /typo3/ directory. The backpath is automatically applied

Parameters
string$lib,Library name. Call it with the full path like "contrib/prototype/prototype.js" to load it
Returns
void
Todo:
Define visibility

Definition at line 1561 of file DocumentTemplate.php.

Referenced by TYPO3\CMS\Backend\Template\DocumentTemplate\getContextMenuCode(), TYPO3\CMS\Backend\Template\DocumentTemplate\getDragDropCode(), TYPO3\CMS\Backend\Template\DocumentTemplate\getDynTabMenu(), and TYPO3\CMS\Backend\Template\DocumentTemplate\setModuleTemplate().

◆ makeShortcutIcon()

TYPO3\CMS\Backend\Template\DocumentTemplate::makeShortcutIcon (   $gvList,
  $setList,
  $modName,
  $motherModName = '' 
)

Returns a linked shortcut-icon which will call the shortcut frame and set a shortcut there back to the calling page/module

Parameters
string$gvListIs the list of GET variables to store (if any)
string$setListIs the list of SET[] variables to store (if any) - SET[] variables a stored in $GLOBALS["SOBE"]->MOD_SETTINGS for backend modules
string$modNameModule name string
string$motherModNameIs used to enter the "parent module name" if the module is a submodule under eg. Web>* or File>*. You can also set this value to "1" in which case the currentLoadedModule is sent to the shortcut script (so - not a fixed value!) - that is used in file_edit.php and wizard_rte.php scripts where those scripts are really running as a part of another module.
Returns
string HTML content
Todo:
Define visibility

Definition at line 613 of file DocumentTemplate.php.

References TYPO3\CMS\Backend\Template\DocumentTemplate\$backPath, $GLOBALS, TYPO3\CMS\Core\Utility\GeneralUtility\getIndpEnv(), TYPO3\CMS\Backend\Utility\IconUtility\getSpriteIcon(), TYPO3\CMS\Backend\Template\DocumentTemplate\makeShortcutUrl(), and TYPO3\CMS\Core\Utility\GeneralUtility\quoteJSvalue().

◆ makeShortcutUrl()

TYPO3\CMS\Backend\Template\DocumentTemplate::makeShortcutUrl (   $gvList,
  $setList 
)

MAKE url for storing Internal func

Parameters
string$gvListIs the list of GET variables to store (if any)
string$setListIs the list of SET[] variables to store (if any) - SET[] variables a stored in $GLOBALS["SOBE"]->MOD_SETTINGS for backend modules
Returns
string private
See also
makeShortcutIcon()
Todo:
Define visibility

Definition at line 648 of file DocumentTemplate.php.

References $GLOBALS, TYPO3\CMS\Core\Utility\GeneralUtility\_GET(), TYPO3\CMS\Core\Utility\GeneralUtility\compileSelectedGetVarsFromArray(), and TYPO3\CMS\Core\Utility\GeneralUtility\implodeArrayForUrl().

Referenced by TYPO3\CMS\Backend\Template\DocumentTemplate\makeShortcutIcon().

◆ menuTable()

TYPO3\CMS\Backend\Template\DocumentTemplate::menuTable (   $arr1,
  $arr2 = array(),
  $arr3 = array() 
)

Constructs a table with content from the $arr1, $arr2 and $arr3. Used in eg. ext/belog/mod/index.php - refer to that for examples

Parameters
array$arr1Menu elements on first level
array$arr2Secondary items
array$arr3Third-level items
Returns
string HTML content,
..
Todo:
Define visibility

Definition at line 1510 of file DocumentTemplate.php.

◆ moduleBody()

TYPO3\CMS\Backend\Template\DocumentTemplate::moduleBody (   $pageRecord = array(),
  $buttons = array(),
  $markerArray = array(),
  $subpartArray = array() 
)

Put together the various elements for the module <body> using a static HTML template

Parameters
array$pageRecordRecord of the current page, used for page path and info
array$buttonsHTML for all buttons
array$markerArrayHTML for all other markers
array$subpartArrayHTML for the subparts
Returns
string Composite HTML

Definition at line 1886 of file DocumentTemplate.php.

References $GLOBALS, TYPO3\CMS\Core\Utility\GeneralUtility\callUserFunction(), TYPO3\CMS\Backend\Template\DocumentTemplate\getDocHeaderButtons(), TYPO3\CMS\Backend\Template\DocumentTemplate\getPageInfo(), TYPO3\CMS\Backend\Template\DocumentTemplate\getPagePath(), TYPO3\CMS\Core\Html\HtmlParser\getSubpart(), TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance(), TYPO3\CMS\Core\Html\HtmlParser\substituteMarkerArray(), and TYPO3\CMS\Core\Html\HtmlParser\substituteSubpart().

◆ parseTime()

TYPO3\CMS\Backend\Template\DocumentTemplate::parseTime ( )

Returns script parsetime IF ->parseTimeFlag is set and user is "admin" Automatically outputted in page end

Returns
string HTML formated with

-tags

Todo:
Define visibility

Definition at line 742 of file DocumentTemplate.php.

◆ redirectUrls()

TYPO3\CMS\Backend\Template\DocumentTemplate::redirectUrls (   $thisLocation = '')

Returns JavaScript variables setting the returnUrl and thisScript location for use by JavaScript on the page. Used in fx. db_list.php (Web>List)

Parameters
string$thisLocationURL to "this location" / current script
Returns
string Urls are returned as JavaScript variables T3_RETURN_URL and T3_THIS_LOCATION
See also
typo3/db_list.php
Todo:
Define visibility

Definition at line 699 of file DocumentTemplate.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\_GP(), TYPO3\CMS\Core\Utility\GeneralUtility\linkThisScript(), and TYPO3\CMS\Core\Utility\GeneralUtility\sanitizeLocalUrl().

◆ render()

TYPO3\CMS\Backend\Template\DocumentTemplate::render (   $title,
  $content,
  $includeCsh = TRUE 
)

Shortcut for render the complete page of a module

Parameters
string$titlepage title
string$contentpage content
boolean$includeCshflag for including csh code
Returns
string complete page

Definition at line 973 of file DocumentTemplate.php.

References TYPO3\CMS\Backend\Template\DocumentTemplate\endPage(), TYPO3\CMS\Backend\Template\DocumentTemplate\insertStylesAndJS(), and TYPO3\CMS\Backend\Template\DocumentTemplate\startPage().

◆ renderFlashMessages()

TYPO3\CMS\Backend\Template\DocumentTemplate::renderFlashMessages ( array  $params,
\TYPO3\CMS\Core\Http\AjaxRequestHandler  $ajaxObj 
)

Renders the FlashMessages from queue and returns them as AJAX.

Parameters
array$paramsAlways empty.
\TYPO3\CMS\Core\Http\AjaxRequestHandler$ajaxObjThe AjaxRequestHandler object used to return content and set content types
Returns
void

Definition at line 1956 of file DocumentTemplate.php.

◆ rfw()

TYPO3\CMS\Backend\Template\DocumentTemplate::rfw (   $string)

red-fontwrap. Returns the string wrapped in a -tag defining the color to be red

Parameters
string$stringInput string
Returns
string Output string
Todo:
Define visibility

Definition at line 1390 of file DocumentTemplate.php.

◆ section()

TYPO3\CMS\Backend\Template\DocumentTemplate::section (   $label,
  $text,
  $nostrtoupper = FALSE,
  $sH = FALSE,
  $type = 0,
  $allowHTMLinHeader = FALSE 
)

Begins an output section and sets header and content

Parameters
string$labelThe header
string$textThe HTML-content
boolean$nostrtoupperA flag that will prevent the header from being converted to uppercase
boolean$sHDefines the type of header (if set, "<h3>" rather than the default "h4")
integer$typeThe number of an icon to show with the header (see the icon-function). -1,1,2,3
boolean$allowHTMLinHeaderIf set, HTML tags are allowed in $label (otherwise this value is by default htmlspecialchars()'ed)
Returns
string HTML content
See also
icons(), sectionHeader()
Todo:
Define visibility

Definition at line 1010 of file DocumentTemplate.php.

References TYPO3\CMS\Backend\Template\DocumentTemplate\icons(), TYPO3\CMS\Backend\Template\DocumentTemplate\sectionBegin(), and TYPO3\CMS\Backend\Template\DocumentTemplate\sectionHeader().

Referenced by TYPO3\CMS\Backend\Template\DocumentTemplate\startPage().

◆ sectionBegin()

TYPO3\CMS\Backend\Template\DocumentTemplate::sectionBegin ( )

Begins an output section. Returns the

-begin tag AND sets the ->sectionFlag TRUE (if the ->sectionFlag is not already set!) 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!
Returns
string HTML content
Todo:
Define visibility

Definition at line 1093 of file DocumentTemplate.php.

Referenced by TYPO3\CMS\Backend\Template\DocumentTemplate\section(), and TYPO3\CMS\Backend\Template\DocumentTemplate\sectionHeader().

◆ sectionEnd()

TYPO3\CMS\Backend\Template\DocumentTemplate::sectionEnd ( )

Ends and output section Returns the -end tag AND clears the ->sectionFlag (but does so only IF the sectionFlag is set - that is a section is 'open') See sectionBegin() also.

Returns
string HTML content
Todo:
Define visibility

Definition at line 1117 of file DocumentTemplate.php.

Referenced by TYPO3\CMS\Backend\Template\DocumentTemplate\divider(), and TYPO3\CMS\Backend\Template\DocumentTemplate\header().

◆ sectionHeader()

TYPO3\CMS\Backend\Template\DocumentTemplate::sectionHeader (   $label,
  $sH = FALSE,
  $addAttrib = '' 
)

Make a section header. Begins a section if not already open.

Parameters
string$labelThe label between the

or tags. (Allows HTML) boolean $sH If set, is used, otherwise string $addAttrib Additional attributes to h-tag, eg. ' class=""' string HTML content todo 889.

Definition at line 1072 of file DocumentTemplate.php.

References TYPO3\CMS\Backend\Template\DocumentTemplate\sectionBegin().

Referenced by TYPO3\CMS\Backend\Template\DocumentTemplate\section().

◆ setExtDirectStateProvider()

TYPO3\CMS\Backend\Template\DocumentTemplate::setExtDirectStateProvider ( )

Sets inclusion of StateProvider

Returns
void

Definition at line 442 of file DocumentTemplate.php.

◆ setModuleTemplate()

TYPO3\CMS\Backend\Template\DocumentTemplate::setModuleTemplate (   $filename)

Define the template for the module

Parameters
string$filenamefilename
Returns
void

Definition at line 1869 of file DocumentTemplate.php.

References TYPO3\CMS\Backend\Template\DocumentTemplate\getHtmlTemplate(), and TYPO3\CMS\Backend\Template\DocumentTemplate\loadJavascriptLib().

◆ spacer()

TYPO3\CMS\Backend\Template\DocumentTemplate::spacer (   $dist)

Returns a blank

-section with a height
Parameters
integer$distPadding-top for the div-section (should be margin-top but konqueror (3.1) doesn't like it :-(
Returns
string HTML content
Todo:
Define visibility

Definition at line 1052 of file DocumentTemplate.php.

◆ startPage()

TYPO3\CMS\Backend\Template\DocumentTemplate::startPage (   $title,
  $includeCsh = TRUE 
)

Returns page start This includes the proper header with charset, title, meta tag and beginning body-tag.

Parameters
string$titleHTML Page title for the header
boolean$includeCshflag for including CSH
Returns
string Returns the whole header section of a HTML-document based on settings in internal variables (like styles, javascript code, charset, generator and docType)
See also
endPage()
Todo:
Define visibility

Definition at line 775 of file DocumentTemplate.php.

References TYPO3\CMS\Backend\Template\DocumentTemplate\section().

Referenced by TYPO3\CMS\Backend\Template\DocumentTemplate\render().

◆ t3Button()

TYPO3\CMS\Backend\Template\DocumentTemplate::t3Button (   $onClick,
  $label 
)

Returns an <input> button with the $onClick action and $label

Parameters
string$onClickThe value of the onclick attribute of the input tag (submit type)
string$labelThe label for the button (which will be htmlspecialchar'ed)
Returns
string A <input> tag of the type "submit
Todo:
Define visibility

Definition at line 1367 of file DocumentTemplate.php.

◆ table()

TYPO3\CMS\Backend\Template\DocumentTemplate::table (   $data,
  $layout = NULL 
)

Returns a table based on the input $data

Parameters
array$dataMultidim array with first levels = rows, second levels = cells
array$layoutIf set, then this provides an alternative layout array instead of $this->tableLayout
Returns
string The HTML table.

Definition at line 1466 of file DocumentTemplate.php.

References $result, and TYPO3\CMS\Backend\Template\DocumentTemplate\$tableLayout.

◆ useCompatibilityTag()

TYPO3\CMS\Backend\Template\DocumentTemplate::useCompatibilityTag (   $useCompatibilityTag = TRUE)

Defines whether to use the X-UA-Compatible meta tag.

Parameters
boolean$useCompatibilityTagWhether to use the tag
Returns
void

Definition at line 755 of file DocumentTemplate.php.

◆ viewPageIcon()

TYPO3\CMS\Backend\Template\DocumentTemplate::viewPageIcon (   $id,
  $backPath,
  $addParams = 'hspace="3"' 
)

Makes link to page $id in frontend (view page) Returns an magnifier-glass icon which links to the frontend index.php document for viewing the page with id $id $id must be a page-uid If the BE_USER has access to Web>List then a link to that module is shown as well (with return-url)

Parameters
integer$idThe page id
string$backPathThe current "BACK_PATH" (the back relative to the typo3/ directory)
string$addParamsAdditional parameters for the image tag(s)
Returns
string HTML string with linked icon(s)
Todo:
Define visibility

Definition at line 485 of file DocumentTemplate.php.

References TYPO3\CMS\Backend\Template\DocumentTemplate\$backPath, $GLOBALS, TYPO3\CMS\Backend\Utility\BackendUtility\BEgetRootLine(), TYPO3\CMS\Core\Utility\GeneralUtility\getIndpEnv(), TYPO3\CMS\Backend\Utility\BackendUtility\getListViewLink(), TYPO3\CMS\Backend\Utility\IconUtility\skinImg(), and TYPO3\CMS\Backend\Utility\BackendUtility\viewOnClick().

Referenced by TYPO3\CMS\Backend\Template\DocumentTemplate\getHeader().

◆ wrapClickMenuOnIcon()

TYPO3\CMS\Backend\Template\DocumentTemplate::wrapClickMenuOnIcon (   $str,
  $table,
  $uid = 0,
  $listFr = TRUE,
  $addParams = '',
  $enDisItems = '',
  $returnOnClick = FALSE 
)

Makes click menu link (context sensitive menu) 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) 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)

Parameters
string$strString to be wrapped in link, typ. image tag.
string$tableTable 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
integer$uidIf icon is for database record this is the UID for the record from $table
boolean$listFrTells the top frame script that the link is coming from a "list" frame which means a frame from within the backend content frame.
string$addParamsAdditional GET parameters for the link to alt_clickmenu.php
string$enDisItemsEnable / 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.
boolean$returnOnClickIf set, will return only the onclick JavaScript, not the whole link.
Returns
string The link-wrapped input string.
Todo:
Define visibility

Definition at line 467 of file DocumentTemplate.php.

References TYPO3\CMS\Backend\Template\DocumentTemplate\$backPath, $GLOBALS, $uid, and TYPO3\CMS\Core\Utility\GeneralUtility\shortMD5().

Referenced by TYPO3\CMS\Backend\Template\DocumentTemplate\getHeader(), and TYPO3\CMS\Backend\Template\DocumentTemplate\getResourceHeader().

◆ wrapInCData()

TYPO3\CMS\Backend\Template\DocumentTemplate::wrapInCData (   $string)

Returns string wrapped in CDATA "tags" for XML / XHTML (wrap content of <script> and <style> sections in those!)

Parameters
string$stringInput string
Returns
string Output string
Todo:
Define visibility

Definition at line 1401 of file DocumentTemplate.php.

◆ wrapScriptTags()

TYPO3\CMS\Backend\Template\DocumentTemplate::wrapScriptTags (   $string,
  $linebreak = TRUE 
)

Wraps the input string in script tags. Automatic re-identing of the JS code is done by using the first line as ident reference. This is nice for identing JS code with PHP code on the same level.

Parameters
string$stringInput string
boolean$linebreakWrap script element in linebreaks? Default is TRUE.
Returns
string Output string
Todo:
Define visibility

Definition at line 1416 of file DocumentTemplate.php.

Referenced by TYPO3\CMS\Backend\Template\DocumentTemplate\insertStylesAndJS().

◆ xUaCompatible()

TYPO3\CMS\Backend\Template\DocumentTemplate::xUaCompatible (   $content = 'IE=8')

Returns X-UA-Compatible meta tag

Parameters
string$contentContent of the compatible tag (default: IE-8)
Returns
string <meta http-equiv="X-UA-Compatible" content="???">

Definition at line 1313 of file DocumentTemplate.php.

Member Data Documentation

◆ $backGroundImage

TYPO3\CMS\Backend\Template\DocumentTemplate::$backGroundImage = ''
Todo:
Define visibility

Definition at line 214 of file DocumentTemplate.php.

◆ $backPath

◆ $bgColor

TYPO3\CMS\Backend\Template\DocumentTemplate::$bgColor = '#F7F3EF'
Todo:
Define visibility

Definition at line 155 of file DocumentTemplate.php.

◆ $bgColor2

TYPO3\CMS\Backend\Template\DocumentTemplate::$bgColor2 = '#9BA1A8'
Todo:
Define visibility

Definition at line 161 of file DocumentTemplate.php.

◆ $bgColor3

TYPO3\CMS\Backend\Template\DocumentTemplate::$bgColor3 = '#F6F2E6'
Todo:
Define visibility

Definition at line 167 of file DocumentTemplate.php.

◆ $bgColor4

TYPO3\CMS\Backend\Template\DocumentTemplate::$bgColor4 = '#D9D5C9'
Todo:
Define visibility

Definition at line 173 of file DocumentTemplate.php.

◆ $bgColor5

TYPO3\CMS\Backend\Template\DocumentTemplate::$bgColor5 = '#ABBBB4'
Todo:
Define visibility

Definition at line 179 of file DocumentTemplate.php.

◆ $bgColor6

TYPO3\CMS\Backend\Template\DocumentTemplate::$bgColor6 = '#E7DBA8'
Todo:
Define visibility

Definition at line 185 of file DocumentTemplate.php.

◆ $bodyTagAdditions

TYPO3\CMS\Backend\Template\DocumentTemplate::$bodyTagAdditions = ''
Todo:
Define visibility

Definition at line 123 of file DocumentTemplate.php.

◆ $bodyTagId

TYPO3\CMS\Backend\Template\DocumentTemplate::$bodyTagId = ''
Todo:
Define visibility

Definition at line 117 of file DocumentTemplate.php.

◆ $charset

TYPO3\CMS\Backend\Template\DocumentTemplate::$charset = 'utf-8'
protected

internal character set, nowadays utf-8 for everything

Definition at line 277 of file DocumentTemplate.php.

◆ $divClass

TYPO3\CMS\Backend\Template\DocumentTemplate::$divClass = ''
Todo:
Define visibility

Definition at line 289 of file DocumentTemplate.php.

◆ $docType

TYPO3\CMS\Backend\Template\DocumentTemplate::$docType = ''
Todo:
Define visibility

Definition at line 95 of file DocumentTemplate.php.

◆ $endJS

TYPO3\CMS\Backend\Template\DocumentTemplate::$endJS = 1
Todo:
Define visibility

Definition at line 147 of file DocumentTemplate.php.

◆ $endOfPageJsBlock

TYPO3\CMS\Backend\Template\DocumentTemplate::$endOfPageJsBlock = ''
Todo:
Define visibility

Definition at line 299 of file DocumentTemplate.php.

◆ $extDirectStateProvider

TYPO3\CMS\Backend\Template\DocumentTemplate::$extDirectStateProvider = FALSE
protected

Definition at line 314 of file DocumentTemplate.php.

◆ $extJScode

TYPO3\CMS\Backend\Template\DocumentTemplate::$extJScode = ''
Todo:
Define visibility

Definition at line 72 of file DocumentTemplate.php.

◆ $form

TYPO3\CMS\Backend\Template\DocumentTemplate::$form = ''
Todo:
Define visibility

Definition at line 54 of file DocumentTemplate.php.

◆ $form_largeComp

TYPO3\CMS\Backend\Template\DocumentTemplate::$form_largeComp = 1.33
Todo:
Define visibility

Definition at line 141 of file DocumentTemplate.php.

◆ $hasDocheader

TYPO3\CMS\Backend\Template\DocumentTemplate::$hasDocheader = TRUE
Todo:
Define visibility

Definition at line 304 of file DocumentTemplate.php.

◆ $hoverColor

TYPO3\CMS\Backend\Template\DocumentTemplate::$hoverColor = '#254D7B'
Todo:
Define visibility

Definition at line 190 of file DocumentTemplate.php.

◆ $inDocStyles

TYPO3\CMS\Backend\Template\DocumentTemplate::$inDocStyles = ''

◆ $inDocStyles_TBEstyle

TYPO3\CMS\Backend\Template\DocumentTemplate::$inDocStyles_TBEstyle = ''
Todo:
Define visibility

Definition at line 220 of file DocumentTemplate.php.

Referenced by TYPO3\CMS\Backend\Template\DocumentTemplate\docStyle().

◆ $inDocStylesArray

TYPO3\CMS\Backend\Template\DocumentTemplate::$inDocStylesArray = array()
Todo:
Define visibility

Definition at line 135 of file DocumentTemplate.php.

◆ $JScode

TYPO3\CMS\Backend\Template\DocumentTemplate::$JScode = ''
Todo:
Define visibility

Definition at line 66 of file DocumentTemplate.php.

◆ $JScodeArray

TYPO3\CMS\Backend\Template\DocumentTemplate::$JScodeArray
Initial value:
= array('jumpToUrl' => '
function jumpToUrl(URL) {
window.location.href = URL;
return false;
}
')
Todo:
Define visibility

Definition at line 78 of file DocumentTemplate.php.

◆ $JScodeLibArray

TYPO3\CMS\Backend\Template\DocumentTemplate::$JScodeLibArray = array()
Todo:
Define visibility

Definition at line 60 of file DocumentTemplate.php.

◆ $jsFiles

TYPO3\CMS\Backend\Template\DocumentTemplate::$jsFiles
protected
Initial value:
= array(
)

Definition at line 255 of file DocumentTemplate.php.

◆ $jsFilesNoConcatenation

TYPO3\CMS\Backend\Template\DocumentTemplate::$jsFilesNoConcatenation
protected
Initial value:
= array(
'modernizr' => 'contrib/modernizr/modernizr.min.js'
)

Definition at line 263 of file DocumentTemplate.php.

◆ $moduleTemplate

TYPO3\CMS\Backend\Template\DocumentTemplate::$moduleTemplate = ''
Todo:
Define visibility

Definition at line 101 of file DocumentTemplate.php.

◆ $moduleTemplateFilename

TYPO3\CMS\Backend\Template\DocumentTemplate::$moduleTemplateFilename = ''
protected

Definition at line 104 of file DocumentTemplate.php.

◆ $pageHeaderBlock

TYPO3\CMS\Backend\Template\DocumentTemplate::$pageHeaderBlock = ''
Todo:
Define visibility

Definition at line 294 of file DocumentTemplate.php.

◆ $pageHeaderFooterTemplateFile

TYPO3\CMS\Backend\Template\DocumentTemplate::$pageHeaderFooterTemplateFile = ''
protected

Definition at line 312 of file DocumentTemplate.php.

◆ $pageRenderer

TYPO3\CMS\Backend\Template\DocumentTemplate::$pageRenderer
protected

◆ $parseTimeFlag

TYPO3\CMS\Backend\Template\DocumentTemplate::$parseTimeFlag = 0
Todo:
Define visibility

Definition at line 272 of file DocumentTemplate.php.

◆ $postCode

TYPO3\CMS\Backend\Template\DocumentTemplate::$postCode = ''
Todo:
Define visibility

Definition at line 89 of file DocumentTemplate.php.

◆ $scriptID

TYPO3\CMS\Backend\Template\DocumentTemplate::$scriptID = ''
Todo:
Define visibility

Definition at line 111 of file DocumentTemplate.php.

Referenced by TYPO3\CMS\Backend\Template\DocumentTemplate\__construct().

◆ $sectionFlag

TYPO3\CMS\Backend\Template\DocumentTemplate::$sectionFlag = 0
Todo:
Define visibility

Definition at line 283 of file DocumentTemplate.php.

◆ $showFlashMessages

boolean TYPO3\CMS\Backend\Template\DocumentTemplate::$showFlashMessages = TRUE

Whether flashmessages should be rendered or not

Definition at line 321 of file DocumentTemplate.php.

◆ $styleSheetFile

TYPO3\CMS\Backend\Template\DocumentTemplate::$styleSheetFile = ''
Todo:
Define visibility

Definition at line 196 of file DocumentTemplate.php.

◆ $styleSheetFile2

TYPO3\CMS\Backend\Template\DocumentTemplate::$styleSheetFile2 = ''
Todo:
Define visibility

Definition at line 202 of file DocumentTemplate.php.

◆ $styleSheetFile_post

TYPO3\CMS\Backend\Template\DocumentTemplate::$styleSheetFile_post = ''
Todo:
Define visibility

Definition at line 208 of file DocumentTemplate.php.

◆ $stylesheetsCore

TYPO3\CMS\Backend\Template\DocumentTemplate::$stylesheetsCore
protected
Initial value:
= array(
'structure' => 'sysext/backend/Resources/Public/Css/structure/',
'visual' => 'sysext/backend/Resources/Public/Css/visual/',
'generatedSprites' => '../typo3temp/sprites/'
)

Definition at line 238 of file DocumentTemplate.php.

◆ $stylesheetsSkins

TYPO3\CMS\Backend\Template\DocumentTemplate::$stylesheetsSkins
protected
Initial value:
= array(
'structure' => 'Resources/Public/Css/structure/',
'visual' => 'Resources/Public/Css/visual/'
)

Definition at line 245 of file DocumentTemplate.php.

Referenced by TYPO3\CMS\Backend\Template\DocumentTemplate\getSkinStylesheetDirectories().

◆ $table_TABLE

TYPO3\CMS\Backend\Template\DocumentTemplate::$table_TABLE = '<table border="0" cellspacing="0" cellpadding="0" class="typo3-dblist" id="typo3-tmpltable">'
Todo:
Define visibility

Definition at line 1455 of file DocumentTemplate.php.

◆ $table_TR

TYPO3\CMS\Backend\Template\DocumentTemplate::$table_TR = '<tr>'
Todo:
Define visibility

Definition at line 1450 of file DocumentTemplate.php.

◆ $tableLayout

TYPO3\CMS\Backend\Template\DocumentTemplate::$tableLayout
Initial value:
= array(
'defRow' => array(
'defCol' => array('<td valign="top">', '</td>')
)
)
Todo:
Define visibility

Definition at line 1441 of file DocumentTemplate.php.

Referenced by TYPO3\CMS\Backend\Template\DocumentTemplate\table().

◆ $useCompatibilityTag

TYPO3\CMS\Backend\Template\DocumentTemplate::$useCompatibilityTag = TRUE
protected

Definition at line 227 of file DocumentTemplate.php.

◆ $xUaCompatibilityVersion

TYPO3\CMS\Backend\Template\DocumentTemplate::$xUaCompatibilityVersion = 'IE=10'
protected

Definition at line 234 of file DocumentTemplate.php.

◆ STATUS_ICON_ERROR

const TYPO3\CMS\Backend\Template\DocumentTemplate::STATUS_ICON_ERROR = 3

Definition at line 323 of file DocumentTemplate.php.

◆ STATUS_ICON_NOTIFICATION

const TYPO3\CMS\Backend\Template\DocumentTemplate::STATUS_ICON_NOTIFICATION = 1

Definition at line 325 of file DocumentTemplate.php.

◆ STATUS_ICON_OK

const TYPO3\CMS\Backend\Template\DocumentTemplate::STATUS_ICON_OK = -1

Definition at line 326 of file DocumentTemplate.php.

◆ STATUS_ICON_WARNING

const TYPO3\CMS\Backend\Template\DocumentTemplate::STATUS_ICON_WARNING = 2

Definition at line 324 of file DocumentTemplate.php.