TYPO3 API  SVNRelease
Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | Static Protected Attributes
t3lib_PageRenderer Class Reference
Inheritance diagram for t3lib_PageRenderer:
Inheritance graph
[legend]
Collaboration diagram for t3lib_PageRenderer:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 __construct ($templateFile= '', $backPath=NULL)
 setTitle ($title)
 setRenderXhtml ($enable)
 setXmlPrologAndDocType ($xmlPrologAndDocType)
 setCharSet ($charSet)
 setLanguage ($lang)
 setHtmlTag ($htmlTag)
 setHeadTag ($headTag)
 setFavIcon ($favIcon)
 setIconMimeType ($iconMimeType)
 setBaseUrl ($baseUrl)
 setTemplateFile ($file)
 setBackPath ($backPath)
 setBodyContent ($content)
 setPrototypePath ($path)
 setScriptaculousPath ($path)
 setExtCorePath ($path)
 setExtJsPath ($path)
 setSvgPath ($path)
 enableMoveJsFromHeaderToFooter ()
 disableMoveJsFromHeaderToFooter ()
 enableCompressJavascript ()
 disableCompressJavascript ()
 enableCompressCss ()
 disableCompressCss ()
 enableConcatenateFiles ()
 disableConcatenateFiles ()
 enableRemoveLineBreaksFromTemplate ()
 disableRemoveLineBreaksFromTemplate ()
 enableDebugMode ()
 getTitle ()
 getCharSet ()
 getLanguage ()
 getRenderXhtml ()
 getHtmlTag ()
 getHeadTag ()
 getFavIcon ()
 getIconMimeType ()
 getBaseUrl ()
 getTemplateFile ($file)
 getMoveJsFromHeaderToFooter ()
 getCompressJavascript ()
 getCompressCss ()
 getConcatenateFiles ()
 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= '')
 addJsFooterLibrary ($name, $file, $type= 'text/javascript', $compress=FALSE, $forceOnTop=FALSE, $allWrap= '')
 addJsFile ($file, $type= 'text/javascript', $compress=TRUE, $forceOnTop=FALSE, $allWrap= '')
 addJsFooterFile ($file, $type= 'text/javascript', $compress=TRUE, $forceOnTop=FALSE, $allWrap= '')
 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= '')
 addCssInlineBlock ($name, $block, $compress=FALSE, $forceOnTop=FALSE)
 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)

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'
 $backPath

Protected Member Functions

 reset ()
 renderJsLibraries ()
 includeLanguageFileForInline ($fileRef, $selectionPrefix= '', $stripFromSelectionName= '', $errorMode=0)
 doConcatenate ()
 doCompress ()
 getCompressor ()
 processJsFile ($filename)

Protected Attributes

 $compressJavascript = FALSE
 $compressCss = FALSE
 $removeLineBreaksFromTemplate = FALSE
 $concatenateFiles = FALSE
 $moveJsFromHeaderToFooter = FALSE
 $csConvObj
 $lang
 $compressor
 $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')
 $prototypePath = 'contrib/prototype/'
 $scriptaculousPath = 'contrib/scriptaculous/'
 $extCorePath = 'contrib/extjs/'
 $extJsPath = 'contrib/extjs/'
 $svgPath = 'contrib/websvg/'
 $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
 $extJStheme = TRUE
 $extJScss = TRUE
 $enableExtJSQuickTips = FALSE
 $inlineLanguageLabels = array()
 $inlineLanguageLabelFiles = array()
 $inlineSettings = array()
 $inlineJavascriptWrap = array()
 $compressError = ''
 $addSvg = FALSE
 $enableSvgDebug = FALSE

Static Protected Attributes

static $jsFiles = array()
static $jsFooterFiles = array()
static $jsLibs = array()
static $jsFooterLibs = array()
static $cssFiles = array()

Detailed Description

Definition at line 37 of file class.t3lib_pagerenderer.php.


Constructor & Destructor Documentation

t3lib_PageRenderer::__construct ( templateFile = '',
backPath = NULL 
)

Constructor

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/
Returns:
void

Definition at line 152 of file class.t3lib_pagerenderer.php.

References $backPath, $GLOBALS, $templateFile, t3lib_div\makeInstance(), and reset().


