TYPO3 CMS  TYPO3_6-2
TYPO3\CMS\Core\Page\PageRenderer Class Reference
Inheritance diagram for TYPO3\CMS\Core\Page\PageRenderer:
TYPO3\CMS\Core\SingletonInterface t3lib_PageRenderer

Public Member Functions

 __construct ($templateFile='', $backPath=NULL)
 
 setTitle ($title)
 
 setRenderXhtml ($enable)
 
 setXmlPrologAndDocType ($xmlPrologAndDocType)
 
 setCharSet ($charSet)
 
 setLanguage ($lang)
 
 setMetaCharsetTag ($metaCharsetTag)
 
 setHtmlTag ($htmlTag)
 
 setHeadTag ($headTag)
 
 setFavIcon ($favIcon)
 
 setIconMimeType ($iconMimeType)
 
 setBaseUrl ($baseUrl)
 
 setTemplateFile ($file)
 
 setBackPath ($backPath)
 
 setBodyContent ($content)
 
 setRequireJsPath ($path)
 
 setPrototypePath ($path)
 
 setScriptaculousPath ($path)
 
 setExtCorePath ($path)
 
 setExtJsPath ($path)
 
 setSvgPath ($path)
 
 enableMoveJsFromHeaderToFooter ()
 
 disableMoveJsFromHeaderToFooter ()
 
 enableCompressJavascript ()
 
 disableCompressJavascript ()
 
 enableCompressCss ()
 
 disableCompressCss ()
 
 enableConcatenateFiles ()
 
 disableConcatenateFiles ()
 
 enableConcatenateJavascript ()
 
 disableConcatenateJavascript ()
 
 enableConcatenateCss ()
 
 disableConcatenateCss ()
 
 enableRemoveLineBreaksFromTemplate ()
 
 disableRemoveLineBreaksFromTemplate ()
 
 enableDebugMode ()
 
 getTitle ()
 
 getCharSet ()
 
 getLanguage ()
 
 getRenderXhtml ()
 
 getHtmlTag ()
 
 getMetaCharsetTag ()
 
 getHeadTag ()
 
 getFavIcon ()
 
 getIconMimeType ()
 
 getBaseUrl ()
 
 getTemplateFile ()
 
 getMoveJsFromHeaderToFooter ()
 
 getCompressJavascript ()
 
 getCompressCss ()
 
 getConcatenateFiles ()
 
 getConcatenateJavascript ()
 
 getConcatenateCss ()
 
 getRemoveLineBreaksFromTemplate ()
 
 getBodyContent ()
 
 getPrototypePath ()
 
 getScriptaculousPath ()
 
 getExtCorePath ()
 
 getExtJsPath ()
 
 getSvgPath ()
 
 getInlineLanguageLabels ()
 
 getInlineLanguageLabelFiles ()
 
 addMetaTag ($meta)
 
 addInlineComment ($comment)
 
 addHeaderData ($data)
 
 addFooterData ($data)
 
 addJsLibrary ($name, $file, $type='text/javascript', $compress=FALSE, $forceOnTop=FALSE, $allWrap='', $excludeFromConcatenation=FALSE, $splitChar='|')
 
 addJsFooterLibrary ($name, $file, $type='text/javascript', $compress=FALSE, $forceOnTop=FALSE, $allWrap='', $excludeFromConcatenation=FALSE, $splitChar='|')
 
 addJsFile ($file, $type='text/javascript', $compress=TRUE, $forceOnTop=FALSE, $allWrap='', $excludeFromConcatenation=FALSE, $splitChar='|')
 
 addJsFooterFile ($file, $type='text/javascript', $compress=TRUE, $forceOnTop=FALSE, $allWrap='', $excludeFromConcatenation=FALSE, $splitChar='|')
 
 addJsInlineCode ($name, $block, $compress=TRUE, $forceOnTop=FALSE)
 
 addJsFooterInlineCode ($name, $block, $compress=TRUE, $forceOnTop=FALSE)
 
 addExtOnReadyCode ($block, $forceOnTop=FALSE)
 
 addCssFile ($file, $rel='stylesheet', $media='all', $title='', $compress=TRUE, $forceOnTop=FALSE, $allWrap='', $excludeFromConcatenation=FALSE, $splitChar='|')
 
 addCssLibrary ($file, $rel='stylesheet', $media='all', $title='', $compress=TRUE, $forceOnTop=FALSE, $allWrap='', $excludeFromConcatenation=FALSE, $splitChar='|')
 
 addCssInlineBlock ($name, $block, $compress=FALSE, $forceOnTop=FALSE)
 
 loadJquery ($version=NULL, $source=NULL, $namespace=self::JQUERY_NAMESPACE_DEFAULT)
 
 loadRequireJs ()
 
 addRequireJsConfiguration (array $configuration)
 
 loadRequireJsModule ($mainModuleName)
 
 loadPrototype ()
 
 loadScriptaculous ($modules='all')
 
 loadExtJS ($css=TRUE, $theme=TRUE, $adapter='')
 
 enableExtJSQuickTips ()
 
 loadExtCore ()
 
 loadSvg ()
 
 enableSvgDebug ()
 
 svgForceFlash ()
 
 enableExtJsDebug ()
 
 enableExtCoreDebug ()
 
 addInlineLanguageLabel ($key, $value)
 
 addInlineLanguageLabelArray (array $array)
 
 addInlineLanguageLabelFile ($fileRef, $selectionPrefix='', $stripFromSelectionName='', $errorMode=0)
 
 addInlineSetting ($namespace, $key, $value)
 
 addInlineSettingArray ($namespace, array $array)
 
 addBodyContent ($content)
 
 render ($part=self::PART_COMPLETE)
 
 renderPageWithUncachedObjects ($substituteHash)
 
 renderJavaScriptAndCssForProcessingOfUncachedContentObjects ($cachedPageContent, $substituteHash)
 

Public Attributes

const PART_COMPLETE = 0
 
const PART_HEADER = 1
 
const PART_FOOTER = 2
 
const EXTJS_ADAPTER_JQUERY = 'jquery'
 
const EXTJS_ADAPTER_PROTOTYPE = 'prototype'
 
const EXTJS_ADAPTER_YUI = 'yui'
 
const JQUERY_VERSION_LATEST = '1.11.0'
 
const JQUERY_NAMESPACE_NONE = 'none'
 
const JQUERY_NAMESPACE_DEFAULT = 'jQuery'
 
const JQUERY_NAMESPACE_DEFAULT_NOCONFLICT = 'defaultNoConflict'
 
 $backPath
 

Protected Member Functions

 reset ()
 
 prepareRendering ()
 
 renderJavaScriptAndCss ()
 
 getPreparedMarkerArray ($jsLibs, $jsFiles, $jsFooterFiles, $cssLibs, $cssFiles, $jsInline, $cssInline, $jsFooterInline, $jsFooterLibs, $metaTags)
 
 getPreparedMarkerArrayForPageWithUncachedObjects ($substituteHash)
 
 getTemplateForPart ($part)
 
 renderMainJavaScriptLibraries ()
 
 addAjaxUrlsToInlineSettings ()
 
 renderJqueryScriptTag ($version, $source, $namespace)
 
 renderCssLibraries ()
 
 renderCssFiles ()
 
 renderCssInline ()
 
 renderAdditionalJavaScriptLibraries ()
 
 renderJavaScriptFiles ()
 
 renderInlineJavaScript ()
 
 includeLanguageFileForInline ($fileRef, $selectionPrefix='', $stripFromSelectionName='', $errorMode=0)
 
 readLLfile ($fileRef, $errorMode=0)
 
 doConcatenate ()
 
 doConcatenateJavaScript ()
 
 doConcatenateCss ()
 
 doCompress ()
 
 doCompressCss ()
 
 doCompressJavaScript ()
 
 getCompressor ()
 
 processJsFile ($filename)
 
 executePreRenderHook ()
 
 executeRenderPostTransformHook ()
 
 executePostRenderHook (&$jsLibs, &$jsFiles, &$jsFooterFiles, &$cssLibs, &$cssFiles, &$jsInline, &$cssInline, &$jsFooterInline, &$jsFooterLibs)
 

