TYPO3CMS  8
 All Classes Namespaces Files Functions Variables Pages
DocumentTemplate Class Reference

Public Member Functions

 __construct ()
 
 setExtDirectStateProvider ()
 
 viewPageIcon ($id)
 
 getHeader ($table, $row, $path, $noViewPageIcon=false, $tWrap=['', ''], $enableClickMenu=true)
 
 getResourceHeader (\TYPO3\CMS\Core\Resource\ResourceInterface $resource, $tWrap=['', ''], $enableClickMenu=true)
 
 makeShortcutIcon ($gvList, $setList, $modName, $motherModName= '', $classes= '')
 
 makeShortcutUrl ($gvList, $setList)
 
 formWidth ($size=48, $textarea=false, $styleOverride= '')
 
 redirectUrls ($thisLocation= '')
 
 useCompatibilityTag ($useCompatibilityTag=true)
 
 startPage ($title)
 
 endPage ()
 
 render ($title, $content)
 
 header ($text)
 
 section ($label, $text, $nostrtoupper=false, $sH=false, $type=0, $allowHTMLinHeader=false)
 
 divider ($dist)
 
 sectionHeader ($label, $sH=false, $addAttrib= '')
 
 sectionBegin ()
 
 sectionEnd ()
 
 docBodyTagBegin ()
 
 docStyle ()
 
 addStyleSheet ($key, $href, $title= '', $relation= 'stylesheet')
 
 addStyleSheetDirectory ($path)
 
 insertStylesAndJS ($content)
 
 getSkinStylesheetDirectories ()
 
 generator ()
 
 xUaCompatible ($content= 'IE=8')
 
 icons ($type, $styleAttribValue= '')
 
 t3Button ($onClick, $label)
 
 wrapInCData ($string)
 
 wrapScriptTags ($string, $linebreak=true)
 
 funcMenu ($content, $menu)
 
 loadJavascriptLib ($lib)
 
 getContextMenuCode ()
 
 getDragDropCode ($table, $additionalJavaScriptCode= '')
 
 getTabMenu ($mainParams, $elementName, $currentValue, $menuItems, $script= '', $addparams= '')
 
 getTabMenuRaw ($menuItems)
 
 getVersionSelector ($id, $noAction=false)
 
 getHtmlTemplate ($filename)
 
 setModuleTemplate ($filename)
 
 moduleBody ($pageRecord=[], $buttons=[], $markerArray=[], $subpartArray=[])
 

Public Attributes

 $form = ''
 
 $JScode = ''
 
 $extJScode = ''
 
 $JScodeArray
 
 $postCode = ''
 
 $moduleTemplate = ''
 
 $scriptID = ''
 
 $bodyTagId = ''
 
 $bodyTagAdditions = ''
 
 $inDocStylesArray = []
 
 $form_largeComp = 1.33
 
 $styleSheetFile = ''
 
 $styleSheetFile2 = ''
 
 $styleSheetFile_post = ''
 
 $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
 

Protected Member Functions

 initPageRenderer ()
 
 getDocHeaderButtons ($buttons)
 
 getPagePath ($pageRecord)
 
 getPageInfo ($pageRecord)
 
 getBackendFavicon ()
 
 getUriForFileName ($filename)
 

Protected Attributes

 $moduleTemplateFilename = ''
 
 $useCompatibilityTag = true
 
 $xUaCompatibilityVersion = 'IE=edge'
 
 $stylesheetsSkins
 
 $jsFiles = []
 
 $jsFilesNoConcatenation = []
 
 $pageRenderer = null
 
 $pageHeaderFooterTemplateFile = ''
 
 $extDirectStateProvider = false
 
 $iconFactory
 
 $templateService
 

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.

Please refer to Inside TYPO3 for a discussion of how to use this API.

Definition at line 41 of file DocumentTemplate.php.

Constructor & Destructor Documentation

Member Function Documentation

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

Definition at line 900 of file DocumentTemplate.php.

addStyleSheetDirectory (   $path)

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

Parameters
string$pathdirectory to add
Returns
void

Definition at line 911 of file DocumentTemplate.php.

References GeneralUtility\getFileAbsFileName(), GeneralUtility\getFilesInDir(), and PathUtility\getRelativePathTo().

Referenced by DocumentTemplate\__construct().

divider (   $dist)

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

Parameters
int$distThe margin-top/-bottom of the
ruler.
Returns
string HTML content
Deprecated:
since TYPO3 CMS 8, will be removed in TYPO3 CMS 9.

Definition at line 764 of file DocumentTemplate.php.

References GeneralUtility\logDeprecatedFunction(), and DocumentTemplate\sectionEnd().