Member Function Documentation

t3lib_PageRenderer::addBodyContent ( content)

Adds content to body content

Parameters:
string$content
Returns:
void

Definition at line 1359 of file class.t3lib_pagerenderer.php.

References $content.

t3lib_PageRenderer::addCssFile ( file,
rel = 'stylesheet',
media = 'all',
title = '',
compress = TRUE,
forceOnTop = FALSE,
allWrap = '' 
)

Adds CSS file

Parameters:
string$file
string$rel
string$media
string$title
boolean$compress
boolean$forceOnTop
Returns:
void

Definition at line 1088 of file class.t3lib_pagerenderer.php.

References $title.

Referenced by renderJsLibraries().

t3lib_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 1112 of file class.t3lib_pagerenderer.php.

t3lib_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 931 of file class.t3lib_pagerenderer.php.

t3lib_PageRenderer::addFooterData ( data)

Adds footer data

Parameters:
string$datafree header data for HTML header
Returns:
void

Definition at line 769 of file class.t3lib_pagerenderer.php.

t3lib_PageRenderer::addHeaderData ( data)

Adds header data

Parameters:
string$datafree header data for HTML header
Returns:
void

Definition at line 757 of file class.t3lib_pagerenderer.php.

t3lib_PageRenderer::addInlineComment ( comment)

Adds inline HTML comment

Parameters:
string$comment
Returns:
void

Definition at line 745 of file class.t3lib_pagerenderer.php.

t3lib_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 1260 of file class.t3lib_pagerenderer.php.

References $value.

t3lib_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 1273 of file class.t3lib_pagerenderer.php.

t3lib_PageRenderer::addInlineLanguageLabelFile ( fileRef,
selectionPrefix = '',
stripFromSelectionName = '',
errorMode = 0 
)

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

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

Definition at line 1286 of file class.t3lib_pagerenderer.php.

t3lib_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 1309 of file class.t3lib_pagerenderer.php.

References $value.

t3lib_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 1336 of file class.t3lib_pagerenderer.php.

t3lib_PageRenderer::addJsFile ( file,
type = 'text/javascript',
compress = TRUE,
forceOnTop = FALSE,
allWrap = '' 
)

Adds JS file

Parameters:
string$file
string$type
boolean$compress
boolean$forceOnTop
string$allWrap
Returns:
void

Definition at line 843 of file class.t3lib_pagerenderer.php.

t3lib_PageRenderer::addJsFooterFile ( file,
type = 'text/javascript',
compress = TRUE,
forceOnTop = FALSE,
allWrap = '' 
)

Adds JS file to footer

Parameters:
string$file
string$type
boolean$compress
boolean$forceOnTop
Returns:
void

Definition at line 867 of file class.t3lib_pagerenderer.php.

t3lib_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 913 of file class.t3lib_pagerenderer.php.

t3lib_PageRenderer::addJsFooterLibrary ( name,
file,
type = 'text/javascript',
compress = FALSE,
forceOnTop = FALSE,
allWrap = '' 
)

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

Parameters:
string$name
string$file
string$type
boolean$compressflag if library should be compressed
boolean$forceOnTopflag if added library should be inserted at begin of this block
string$allWrap
Returns:
void

Definition at line 816 of file class.t3lib_pagerenderer.php.

t3lib_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 893 of file class.t3lib_pagerenderer.php.

t3lib_PageRenderer::addJsLibrary ( name,
file,
type = 'text/javascript',
compress = FALSE,
forceOnTop = FALSE,
allWrap = '' 
)

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

Parameters:
string$name
string$file
string$type
boolean$compressflag if library should be compressed
boolean$forceOnTopflag if added library should be inserted at begin of this block
string$allWrap
Returns:
void

Definition at line 788 of file class.t3lib_pagerenderer.php.

t3lib_PageRenderer::addMetaTag ( meta)

Adds meta data

Parameters:
string$metameta data (complete metatag)
Returns:
void

Definition at line 733 of file class.t3lib_pagerenderer.php.

Referenced by svgForceFlash().

t3lib_PageRenderer::disableCompressCss ( )

Disables compression of css

Parameters:
void
Returns:
void

Definition at line 445 of file class.t3lib_pagerenderer.php.