Protected Attributes

 $compressJavascript = FALSE
 
 $compressCss = FALSE
 
 $removeLineBreaksFromTemplate = FALSE
 
 $concatenateFiles = FALSE
 
 $concatenateJavascript = FALSE
 
 $concatenateCss = FALSE
 
 $moveJsFromHeaderToFooter = FALSE
 
 $csConvObj
 
 $locales
 
 $lang
 
 $languageDependencies = array()
 
 $compressor
 
 $jsFiles = array()
 
 $jsFooterFiles = array()
 
 $jsLibs = array()
 
 $jsFooterLibs = array()
 
 $cssFiles = array()
 
 $cssLibs = array()
 
 $title
 
 $charSet
 
 $favIcon
 
 $baseUrl
 
 $renderXhtml = TRUE
 
 $xmlPrologAndDocType = ''
 
 $metaTags = array()
 
 $inlineComments = array()
 
 $headerData = array()
 
 $footerData = array()
 
 $titleTag = '<title>|</title>'
 
 $metaCharsetTag = '<meta http-equiv="Content-Type" content="text/html; charset=|" />'
 
 $htmlTag = '<html>'
 
 $headTag = '<head>'
 
 $baseUrlTag = '<base href="|" />'
 
 $iconMimeType = ''
 
 $shortcutTag
 
 $jsInline = array()
 
 $jsFooterInline = array()
 
 $extOnReadyCode = array()
 
 $cssInline = array()
 
 $bodyContent
 
 $templateFile
 
 $jsLibraryNames = array('prototype', 'scriptaculous', 'extjs')
 
 $requireJsPath = 'contrib/requirejs/'
 
 $prototypePath = 'contrib/prototype/'
 
 $scriptaculousPath = 'contrib/scriptaculous/'
 
 $extCorePath = 'contrib/extjs/'
 
 $extJsPath = 'contrib/extjs/'
 
 $svgPath = 'contrib/websvg/'
 
 $jQueryPath = 'contrib/jquery/'
 
 $jQueryVersions = array()
 
 $availableLocalJqueryVersions
 
 $jQueryCdnUrls
 
 $addRequireJs = FALSE
 
 $requireJsConfig = array()
 
 $addPrototype = FALSE
 
 $addScriptaculous = FALSE
 
 $addScriptaculousModules = array('builder' => FALSE, 'effects' => FALSE, 'dragdrop' => FALSE, 'controls' => FALSE, 'slider' => FALSE)
 
 $addExtJS = FALSE
 
 $addExtCore = FALSE
 
 $extJSadapter = 'ext/ext-base.js'
 
 $extDirectCodeAdded = FALSE
 
 $enableExtJsDebug = FALSE
 
 $enableExtCoreDebug = FALSE
 
 $enableJqueryDebug = FALSE
 
 $extJStheme = TRUE
 
 $extJScss = TRUE
 
 $enableExtJSQuickTips = FALSE
 
 $inlineLanguageLabels = array()
 
 $inlineLanguageLabelFiles = array()
 
 $inlineSettings = array()
 
 $inlineJavascriptWrap = array()
 
 $compressError = ''
 
 $endingSlash = ''
 
 $addSvg = FALSE
 
 $enableSvgDebug = FALSE
 

Detailed Description

TYPO3 pageRender class (new in TYPO3 4.3.0) This class render the HTML of a webpage, usable for BE and FE

Author
Steffen Kamper info@.nosp@m.sk-t.nosp@m.ypo3..nosp@m.de
Kai Vogel kai.v.nosp@m.ogel.nosp@m.@spee.nosp@m.dpro.nosp@m.gs.de

Definition at line 27 of file PageRenderer.php.

Constructor & Destructor Documentation

◆ __construct()

TYPO3\CMS\Core\Page\PageRenderer::__construct (   $templateFile = '',
  $backPath = NULL 
)
Parameters
string$templateFileDeclare the used template file. Omit this parameter will use default template
string$backPathRelative path to typo3-folder. It varies for BE modules, in FE it will be typo3/

Definition at line 483 of file PageRenderer.php.

References TYPO3\CMS\Core\Page\PageRenderer\$backPath, $GLOBALS, TYPO3\CMS\Core\Page\PageRenderer\$templateFile, TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance(), and TYPO3\CMS\Core\Page\PageRenderer\reset().

Member Function Documentation

◆ addAjaxUrlsToInlineSettings()

TYPO3\CMS\Core\Page\PageRenderer::addAjaxUrlsToInlineSettings ( )
protected

Make URLs to all backend ajax handlers available as inline setting.

Definition at line 2298 of file PageRenderer.php.

References $GLOBALS, and TYPO3\CMS\Backend\Utility\BackendUtility\getAjaxUrl().

Referenced by TYPO3\CMS\Core\Page\PageRenderer\renderMainJavaScriptLibraries().

◆ addBodyContent()

TYPO3\CMS\Core\Page\PageRenderer::addBodyContent (   $content)

Adds content to body content

Parameters
string$content
Returns
void

Definition at line 1917 of file PageRenderer.php.

◆ addCssFile()

TYPO3\CMS\Core\Page\PageRenderer::addCssFile (   $file,
  $rel = 'stylesheet',
  $media = 'all',
  $title = '',
  $compress = TRUE,
  $forceOnTop = FALSE,
  $allWrap = '',
  $excludeFromConcatenation = FALSE,
  $splitChar = '|' 
)

Adds CSS file

Parameters
string$file
string$rel
string$media
string$title
boolean$compress
boolean$forceOnTop
string$allWrap
boolean$excludeFromConcatenation
string$splitCharThe char used to split the allWrap value, default is "|"
Returns
void

Definition at line 1507 of file PageRenderer.php.

References TYPO3\CMS\Core\Page\PageRenderer\$title.

◆ addCssInlineBlock()

TYPO3\CMS\Core\Page\PageRenderer::addCssInlineBlock (   $name,
  $block,
  $compress = FALSE,
  $forceOnTop = FALSE 
)

Adds CSS inline code

Parameters
string$name
string$block
boolean$compress
boolean$forceOnTop
Returns
void

Definition at line 1562 of file PageRenderer.php.

◆ addCssLibrary()

TYPO3\CMS\Core\Page\PageRenderer::addCssLibrary (   $file,
  $rel = 'stylesheet',
  $media = 'all',
  $title = '',
  $compress = TRUE,
  $forceOnTop = FALSE,
  $allWrap = '',
  $excludeFromConcatenation = FALSE,
  $splitChar = '|' 
)

Adds CSS file

Parameters
string$file
string$rel
string$media
string$title
boolean$compress
boolean$forceOnTop
string$allWrap
boolean$excludeFromConcatenation
string$splitCharThe char used to split the allWrap value, default is "|"
Returns
void

Definition at line 1537 of file PageRenderer.php.

References TYPO3\CMS\Core\Page\PageRenderer\$title.

Referenced by TYPO3\CMS\Core\Page\PageRenderer\renderMainJavaScriptLibraries().

◆ addExtOnReadyCode()

TYPO3\CMS\Core\Page\PageRenderer::addExtOnReadyCode (   $block,
  $forceOnTop = FALSE 
)

Adds Ext.onready code, which will be wrapped in Ext.onReady(function() {...});

Parameters
string$blockJavascript code
boolean$forceOnTopPosition of the javascript code (TRUE for putting it on top, default is FALSE = bottom)
Returns
void

Definition at line 1356 of file PageRenderer.php.

References $formprotection, $GLOBALS, TYPO3\CMS\Core\Page\PageRenderer\addInlineLanguageLabelArray(), TYPO3\CMS\Core\Page\PageRenderer\addJsFile(), TYPO3\CMS\Core\Page\PageRenderer\addJsInlineCode(), TYPO3\CMS\Core\FormProtection\FormProtectionFactory\get(), TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance(), TYPO3\CMS\Core\Utility\GeneralUtility\resolveBackPath(), and TYPO3_MODE.

◆ addFooterData()

TYPO3\CMS\Core\Page\PageRenderer::addFooterData (   $data)

Adds footer data

Parameters
string$dataFree header data for HTML header
Returns
void

Definition at line 1175 of file PageRenderer.php.

◆ addHeaderData()

TYPO3\CMS\Core\Page\PageRenderer::addHeaderData (   $data)

Adds header data

Parameters
string$dataFree header data for HTML header
Returns
void

Definition at line 1163 of file PageRenderer.php.

◆ addInlineComment()

TYPO3\CMS\Core\Page\PageRenderer::addInlineComment (   $comment)

Adds inline HTML comment

Parameters
string$comment
Returns
void

Definition at line 1151 of file PageRenderer.php.

◆ addInlineLanguageLabel()

TYPO3\CMS\Core\Page\PageRenderer::addInlineLanguageLabel (   $key,
  $value 
)

Adds Javascript Inline Label. This will occur in TYPO3.lang - object The label can be used in scripts with TYPO3.lang.<key> Need extJs loaded

Parameters
string$key
string$value
Returns
void

Definition at line 1819 of file PageRenderer.php.

◆ addInlineLanguageLabelArray()

TYPO3\CMS\Core\Page\PageRenderer::addInlineLanguageLabelArray ( array  $array)

Adds Javascript Inline Label Array. This will occur in TYPO3.lang - object The label can be used in scripts with TYPO3.lang.<key> Array will be merged with existing array. Need extJs loaded

Parameters
array$array
Returns
void

Definition at line 1832 of file PageRenderer.php.

Referenced by TYPO3\CMS\Core\Page\PageRenderer\addExtOnReadyCode().

◆ addInlineLanguageLabelFile()

TYPO3\CMS\Core\Page\PageRenderer::addInlineLanguageLabelFile (   $fileRef,
  $selectionPrefix = '',
  $stripFromSelectionName = '',
  $errorMode = 0 
)

Gets labels to be used in JavaScript fetched from a locallang file.

Parameters
string$fileRefInput is a file-reference (see GeneralUtility::getFileAbsFileName). That file is expected to be a 'locallang.xml' file containing a valid XML TYPO3 language structure.
string$selectionPrefixPrefix to select the correct labels (default: '')
string$stripFromSelectionNameSub-prefix to be removed from label names in the result (default: '')
integer$errorModeError mode (when file could not be found): 0 - syslog entry, 1 - do nothing, 2 - throw an exception
Returns
void

Definition at line 1845 of file PageRenderer.php.

