Inheritance diagram for TYPO3\CMS\Core\TypoScript\TemplateService:

Public Member Functions
	__construct (Context $context=null, PackageManager $packageManager=null, TypoScriptFrontendController $frontendController=null)

bool	getProcessExtensionStatics ()

	setProcessExtensionStatics ($processExtensionStatics)

	setVerbose ($verbose)

array	getCurrentPageData (int $pageId, string $mountPointValue)

array	matching ($cc)

	start ($theRootLine)

	runThroughTemplates ($theRootLine, $start_template_uid=0)

	processTemplate ($row, $idList, $pid, $templateID='', $templateParent='', $includePath='')

	updateRootlineData ($fullRootLine)

	includeStaticTypoScriptSources ($idList, $templateID, $pid, $row)

	addExtensionStatics ($idList, $templateID, $pid)

	generateConfig ()

string	substituteConstantsCallBack ($matches)

int	getRootlineLevel ($list)

int	getRootId ()

‪Public Member Functions inherited from ‪TYPO3\CMS\Core\Compatibility\PublicPropertyDeprecationTrait
bool	__isset (string $propertyName)

mixed	__get (string $propertyName)

	__set (string $propertyName, $propertyValue)

	__unset (string $propertyName)

Public Attributes
bool	$tt_track = true

array	$matchAlternative = array( )

int	$ext_constants_BRP = 0

int	$ext_config_BRP = 0

bool	$ext_regLinenumbers = false

bool	$ext_regComments = false

bool	$loaded = false

array	$setup = array( )

array	$flatSetup = array( )

array	$config = array( )

array	$constants = array( )

array	$hierarchyInfo = array( )

array	$rootLine

array null	$sections

string[]	$clearList_const = array( )

array	$clearList_setup = array( )

array	$parserErrors = array( )

array	$setup_constants = array( )

Protected Member Functions
	initializeDatabaseQueryRestrictions ()

string	getTypoScriptSourceFileContent ($filePath, $baseName)

array	prependStaticExtra ($subrow)

	versionOL (&$row)

	processIncludes ()

string	substituteConstants ($all)

	addDefaultTypoScript ()

TypoScriptFrontendController	getTypoScriptFrontendController ()

TimeTracker	getTimeTracker ()

mixed	getCacheEntry ($identifier)

	setCacheEntry ($identifier, $data, $tag)

Protected Attributes
bool	$verbose = false

bool	$matchAll = false

bool	$simulationHiddenOrTime = false

array	$templateIncludePaths = array( )

array	$hierarchyInfoToRoot = array( )

int	$rootId

array	$absoluteRootLine

array	$rowSum

string	$sitetitle = ''

array	$sectionsMatch

bool	$extensionStaticsProcessed = false

bool	$processExtensionStatics = false

bool	$isDefaultTypoScriptAdded = false

bool	$processIncludesHasBeenRun = false

AbstractRestrictionContainer	$queryBuilderRestrictions

Context	$context

PackageManager	$packageManager

TypoScriptFrontendController null	$frontendController

Private Attributes
string[]	$deprecatedPublicProperties

bool	$forceTemplateParsing = false

Detailed Description

Template object that is responsible for generating the TypoScript template based on template records.

See also: ‪\TYPO3\CMS\Core\TypoScript\Parser\TypoScriptParser; ‪\TYPO3\CMS\Core\Configuration\TypoScript\ConditionMatching\AbstractConditionMatcher

Definition at line 45 of file TemplateService.php.

Constructor & Destructor Documentation

◆ __construct()

TYPO3\CMS\Core\TypoScript\TemplateService::__construct	(	Context	$context = `null`,
		PackageManager	$packageManager = `null`,
		TypoScriptFrontendController	$frontendController = `null`
	)

Parameters

Context \| null	$context
PackageManager \| null	$packageManager
TypoScriptFrontendController \| null	$frontendController

Definition at line 276 of file TemplateService.php.

References TYPO3\CMS\Core\TypoScript\TemplateService\$context, TYPO3\CMS\Core\TypoScript\TemplateService\$frontendController, $GLOBALS, TYPO3\CMS\Core\TypoScript\TemplateService\$packageManager, and TYPO3\CMS\Core\TypoScript\TemplateService\initializeDatabaseQueryRestrictions().

Member Function Documentation

◆ addDefaultTypoScript()

TYPO3\CMS\Core\TypoScript\TemplateService::addDefaultTypoScript ( )

protected