t3lib_PageRenderer::disableCompressJavascript ( )

Disables compression of javascript

Parameters:
void
Returns:
void

Definition at line 425 of file class.t3lib_pagerenderer.php.

t3lib_PageRenderer::disableConcatenateFiles ( )

Disables concatenation of js/css files

Parameters:
void
Returns:
void

Definition at line 465 of file class.t3lib_pagerenderer.php.

t3lib_PageRenderer::disableMoveJsFromHeaderToFooter ( )

Disables MoveJsFromHeaderToFooter

Parameters:
void
Returns:
void

Definition at line 405 of file class.t3lib_pagerenderer.php.

t3lib_PageRenderer::disableRemoveLineBreaksFromTemplate ( )

Unsets removal of all line breaks in template

Parameters:
void
Returns:
void

Definition at line 485 of file class.t3lib_pagerenderer.php.

t3lib_PageRenderer::doCompress ( ) [protected]

compress inline code

Returns:
void

Definition at line 1849 of file class.t3lib_pagerenderer.php.

References $GLOBALS, t3lib_div\callUserFunction(), getCompressor(), and t3lib_div\minifyJavaScript().

Referenced by render().

t3lib_PageRenderer::doConcatenate ( ) [protected]

concatenate files into one file registered handler

Returns:
void

Definition at line 1820 of file class.t3lib_pagerenderer.php.

References $GLOBALS, t3lib_div\callUserFunction(), and getCompressor().

Referenced by render().

t3lib_PageRenderer::enableCompressCss ( )

Enables compression of css

Parameters:
void
Returns:
void

Definition at line 435 of file class.t3lib_pagerenderer.php.

t3lib_PageRenderer::enableCompressJavascript ( )

Enables compression of javascript

Parameters:
void
Returns:
void

Definition at line 415 of file class.t3lib_pagerenderer.php.

t3lib_PageRenderer::enableConcatenateFiles ( )

Enables concatenation of js/css files

Parameters:
void
Returns:
void

Definition at line 455 of file class.t3lib_pagerenderer.php.

t3lib_PageRenderer::enableDebugMode ( )

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

Parameters:
void
Returns:
void

Definition at line 496 of file class.t3lib_pagerenderer.php.

References enableExtCoreDebug(), enableExtJsDebug(), and enableSvgDebug().

t3lib_PageRenderer::enableExtCoreDebug ( )

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

Returns:
void

Definition at line 1247 of file class.t3lib_pagerenderer.php.

Referenced by enableDebugMode(), and renderJsLibraries().

t3lib_PageRenderer::enableExtJsDebug ( )

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

Definition at line 1238 of file class.t3lib_pagerenderer.php.

Referenced by enableDebugMode(), and renderJsLibraries().

t3lib_PageRenderer::enableExtJSQuickTips ( )

Enables ExtJs QuickTips Need extJs loaded

Returns:
void

Definition at line 1195 of file class.t3lib_pagerenderer.php.

Referenced by renderJsLibraries().

t3lib_PageRenderer::enableMoveJsFromHeaderToFooter ( )

Enables MoveJsFromHeaderToFooter

Parameters:
void
Returns:
void

Definition at line 395 of file class.t3lib_pagerenderer.php.

t3lib_PageRenderer::enableRemoveLineBreaksFromTemplate ( )

Sets removal of all line breaks in template

Parameters:
void
Returns:
void

Definition at line 475 of file class.t3lib_pagerenderer.php.

t3lib_PageRenderer::enableSvgDebug ( )

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

Definition at line 1222 of file class.t3lib_pagerenderer.php.

Referenced by enableDebugMode(), and renderJsLibraries().

t3lib_PageRenderer::getBaseUrl ( )

Gets base url

Returns:
string $url

Definition at line 590 of file class.t3lib_pagerenderer.php.

t3lib_PageRenderer::getBodyContent ( )

Gets content for body

Returns:
string

Definition at line 653 of file class.t3lib_pagerenderer.php.

t3lib_PageRenderer::getCharSet ( )

Gets the charSet

Returns:
string $charSet

Definition at line 527 of file class.t3lib_pagerenderer.php.

Referenced by renderJsLibraries().

t3lib_PageRenderer::getCompressCss ( )

Gets compress of css