◆ addInlineSetting()

TYPO3\CMS\Core\Page\PageRenderer::addInlineSetting (   $namespace,
  $key,
  $value 
)

Adds Javascript Inline Setting. This will occur in TYPO3.settings - object The label can be used in scripts with TYPO3.setting.<key> Need extJs loaded

Parameters
string$namespace
string$key
string$value
Returns
void

Definition at line 1867 of file PageRenderer.php.

References TYPO3\CMS\Core\Page\PageRenderer\$inlineSettings.

◆ addInlineSettingArray()

TYPO3\CMS\Core\Page\PageRenderer::addInlineSettingArray (   $namespace,
array  $array 
)

Adds Javascript Inline Setting. This will occur in TYPO3.settings - object The label can be used in scripts with TYPO3.setting.<key> Array will be merged with existing array. Need extJs loaded

Parameters
string$namespace
array$array
Returns
void

Definition at line 1894 of file PageRenderer.php.

References TYPO3\CMS\Core\Page\PageRenderer\$inlineSettings.

Referenced by TYPO3\CMS\Core\Page\PageRenderer\loadRequireJs().

◆ addJsFile()

TYPO3\CMS\Core\Page\PageRenderer::addJsFile (   $file,
  $type = 'text/javascript',
  $compress = TRUE,
  $forceOnTop = FALSE,
  $allWrap = '',
  $excludeFromConcatenation = FALSE,
  $splitChar = '|' 
)

Adds JS file

Parameters
string$fileFile name
string$typeContent Type
boolean$compress
boolean$forceOnTop
string$allWrap
boolean$excludeFromConcatenation
string$splitCharThe char used to split the allWrap value, default is "|"
Returns
void

Definition at line 1255 of file PageRenderer.php.

Referenced by TYPO3\CMS\Core\Page\PageRenderer\addExtOnReadyCode().

◆ addJsFooterFile()

TYPO3\CMS\Core\Page\PageRenderer::addJsFooterFile (   $file,
  $type = 'text/javascript',
  $compress = TRUE,
  $forceOnTop = FALSE,
  $allWrap = '',
  $excludeFromConcatenation = FALSE,
  $splitChar = '|' 
)

Adds JS file to footer

Parameters
string$fileFile name
string$typeContent Type
boolean$compress
boolean$forceOnTop
string$allWrap
boolean$excludeFromConcatenation
string$splitCharThe char used to split the allWrap value, default is "|"
Returns
void

Definition at line 1288 of file PageRenderer.php.

◆ addJsFooterInlineCode()

TYPO3\CMS\Core\Page\PageRenderer::addJsFooterInlineCode (   $name,
  $block,
  $compress = TRUE,
  $forceOnTop = FALSE 
)

Adds JS inline code to footer

Parameters
string$name
string$block
boolean$compress
boolean$forceOnTop
Returns
void

Definition at line 1338 of file PageRenderer.php.

◆ addJsFooterLibrary()

TYPO3\CMS\Core\Page\PageRenderer::addJsFooterLibrary (   $name,
  $file,
  $type = 'text/javascript',
  $compress = FALSE,
  $forceOnTop = FALSE,
  $allWrap = '',
  $excludeFromConcatenation = FALSE,
  $splitChar = '|' 
)

Adds JS Library to Footer. JS Library block is rendered on top of the Footer JS files.

Parameters
string$nameArbitrary identifier
string$fileFile name
string$typeContent Type
boolean$compressFlag if library should be compressed
boolean$forceOnTopFlag if added library should be inserted at begin of this block
string$allWrap
boolean$excludeFromConcatenation
string$splitCharThe char used to split the allWrap value, default is "|"
Returns
void

Definition at line 1225 of file PageRenderer.php.

◆ addJsInlineCode()

TYPO3\CMS\Core\Page\PageRenderer::addJsInlineCode (   $name,
  $block,
  $compress = TRUE,
  $forceOnTop = FALSE 
)

Adds JS inline code

Parameters
string$name
string$block
boolean$compress
boolean$forceOnTop
Returns
void

Definition at line 1318 of file PageRenderer.php.

Referenced by TYPO3\CMS\Core\Page\PageRenderer\addExtOnReadyCode(), and TYPO3\CMS\Core\Page\PageRenderer\loadRequireJsModule().

◆ addJsLibrary()

TYPO3\CMS\Core\Page\PageRenderer::addJsLibrary (   $name,
  $file,
  $type = 'text/javascript',
  $compress = FALSE,
  $forceOnTop = FALSE,
  $allWrap = '',
  $excludeFromConcatenation = FALSE,
  $splitChar = '|' 
)

Adds JS Library. JS Library block is rendered on top of the JS files.

Parameters
string$nameArbitrary identifier
string$fileFile name
string$typeContent Type
boolean$compressFlag if library should be compressed
boolean$forceOnTopFlag if added library should be inserted at begin of this block
string$allWrap
boolean$excludeFromConcatenation
string$splitCharThe char used to split the allWrap value, default is "|"
Returns
void

Definition at line 1194 of file PageRenderer.php.

◆ addMetaTag()

TYPO3\CMS\Core\Page\PageRenderer::addMetaTag (   $meta)

Adds meta data

Parameters
string$metaMeta data (complete metatag)
Returns
void

Definition at line 1139 of file PageRenderer.php.

Referenced by TYPO3\CMS\Core\Page\PageRenderer\svgForceFlash().

◆ addRequireJsConfiguration()

TYPO3\CMS\Core\Page\PageRenderer::addRequireJsConfiguration ( array  $configuration)

Add additional configuration to require js.

Configuration will be merged recursive with overrule.

To add another path mapping deliver the following configuration: 'paths' => array( 'EXTERN/JQUERY-UI/1.10.3' => 'contrib/jqueryui/jquery-ui-1.10.4.custom.min', ),

Author
Daniel Siepmann danie.nosp@m.l.si.nosp@m.epman.nosp@m.n@ty.nosp@m.po3.o.nosp@m.rg
Parameters
array$configurationThe configuration that will be merged with existing one.
Returns
void

Definition at line 1655 of file PageRenderer.php.

References TYPO3\CMS\Core\Utility\ArrayUtility\mergeRecursiveWithOverrule().

◆ disableCompressCss()

TYPO3\CMS\Core\Page\PageRenderer::disableCompressCss ( )

Disables compression of css

Returns
void

Definition at line 794 of file PageRenderer.php.

◆ disableCompressJavascript()

TYPO3\CMS\Core\Page\PageRenderer::disableCompressJavascript ( )

Disables compression of javascript

Returns
void

Definition at line 776 of file PageRenderer.php.

◆ disableConcatenateCss()

TYPO3\CMS\Core\Page\PageRenderer::disableConcatenateCss ( )

Disables concatenation of css files

Returns
void

Definition at line 848 of file PageRenderer.php.

◆ disableConcatenateFiles()

TYPO3\CMS\Core\Page\PageRenderer::disableConcatenateFiles ( )

Disables concatenation of js and css files

Returns
void

Definition at line 812 of file PageRenderer.php.

◆ disableConcatenateJavascript()

TYPO3\CMS\Core\Page\PageRenderer::disableConcatenateJavascript ( )

Disables concatenation of js files

Returns
void

Definition at line 830 of file PageRenderer.php.

◆ disableMoveJsFromHeaderToFooter()

TYPO3\CMS\Core\Page\PageRenderer::disableMoveJsFromHeaderToFooter ( )

Disables MoveJsFromHeaderToFooter

Returns
void

Definition at line 758 of file PageRenderer.php.

◆ disableRemoveLineBreaksFromTemplate()

TYPO3\CMS\Core\Page\PageRenderer::disableRemoveLineBreaksFromTemplate ( )

Unsets removal of all line breaks in template

Returns
void

Definition at line 866 of file PageRenderer.php.

◆ doCompress()

TYPO3\CMS\Core\Page\PageRenderer::doCompress ( )
protected

◆ doCompressCss()

TYPO3\CMS\Core\Page\PageRenderer::doCompressCss ( )
protected

Compresses CSS according to configuration.

Returns
void

Definition at line 2711 of file PageRenderer.php.

References $GLOBALS, TYPO3\CMS\Core\Utility\GeneralUtility\callUserFunction(), TYPO3\CMS\Core\Page\PageRenderer\getCompressor(), and TYPO3_MODE.

Referenced by TYPO3\CMS\Core\Page\PageRenderer\doCompress().

◆ doCompressJavaScript()

TYPO3\CMS\Core\Page\PageRenderer::doCompressJavaScript ( )
protected

◆ doConcatenate()

TYPO3\CMS\Core\Page\PageRenderer::doConcatenate ( )
protected

Concatenate files into one file registered handler

Returns
void

Definition at line 2639 of file PageRenderer.php.

References TYPO3\CMS\Core\Page\PageRenderer\doConcatenateCss(), and TYPO3\CMS\Core\Page\PageRenderer\doConcatenateJavaScript().

Referenced by TYPO3\CMS\Core\Page\PageRenderer\renderJavaScriptAndCss().

◆ doConcatenateCss()

TYPO3\CMS\Core\Page\PageRenderer::doConcatenateCss ( )
protected

Concatenate CSS files according to configuration.

Returns
void

Definition at line 2674 of file PageRenderer.php.