Adds the TypoScript from the global array. The class property isDefaultTypoScriptAdded ensures that the adding only happens once.

See also: ‪isDefaultTypoScriptAdded

Definition at line 1184 of file TemplateService.php.

References $GLOBALS, TYPO3\CMS\Core\Utility\ArrayUtility\flattenPlain(), TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController\getSite(), and TYPO3\CMS\Core\TypoScript\TemplateService\getTypoScriptFrontendController().

Referenced by TYPO3\CMS\Core\TypoScript\TemplateService\generateConfig(), and TYPO3\CMS\Core\TypoScript\TemplateService\runThroughTemplates().

◆ addExtensionStatics()

TYPO3\CMS\Core\TypoScript\TemplateService::addExtensionStatics	(	$idList,
		$templateID,
		$pid
	)

Adds the default TypoScript files for extensions if any.

Parameters

string	$idList	‪A list of already processed template ids including the current; The list is on the form "[prefix]_[uid]" where [prefix] is "sys" for "sys_template" records and "ext_" for static include files (from extensions). The list is used to check that the recursive inclusion of templates does not go into circles: Simply it is used to NOT include a template record/file which has already BEEN included somewhere in the recursion.
string	$templateID	‪The id of the current template. Same syntax as $idList ids, eg. "sys_123
int	$pid	‪The PID of the input template record

See also: ‪includeStaticTypoScriptSources()

Definition at line 844 of file TemplateService.php.

References TYPO3\CMS\Core\TypoScript\TemplateService\$config, TYPO3\CMS\Core\TypoScript\TemplateService\$constants, TYPO3\CMS\Core\TypoScript\TemplateService\prependStaticExtra(), and TYPO3\CMS\Core\TypoScript\TemplateService\processTemplate().

Referenced by TYPO3\CMS\Core\TypoScript\TemplateService\includeStaticTypoScriptSources(), and TYPO3\CMS\Core\TypoScript\TemplateService\runThroughTemplates().

◆ generateConfig()

TYPO3\CMS\Core\TypoScript\TemplateService::generateConfig ( )

Generates the configuration array by replacing constants and parsing the whole thing. Depends on $this->config and $this->constants to be set prior to this! (done by processTemplate/runThroughTemplates)

See also: ‪\TYPO3\CMS\Core\TypoScript\Parser\TypoScriptParser; ‪start()

Definition at line 951 of file TemplateService.php.

Referenced by TYPO3\CMS\Core\TypoScript\TemplateService\start().

◆ getCacheEntry()

mixed TYPO3\CMS\Core\TypoScript\TemplateService::getCacheEntry ( $identifier )

protected

Returns data stored for the hash string in the cache "cache_hash" used to store the parsed TypoScript template structures.

Parameters

string $identifier ‪The hash-string which was used to store the data value

Returns: ‪mixed The data from the cache

Definition at line 1285 of file TemplateService.php.

Referenced by TYPO3\CMS\Core\TypoScript\TemplateService\start().

◆ getCurrentPageData()

array TYPO3\CMS\Core\TypoScript\TemplateService::getCurrentPageData	(	int	$pageId,
		string	$mountPointValue
	)

Fetches the "currentPageData" array from cache

NOTE about currentPageData: It holds information about the TypoScript conditions along with the list of template uid's which is used on the page. In the getFromCache() function in TSFE, currentPageData is used to evaluate if there is a template and if the matching conditions are alright. Unfortunately this does not take into account if the templates in the rowSum of currentPageData has changed composition, eg. due to hidden fields or start/end time. So if a template is hidden or times out, it'll not be discovered unless the page is regenerated - at least the this->start function must be called, because this will make a new portion of data in currentPageData string.

Parameters

int	$pageId
string	$mountPointValue

Returns: ‪array Returns the unmatched array $currentPageData if found cached in "cache_pagesection". Otherwise FALSE is returned which means that the array must be generated and stored in the cache

Exceptions

Definition at line 346 of file TemplateService.php.

◆ getProcessExtensionStatics()

bool TYPO3\CMS\Core\TypoScript\TemplateService::getProcessExtensionStatics ( )

Returns: ‪bool

Definition at line 292 of file TemplateService.php.

References TYPO3\CMS\Core\TypoScript\TemplateService\$processExtensionStatics.

◆ getRootId()

int TYPO3\CMS\Core\TypoScript\TemplateService::getRootId ( )

Returns the page ID of the rootlevel

Returns: ‪int

Definition at line 1167 of file TemplateService.php.