Returns:
boolean

Definition at line 626 of file class.t3lib_pagerenderer.php.

t3lib_PageRenderer::getCompressJavascript ( )

Gets compress of javascript

Returns:
boolean

Definition at line 617 of file class.t3lib_pagerenderer.php.

t3lib_PageRenderer::getCompressor ( ) [protected]

Returns instance of t3lib_Compressor

Returns:
t3lib_Compressor Instance of t3lib_Compressor

Definition at line 1907 of file class.t3lib_pagerenderer.php.

References t3lib_div\makeInstance().

Referenced by doCompress(), doConcatenate(), and processJsFile().

t3lib_PageRenderer::getConcatenateFiles ( )

Gets concatenate of files

Returns:
boolean

Definition at line 635 of file class.t3lib_pagerenderer.php.

t3lib_PageRenderer::getExtCorePath ( )

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

Returns:
string

Definition at line 680 of file class.t3lib_pagerenderer.php.

t3lib_PageRenderer::getExtJsPath ( )

Gets Path for ExtJs library (relative to typo3 directory)

Returns:
string

Definition at line 689 of file class.t3lib_pagerenderer.php.

t3lib_PageRenderer::getFavIcon ( )

Gets favicon

Returns:
string $favIcon

Definition at line 572 of file class.t3lib_pagerenderer.php.

t3lib_PageRenderer::getHeadTag ( )

Gets head tag

Returns:
string $tag head tag

Definition at line 563 of file class.t3lib_pagerenderer.php.

t3lib_PageRenderer::getHtmlTag ( )

Gets html tag

Returns:
string $htmlTag html tag

Definition at line 554 of file class.t3lib_pagerenderer.php.

t3lib_PageRenderer::getIconMimeType ( )

Gets icon mime type

Returns:
string $iconMimeType

Definition at line 581 of file class.t3lib_pagerenderer.php.

t3lib_PageRenderer::getInlineLanguageLabelFiles ( )

Gets the inline language files

Returns:
array

Definition at line 716 of file class.t3lib_pagerenderer.php.

t3lib_PageRenderer::getInlineLanguageLabels ( )

Gets the inline language labels.

Returns:
array The inline language labels

Definition at line 707 of file class.t3lib_pagerenderer.php.

t3lib_PageRenderer::getLanguage ( )

Gets the language

Returns:
string $lang

Definition at line 536 of file class.t3lib_pagerenderer.php.

t3lib_PageRenderer::getMoveJsFromHeaderToFooter ( )

Gets MoveJsFromHeaderToFooter

Returns:
boolean

Definition at line 608 of file class.t3lib_pagerenderer.php.

t3lib_PageRenderer::getPrototypePath ( )

Gets Path for prototype library (relative to typo3 directory)

Returns:
string

Definition at line 662 of file class.t3lib_pagerenderer.php.

t3lib_PageRenderer::getRemoveLineBreaksFromTemplate ( )

Gets remove of empty lines from template

Returns:
boolean

Definition at line 644 of file class.t3lib_pagerenderer.php.

t3lib_PageRenderer::getRenderXhtml ( )

Returns rendering mode XHTML or HTML

Returns:
boolean TRUE if XHTML, FALSE if HTML

Definition at line 545 of file class.t3lib_pagerenderer.php.

Referenced by render().

t3lib_PageRenderer::getScriptaculousPath ( )

Gets Path for scriptaculous library (relative to typo3 directory)

Returns:
string

Definition at line 671 of file class.t3lib_pagerenderer.php.

t3lib_PageRenderer::getSvgPath ( )

Gets Path for SVG library (relative to typo3 directory)

Returns:
string

Definition at line 698 of file class.t3lib_pagerenderer.php.

t3lib_PageRenderer::getTemplateFile ( file)

Gets template file

Returns:
string $file

Definition at line 599 of file class.t3lib_pagerenderer.php.

t3lib_PageRenderer::getTitle ( )

Gets the title

Returns:
string $title title of webpage

Definition at line 518 of file class.t3lib_pagerenderer.php.

t3lib_PageRenderer::includeLanguageFileForInline ( fileRef,
selectionPrefix = '',
stripFromSelectionName = '',
errorMode = 0 
) [protected]