References $GLOBALS, TYPO3\CMS\Core\Utility\GeneralUtility\callUserFunction(), TYPO3\CMS\Core\Page\PageRenderer\getCompressor(), and TYPO3_MODE.

Referenced by TYPO3\CMS\Core\Page\PageRenderer\doConcatenate().

◆ doConcatenateJavaScript()

TYPO3\CMS\Core\Page\PageRenderer::doConcatenateJavaScript ( )
protected

Concatenate JavaScript files according to the configuration.

Returns
void

Definition at line 2649 of file PageRenderer.php.

References $GLOBALS, TYPO3\CMS\Core\Utility\GeneralUtility\callUserFunction(), TYPO3\CMS\Core\Page\PageRenderer\getCompressor(), and TYPO3_MODE.

Referenced by TYPO3\CMS\Core\Page\PageRenderer\doConcatenate().

◆ enableCompressCss()

TYPO3\CMS\Core\Page\PageRenderer::enableCompressCss ( )

Enables compression of css

Returns
void

Definition at line 785 of file PageRenderer.php.

◆ enableCompressJavascript()

TYPO3\CMS\Core\Page\PageRenderer::enableCompressJavascript ( )

Enables compression of javascript

Returns
void

Definition at line 767 of file PageRenderer.php.

◆ enableConcatenateCss()

TYPO3\CMS\Core\Page\PageRenderer::enableConcatenateCss ( )

Enables concatenation of css files

Returns
void

Definition at line 839 of file PageRenderer.php.

◆ enableConcatenateFiles()

TYPO3\CMS\Core\Page\PageRenderer::enableConcatenateFiles ( )

Enables concatenation of js and css files

Returns
void

Definition at line 803 of file PageRenderer.php.

◆ enableConcatenateJavascript()

TYPO3\CMS\Core\Page\PageRenderer::enableConcatenateJavascript ( )

Enables concatenation of js files

Returns
void

Definition at line 821 of file PageRenderer.php.

◆ enableDebugMode()

TYPO3\CMS\Core\Page\PageRenderer::enableDebugMode ( )

Enables Debug Mode This is a shortcut to switch off all compress/concatenate features to enable easier debug

Returns
void

Definition at line 876 of file PageRenderer.php.

References TYPO3\CMS\Core\Page\PageRenderer\enableExtCoreDebug(), TYPO3\CMS\Core\Page\PageRenderer\enableExtJsDebug(), and TYPO3\CMS\Core\Page\PageRenderer\enableSvgDebug().

◆ enableExtCoreDebug()

TYPO3\CMS\Core\Page\PageRenderer::enableExtCoreDebug ( )

Call this function to load debug version of ExtCore. Use this for development only

Returns
void

Definition at line 1806 of file PageRenderer.php.

Referenced by TYPO3\CMS\Core\Page\PageRenderer\enableDebugMode(), and TYPO3\CMS\Core\Page\PageRenderer\renderMainJavaScriptLibraries().

◆ enableExtJsDebug()

TYPO3\CMS\Core\Page\PageRenderer::enableExtJsDebug ( )

Call this function to load debug version of ExtJS. Use this for development only

Returns
void

Definition at line 1797 of file PageRenderer.php.

Referenced by TYPO3\CMS\Core\Page\PageRenderer\enableDebugMode(), and TYPO3\CMS\Core\Page\PageRenderer\renderMainJavaScriptLibraries().

◆ enableExtJSQuickTips()

TYPO3\CMS\Core\Page\PageRenderer::enableExtJSQuickTips ( )

Enables ExtJs QuickTips Need extJs loaded

Returns
void

Definition at line 1752 of file PageRenderer.php.

Referenced by TYPO3\CMS\Core\Page\PageRenderer\renderMainJavaScriptLibraries().

◆ enableMoveJsFromHeaderToFooter()

TYPO3\CMS\Core\Page\PageRenderer::enableMoveJsFromHeaderToFooter ( )

Enables MoveJsFromHeaderToFooter

Returns
void

Definition at line 749 of file PageRenderer.php.

◆ enableRemoveLineBreaksFromTemplate()

TYPO3\CMS\Core\Page\PageRenderer::enableRemoveLineBreaksFromTemplate ( )

Sets removal of all line breaks in template

Returns
void

Definition at line 857 of file PageRenderer.php.

◆ enableSvgDebug()

TYPO3\CMS\Core\Page\PageRenderer::enableSvgDebug ( )

Call this function to load debug version of ExtJS. Use this for development only

Returns
void

Definition at line 1779 of file PageRenderer.php.

Referenced by TYPO3\CMS\Core\Page\PageRenderer\enableDebugMode(), and TYPO3\CMS\Core\Page\PageRenderer\renderMainJavaScriptLibraries().

◆ executePostRenderHook()

TYPO3\CMS\Core\Page\PageRenderer::executePostRenderHook ( $jsLibs,
$jsFiles,
$jsFooterFiles,
$cssLibs,
$cssFiles,
$jsInline,
$cssInline,
$jsFooterInline,
$jsFooterLibs 
)
protected

◆ executePreRenderHook()

TYPO3\CMS\Core\Page\PageRenderer::executePreRenderHook ( )
protected

Execute PreRenderHook for possible manipulation

Returns
void

Definition at line 2817 of file PageRenderer.php.

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

Referenced by TYPO3\CMS\Core\Page\PageRenderer\renderJavaScriptAndCss().

◆ executeRenderPostTransformHook()

TYPO3\CMS\Core\Page\PageRenderer::executeRenderPostTransformHook ( )
protected

PostTransform for possible manipulation of concatenated and compressed files

Returns
void

Definition at line 2842 of file PageRenderer.php.

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

Referenced by TYPO3\CMS\Core\Page\PageRenderer\renderJavaScriptAndCss().

◆ getBaseUrl()

TYPO3\CMS\Core\Page\PageRenderer::getBaseUrl ( )

Gets HTML base URL

Returns
string $url

Definition at line 979 of file PageRenderer.php.

References TYPO3\CMS\Core\Page\PageRenderer\$baseUrl.

◆ getBodyContent()

TYPO3\CMS\Core\Page\PageRenderer::getBodyContent ( )

Gets content for body

Returns
string

Definition at line 1060 of file PageRenderer.php.

References TYPO3\CMS\Core\Page\PageRenderer\$bodyContent.

◆ getCharSet()

TYPO3\CMS\Core\Page\PageRenderer::getCharSet ( )

Gets the charSet

Returns
string $charSet

Definition at line 907 of file PageRenderer.php.

References TYPO3\CMS\Core\Page\PageRenderer\$charSet.

Referenced by TYPO3\CMS\Core\Page\PageRenderer\renderMainJavaScriptLibraries().

◆ getCompressCss()

TYPO3\CMS\Core\Page\PageRenderer::getCompressCss ( )

Gets compress of css

Returns
boolean

Definition at line 1015 of file PageRenderer.php.

References TYPO3\CMS\Core\Page\PageRenderer\$compressCss.

◆ getCompressJavascript()

TYPO3\CMS\Core\Page\PageRenderer::getCompressJavascript ( )

Gets compress of javascript

Returns
boolean

Definition at line 1006 of file PageRenderer.php.

References TYPO3\CMS\Core\Page\PageRenderer\$compressJavascript.

◆ getCompressor()

◆ getConcatenateCss()

TYPO3\CMS\Core\Page\PageRenderer::getConcatenateCss ( )

Gets concatenate of css files

Returns
boolean

Definition at line 1042 of file PageRenderer.php.

References TYPO3\CMS\Core\Page\PageRenderer\$concatenateCss.

◆ getConcatenateFiles()

TYPO3\CMS\Core\Page\PageRenderer::getConcatenateFiles ( )

Gets concatenate of js and css files

Returns
boolean

Definition at line 1024 of file PageRenderer.php.

References TYPO3\CMS\Core\Page\PageRenderer\$concatenateFiles.

◆ getConcatenateJavascript()

TYPO3\CMS\Core\Page\PageRenderer::getConcatenateJavascript ( )

Gets concatenate of js files

Returns
boolean

Definition at line 1033 of file PageRenderer.php.

References TYPO3\CMS\Core\Page\PageRenderer\$concatenateJavascript.

◆ getExtCorePath()

TYPO3\CMS\Core\Page\PageRenderer::getExtCorePath ( )

Gets Path for Ext Core library (relative to typo3 directory)

Returns
string

Definition at line 1087 of file PageRenderer.php.

References TYPO3\CMS\Core\Page\PageRenderer\$extCorePath.

◆ getExtJsPath()

TYPO3\CMS\Core\Page\PageRenderer::getExtJsPath ( )

Gets Path for ExtJs library (relative to typo3 directory)

Returns
string

Definition at line 1096 of file PageRenderer.php.

References TYPO3\CMS\Core\Page\PageRenderer\$extJsPath.

◆ getFavIcon()

TYPO3\CMS\Core\Page\PageRenderer::getFavIcon ( )

Gets favicon

Returns
string $favIcon

Definition at line 961 of file PageRenderer.php.

References TYPO3\CMS\Core\Page\PageRenderer\$favIcon.

◆ getHeadTag()

TYPO3\CMS\Core\Page\PageRenderer::getHeadTag ( )

Gets head tag

Returns
string $tag Head tag