docBodyTagBegin ( )

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

Returns
string HTML body tag

Definition at line 857 of file DocumentTemplate.php.

Referenced by DocumentTemplate\startPage().

docStyle ( )

Outputting document style

Returns
string HTML style section/link tags

Definition at line 867 of file DocumentTemplate.php.

Referenced by DocumentTemplate\startPage().

endPage ( )

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

Returns
string The HTML end of a page
See also
startPage()

Definition at line 667 of file DocumentTemplate.php.

References GeneralUtility\devLog(), BackendUtility\getUpdateSignalCode(), DocumentTemplate\header(), and GeneralUtility\wrapJS().

Referenced by DocumentTemplate\render().

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
int$sizeA relative number which multiplied with approx. 10 will lead to the width in pixels
bool$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)

Definition at line 520 of file DocumentTemplate.php.

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
Deprecated:
since TYPO3 CMS 8, will be removed in TYPO3 CMS 9.

Definition at line 1111 of file DocumentTemplate.php.

References GeneralUtility\logDeprecatedFunction().

generator ( )

Returns generator meta tag

Returns
string <meta> tag with name "generator

Definition at line 981 of file DocumentTemplate.php.

Referenced by DocumentTemplate\startPage().

getBackendFavicon ( )
protected

Retrieves configured favicon for backend (with fallback)

Returns
string

Definition at line 1512 of file DocumentTemplate.php.

References $extConf, $GLOBALS, ExtensionManagementUtility\extPath(), PathUtility\getAbsoluteWebPath(), and DocumentTemplate\getUriForFileName().

Referenced by DocumentTemplate\startPage().

getContextMenuCode ( )

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

Returns
void
Deprecated:
since TYPO3 v8, will be removed in TYPO3 v9

Definition at line 1142 of file DocumentTemplate.php.

References GeneralUtility\logDeprecatedFunction().

getDocHeaderButtons (   $buttons)
protected

Fill the button lists with the defined HTML

Parameters
array$buttonsHTML for all buttons
Returns
array Containing HTML for both buttonlists

Definition at line 1400 of file DocumentTemplate.php.

References $GLOBALS, and GeneralUtility\callUserFunction().

Referenced by DocumentTemplate\moduleBody().

getDragDropCode (   $table,
  $additionalJavaScriptCode = '' 
)

Includes the necessary javascript file for use on pages which have the drag and drop functionality (legacy folder tree)

Parameters
string$tableindicator of which table the drag and drop function should work on (pages or folders)
string$additionalJavaScriptCodeadds more code to the additional javascript code
Returns
void
Deprecated:
since TYPO3 CMS 8, will be removed in TYPO3 CMS 9.

Definition at line 1158 of file DocumentTemplate.php.

References GeneralUtility\logDeprecatedFunction().