Definition at line 1774 of file class.t3lib_pagerenderer.php.

References $value, and t3lib_div\readLLfile().

Referenced by renderJsLibraries().

t3lib_PageRenderer::loadExtCore ( )

call function if you need the ExtCore library

Returns:
void

Definition at line 1205 of file class.t3lib_pagerenderer.php.

t3lib_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 1167 of file class.t3lib_pagerenderer.php.

References t3lib_div\strtolower().

t3lib_PageRenderer::loadPrototype ( )

call function if you need the prototype library

Returns:
void

Definition at line 1129 of file class.t3lib_pagerenderer.php.

t3lib_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 1139 of file class.t3lib_pagerenderer.php.

References $value, and t3lib_div\trimExplode().

t3lib_PageRenderer::loadSvg ( )

call function if you need the SVG library

Returns:
void

Definition at line 1214 of file class.t3lib_pagerenderer.php.

t3lib_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 1922 of file class.t3lib_pagerenderer.php.

References t3lib_div\createVersionNumberedFilename(), and getCompressor().

Referenced by renderJsLibraries().

t3lib_PageRenderer::render ( part = self::PART_COMPLETE)

render the section (Header or Footer)

Parameters:
int$partsection which should be rendered: self::PART_COMPLETE, self::PART_HEADER or self::PART_FOOTER
Returns:
string content of rendered section

Definition at line 1376 of file class.t3lib_pagerenderer.php.

References $cssFiles, $cssInline, $GLOBALS, $jsFiles, $jsFooterFiles, $jsFooterInline, $jsFooterLibs, $jsInline, $jsLibs, $metaTags, $templateFile, t3lib_div\callUserFunction(), t3lib_div\createVersionNumberedFilename(), doCompress(), doConcatenate(), t3lib_div\getFileAbsFileName(), getRenderXhtml(), t3lib_div\getURL(), renderJsLibraries(), reset(), t3lib_div\resolveBackPath(), and t3lib_parsehtml\substituteMarkerArray().

t3lib_PageRenderer::renderJsLibraries ( ) [protected]

helper function for render the javascript libraries

Returns:
string content with javascript libraries

Definition at line 1625 of file class.t3lib_pagerenderer.php.

References $GLOBALS, $inlineSettings, $module, $value, addCssFile(), enableExtCoreDebug(), enableExtJsDebug(), enableExtJSQuickTips(), enableSvgDebug(), getCharSet(), includeLanguageFileForInline(), t3lib_div\locationHeaderUrl(), and processJsFile().

Referenced by render().

t3lib_PageRenderer::reset ( ) [protected]

reset all vars to initial values

Returns:
void

Definition at line 178 of file class.t3lib_pagerenderer.php.

Referenced by __construct(), and render().

t3lib_PageRenderer::setBackPath ( backPath)

Sets back path

Parameters:
string$backPath
Returns:
void

Definition at line 318 of file class.t3lib_pagerenderer.php.

References $backPath.

t3lib_PageRenderer::setBaseUrl ( baseUrl)

Sets base url

Parameters:
string$url
Returns:
void

Definition at line 298 of file class.t3lib_pagerenderer.php.

References $baseUrl.

t3lib_PageRenderer::setBodyContent ( content)

Sets Content for Body

Parameters:
string$content
Returns:
void

Definition at line 328 of file class.t3lib_pagerenderer.php.

References $content.

t3lib_PageRenderer::setCharSet ( charSet)

Sets meta charset

Parameters:
string$charSetused charset
Returns:
void

Definition at line 238 of file class.t3lib_pagerenderer.php.

References $charSet.

t3lib_PageRenderer::setExtCorePath ( path)

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

Parameters:
string$path
Returns:
void

Definition at line 358 of file class.t3lib_pagerenderer.php.

t3lib_PageRenderer::setExtJsPath ( path)

Sets Path for ExtJs library (relative to typo3 directory)

Parameters:
string$path
Returns:
void

Definition at line 368 of file class.t3lib_pagerenderer.php.

t3lib_PageRenderer::setFavIcon ( favIcon)

Sets favicon

Parameters:
string$favIcon
Returns:
void

Definition at line 278 of file class.t3lib_pagerenderer.php.

References $favIcon.