Definition at line 952 of file PageRenderer.php.

References TYPO3\CMS\Core\Page\PageRenderer\$headTag.

◆ getHtmlTag()

TYPO3\CMS\Core\Page\PageRenderer::getHtmlTag ( )

Gets html tag

Returns
string $htmlTag Html tag

Definition at line 934 of file PageRenderer.php.

References TYPO3\CMS\Core\Page\PageRenderer\$htmlTag.

◆ getIconMimeType()

TYPO3\CMS\Core\Page\PageRenderer::getIconMimeType ( )

Gets icon mime type

Returns
string $iconMimeType

Definition at line 970 of file PageRenderer.php.

References TYPO3\CMS\Core\Page\PageRenderer\$iconMimeType.

◆ getInlineLanguageLabelFiles()

TYPO3\CMS\Core\Page\PageRenderer::getInlineLanguageLabelFiles ( )

Gets the inline language files

Returns
array

Definition at line 1123 of file PageRenderer.php.

References TYPO3\CMS\Core\Page\PageRenderer\$inlineLanguageLabelFiles.

◆ getInlineLanguageLabels()

TYPO3\CMS\Core\Page\PageRenderer::getInlineLanguageLabels ( )

Gets the inline language labels.

Returns
array The inline language labels

Definition at line 1114 of file PageRenderer.php.

References TYPO3\CMS\Core\Page\PageRenderer\$inlineLanguageLabels.

◆ getLanguage()

TYPO3\CMS\Core\Page\PageRenderer::getLanguage ( )

Gets the language

Returns
string $lang

Definition at line 916 of file PageRenderer.php.

References TYPO3\CMS\Core\Page\PageRenderer\$lang.

◆ getMetaCharsetTag()

TYPO3\CMS\Core\Page\PageRenderer::getMetaCharsetTag ( )

Get meta charset

Returns
string

Definition at line 943 of file PageRenderer.php.

References TYPO3\CMS\Core\Page\PageRenderer\$metaCharsetTag.

◆ getMoveJsFromHeaderToFooter()

TYPO3\CMS\Core\Page\PageRenderer::getMoveJsFromHeaderToFooter ( )

Gets MoveJsFromHeaderToFooter

Returns
boolean

Definition at line 997 of file PageRenderer.php.

References TYPO3\CMS\Core\Page\PageRenderer\$moveJsFromHeaderToFooter.

◆ getPreparedMarkerArray()

TYPO3\CMS\Core\Page\PageRenderer::getPreparedMarkerArray (   $jsLibs,
  $jsFiles,
  $jsFooterFiles,
  $cssLibs,
  $cssFiles,
  $jsInline,
  $cssInline,
  $jsFooterInline,
  $jsFooterLibs,
  $metaTags 
)
protected

Fills the marker array with the given strings and trims each value

Parameters
$jsLibsstring
$jsFilesstring
$jsFooterFilesstring
$cssLibsstring
$cssFilesstring
$jsInlinestring
$cssInlinestring
$jsFooterInlinestring
$jsFooterLibsstring
$metaTagsstring
Returns
array Marker array

Definition at line 2063 of file PageRenderer.php.

References TYPO3\CMS\Core\Page\PageRenderer\$cssFiles, TYPO3\CMS\Core\Page\PageRenderer\$cssInline, TYPO3\CMS\Core\Page\PageRenderer\$cssLibs, TYPO3\CMS\Core\Page\PageRenderer\$jsFiles, TYPO3\CMS\Core\Page\PageRenderer\$jsFooterFiles, TYPO3\CMS\Core\Page\PageRenderer\$jsFooterInline, TYPO3\CMS\Core\Page\PageRenderer\$jsFooterLibs, TYPO3\CMS\Core\Page\PageRenderer\$jsInline, TYPO3\CMS\Core\Page\PageRenderer\$jsLibs, and TYPO3\CMS\Core\Page\PageRenderer\$metaTags.

Referenced by TYPO3\CMS\Core\Page\PageRenderer\render().

◆ getPreparedMarkerArrayForPageWithUncachedObjects()

TYPO3\CMS\Core\Page\PageRenderer::getPreparedMarkerArrayForPageWithUncachedObjects (   $substituteHash)
protected

Fills the marker array with the given strings and trims each value

Parameters
string$substituteHashThe hash that is used for the placehoder markers
Returns
array Marker array

Definition at line 2097 of file PageRenderer.php.

Referenced by TYPO3\CMS\Core\Page\PageRenderer\renderPageWithUncachedObjects().

◆ getPrototypePath()

TYPO3\CMS\Core\Page\PageRenderer::getPrototypePath ( )

Gets Path for prototype library (relative to typo3 directory)

Returns
string

Definition at line 1069 of file PageRenderer.php.

References TYPO3\CMS\Core\Page\PageRenderer\$prototypePath.

◆ getRemoveLineBreaksFromTemplate()

TYPO3\CMS\Core\Page\PageRenderer::getRemoveLineBreaksFromTemplate ( )

Gets remove of empty lines from template

Returns
boolean

Definition at line 1051 of file PageRenderer.php.

References TYPO3\CMS\Core\Page\PageRenderer\$removeLineBreaksFromTemplate.

◆ getRenderXhtml()

TYPO3\CMS\Core\Page\PageRenderer::getRenderXhtml ( )

Returns rendering mode XHTML or HTML

Returns
boolean TRUE if XHTML, FALSE if HTML

Definition at line 925 of file PageRenderer.php.

References TYPO3\CMS\Core\Page\PageRenderer\$renderXhtml.

Referenced by TYPO3\CMS\Core\Page\PageRenderer\prepareRendering().

◆ getScriptaculousPath()

TYPO3\CMS\Core\Page\PageRenderer::getScriptaculousPath ( )

Gets Path for scriptaculous library (relative to typo3 directory)

Returns
string

Definition at line 1078 of file PageRenderer.php.

References TYPO3\CMS\Core\Page\PageRenderer\$scriptaculousPath.

◆ getSvgPath()

TYPO3\CMS\Core\Page\PageRenderer::getSvgPath ( )

Gets Path for SVG library (relative to typo3 directory)

Returns
string

Definition at line 1105 of file PageRenderer.php.

References TYPO3\CMS\Core\Page\PageRenderer\$svgPath.

◆ getTemplateFile()

TYPO3\CMS\Core\Page\PageRenderer::getTemplateFile ( )

Gets template file

Returns
string

Definition at line 988 of file PageRenderer.php.

References TYPO3\CMS\Core\Page\PageRenderer\$templateFile.

◆ getTemplateForPart()

TYPO3\CMS\Core\Page\PageRenderer::getTemplateForPart (   $part)
protected

◆ getTitle()

TYPO3\CMS\Core\Page\PageRenderer::getTitle ( )

Gets the title

Returns
string $title Title of webpage

Definition at line 898 of file PageRenderer.php.

References TYPO3\CMS\Core\Page\PageRenderer\$title.

◆ includeLanguageFileForInline()

TYPO3\CMS\Core\Page\PageRenderer::includeLanguageFileForInline (   $fileRef,
  $selectionPrefix = '',
  $stripFromSelectionName = '',
  $errorMode = 0 
)
protected

Include language file for inline usage

Parameters
string$fileRef
string$selectionPrefix
string$stripFromSelectionName
integer$errorMode
Returns
void
Exceptions

Definition at line 2564 of file PageRenderer.php.

References TYPO3\CMS\Core\Page\PageRenderer\readLLfile().

Referenced by TYPO3\CMS\Core\Page\PageRenderer\renderMainJavaScriptLibraries().

◆ loadExtCore()

TYPO3\CMS\Core\Page\PageRenderer::loadExtCore ( )

Call function if you need the ExtCore library

Returns
void

Definition at line 1761 of file PageRenderer.php.

◆ loadExtJS()

TYPO3\CMS\Core\Page\PageRenderer::loadExtJS (   $css = TRUE,
  $theme = TRUE,
  $adapter = '' 
)

call this function if you need the extJS library

Parameters
boolean$cssFlag, if set the ext-css will be loaded
boolean$themeFlag, if set the ext-theme "grey" will be loaded
string$adapterChoose alternative adapter, possible values: yui, prototype, jquery
Returns
void

Definition at line 1726 of file PageRenderer.php.

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

◆ loadJquery()

TYPO3\CMS\Core\Page\PageRenderer::loadJquery (   $version = NULL,
  $source = NULL,
  $namespace = self::JQUERY_NAMESPACE_DEFAULT 
)

Call this function if you need to include the jQuery library

Parameters
null | string$versionThe jQuery version that should be included, either "latest" or any available version
null | string$sourceThe location of the jQuery source, can be "local", "google", "msn", "jquery" or just an URL to your jQuery lib
string$namespaceThe namespace in which the jQuery object of the specific version should be stored.
Returns
void
Exceptions

Definition at line 1581 of file PageRenderer.php.

◆ loadPrototype()

TYPO3\CMS\Core\Page\PageRenderer::loadPrototype ( )

Call function if you need the prototype library

Returns
void

Definition at line 1688 of file PageRenderer.php.

◆ loadRequireJs()

TYPO3\CMS\Core\Page\PageRenderer::loadRequireJs ( )