References TYPO3\CMS\Core\TypoScript\TemplateService\$rootId.

◆ getRootlineLevel()

int TYPO3\CMS\Core\TypoScript\TemplateService::getRootlineLevel ( $list )

Returns the level of the given page in the rootline - Multiple pages can be given by separating the UIDs by comma.

Parameters

string $list ‪A list of UIDs for which the rootline-level should get returned

Returns: ‪int The level in the rootline. If more than one page was given the lowest level will get returned.

Definition at line 1150 of file TemplateService.php.

◆ getTimeTracker()

TimeTracker TYPO3\CMS\Core\TypoScript\TemplateService::getTimeTracker ( )

protected

Returns: ‪TimeTracker

Definition at line 1273 of file TemplateService.php.

Referenced by TYPO3\CMS\Core\TypoScript\TemplateService\generateConfig(), TYPO3\CMS\Core\TypoScript\TemplateService\start(), and TYPO3\CMS\Core\TypoScript\TemplateService\substituteConstants().

◆ getTypoScriptFrontendController()

TypoScriptFrontendController TYPO3\CMS\Core\TypoScript\TemplateService::getTypoScriptFrontendController ( )

protected

Returns: ‪TypoScriptFrontendController

Definition at line 1265 of file TemplateService.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Core\TypoScript\TemplateService\addDefaultTypoScript(), and TYPO3\CMS\Core\TypoScript\TemplateService\start().

◆ getTypoScriptSourceFileContent()

string TYPO3\CMS\Core\TypoScript\TemplateService::getTypoScriptSourceFileContent	(	$filePath,
		$baseName
	)

protected

Retrieves the content of the first existing file by extension order. Returns the empty string if no file is found.

Parameters

string	$filePath	‪The location of the file.
string	$baseName	‪The base file name. "constants" or "setup".

Returns: ‪string

Definition at line 823 of file TemplateService.php.

Referenced by TYPO3\CMS\Core\TypoScript\TemplateService\includeStaticTypoScriptSources().

◆ includeStaticTypoScriptSources()

TYPO3\CMS\Core\TypoScript\TemplateService::includeStaticTypoScriptSources	(	$idList,
		$templateID,
		$pid,
		$row
	)

Includes static template files (from extensions) for the input template record row.

Parameters

string	$idList	‪A list of already processed template ids including the current; The list is on the form "[prefix]_[uid]" where [prefix] is "sys" for "sys_template" records and "ext_" for static include files (from extensions). The list is used to check that the recursive inclusion of templates does not go into circles: Simply it is used to NOT include a template record/file which has already BEEN included somewhere in the recursion.
string	$templateID	‪The id of the current template. Same syntax as $idList ids, eg. "sys_123
int	$pid	‪The PID of the input template record
array	$row	‪A full TypoScript template record

See also: ‪processTemplate()

Definition at line 739 of file TemplateService.php.

References $GLOBALS, TYPO3\CMS\Core\TypoScript\TemplateService\addExtensionStatics(), TYPO3\CMS\Core\Utility\ExtensionManagementUtility\extPath(), TYPO3\CMS\Core\TypoScript\TemplateService\getTypoScriptSourceFileContent(), TYPO3\CMS\Core\Utility\GeneralUtility\intExplode(), TYPO3\CMS\Core\Utility\ExtensionManagementUtility\isLoaded(), TYPO3\CMS\Core\TypoScript\TemplateService\prependStaticExtra(), TYPO3\CMS\Core\TypoScript\TemplateService\processTemplate(), and TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

Referenced by TYPO3\CMS\Core\TypoScript\TemplateService\processTemplate().

◆ initializeDatabaseQueryRestrictions()

TYPO3\CMS\Core\TypoScript\TemplateService::initializeDatabaseQueryRestrictions ( )

protected

Set up the query builder restrictions, optionally include hidden records

Definition at line 317 of file TemplateService.php.

Referenced by TYPO3\CMS\Core\TypoScript\TemplateService\__construct().

◆ matching()

array TYPO3\CMS\Core\TypoScript\TemplateService::matching ( $cc )

Fetches data about which TypoScript-matches there are at this page. Then it performs a matchingtest.

Parameters

array $cc ‪An array with three keys, "all", "rowSum" and "rootLine" - all coming from the "currentPageData" array

Returns: ‪array The input array but with a new key added, "match" which contains the items from the "all" key which when passed to tslib_matchCondition returned TRUE.