t3lib_PageRenderer::setHeadTag ( headTag)

Sets head tag

Parameters:
string$taghead tag
Returns:
void

Definition at line 268 of file class.t3lib_pagerenderer.php.

References $headTag.

t3lib_PageRenderer::setHtmlTag ( htmlTag)

Sets html tag

Parameters:
string$htmlTaghtml tag
Returns:
void

Definition at line 258 of file class.t3lib_pagerenderer.php.

References $htmlTag.

t3lib_PageRenderer::setIconMimeType ( iconMimeType)

Sets icon mime type

Parameters:
string$iconMimeType
Returns:
void

Definition at line 288 of file class.t3lib_pagerenderer.php.

References $iconMimeType.

t3lib_PageRenderer::setLanguage ( lang)

Sets language

Parameters:
string$langused language
Returns:
void

Definition at line 248 of file class.t3lib_pagerenderer.php.

References $lang.

t3lib_PageRenderer::setPrototypePath ( path)

Sets Path for prototype library (relative to typo3 directory)

Parameters:
stringpath
Returns:
void

Definition at line 338 of file class.t3lib_pagerenderer.php.

t3lib_PageRenderer::setRenderXhtml ( enable)

Enables/disables rendering of XHTML code

Parameters:
boolean$enableEnable XHTML
Returns:
void

Definition at line 218 of file class.t3lib_pagerenderer.php.

t3lib_PageRenderer::setScriptaculousPath ( path)

Sets Path for scriptaculous library (relative to typo3 directory)

Parameters:
string$path
Returns:
void

Definition at line 348 of file class.t3lib_pagerenderer.php.

t3lib_PageRenderer::setSvgPath ( path)

Sets Path for SVG library (websvg)

Parameters:
string$path
Returns:
void

Definition at line 378 of file class.t3lib_pagerenderer.php.

t3lib_PageRenderer::setTemplateFile ( file)

Sets template file

Parameters:
string$file
Returns:
void

Definition at line 308 of file class.t3lib_pagerenderer.php.

t3lib_PageRenderer::setTitle ( title)

Sets the title

Parameters:
string$titletitle of webpage
Returns:
void

Definition at line 207 of file class.t3lib_pagerenderer.php.

References $title.

t3lib_PageRenderer::setXmlPrologAndDocType ( xmlPrologAndDocType)

Sets xml prolog and docType

Parameters:
string$xmlPrologAndDocTypecomplete tags for xml prolog and docType
Returns:
void

Definition at line 228 of file class.t3lib_pagerenderer.php.

References $xmlPrologAndDocType.

t3lib_PageRenderer::svgForceFlash ( )

call this function to force flash usage with SVG library

Definition at line 1230 of file class.t3lib_pagerenderer.php.

References addMetaTag().


Member Data Documentation

t3lib_PageRenderer::$addExtCore = FALSE [protected]

Definition at line 112 of file class.t3lib_pagerenderer.php.

t3lib_PageRenderer::$addExtJS = FALSE [protected]

Definition at line 111 of file class.t3lib_pagerenderer.php.

t3lib_PageRenderer::$addPrototype = FALSE [protected]

Definition at line 108 of file class.t3lib_pagerenderer.php.

t3lib_PageRenderer::$addScriptaculous = FALSE [protected]

Definition at line 109 of file class.t3lib_pagerenderer.php.

t3lib_PageRenderer::$addScriptaculousModules = array('builder' => FALSE, 'effects' => FALSE, 'dragdrop' => FALSE, 'controls' => FALSE, 'slider' => FALSE) [protected]

Definition at line 110 of file class.t3lib_pagerenderer.php.

t3lib_PageRenderer::$addSvg = FALSE [protected]

Definition at line 139 of file class.t3lib_pagerenderer.php.

t3lib_PageRenderer::$backPath

Definition at line 143 of file class.t3lib_pagerenderer.php.

Referenced by __construct(), and setBackPath().

t3lib_PageRenderer::$baseUrl [protected]

Definition at line 64 of file class.t3lib_pagerenderer.php.

Referenced by setBaseUrl().

t3lib_PageRenderer::$baseUrlTag = '<base href="|" />' [protected]

Definition at line 78 of file class.t3lib_pagerenderer.php.