getHeader (   $table,
  $row,
  $path,
  $noViewPageIcon = false,
  $tWrap = ['',
'']  ,
  $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
bool$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
Deprecated:
since TYPO3 v8, will be removed in TYPO3 v9

Definition at line 397 of file DocumentTemplate.php.

References $GLOBALS, BackendUtility\getRecordTitle(), GeneralUtility\logDeprecatedFunction(), Icon\SIZE_SMALL, DocumentTemplate\viewPageIcon(), and BackendUtility\wrapClickMenuOnIcon().

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

Definition at line 1263 of file DocumentTemplate.php.

References $GLOBALS, GeneralUtility\getFileAbsFileName(), GeneralUtility\isAbsPath(), GeneralUtility\isAllowedAbsPath(), GeneralUtility\isFirstPartOfStr(), and GeneralUtility\resolveBackPath().

Referenced by DocumentTemplate\setModuleTemplate().

getPageInfo (   $pageRecord)
protected

Setting page icon with clickmenu + uid for docheader

Parameters
array$pageRecordCurrent page
Returns
string Page info

Definition at line 1479 of file DocumentTemplate.php.

References $GLOBALS, BackendUtility\getRecordIconAltText(), BackendUtility\getRecordTitle(), Icon\SIZE_SMALL, and BackendUtility\wrapClickMenuOnIcon().

Referenced by DocumentTemplate\moduleBody().

getPagePath (   $pageRecord)
protected

Generate the page path for docheader

Parameters
array$pageRecordCurrent page
Returns
string Page path

Definition at line 1446 of file DocumentTemplate.php.

References $GLOBALS.

Referenced by DocumentTemplate\moduleBody().

getResourceHeader ( \TYPO3\CMS\Core\Resource\ResourceInterface  $resource,
  $tWrap = ['',
'']  ,
  $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
Deprecated:
since TYPO3 v8, will be removed in TYPO3 v9

Definition at line 427 of file DocumentTemplate.php.

References GeneralUtility\logDeprecatedFunction(), Icon\SIZE_SMALL, and BackendUtility\wrapClickMenuOnIcon().

getSkinStylesheetDirectories ( )

Returns an array of all stylesheet directories belonging to core and skins

Returns
array Stylesheet directories

Definition at line 944 of file DocumentTemplate.php.

References $GLOBALS, DocumentTemplate\$stylesheetsSkins, ExtensionManagementUtility\extPath(), and ExtensionManagementUtility\isLoaded().

Referenced by DocumentTemplate\__construct().

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
Deprecated:
since TYPO3 CMS 8, will be removed in TYPO3 CMS 9.

Definition at line 1182 of file DocumentTemplate.php.

References DocumentTemplate\getTabMenuRaw(), GeneralUtility\implodeArrayForUrl(), and GeneralUtility\logDeprecatedFunction().

getTabMenuRaw (   $menuItems)

Creates the HTML content for the tab menu

Parameters
array$menuItemsMenu items for tabs
Returns
string Table HTML private

Definition at line 1212 of file DocumentTemplate.php.

Referenced by DocumentTemplate\getTabMenu().

getUriForFileName (   $filename)
protected

Returns the uri of a relative reference, resolves the "EXT:" prefix (way of referring to files inside extensions) and checks that the file is inside the PATH_site of the TYPO3 installation

Parameters
string$filenameThe input filename/filepath to evaluate
Returns
string Returns the filename of $filename if valid, otherwise blank string.

Definition at line 1532 of file DocumentTemplate.php.

References PathUtility\getAbsoluteWebPath(), GeneralUtility\getFileAbsFileName(), and GeneralUtility\getIndpEnv().

Referenced by DocumentTemplate\getBackendFavicon().

getVersionSelector (   $id,
  $noAction = false 
)

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

Parameters
int$idPage id to create selector for.
bool$noActionIf set, there will be no button for swapping page.
Returns
string
Deprecated:
since TYPO3 CMS 8, will be removed in TYPO3 CMS 9.

Definition at line 1244 of file DocumentTemplate.php.

References ExtensionManagementUtility\isLoaded(), GeneralUtility\logDeprecatedFunction(), and GeneralUtility\makeInstance().

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
Deprecated:
since TYPO3 v8, will be removed in TYPO3 9

Definition at line 713 of file DocumentTemplate.php.

References GeneralUtility\logDeprecatedFunction(), and DocumentTemplate\sectionEnd().

Referenced by DocumentTemplate\endPage(), and DocumentTemplate\startPage().

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
int$typeSee description
string$styleAttribValueValue for style attribute
Returns
string HTML image tag (if applicable)
Deprecated:
since TYPO3 v8, will be removed in TYPO3 v9

Definition at line 1018 of file DocumentTemplate.php.

References GeneralUtility\logDeprecatedFunction(), and Icon\SIZE_SMALL.

Referenced by DocumentTemplate\section().

initPageRenderer ( )
protected

Initializes the page renderer object

Definition at line 311 of file DocumentTemplate.php.

References $GLOBALS, and GeneralUtility\makeInstance().

Referenced by DocumentTemplate\__construct().

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

Definition at line 928 of file DocumentTemplate.php.

References GeneralUtility\wrapJS().

Referenced by DocumentTemplate\render().

loadJavascriptLib (   $lib)

Includes a javascript library that exists in the core /typo3/ directory

Parameters
string$lib,Library name. Call it with the full path like "sysext/core/Resources/Public/JavaScript/QueryGenerator.js" to load it
Returns
void
Deprecated:
since TYPO3 v8, will be removed in TYPO3 v9

Definition at line 1130 of file DocumentTemplate.php.

References GeneralUtility\logDeprecatedFunction().

makeShortcutIcon (   $gvList,
  $setList,
  $modName,
  $motherModName = '',
  $classes = '' 
)

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 | int$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 and wizard_rte modules where those are really running as a part of another module.
string$classes
Returns
string HTML content

Definition at line 455 of file DocumentTemplate.php.

References $GLOBALS, GeneralUtility\_GET(), GeneralUtility\getIndpEnv(), DocumentTemplate\makeShortcutUrl(), GeneralUtility\quoteJSvalue(), BackendUtility\shortcutExists(), and Icon\SIZE_SMALL.

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()

Definition at line 502 of file DocumentTemplate.php.

References $GLOBALS, GeneralUtility\_GET(), GeneralUtility\compileSelectedGetVarsFromArray(), and GeneralUtility\implodeArrayForUrl().

Referenced by DocumentTemplate\makeShortcutIcon().

moduleBody (   $pageRecord = [],
  $buttons = [],
  $markerArray = [],
  $subpartArray = [] 
)

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 1305 of file DocumentTemplate.php.

References $GLOBALS, DocumentTemplate\$moduleTemplate, DocumentTemplate\$moduleTemplateFilename, GeneralUtility\callUserFunction(), DocumentTemplate\getDocHeaderButtons(), DocumentTemplate\getPageInfo(), and DocumentTemplate\getPagePath().

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

Definition at line 533 of file DocumentTemplate.php.

References GeneralUtility\_GP(), GeneralUtility\linkThisScript(), GeneralUtility\quoteJSvalue(), and GeneralUtility\sanitizeLocalUrl().

render (   $title,
  $content 
)

Shortcut for render the complete page of a module

Parameters
string$titlepage title
string$contentpage content
Returns
string complete page

Definition at line 697 of file DocumentTemplate.php.

References DocumentTemplate\endPage(), DocumentTemplate\insertStylesAndJS(), and DocumentTemplate\startPage().

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
bool$nostrtoupperA flag that will prevent the header from being converted to uppercase
bool$sHDefines the type of header (if set, "<h3>" rather than the default "h4")
int$typeThe number of an icon to show with the header (see the icon-function). -1,1,2,3
bool$allowHTMLinHeaderIf set, HTML tags are allowed in $label (otherwise this value is by default htmlspecialchars()'ed)
Returns
string HTML content
See also
icons(), sectionHeader()
Deprecated:
since TYPO3 CMS 8, will be removed in TYPO3 CMS 9.

Definition at line 737 of file DocumentTemplate.php.

References DocumentTemplate\icons(), GeneralUtility\logDeprecatedFunction(), DocumentTemplate\sectionBegin(), and DocumentTemplate\sectionHeader().

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
Deprecated:
since TYPO3 CMS 8, will be removed in TYPO3 CMS 9.

Definition at line 809 of file DocumentTemplate.php.

References GeneralUtility\logDeprecatedFunction().

Referenced by DocumentTemplate\section(), and DocumentTemplate\sectionHeader().

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
Deprecated:
since TYPO3 CMS 8, will be removed in TYPO3 CMS 9.

Definition at line 835 of file DocumentTemplate.php.

References GeneralUtility\logDeprecatedFunction().

Referenced by DocumentTemplate\divider(), and DocumentTemplate\header().

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) bool $sH If set, is used, otherwise string $addAttrib Additional attributes to h-tag, eg. ' class=""' string HTML content deprecated 19.

Definition at line 786 of file DocumentTemplate.php.

References GeneralUtility\logDeprecatedFunction(), and DocumentTemplate\sectionBegin().

Referenced by DocumentTemplate\section().

setExtDirectStateProvider ( )

Sets inclusion of StateProvider

Returns
void

Definition at line 346 of file DocumentTemplate.php.

setModuleTemplate (   $filename)

Define the template for the module

Parameters
string$filenamefilename
Returns
void

Definition at line 1290 of file DocumentTemplate.php.

References DocumentTemplate\getHtmlTemplate().

startPage (   $title)

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
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()

Definition at line 573 of file DocumentTemplate.php.

References $GLOBALS, DocumentTemplate\$pageRenderer, GeneralUtility\callUserFunction(), DocumentTemplate\docBodyTagBegin(), DocumentTemplate\docStyle(), DocumentTemplate\generator(), DocumentTemplate\getBackendFavicon(), GeneralUtility\getFileAbsFileName(), DocumentTemplate\header(), PageRenderer\PART_FOOTER, PageRenderer\PART_HEADER, DocumentTemplate\useCompatibilityTag(), and DocumentTemplate\xUaCompatible().

Referenced by DocumentTemplate\render().

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
Deprecated:
since TYPO3 v8, will be removed in TYPO3 v9

Definition at line 1050 of file DocumentTemplate.php.

References GeneralUtility\logDeprecatedFunction().

useCompatibilityTag (   $useCompatibilityTag = true)

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

Parameters
bool$useCompatibilityTagWhether to use the tag
Returns
void

Definition at line 554 of file DocumentTemplate.php.

References DocumentTemplate\$useCompatibilityTag.

Referenced by DocumentTemplate\startPage().

viewPageIcon (   $id)

Makes link to page $id in frontend (view page) Returns an 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
int$idThe page id
Returns
string HTML string with linked icon(s)
Deprecated:
since TYPO3 v8, will be removed in TYPO3 v9

Definition at line 368 of file DocumentTemplate.php.

References $GLOBALS, BackendUtility\BEgetRootLine(), GeneralUtility\getIndpEnv(), GeneralUtility\logDeprecatedFunction(), Icon\SIZE_SMALL, and BackendUtility\viewOnClick().

Referenced by DocumentTemplate\getHeader().

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
Deprecated:
since TYPO3 CMS 8, will be removed in TYPO3 CMS 9.

Definition at line 1064 of file DocumentTemplate.php.

References GeneralUtility\logDeprecatedFunction().

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
bool$linebreakWrap script element in linebreaks? Default is TRUE.
Returns
string Output string
Deprecated:
since TYPO3 v8, will be removed in TYPO3 v9, use GeneralUtility::wrapJS()

Definition at line 1081 of file DocumentTemplate.php.

References GeneralUtility\logDeprecatedFunction().

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 993 of file DocumentTemplate.php.

Referenced by DocumentTemplate\startPage().

Member Data Documentation

$bodyTagAdditions = ''

Definition at line 118 of file DocumentTemplate.php.

$bodyTagId = ''

Definition at line 111 of file DocumentTemplate.php.

$divClass = ''

Definition at line 208 of file DocumentTemplate.php.

$endOfPageJsBlock = ''

Definition at line 218 of file DocumentTemplate.php.

$extDirectStateProvider = false
protected

Definition at line 240 of file DocumentTemplate.php.

$extJScode = ''

Definition at line 64 of file DocumentTemplate.php.

$form = ''

Definition at line 50 of file DocumentTemplate.php.

$form_largeComp = 1.33

Definition at line 133 of file DocumentTemplate.php.

$hasDocheader = true

Definition at line 223 of file DocumentTemplate.php.

$iconFactory
protected

Definition at line 252 of file DocumentTemplate.php.

$inDocStylesArray = []

Definition at line 126 of file DocumentTemplate.php.

$JScode = ''

Definition at line 57 of file DocumentTemplate.php.

$JScodeArray
Initial value:
= ['jumpToUrl' => '
function jumpToUrl(URL) {
window.location.href = URL;
return false;
}
']

Definition at line 71 of file DocumentTemplate.php.

$jsFiles = []
protected

Definition at line 186 of file DocumentTemplate.php.

$jsFilesNoConcatenation = []
protected

Definition at line 193 of file DocumentTemplate.php.

$moduleTemplate = ''

Definition at line 90 of file DocumentTemplate.php.

Referenced by DocumentTemplate\moduleBody().

$moduleTemplateFilename = ''
protected

Definition at line 97 of file DocumentTemplate.php.

Referenced by DocumentTemplate\moduleBody().

$pageHeaderBlock = ''

Definition at line 213 of file DocumentTemplate.php.

$pageHeaderFooterTemplateFile = ''
protected

Definition at line 235 of file DocumentTemplate.php.

$pageRenderer = null
protected

Definition at line 228 of file DocumentTemplate.php.

Referenced by DocumentTemplate\startPage().

$postCode = ''

Definition at line 83 of file DocumentTemplate.php.

$scriptID = ''

Definition at line 104 of file DocumentTemplate.php.

Referenced by DocumentTemplate\__construct().

$sectionFlag = 0

Definition at line 201 of file DocumentTemplate.php.

bool $showFlashMessages = true

Whether flashmessages should be rendered or not

Definition at line 247 of file DocumentTemplate.php.

$styleSheetFile = ''

Definition at line 140 of file DocumentTemplate.php.

$styleSheetFile2 = ''

Definition at line 147 of file DocumentTemplate.php.

$styleSheetFile_post = ''

Definition at line 154 of file DocumentTemplate.php.

$stylesheetsSkins
protected
Initial value:
= [
'structure' => 'Resources/Public/Css/structure/'

Definition at line 176 of file DocumentTemplate.php.

Referenced by DocumentTemplate\getSkinStylesheetDirectories().

$templateService
protected

Definition at line 257 of file DocumentTemplate.php.

$useCompatibilityTag = true
protected

Definition at line 161 of file DocumentTemplate.php.

Referenced by DocumentTemplate\useCompatibilityTag().

$xUaCompatibilityVersion = 'IE=edge'
protected

Definition at line 168 of file DocumentTemplate.php.

const STATUS_ICON_ERROR = 3

Definition at line 259 of file DocumentTemplate.php.

const STATUS_ICON_NOTIFICATION = 1

Definition at line 261 of file DocumentTemplate.php.

const STATUS_ICON_OK = -1

Definition at line 262 of file DocumentTemplate.php.

const STATUS_ICON_WARNING = 2

Definition at line 260 of file DocumentTemplate.php.