Definition at line 357 of file TemplateService.php.

References TYPO3\CMS\Core\TypoScript\TemplateService\$sectionsMatch.

Referenced by TYPO3\CMS\Core\TypoScript\TemplateService\start().

◆ prependStaticExtra()

array TYPO3\CMS\Core\TypoScript\TemplateService::prependStaticExtra ( $subrow )

protected

Appends (not prepends) additional TypoScript code to static template records/files as set in TYPO3_CONF_VARS For files the "uid" value is the extension key but with any underscores removed. Possibly with a path if its a static file selected in the template record

Parameters

array $subrow ‪Static template record/file

Returns: ‪array Returns the input array where the values for keys "config" and "constants" may have been modified with prepended code.

See also: ‪addExtensionStatics(); ‪includeStaticTypoScriptSources()

Definition at line 912 of file TemplateService.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Core\TypoScript\TemplateService\addExtensionStatics(), and TYPO3\CMS\Core\TypoScript\TemplateService\includeStaticTypoScriptSources().

◆ processIncludes()

TYPO3\CMS\Core\TypoScript\TemplateService::processIncludes ( )

protected

Searching TypoScript code text (for constants and config (Setup)) for include instructions and does the inclusion of external TypoScript files if needed.

See also: ‪\TYPO3\CMS\Core\TypoScript\Parser\TypoScriptParser; ‪generateConfig()

Definition at line 1068 of file TemplateService.php.

References TYPO3\CMS\Core\TypoScript\TemplateService\$templateIncludePaths, and TYPO3\CMS\Core\TypoScript\Parser\TypoScriptParser\checkIncludeLines().

Referenced by TYPO3\CMS\Core\TypoScript\TemplateService\generateConfig(), and TYPO3\CMS\Core\TypoScript\TemplateService\runThroughTemplates().

◆ processTemplate()

TYPO3\CMS\Core\TypoScript\TemplateService::processTemplate	(	$row,
		$idList,
		$pid,
		$templateID = `''`,
		$templateParent = `''`,
		$includePath = `''`
	)

Checks if the template ($row) has some included templates and after including them it fills the arrays with the setup Builds up $this->rowSum

Parameters

array	$row	‪A full TypoScript template record (sys_template/forged "dummy" record made from static template file)
string	$idList	‪A list of already processed template ids including the current; The list is on the form "[prefix]_[uid]" where [prefix] is "sys" for "sys_template" records, records and "ext_" for static include files (from extensions). The list is used to check that the recursive inclusion of templates does not go into circles: Simply it is used to NOT include a template record/file which has already BEEN included somewhere in the recursion.
int	$pid	‪The PID of the input template record
string	$templateID	‪The id of the current template. Same syntax as $idList ids, eg. "sys_123 @param string $templateParent Parent template id (during recursive call); Same syntax as $idList ids, eg. "sys_123
string	$includePath	‪Specifies the path from which the template was included (used with static_includes)

See also: ‪runThroughTemplates()

Definition at line 592 of file TemplateService.php.

References TYPO3\CMS\Core\TypoScript\TemplateService\includeStaticTypoScriptSources(), TYPO3\CMS\Core\Utility\GeneralUtility\intExplode(), and TYPO3\CMS\Core\TypoScript\TemplateService\versionOL().

Referenced by TYPO3\CMS\Core\TypoScript\TemplateService\addExtensionStatics(), TYPO3\CMS\Core\TypoScript\TemplateService\includeStaticTypoScriptSources(), and TYPO3\CMS\Core\TypoScript\TemplateService\runThroughTemplates().

◆ runThroughTemplates()

TYPO3\CMS\Core\TypoScript\TemplateService::runThroughTemplates	(	$theRootLine,
		$start_template_uid = `0`
	)