t3lib_PageRenderer::$bodyContent [protected]

Definition at line 89 of file class.t3lib_pagerenderer.php.

t3lib_PageRenderer::$charSet [protected]

Definition at line 62 of file class.t3lib_pagerenderer.php.

Referenced by setCharSet().

t3lib_PageRenderer::$compressCss = FALSE [protected]

Definition at line 40 of file class.t3lib_pagerenderer.php.

t3lib_PageRenderer::$compressError = '' [protected]

Definition at line 136 of file class.t3lib_pagerenderer.php.

t3lib_PageRenderer::$compressJavascript = FALSE [protected]

Definition at line 39 of file class.t3lib_pagerenderer.php.

t3lib_PageRenderer::$compressor [protected]

Definition at line 52 of file class.t3lib_pagerenderer.php.

t3lib_PageRenderer::$concatenateFiles = FALSE [protected]

Definition at line 43 of file class.t3lib_pagerenderer.php.

t3lib_PageRenderer::$csConvObj [protected]

Definition at line 48 of file class.t3lib_pagerenderer.php.

t3lib_PageRenderer::$cssFiles = array() [static, protected]

Definition at line 59 of file class.t3lib_pagerenderer.php.

Referenced by render().

t3lib_PageRenderer::$cssInline = array() [protected]

Definition at line 87 of file class.t3lib_pagerenderer.php.

Referenced by render().

t3lib_PageRenderer::$enableExtCoreDebug = FALSE [protected]

Definition at line 117 of file class.t3lib_pagerenderer.php.

t3lib_PageRenderer::$enableExtJsDebug = FALSE [protected]

Definition at line 116 of file class.t3lib_pagerenderer.php.

t3lib_PageRenderer::$enableExtJSQuickTips = FALSE [protected]

Definition at line 127 of file class.t3lib_pagerenderer.php.

t3lib_PageRenderer::$enableSvgDebug = FALSE [protected]

Definition at line 140 of file class.t3lib_pagerenderer.php.

t3lib_PageRenderer::$extCorePath = 'contrib/extjs/' [protected]

Definition at line 102 of file class.t3lib_pagerenderer.php.

t3lib_PageRenderer::$extDirectCodeAdded = FALSE [protected]

Definition at line 114 of file class.t3lib_pagerenderer.php.

t3lib_PageRenderer::$extJSadapter = 'ext/ext-base.js' [protected]

Definition at line 113 of file class.t3lib_pagerenderer.php.

t3lib_PageRenderer::$extJScss = TRUE [protected]

Definition at line 125 of file class.t3lib_pagerenderer.php.

t3lib_PageRenderer::$extJsPath = 'contrib/extjs/' [protected]

Definition at line 103 of file class.t3lib_pagerenderer.php.

t3lib_PageRenderer::$extJStheme = TRUE [protected]

Definition at line 124 of file class.t3lib_pagerenderer.php.

t3lib_PageRenderer::$extOnReadyCode = array() [protected]

Definition at line 86 of file class.t3lib_pagerenderer.php.

t3lib_PageRenderer::$favIcon [protected]

Definition at line 63 of file class.t3lib_pagerenderer.php.

Referenced by setFavIcon().

t3lib_PageRenderer::$footerData = array() [protected]

Definition at line 73 of file class.t3lib_pagerenderer.php.

t3lib_PageRenderer::$headerData = array() [protected]

Definition at line 72 of file class.t3lib_pagerenderer.php.

t3lib_PageRenderer::$headTag = '<head>' [protected]

Definition at line 77 of file class.t3lib_pagerenderer.php.

Referenced by setHeadTag().

t3lib_PageRenderer::$htmlTag = '<html>' [protected]

Definition at line 76 of file class.t3lib_pagerenderer.php.

Referenced by setHtmlTag().

t3lib_PageRenderer::$iconMimeType = '' [protected]

Definition at line 79 of file class.t3lib_pagerenderer.php.

Referenced by setIconMimeType().

t3lib_PageRenderer::$inlineComments = array() [protected]

Definition at line 71 of file class.t3lib_pagerenderer.php.

t3lib_PageRenderer::$inlineJavascriptWrap = array() [protected]

Definition at line 133 of file class.t3lib_pagerenderer.php.