Call function if you need the requireJS library this automatically adds the JavaScript path of all loaded extensions in the requireJS path option so it resolves names like TYPO3/CMS/MyExtension/MyJsFile to EXT:MyExtension/Resources/Public/JavaScript/MyJsFile.js when using requireJS

Returns
void

Definition at line 1610 of file PageRenderer.php.

References $GLOBALS, TYPO3\CMS\Core\Page\PageRenderer\addInlineSettingArray(), TYPO3\CMS\Core\Utility\GeneralUtility\getFileAbsFileName(), TYPO3\CMS\Core\Utility\ExtensionManagementUtility\getLoadedExtensionListArray(), TYPO3\CMS\Core\Utility\PathUtility\getRelativePath(), and TYPO3\CMS\Core\Utility\GeneralUtility\underscoredToUpperCamelCase().

Referenced by TYPO3\CMS\Core\Page\PageRenderer\loadRequireJsModule().

◆ loadRequireJsModule()

TYPO3\CMS\Core\Page\PageRenderer::loadRequireJsModule (   $mainModuleName)

includes a AMD-compatible JS file by resolving the ModuleName, and then requires the file via a requireJS request

this function only works for AMD-ready JS modules, used like "define('TYPO3/CMS/Backend/FormEngine..." in the JS file

TYPO3/CMS/Backend/FormEngine => "TYPO3": Vendor Name "CMS": Product Name "Backend": Extension Name "FormEngine": FileName in the Resources/Public/JavaScript folder

Parameters
$mainModuleNamemust be in the form of "TYPO3/CMS/PackageName/ModuleName" e.g. "TYPO3/CMS/Backend/FormEngine"
Returns
void

Definition at line 1674 of file PageRenderer.php.

References TYPO3\CMS\Core\Page\PageRenderer\addJsInlineCode(), and TYPO3\CMS\Core\Page\PageRenderer\loadRequireJs().

◆ loadScriptaculous()

TYPO3\CMS\Core\Page\PageRenderer::loadScriptaculous (   $modules = 'all')

Call function if you need the Scriptaculous library

Parameters
string$modulesAdd modules you need. use "all" if you need complete modules
Returns
void

Definition at line 1698 of file PageRenderer.php.

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

◆ loadSvg()

TYPO3\CMS\Core\Page\PageRenderer::loadSvg ( )

Call function if you need the SVG library

Returns
void

Definition at line 1770 of file PageRenderer.php.

◆ prepareRendering()

TYPO3\CMS\Core\Page\PageRenderer::prepareRendering ( )
protected

Remove ending slashes from static header block if the page is beeing rendered as html (not xhtml) and define property $this->endingSlash for further use

Returns
void

Definition at line 2001 of file PageRenderer.php.

References TYPO3\CMS\Core\Page\PageRenderer\getRenderXhtml().

Referenced by TYPO3\CMS\Core\Page\PageRenderer\render(), TYPO3\CMS\Core\Page\PageRenderer\renderJavaScriptAndCssForProcessingOfUncachedContentObjects(), and TYPO3\CMS\Core\Page\PageRenderer\renderPageWithUncachedObjects().

◆ processJsFile()

TYPO3\CMS\Core\Page\PageRenderer::processJsFile (   $filename)
protected

Processes a Javascript file dependent on the current context

Adds the version number for Frontend, compresses the file for Backend

Parameters
string$filenameFilename
Returns
string New filename

Definition at line 2789 of file PageRenderer.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\createVersionNumberedFilename(), TYPO3\CMS\Core\Page\PageRenderer\getCompressor(), and TYPO3_MODE.

Referenced by TYPO3\CMS\Core\Page\PageRenderer\renderMainJavaScriptLibraries().

◆ readLLfile()

TYPO3\CMS\Core\Page\PageRenderer::readLLfile (   $fileRef,
  $errorMode = 0 
)
protected

Reads a locallang file.

Parameters
string$fileRefReference to a relative filename to include.
integer$errorModeError mode (when file could not be found): 0 - syslog entry, 1 - do nothing, 2 - throw an exception
Returns
array Returns the $LOCAL_LANG array found in the file. If no array found, returns empty array.

Definition at line 2599 of file PageRenderer.php.

References TYPO3\CMS\Core\Page\PageRenderer\$lang, and TYPO3\CMS\Core\Utility\ArrayUtility\mergeRecursiveWithOverrule().

Referenced by TYPO3\CMS\Core\Page\PageRenderer\includeLanguageFileForInline().

◆ render()

◆ renderAdditionalJavaScriptLibraries()

TYPO3\CMS\Core\Page\PageRenderer::renderAdditionalJavaScriptLibraries ( )
protected

◆ renderCssFiles()

TYPO3\CMS\Core\Page\PageRenderer::renderCssFiles ( )
protected

◆ renderCssInline()

TYPO3\CMS\Core\Page\PageRenderer::renderCssInline ( )
protected

Render inline CSS

Returns
string

Definition at line 2419 of file PageRenderer.php.

References TYPO3\CMS\Core\Page\PageRenderer\$cssInline.

Referenced by TYPO3\CMS\Core\Page\PageRenderer\renderJavaScriptAndCss().

◆ renderCssLibraries()

TYPO3\CMS\Core\Page\PageRenderer::renderCssLibraries ( )
protected

◆ renderInlineJavaScript()

TYPO3\CMS\Core\Page\PageRenderer::renderInlineJavaScript ( )
protected

Render inline JavaScript

Returns
array<string> jsInline and jsFooterInline string

Definition at line 2520 of file PageRenderer.php.

References TYPO3\CMS\Core\Page\PageRenderer\$jsFooterInline, and TYPO3\CMS\Core\Page\PageRenderer\$jsInline.

Referenced by TYPO3\CMS\Core\Page\PageRenderer\renderJavaScriptAndCss().

◆ renderJavaScriptAndCss()

◆ renderJavaScriptAndCssForProcessingOfUncachedContentObjects()

TYPO3\CMS\Core\Page\PageRenderer::renderJavaScriptAndCssForProcessingOfUncachedContentObjects (   $cachedPageContent,
  $substituteHash 
)

◆ renderJavaScriptFiles()

TYPO3\CMS\Core\Page\PageRenderer::renderJavaScriptFiles ( )
protected

◆ renderJqueryScriptTag()

TYPO3\CMS\Core\Page\PageRenderer::renderJqueryScriptTag (   $version,
  $source,
  $namespace 
)
protected

Renders the HTML script tag for the given jQuery version.

Parameters
string$versionThe jQuery version that should be included, either "latest" or any available version
string$sourceThe location of the jQuery source, can be "local", "google", "msn" or "jquery
string$namespaceThe namespace in which the jQuery object of the specific version should be stored
Returns
string

Definition at line 2314 of file PageRenderer.php.

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

Referenced by TYPO3\CMS\Core\Page\PageRenderer\renderMainJavaScriptLibraries().

◆ renderMainJavaScriptLibraries()

◆ renderPageWithUncachedObjects()

TYPO3\CMS\Core\Page\PageRenderer::renderPageWithUncachedObjects (   $substituteHash)

Render the page but not the JavaScript and CSS Files

Parameters
string$substituteHashThe hash that is used for the placehoder markers private
Returns
string Content of rendered section

Definition at line 1953 of file PageRenderer.php.

References TYPO3\CMS\Core\Page\PageRenderer\getPreparedMarkerArrayForPageWithUncachedObjects(), TYPO3\CMS\Core\Page\PageRenderer\getTemplateForPart(), and TYPO3\CMS\Core\Page\PageRenderer\prepareRendering().

◆ reset()

TYPO3\CMS\Core\Page\PageRenderer::reset ( )
protected

◆ setBackPath()

TYPO3\CMS\Core\Page\PageRenderer::setBackPath (   $backPath)

Sets back path

Parameters
string$backPath
Returns
void

Definition at line 664 of file PageRenderer.php.

References TYPO3\CMS\Core\Page\PageRenderer\$backPath.

◆ setBaseUrl()

TYPO3\CMS\Core\Page\PageRenderer::setBaseUrl (   $baseUrl)

Sets HTML base URL

Parameters
string$baseUrlHTML base URL
Returns
void

Definition at line 644 of file PageRenderer.php.

References TYPO3\CMS\Core\Page\PageRenderer\$baseUrl.

◆ setBodyContent()

TYPO3\CMS\Core\Page\PageRenderer::setBodyContent (   $content)

Sets Content for Body

Parameters
string$content
Returns
void

Definition at line 674 of file PageRenderer.php.

◆ setCharSet()

TYPO3\CMS\Core\Page\PageRenderer::setCharSet (   $charSet)

Sets meta charset

Parameters
string$charSetUsed charset
Returns
void

Definition at line 565 of file PageRenderer.php.

References TYPO3\CMS\Core\Page\PageRenderer\$charSet.

◆ setExtCorePath()

TYPO3\CMS\Core\Page\PageRenderer::setExtCorePath (   $path)

Sets Path for Ext Core library (relative to typo3 directory)

Parameters
string$path
Returns
void

Definition at line 714 of file PageRenderer.php.

◆ setExtJsPath()

TYPO3\CMS\Core\Page\PageRenderer::setExtJsPath (   $path)

Sets Path for ExtJs library (relative to typo3 directory)

Parameters
string$path
Returns
void

Definition at line 724 of file PageRenderer.php.

◆ setFavIcon()

TYPO3\CMS\Core\Page\PageRenderer::setFavIcon (   $favIcon)

Sets favicon

Parameters
string$favIcon
Returns
void

Definition at line 624 of file PageRenderer.php.

References TYPO3\CMS\Core\Page\PageRenderer\$favIcon.

◆ setHeadTag()

TYPO3\CMS\Core\Page\PageRenderer::setHeadTag (   $headTag)

Sets HTML head tag

Parameters
string$headTagHTML head tag
Returns
void

Definition at line 614 of file PageRenderer.php.

References TYPO3\CMS\Core\Page\PageRenderer\$headTag.

◆ setHtmlTag()

TYPO3\CMS\Core\Page\PageRenderer::setHtmlTag (   $htmlTag)

Sets html tag

Parameters
string$htmlTagHtml tag
Returns
void

Definition at line 604 of file PageRenderer.php.

References TYPO3\CMS\Core\Page\PageRenderer\$htmlTag.

◆ setIconMimeType()

TYPO3\CMS\Core\Page\PageRenderer::setIconMimeType (   $iconMimeType)

Sets icon mime type

Parameters
string$iconMimeType
Returns
void

Definition at line 634 of file PageRenderer.php.

References TYPO3\CMS\Core\Page\PageRenderer\$iconMimeType.

◆ setLanguage()

TYPO3\CMS\Core\Page\PageRenderer::setLanguage (   $lang)

Sets language

Parameters
string$langUsed language
Returns
void

Definition at line 575 of file PageRenderer.php.

References TYPO3\CMS\Core\Page\PageRenderer\$lang.

◆ setMetaCharsetTag()

TYPO3\CMS\Core\Page\PageRenderer::setMetaCharsetTag (   $metaCharsetTag)

Set the meta charset tag

Parameters
string$metaCharsetTag
Returns
void

Definition at line 594 of file PageRenderer.php.

References TYPO3\CMS\Core\Page\PageRenderer\$metaCharsetTag.

◆ setPrototypePath()

TYPO3\CMS\Core\Page\PageRenderer::setPrototypePath (   $path)

Sets path to prototype library (relative to typo3 directory)

Parameters
string$pathPath to prototype library
Returns
void

Definition at line 694 of file PageRenderer.php.

◆ setRenderXhtml()

TYPO3\CMS\Core\Page\PageRenderer::setRenderXhtml (   $enable)

Enables/disables rendering of XHTML code

Parameters
boolean$enableEnable XHTML
Returns
void

Definition at line 545 of file PageRenderer.php.

◆ setRequireJsPath()

TYPO3\CMS\Core\Page\PageRenderer::setRequireJsPath (   $path)

Sets path to requireJS library (relative to typo3 directory)

Parameters
string$pathPath to requireJS library
Returns
void

Definition at line 684 of file PageRenderer.php.

◆ setScriptaculousPath()

TYPO3\CMS\Core\Page\PageRenderer::setScriptaculousPath (   $path)

Sets Path for scriptaculous library (relative to typo3 directory)

Parameters
string$path
Returns
void

Definition at line 704 of file PageRenderer.php.

◆ setSvgPath()

TYPO3\CMS\Core\Page\PageRenderer::setSvgPath (   $path)

Sets Path for SVG library (websvg)

Parameters
string$path
Returns
void

Definition at line 734 of file PageRenderer.php.

◆ setTemplateFile()

TYPO3\CMS\Core\Page\PageRenderer::setTemplateFile (   $file)

Sets template file

Parameters
string$file
Returns
void

Definition at line 654 of file PageRenderer.php.

◆ setTitle()

TYPO3\CMS\Core\Page\PageRenderer::setTitle (   $title)

Sets the title

Parameters
string$titletitle of webpage
Returns
void

Definition at line 535 of file PageRenderer.php.

References TYPO3\CMS\Core\Page\PageRenderer\$title.

◆ setXmlPrologAndDocType()

TYPO3\CMS\Core\Page\PageRenderer::setXmlPrologAndDocType (   $xmlPrologAndDocType)

Sets xml prolog and docType

Parameters
string$xmlPrologAndDocTypeComplete tags for xml prolog and docType
Returns
void

Definition at line 555 of file PageRenderer.php.

References TYPO3\CMS\Core\Page\PageRenderer\$xmlPrologAndDocType.

◆ svgForceFlash()

TYPO3\CMS\Core\Page\PageRenderer::svgForceFlash ( )

Call this function to force flash usage with SVG library

Returns
void

Definition at line 1788 of file PageRenderer.php.

References TYPO3\CMS\Core\Page\PageRenderer\addMetaTag().

Member Data Documentation

◆ $addExtCore

TYPO3\CMS\Core\Page\PageRenderer::$addExtCore = FALSE
protected

Definition at line 384 of file PageRenderer.php.

◆ $addExtJS

TYPO3\CMS\Core\Page\PageRenderer::$addExtJS = FALSE
protected

Definition at line 379 of file PageRenderer.php.

◆ $addPrototype

TYPO3\CMS\Core\Page\PageRenderer::$addPrototype = FALSE
protected

Definition at line 364 of file PageRenderer.php.

◆ $addRequireJs

TYPO3\CMS\Core\Page\PageRenderer::$addRequireJs = FALSE
protected

Definition at line 353 of file PageRenderer.php.

◆ $addScriptaculous

TYPO3\CMS\Core\Page\PageRenderer::$addScriptaculous = FALSE
protected

Definition at line 369 of file PageRenderer.php.

◆ $addScriptaculousModules

TYPO3\CMS\Core\Page\PageRenderer::$addScriptaculousModules = array('builder' => FALSE, 'effects' => FALSE, 'dragdrop' => FALSE, 'controls' => FALSE, 'slider' => FALSE)
protected

Definition at line 374 of file PageRenderer.php.

◆ $addSvg

TYPO3\CMS\Core\Page\PageRenderer::$addSvg = FALSE
protected

Definition at line 465 of file PageRenderer.php.

◆ $availableLocalJqueryVersions

TYPO3\CMS\Core\Page\PageRenderer::$availableLocalJqueryVersions
protected
Initial value:
= array(
'1.8.2',
'1.9.1',
self::JQUERY_VERSION_LATEST
)

Definition at line 332 of file PageRenderer.php.

◆ $backPath

TYPO3\CMS\Core\Page\PageRenderer::$backPath

◆ $baseUrl

TYPO3\CMS\Core\Page\PageRenderer::$baseUrl
protected

◆ $baseUrlTag

TYPO3\CMS\Core\Page\PageRenderer::$baseUrlTag = '<base href="|" />'
protected

Definition at line 218 of file PageRenderer.php.

◆ $bodyContent

TYPO3\CMS\Core\Page\PageRenderer::$bodyContent
protected

Definition at line 255 of file PageRenderer.php.

Referenced by TYPO3\CMS\Core\Page\PageRenderer\getBodyContent().

◆ $charSet

TYPO3\CMS\Core\Page\PageRenderer::$charSet
protected

◆ $compressCss

TYPO3\CMS\Core\Page\PageRenderer::$compressCss = FALSE
protected

Definition at line 51 of file PageRenderer.php.

Referenced by TYPO3\CMS\Core\Page\PageRenderer\getCompressCss().

◆ $compressError

TYPO3\CMS\Core\Page\PageRenderer::$compressError = ''
protected

Definition at line 451 of file PageRenderer.php.

◆ $compressJavascript

TYPO3\CMS\Core\Page\PageRenderer::$compressJavascript = FALSE
protected

◆ $compressor

TYPO3\CMS\Core\Page\PageRenderer::$compressor
protected

Definition at line 107 of file PageRenderer.php.

Referenced by TYPO3\CMS\Core\Page\PageRenderer\getCompressor().

◆ $concatenateCss

TYPO3\CMS\Core\Page\PageRenderer::$concatenateCss = FALSE
protected

Definition at line 71 of file PageRenderer.php.

Referenced by TYPO3\CMS\Core\Page\PageRenderer\getConcatenateCss().

◆ $concatenateFiles

TYPO3\CMS\Core\Page\PageRenderer::$concatenateFiles = FALSE
protected

◆ $concatenateJavascript

TYPO3\CMS\Core\Page\PageRenderer::$concatenateJavascript = FALSE
protected

◆ $csConvObj

TYPO3\CMS\Core\Page\PageRenderer::$csConvObj
protected

Definition at line 81 of file PageRenderer.php.

◆ $cssFiles

◆ $cssInline

◆ $cssLibs

◆ $enableExtCoreDebug

TYPO3\CMS\Core\Page\PageRenderer::$enableExtCoreDebug = FALSE
protected

Definition at line 404 of file PageRenderer.php.

◆ $enableExtJsDebug

TYPO3\CMS\Core\Page\PageRenderer::$enableExtJsDebug = FALSE
protected

Definition at line 399 of file PageRenderer.php.

◆ $enableExtJSQuickTips

TYPO3\CMS\Core\Page\PageRenderer::$enableExtJSQuickTips = FALSE
protected

Definition at line 424 of file PageRenderer.php.

◆ $enableJqueryDebug

TYPO3\CMS\Core\Page\PageRenderer::$enableJqueryDebug = FALSE
protected

Definition at line 409 of file PageRenderer.php.

◆ $enableSvgDebug

TYPO3\CMS\Core\Page\PageRenderer::$enableSvgDebug = FALSE
protected

Definition at line 470 of file PageRenderer.php.

◆ $endingSlash

TYPO3\CMS\Core\Page\PageRenderer::$endingSlash = ''
protected

Definition at line 458 of file PageRenderer.php.

◆ $extCorePath

TYPO3\CMS\Core\Page\PageRenderer::$extCorePath = 'contrib/extjs/'
protected

Definition at line 288 of file PageRenderer.php.

Referenced by TYPO3\CMS\Core\Page\PageRenderer\getExtCorePath().

◆ $extDirectCodeAdded

TYPO3\CMS\Core\Page\PageRenderer::$extDirectCodeAdded = FALSE
protected

Definition at line 394 of file PageRenderer.php.

◆ $extJSadapter

TYPO3\CMS\Core\Page\PageRenderer::$extJSadapter = 'ext/ext-base.js'
protected

Definition at line 389 of file PageRenderer.php.

◆ $extJScss

TYPO3\CMS\Core\Page\PageRenderer::$extJScss = TRUE
protected

Definition at line 419 of file PageRenderer.php.

◆ $extJsPath

TYPO3\CMS\Core\Page\PageRenderer::$extJsPath = 'contrib/extjs/'
protected

Definition at line 293 of file PageRenderer.php.

Referenced by TYPO3\CMS\Core\Page\PageRenderer\getExtJsPath().

◆ $extJStheme

TYPO3\CMS\Core\Page\PageRenderer::$extJStheme = TRUE
protected

Definition at line 414 of file PageRenderer.php.

◆ $extOnReadyCode

TYPO3\CMS\Core\Page\PageRenderer::$extOnReadyCode = array()
protected

Definition at line 245 of file PageRenderer.php.

◆ $favIcon

TYPO3\CMS\Core\Page\PageRenderer::$favIcon
protected

◆ $footerData

TYPO3\CMS\Core\Page\PageRenderer::$footerData = array()
protected

Definition at line 193 of file PageRenderer.php.

◆ $headerData

TYPO3\CMS\Core\Page\PageRenderer::$headerData = array()
protected

Definition at line 188 of file PageRenderer.php.

◆ $headTag

TYPO3\CMS\Core\Page\PageRenderer::$headTag = '<head>'
protected

◆ $htmlTag

TYPO3\CMS\Core\Page\PageRenderer::$htmlTag = '<html>'
protected

◆ $iconMimeType

TYPO3\CMS\Core\Page\PageRenderer::$iconMimeType = ''
protected

◆ $inlineComments

TYPO3\CMS\Core\Page\PageRenderer::$inlineComments = array()
protected

Definition at line 183 of file PageRenderer.php.

◆ $inlineJavascriptWrap

TYPO3\CMS\Core\Page\PageRenderer::$inlineJavascriptWrap = array()
protected

Definition at line 444 of file PageRenderer.php.

◆ $inlineLanguageLabelFiles

TYPO3\CMS\Core\Page\PageRenderer::$inlineLanguageLabelFiles = array()
protected

◆ $inlineLanguageLabels

TYPO3\CMS\Core\Page\PageRenderer::$inlineLanguageLabels = array()
protected

◆ $inlineSettings

◆ $jQueryCdnUrls

TYPO3\CMS\Core\Page\PageRenderer::$jQueryCdnUrls
protected
Initial value:
= array(
'google' => '//ajax.googleapis.com/ajax/libs/jquery/%1$s/jquery%2$s.js',
'msn' => '//ajax.aspnetcdn.com/ajax/jQuery/jquery-%1$s%2$s.js',
'jquery' => 'http://code.jquery.com/jquery-%1$s%2$s.js'
)

Definition at line 343 of file PageRenderer.php.

◆ $jQueryPath

TYPO3\CMS\Core\Page\PageRenderer::$jQueryPath = 'contrib/jquery/'
protected

Definition at line 305 of file PageRenderer.php.

◆ $jQueryVersions

TYPO3\CMS\Core\Page\PageRenderer::$jQueryVersions = array()
protected

Definition at line 325 of file PageRenderer.php.

◆ $jsFiles

◆ $jsFooterFiles

◆ $jsFooterInline

◆ $jsFooterLibs

◆ $jsInline

◆ $jsLibraryNames

TYPO3\CMS\Core\Page\PageRenderer::$jsLibraryNames = array('prototype', 'scriptaculous', 'extjs')
protected

Definition at line 265 of file PageRenderer.php.

◆ $jsLibs

◆ $lang

◆ $languageDependencies

TYPO3\CMS\Core\Page\PageRenderer::$languageDependencies = array()
protected

Definition at line 102 of file PageRenderer.php.

◆ $locales

TYPO3\CMS\Core\Page\PageRenderer::$locales
protected

Definition at line 86 of file PageRenderer.php.

◆ $metaCharsetTag

TYPO3\CMS\Core\Page\PageRenderer::$metaCharsetTag = '<meta http-equiv="Content-Type" content="text/html; charset=|" />'
protected

◆ $metaTags

TYPO3\CMS\Core\Page\PageRenderer::$metaTags = array()
protected

◆ $moveJsFromHeaderToFooter

TYPO3\CMS\Core\Page\PageRenderer::$moveJsFromHeaderToFooter = FALSE
protected

◆ $prototypePath

TYPO3\CMS\Core\Page\PageRenderer::$prototypePath = 'contrib/prototype/'
protected

Definition at line 278 of file PageRenderer.php.

Referenced by TYPO3\CMS\Core\Page\PageRenderer\getPrototypePath().

◆ $removeLineBreaksFromTemplate

TYPO3\CMS\Core\Page\PageRenderer::$removeLineBreaksFromTemplate = FALSE
protected

◆ $renderXhtml

TYPO3\CMS\Core\Page\PageRenderer::$renderXhtml = TRUE
protected

Definition at line 167 of file PageRenderer.php.

Referenced by TYPO3\CMS\Core\Page\PageRenderer\getRenderXhtml().

◆ $requireJsConfig

TYPO3\CMS\Core\Page\PageRenderer::$requireJsConfig = array()
protected

Definition at line 359 of file PageRenderer.php.

◆ $requireJsPath

TYPO3\CMS\Core\Page\PageRenderer::$requireJsPath = 'contrib/requirejs/'
protected

Definition at line 273 of file PageRenderer.php.

◆ $scriptaculousPath

TYPO3\CMS\Core\Page\PageRenderer::$scriptaculousPath = 'contrib/scriptaculous/'
protected

◆ $shortcutTag

TYPO3\CMS\Core\Page\PageRenderer::$shortcutTag
protected
Initial value:
= '<link rel="shortcut icon" href="%1$s"%2$s />
<link rel="icon" href="%1$s"%2$s />'

Definition at line 228 of file PageRenderer.php.

◆ $svgPath

TYPO3\CMS\Core\Page\PageRenderer::$svgPath = 'contrib/websvg/'
protected

Definition at line 298 of file PageRenderer.php.

Referenced by TYPO3\CMS\Core\Page\PageRenderer\getSvgPath().

◆ $templateFile

TYPO3\CMS\Core\Page\PageRenderer::$templateFile
protected

◆ $title

◆ $titleTag

TYPO3\CMS\Core\Page\PageRenderer::$titleTag = '<title>|</title>'
protected

Definition at line 198 of file PageRenderer.php.

◆ $xmlPrologAndDocType

TYPO3\CMS\Core\Page\PageRenderer::$xmlPrologAndDocType = ''
protected

◆ EXTJS_ADAPTER_JQUERY

const TYPO3\CMS\Core\Page\PageRenderer::EXTJS_ADAPTER_JQUERY = 'jquery'

Definition at line 34 of file PageRenderer.php.

◆ EXTJS_ADAPTER_PROTOTYPE

const TYPO3\CMS\Core\Page\PageRenderer::EXTJS_ADAPTER_PROTOTYPE = 'prototype'

Definition at line 35 of file PageRenderer.php.

◆ EXTJS_ADAPTER_YUI

const TYPO3\CMS\Core\Page\PageRenderer::EXTJS_ADAPTER_YUI = 'yui'

Definition at line 36 of file PageRenderer.php.

◆ JQUERY_NAMESPACE_DEFAULT

const TYPO3\CMS\Core\Page\PageRenderer::JQUERY_NAMESPACE_DEFAULT = 'jQuery'

Definition at line 41 of file PageRenderer.php.

◆ JQUERY_NAMESPACE_DEFAULT_NOCONFLICT

const TYPO3\CMS\Core\Page\PageRenderer::JQUERY_NAMESPACE_DEFAULT_NOCONFLICT = 'defaultNoConflict'

◆ JQUERY_NAMESPACE_NONE

const TYPO3\CMS\Core\Page\PageRenderer::JQUERY_NAMESPACE_NONE = 'none'

◆ JQUERY_VERSION_LATEST

◆ PART_COMPLETE

const TYPO3\CMS\Core\Page\PageRenderer::PART_COMPLETE = 0

◆ PART_FOOTER

const TYPO3\CMS\Core\Page\PageRenderer::PART_FOOTER = 2

◆ PART_HEADER

const TYPO3\CMS\Core\Page\PageRenderer::PART_HEADER = 1