Traverses the rootLine from the root and out. For each page it checks if there is a template record. If there is a template record, $this->processTemplate() is called. Resets and affects internal variables like $this->constants, $this->config and $this->rowSum Also creates $this->rootLine which is a root line stopping at the root template (contrary to $this->getTypoScriptFrontendController()->rootLine which goes all the way to the root of the tree

Parameters

array	$theRootLine	‪The rootline of the current page (going ALL the way to tree root)
int	$start_template_uid	‪Set specific template record UID to select; this is only for debugging/development/analysis use in backend modules like "Web > Template". For parsing TypoScript templates in the frontend it should be 0 (zero)

See also: ‪start()

Definition at line 512 of file TemplateService.php.

Referenced by TYPO3\CMS\Core\TypoScript\TemplateService\start().

◆ setCacheEntry()

TYPO3\CMS\Core\TypoScript\TemplateService::setCacheEntry	(	$identifier,
		$data,
		$tag
	)

protected

Stores $data in the 'hash' cache with the hash key $identifier

Parameters

string	$identifier	‪32 bit hash string (eg. a md5 hash of a serialized array identifying the data being stored)
mixed	$data	‪The data to store
string	$tag	‪Is just a textual identification in order to inform about the content

Definition at line 1297 of file TemplateService.php.

Referenced by TYPO3\CMS\Core\TypoScript\TemplateService\start().

◆ setProcessExtensionStatics()

TYPO3\CMS\Core\TypoScript\TemplateService::setProcessExtensionStatics ( $processExtensionStatics )

Parameters

bool $processExtensionStatics

Definition at line 300 of file TemplateService.php.

References TYPO3\CMS\Core\TypoScript\TemplateService\$processExtensionStatics.

◆ setVerbose()

TYPO3\CMS\Core\TypoScript\TemplateService::setVerbose ( $verbose )

sets the verbose parameter

Parameters

bool $verbose

Definition at line 309 of file TemplateService.php.

References TYPO3\CMS\Core\TypoScript\TemplateService\$verbose.

◆ start()

TYPO3\CMS\Core\TypoScript\TemplateService::start ( $theRootLine )

This is all about fetching the right TypoScript template structure. If it's not cached then it must be generated and cached! The method traverses the rootline structure from out to in, fetches the hierarchy of template records and based on this either finds the cached TypoScript template structure or parses the template and caches it for next time. Sets $this->setup to the parsed TypoScript template array

Parameters

array $theRootLine ‪The rootline of the current page (going ALL the way to tree root)

See also: ‪\TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController::getConfigArray()

Definition at line 382 of file TemplateService.php.

◆ substituteConstants()

string TYPO3\CMS\Core\TypoScript\TemplateService::substituteConstants ( $all )

protected

Substitutes the constants from $this->flatSetup in the text string $all

Parameters

string $all ‪TypoScript code text string

Returns: ‪string The processed string with all constants found in $this->flatSetup as key/value pairs substituted.

See also: ‪generateConfig()

Reimplemented in TYPO3\CMS\Core\TypoScript\ExtendedTemplateService.

Definition at line 1107 of file TemplateService.php.

References TYPO3\CMS\Core\TypoScript\TemplateService\getTimeTracker(), and TYPO3\CMS\Core\TimeTracker\TimeTracker\setTSlogMessage().

Referenced by TYPO3\CMS\Core\TypoScript\TemplateService\generateConfig().

◆ substituteConstantsCallBack()

string TYPO3\CMS\Core\TypoScript\TemplateService::substituteConstantsCallBack ( $matches )

Call back method for preg_replace_callback in substituteConstants

Parameters

array $matches ‪Regular expression matches

Returns: ‪string Replacement

See also: ‪substituteConstants()

Reimplemented in TYPO3\CMS\Core\TypoScript\ExtendedTemplateService.

Definition at line 1132 of file TemplateService.php.

◆ updateRootlineData()

TYPO3\CMS\Core\TypoScript\TemplateService::updateRootlineData ( $fullRootLine )

This function can be used to update the data of the current rootLine e.g. when a different language is used.

This function must not be used if there are different pages in the rootline as before!

Parameters

array $fullRootLine ‪Array containing the FULL rootline (up to the TYPO3 root)

Exceptions

Definition at line 707 of file TemplateService.php.

◆ versionOL()

TYPO3\CMS\Core\TypoScript\TemplateService::versionOL ( & $row )

protected

Creating versioning overlay of a sys_template record.

Parameters

array $row ‪Row to overlay (passed by reference)

Definition at line 931 of file TemplateService.php.

Referenced by TYPO3\CMS\Core\TypoScript\TemplateService\processTemplate(), and TYPO3\CMS\Core\TypoScript\TemplateService\runThroughTemplates().

Member Data Documentation

◆ $absoluteRootLine

array TYPO3\CMS\Core\TypoScript\TemplateService::$absoluteRootLine

protected

Rootline all the way to the root. Set but runThroughTemplates

Definition at line 176 of file TemplateService.php.

Referenced by TYPO3\CMS\Core\TypoScript\TemplateService\runThroughTemplates().

◆ $clearList_const

string [] TYPO3\CMS\Core\TypoScript\TemplateService::$clearList_const = array( )

Used by Backend only (Typoscript Template Analyzer)

Definition at line 205 of file TemplateService.php.

◆ $clearList_setup

array TYPO3\CMS\Core\TypoScript\TemplateService::$clearList_setup = array( )

Used by Backend only (Typoscript Template Analyzer)

Definition at line 211 of file TemplateService.php.

◆ $config

array TYPO3\CMS\Core\TypoScript\TemplateService::$config = array( )

For fetching TypoScript code from template hierarchy before parsing it. Each array contains code field values from template records/files: Setup field

Definition at line 134 of file TemplateService.php.

Referenced by TYPO3\CMS\Core\TypoScript\TemplateService\addExtensionStatics(), TYPO3\CMS\Core\TypoScript\ExtendedTemplateService\ext_outputTS(), and TYPO3\CMS\Core\TypoScript\TemplateService\generateConfig().

◆ $constants

array TYPO3\CMS\Core\TypoScript\TemplateService::$constants = array( )

Constant field

Definition at line 140 of file TemplateService.php.

Referenced by TYPO3\CMS\Core\TypoScript\TemplateService\addExtensionStatics(), TYPO3\CMS\Core\TypoScript\ExtendedTemplateService\ext_regObjectPositions(), TYPO3\CMS\Core\TypoScript\TemplateService\generateConfig(), and TYPO3\CMS\Core\TypoScript\ExtendedTemplateService\generateConfig_constants().

◆ $context

Context TYPO3\CMS\Core\TypoScript\TemplateService::$context

protected

Definition at line 261 of file TemplateService.php.

Referenced by TYPO3\CMS\Core\TypoScript\ExtendedTemplateService\__construct(), and TYPO3\CMS\Core\TypoScript\TemplateService\__construct().

◆ $deprecatedPublicProperties

string [] TYPO3\CMS\Core\TypoScript\TemplateService::$deprecatedPublicProperties

private

Initial value:

= array( 
        'forceTemplateParsing' => 'Using tmpl->forceTemplateParsing is deprecated and will no longer work with TYPO3 v11.0. Use TypoScriptAspect from Context instead.'
     )

Definition at line 50 of file TemplateService.php.

◆ $ext_config_BRP

int TYPO3\CMS\Core\TypoScript\TemplateService::$ext_config_BRP = 0

Definition at line 98 of file TemplateService.php.

◆ $ext_constants_BRP

int TYPO3\CMS\Core\TypoScript\TemplateService::$ext_constants_BRP = 0

Externally set breakpoints (used by Backend Modules)

Definition at line 94 of file TemplateService.php.

◆ $ext_regComments

bool TYPO3\CMS\Core\TypoScript\TemplateService::$ext_regComments = false

Definition at line 106 of file TemplateService.php.

Referenced by TYPO3\CMS\Core\TypoScript\TemplateService\generateConfig().

◆ $ext_regLinenumbers

bool TYPO3\CMS\Core\TypoScript\TemplateService::$ext_regLinenumbers = false

Definition at line 102 of file TemplateService.php.

Referenced by TYPO3\CMS\Core\TypoScript\TemplateService\generateConfig().

◆ $extensionStaticsProcessed

bool TYPO3\CMS\Core\TypoScript\TemplateService::$extensionStaticsProcessed = false

protected

Indicator that extension statics are processed.

These files are considered if either a root template has been processed or the $processExtensionStatics property has been set to TRUE.

Definition at line 229 of file TemplateService.php.

Referenced by TYPO3\CMS\Core\TypoScript\TemplateService\runThroughTemplates().

◆ $flatSetup

array TYPO3\CMS\Core\TypoScript\TemplateService::$flatSetup = array( )

Definition at line 126 of file TemplateService.php.

Referenced by TYPO3\CMS\Core\TypoScript\ExtendedTemplateService\generateConfig_constants().

◆ $forceTemplateParsing

bool TYPO3\CMS\Core\TypoScript\TemplateService::$forceTemplateParsing = false

private

If set, the template is always rendered. Used from Admin Panel.

Deprecated:

Definition at line 73 of file TemplateService.php.

◆ $frontendController

TypoScriptFrontendController null TYPO3\CMS\Core\TypoScript\TemplateService::$frontendController

protected

Definition at line 269 of file TemplateService.php.

Referenced by TYPO3\CMS\Core\TypoScript\TemplateService\__construct().

◆ $hierarchyInfo

array TYPO3\CMS\Core\TypoScript\TemplateService::$hierarchyInfo = array( )

For Template Analyzer in backend

Definition at line 152 of file TemplateService.php.

◆ $hierarchyInfoToRoot

array TYPO3\CMS\Core\TypoScript\TemplateService::$hierarchyInfoToRoot = array( )

protected

For Template Analyzer in backend (setup content only)

Definition at line 158 of file TemplateService.php.

◆ $isDefaultTypoScriptAdded

bool TYPO3\CMS\Core\TypoScript\TemplateService::$isDefaultTypoScriptAdded = false

protected

Set to TRUE after the default TypoScript was added during parsing. This prevents double inclusion of the same TypoScript code.

See also: ‪addDefaultTypoScript()

Definition at line 243 of file TemplateService.php.

Referenced by TYPO3\CMS\Core\TypoScript\TemplateService\runThroughTemplates().

◆ $loaded

bool TYPO3\CMS\Core\TypoScript\TemplateService::$loaded = false

Set, if the TypoScript template structure is loaded and OK, see ->start()

Definition at line 118 of file TemplateService.php.

◆ $matchAll

bool TYPO3\CMS\Core\TypoScript\TemplateService::$matchAll = false

protected

If set, the match-class matches everything! Used for backend modules only. Never frontend!

Definition at line 88 of file TemplateService.php.

◆ $matchAlternative

array TYPO3\CMS\Core\TypoScript\TemplateService::$matchAlternative = array( )

This array is passed on to matchObj by generateConfig(). If it holds elements, they are used for matching instead. See comment at the match-class. Used for backend modules only. Never frontend!

Definition at line 82 of file TemplateService.php.

◆ $packageManager

PackageManager TYPO3\CMS\Core\TypoScript\TemplateService::$packageManager

protected

Definition at line 265 of file TemplateService.php.

Referenced by TYPO3\CMS\Core\TypoScript\TemplateService\__construct().

◆ $parserErrors

array TYPO3\CMS\Core\TypoScript\TemplateService::$parserErrors = array( )

Definition at line 215 of file TemplateService.php.

◆ $processExtensionStatics

bool TYPO3\CMS\Core\TypoScript\TemplateService::$processExtensionStatics = false

protected

Trigger value, to ensure that extension statics are processed.

Definition at line 235 of file TemplateService.php.

Referenced by TYPO3\CMS\Core\TypoScript\TemplateService\getProcessExtensionStatics(), and TYPO3\CMS\Core\TypoScript\TemplateService\setProcessExtensionStatics().

◆ $processIncludesHasBeenRun

bool TYPO3\CMS\Core\TypoScript\TemplateService::$processIncludesHasBeenRun = false

protected

Set to TRUE after $this->config and $this->constants have processed all <INCLUDE_TYPOSCRIPT:> instructions.

This prevents double processing of INCLUDES.

See also: ‪processIncludes()

Definition at line 252 of file TemplateService.php.

◆ $queryBuilderRestrictions

AbstractRestrictionContainer TYPO3\CMS\Core\TypoScript\TemplateService::$queryBuilderRestrictions

protected

Contains the restrictions about deleted, and some frontend related topics

Definition at line 257 of file TemplateService.php.

◆ $rootId

int TYPO3\CMS\Core\TypoScript\TemplateService::$rootId

protected

The Page UID of the root page

Definition at line 164 of file TemplateService.php.

Referenced by TYPO3\CMS\Core\TypoScript\TemplateService\getRootId().

◆ $rootLine

array TYPO3\CMS\Core\TypoScript\TemplateService::$rootLine

The rootline from current page to the root page

Definition at line 170 of file TemplateService.php.

Referenced by TYPO3\CMS\Core\TypoScript\ExtendedTemplateService\ext_prevPageWithTemplate(), TYPO3\CMS\Core\TypoScript\TemplateService\runThroughTemplates(), and TYPO3\CMS\Core\TypoScript\TemplateService\start().

◆ $rowSum

array TYPO3\CMS\Core\TypoScript\TemplateService::$rowSum

protected

Array of arrays with title/uid of templates in hierarchy

Definition at line 182 of file TemplateService.php.

Referenced by TYPO3\CMS\Core\TypoScript\TemplateService\runThroughTemplates(), and TYPO3\CMS\Core\TypoScript\TemplateService\start().

◆ $sections

array null TYPO3\CMS\Core\TypoScript\TemplateService::$sections

Tracking all conditions found during parsing of TypoScript. Used for the "all" key in currentPageData

Definition at line 194 of file TemplateService.php.

Referenced by TYPO3\CMS\Core\TypoScript\TemplateService\start().

◆ $sectionsMatch

array TYPO3\CMS\Core\TypoScript\TemplateService::$sectionsMatch

protected

Tracking all matching conditions found

Definition at line 200 of file TemplateService.php.

Referenced by TYPO3\CMS\Core\TypoScript\TemplateService\matching().

◆ $setup

array TYPO3\CMS\Core\TypoScript\TemplateService::$setup = array( )

Contains TypoScript setup part after parsing

Definition at line 122 of file TemplateService.php.

Referenced by TYPO3\CMS\Core\TypoScript\TemplateService\generateConfig().

◆ $setup_constants

array TYPO3\CMS\Core\TypoScript\TemplateService::$setup_constants = array( )

Definition at line 219 of file TemplateService.php.

◆ $simulationHiddenOrTime

bool TYPO3\CMS\Core\TypoScript\TemplateService::$simulationHiddenOrTime = false

protected

Set if preview of some kind is enabled.

Definition at line 112 of file TemplateService.php.

◆ $sitetitle

string TYPO3\CMS\Core\TypoScript\TemplateService::$sitetitle = ''

protected

The current site title field.

Definition at line 188 of file TemplateService.php.

Referenced by TYPO3\CMS\Core\TypoScript\TemplateService\generateConfig(), and TYPO3\CMS\Core\TypoScript\ExtendedTemplateService\generateConfig_constants().

◆ $templateIncludePaths

array TYPO3\CMS\Core\TypoScript\TemplateService::$templateIncludePaths = array( )

protected

Holds the include paths of the templates (empty if from database)

Definition at line 146 of file TemplateService.php.

Referenced by TYPO3\CMS\Core\TypoScript\TemplateService\processIncludes().

◆ $tt_track

bool TYPO3\CMS\Core\TypoScript\TemplateService::$tt_track = true

If set, the global tt-timeobject is used to log the performance.

Definition at line 66 of file TemplateService.php.

◆ $verbose

bool TYPO3\CMS\Core\TypoScript\TemplateService::$verbose = false

protected

option to enable logging, time-tracking (FE-only) usually, this is only done when

‪in FE a BE_USER is logged-in
‪in BE when the BE_USER needs information about the template (TypoScript module)

Definition at line 60 of file TemplateService.php.

Referenced by TYPO3\CMS\Core\TypoScript\TemplateService\setVerbose().

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addDefaultTypoScript()

◆ addExtensionStatics()

◆ generateConfig()

◆ getCacheEntry()

◆ getCurrentPageData()

◆ getProcessExtensionStatics()

◆ getRootId()

◆ getRootlineLevel()

◆ getTimeTracker()

◆ getTypoScriptFrontendController()

◆ getTypoScriptSourceFileContent()

◆ includeStaticTypoScriptSources()

◆ initializeDatabaseQueryRestrictions()

◆ matching()

◆ prependStaticExtra()

◆ processIncludes()

◆ processTemplate()

◆ runThroughTemplates()

◆ setCacheEntry()

◆ setProcessExtensionStatics()

◆ setVerbose()

◆ start()

◆ substituteConstants()

◆ substituteConstantsCallBack()

◆ updateRootlineData()

◆ versionOL()

Member Data Documentation

◆ $absoluteRootLine

◆ $clearList_const

◆ $clearList_setup

◆ $config

◆ $constants

◆ $context

◆ $deprecatedPublicProperties

◆ $ext_config_BRP

◆ $ext_constants_BRP

◆ $ext_regComments

◆ $ext_regLinenumbers

◆ $extensionStaticsProcessed

◆ $flatSetup

◆ $forceTemplateParsing

◆ $frontendController

◆ $hierarchyInfo

◆ $hierarchyInfoToRoot

◆ $isDefaultTypoScriptAdded

◆ $loaded

◆ $matchAll

◆ $matchAlternative

◆ $packageManager

◆ $parserErrors

◆ $processExtensionStatics

◆ $processIncludesHasBeenRun

◆ $queryBuilderRestrictions

◆ $rootId

◆ $rootLine

◆ $rowSum

◆ $sections

◆ $sectionsMatch

◆ $setup

◆ $setup_constants

◆ $simulationHiddenOrTime

◆ $sitetitle

◆ $templateIncludePaths

◆ $tt_track

◆ $verbose