t3lib_PageRenderer::$inlineLanguageLabelFiles = array() [protected]

Definition at line 130 of file class.t3lib_pagerenderer.php.

t3lib_PageRenderer::$inlineLanguageLabels = array() [protected]

Definition at line 129 of file class.t3lib_pagerenderer.php.

t3lib_PageRenderer::$inlineSettings = array() [protected]

Definition at line 131 of file class.t3lib_pagerenderer.php.

Referenced by renderJsLibraries().

t3lib_PageRenderer::$jsFiles = array() [static, protected]

Definition at line 55 of file class.t3lib_pagerenderer.php.

Referenced by render().

t3lib_PageRenderer::$jsFooterFiles = array() [static, protected]

Definition at line 56 of file class.t3lib_pagerenderer.php.

Referenced by render().

t3lib_PageRenderer::$jsFooterInline = array() [protected]

Definition at line 85 of file class.t3lib_pagerenderer.php.

Referenced by render().

t3lib_PageRenderer::$jsFooterLibs = array() [static, protected]

Definition at line 58 of file class.t3lib_pagerenderer.php.

Referenced by render().

t3lib_PageRenderer::$jsInline = array() [protected]

Definition at line 84 of file class.t3lib_pagerenderer.php.

Referenced by render().

t3lib_PageRenderer::$jsLibraryNames = array('prototype', 'scriptaculous', 'extjs') [protected]

Definition at line 93 of file class.t3lib_pagerenderer.php.

t3lib_PageRenderer::$jsLibs = array() [static, protected]

Definition at line 57 of file class.t3lib_pagerenderer.php.

Referenced by render().

t3lib_PageRenderer::$lang [protected]

Definition at line 49 of file class.t3lib_pagerenderer.php.

Referenced by setLanguage().

t3lib_PageRenderer::$metaCharsetTag = '<meta http-equiv="Content-Type" content="text/html; charset=|" />' [protected]

Definition at line 75 of file class.t3lib_pagerenderer.php.

t3lib_PageRenderer::$metaTags = array() [protected]

Definition at line 70 of file class.t3lib_pagerenderer.php.

Referenced by render().

t3lib_PageRenderer::$moveJsFromHeaderToFooter = FALSE [protected]

Definition at line 45 of file class.t3lib_pagerenderer.php.

t3lib_PageRenderer::$prototypePath = 'contrib/prototype/' [protected]

Definition at line 100 of file class.t3lib_pagerenderer.php.

t3lib_PageRenderer::$removeLineBreaksFromTemplate = FALSE [protected]

Definition at line 41 of file class.t3lib_pagerenderer.php.

t3lib_PageRenderer::$renderXhtml = TRUE [protected]

Definition at line 66 of file class.t3lib_pagerenderer.php.

t3lib_PageRenderer::$scriptaculousPath = 'contrib/scriptaculous/' [protected]

Definition at line 101 of file class.t3lib_pagerenderer.php.

t3lib_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 80 of file class.t3lib_pagerenderer.php.

t3lib_PageRenderer::$svgPath = 'contrib/websvg/' [protected]

Definition at line 104 of file class.t3lib_pagerenderer.php.

t3lib_PageRenderer::$templateFile [protected]

Definition at line 91 of file class.t3lib_pagerenderer.php.

Referenced by __construct(), and render().

t3lib_PageRenderer::$title [protected]

Definition at line 61 of file class.t3lib_pagerenderer.php.

Referenced by addCssFile(), and setTitle().

t3lib_PageRenderer::$titleTag = '<title>|</title>' [protected]

Definition at line 74 of file class.t3lib_pagerenderer.php.

t3lib_PageRenderer::$xmlPrologAndDocType = '' [protected]

Definition at line 69 of file class.t3lib_pagerenderer.php.

Referenced by setXmlPrologAndDocType().

Definition at line 120 of file class.t3lib_pagerenderer.php.

Definition at line 121 of file class.t3lib_pagerenderer.php.

Definition at line 122 of file class.t3lib_pagerenderer.php.

Definition at line 95 of file class.t3lib_pagerenderer.php.

Definition at line 96 of file class.t3lib_pagerenderer.php.

Referenced by template\startPage().


The documentation for this class was generated from the following file: