ExtendedTemplateService

class \TYPO3\CMS\Core\TypoScript\ExtendedTemplateService

Extends
TemplateService

TSParser extension class to TemplateService Contains functions for the TS module in TYPO3 backend

Table of Contents

Properties

$bType  : string
$changed  : bool
$clearList_const  : string[]
Used by Backend only (Typoscript Template Analyzer)
$clearList_const_temp  : array
$clearList_setup  : array
Used by Backend only (Typoscript Template Analyzer)
$clearList_setup_temp  : array
$config  : array
For fetching TypoScript code from template hierarchy before parsing it.
$constantMode  : string
$constants  : array
Constant field
$ext_config_BRP  : mixed
$ext_constants_BRP  : mixed
$ext_expandAllNotes  : int
$ext_inBrace  : int
Tsconstanteditor
$ext_noPMicons  : int
$ext_regComments  : bool
$ext_regLinenumbers  : bool
$flatSetup  : array
$hierarchyInfo  : array
For Template Analyzer in backend
$lastComment  : string
$linkObjects  : bool
$loaded  : bool
Set, if the TypoScript template structure is loaded and OK, see ->start()
$matchAlternative  : array
This array is passed on to matchObj by generateConfig().
$parserErrors  : array
$raw  : array
$rawP  : int
$regexMode  : string
$rootLine  : array
The rootline from current page to the root page
$sections  : array|null
Tracking all conditions found during parsing of TypoScript. Used for the "all" key in currentPageData
$setup  : array
$setup_constants  : array
$templateTitles  : array
Ts analyzer
$tsbrowser_depthKeys  : array
$tsbrowser_searchKeys  : array
Tsbrowser
$tt_track  : bool
If set, the global tt-timeobject is used to log the performance.
$absoluteRootLine  : array
Rootline all the way to the root. Set but runThroughTemplates
$categories  : array
$context  : Context
$extensionStaticsProcessed  : bool
Indicator that extension statics are processed.
$frontendController  : TypoScriptFrontendController|null
$hierarchyInfoToRoot  : array
For Template Analyzer in backend (setup content only)
$isDefaultTypoScriptAdded  : bool
Set to TRUE after the default TypoScript was added during parsing.
$javaScriptInstructions  : array<string, JavaScriptModuleInstruction>
$lnToScript  : array|null
$matchAll  : bool
If set, the match-class matches everything! Used for backend modules only. Never frontend!
$objReg  : int[]
$packageManager  : PackageManager
$processExtensionStatics  : bool
Trigger value, to ensure that extension statics are processed.
$processIncludesHasBeenRun  : bool
Set to TRUE after $this->config and $this->constants have processed all <INCLUDE_TYPOSCRIPT:> instructions.
$queryBuilderRestrictions  : AbstractRestrictionContainer
Contains the restrictions about deleted, and some frontend related topics
$rootId  : int
The Page UID of the root page
$rowSum  : array
Array of arrays with title/uid of templates in hierarchy
$sectionsMatch  : array
Tracking all matching conditions found
$simulationHiddenOrTime  : bool
Set if preview of some kind is enabled.
$templateIncludePaths  : array
Holds the include paths of the templates (empty if from database)
$verbose  : bool
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)

Methods

__construct()  : mixed
addExtensionStatics()  : mixed
Adds the default TypoScript files for extensions if any.
ext_categorizeEditableConstants()  : mixed
ext_depthKeys()  : array
ext_fNandV()  : array
ext_getAllTemplates()  : array[]
Get an array of all template records on a page.
ext_getCategoryLabelArray()  : array
ext_getFirstTemplate()  : array|null
Get a single sys_template record attached to a single page.
ext_getObjTree()  : string
Get object tree
ext_getRootlineNumber()  : int
ext_getSearchKeys()  : array
ext_getSetup()  : array{0: array, 1: string}
ext_getTemplateHierarchyArr()  : array
ext_getTypeData()  : array
ext_prevPageWithTemplate()  : array
ext_printFields()  : array
This functions returns the HTML-code that creates the editor-layout of the module.
ext_procesInput()  : mixed
Process input
ext_process_hierarchyInfo()  : array
Processes the flat array from TemplateService->hierarchyInfo and turns it into a hierarchical array to show dependencies (used by TemplateAnalyzer)
ext_putValueInConf()  : mixed
ext_regObjectPositions()  : void
ext_regObjects()  : mixed
ext_removeValueInConf()  : mixed
generateConfig()  : mixed
Generates the configuration array by replacing constants and parsing the whole thing.
generateConfig_constants()  : array
Parse constants with respect to the constant-editor in this module.
getCurrentPageData()  : array
Fetches the "currentPageData" array from cache
getJavaScriptInstructions()  : array<string, JavaScriptModuleInstruction>
getProcessExtensionStatics()  : bool
getRootId()  : int
Returns the page ID of the rootlevel
getRootlineLevel()  : int
Returns the level of the given page in the rootline - Multiple pages can be given by separating the UIDs by comma.
includeStaticTypoScriptSources()  : mixed
Includes static template files (from extensions) for the input template record row.
lineNumberToScript()  : string
Find the originating template name for an array of line numbers (TypoScript setup only!) Given an array of linenumbers the method will try to find the corresponding template where this line originated The linenumber indicates the *last* lineNumber that is part of the template
matching()  : array
Fetches data about which TypoScript-matches there are at this page. Then it performs a matchingtest.
processTemplate()  : mixed
Checks if the template ($row) has some included templates and after including them it fills the arrays with the setup Builds up $this->rowSum
runThroughTemplates()  : mixed
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.
setProcessExtensionStatics()  : mixed
setVerbose()  : mixed
sets the verbose parameter
start()  : mixed
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.
substituteCMarkers()  : string
Substitute markers added in substituteConstantsCallBack() with ##6chars_B##value1##6chars_M##value2##6chars_E##
substituteConstants()  : string
Substitute constant
substituteConstantsCallBack()  : string
Call back method for preg_replace_callback in substituteConstants
updateRootlineData()  : mixed
This function can be used to update the data of the current rootLine e.g. when a different language is used.
addDefaultTypoScript()  : mixed
Adds the TypoScript from the global array.
getCacheEntry()  : mixed
Returns data stored for the hash string in the cache "cache_hash" used to store the parsed TypoScript template structures.
getLanguageService()  : LanguageService
getRootLine()  : array
Is set by runThroughTemplates(), previously set via TemplateAnalyzerModuleFunctionController from the outside
getTemplateQueryBuilder()  : QueryBuilder
Internal helper method to prepare the query builder for getting sys_template records from a given pid
getTimeTracker()  : TimeTracker
getTypoScriptFrontendController()  : TypoScriptFrontendController|null
getTypoScriptSourceFileContent()  : string
Retrieves the content of the first existing file by extension order.
initializeDatabaseQueryRestrictions()  : mixed
Set up the query builder restrictions, optionally include hidden records
prependStaticExtra()  : array
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
processIncludes()  : mixed
Searching TypoScript code text (for constants and config (Setup)) for include instructions and does the inclusion of external TypoScript files if needed.
setCacheEntry()  : mixed
Stores $data in the 'hash' cache with the hash key $identifier
versionOL()  : mixed
Creating versioning overlay of a sys_template record.

Properties

$clearList_const

Used by Backend only (Typoscript Template Analyzer)

public string[] $clearList_const = []

$clearList_const_temp

public array $clearList_const_temp

$clearList_setup

Used by Backend only (Typoscript Template Analyzer)

public array $clearList_setup = []

$clearList_setup_temp

public array $clearList_setup_temp

$config

For fetching TypoScript code from template hierarchy before parsing it.

public array $config = []

Each array contains code field values from template records/files: Setup field

$constantMode

public string $constantMode = ''

$constants

Constant field

public array $constants = []

$ext_config_BRP

Deprecated

Unused since v11, will be removed in v12

public mixed $ext_config_BRP = 0

$ext_constants_BRP

Deprecated

Unused since v11, will be removed in v12

public mixed $ext_constants_BRP = 0

$ext_expandAllNotes

public int $ext_expandAllNotes = 0

$ext_inBrace

Tsconstanteditor

public int $ext_inBrace = 0

$ext_noPMicons

public int $ext_noPMicons = 0

$ext_regComments

public bool $ext_regComments = false

$ext_regLinenumbers

public bool $ext_regLinenumbers = false

$hierarchyInfo

For Template Analyzer in backend

public array $hierarchyInfo = []

$lastComment

public string $lastComment = ''

$linkObjects

public bool $linkObjects = false

$loaded

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

public bool $loaded = false

$matchAlternative

This array is passed on to matchObj by generateConfig().

public array $matchAlternative = []

If it holds elements, they are used for matching instead. See comment at the match-class. Used for backend modules only. Never frontend!

$parserErrors

public array $parserErrors = []

$rootLine

The rootline from current page to the root page

public array $rootLine

$sections

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

public array|null $sections

$setup

public array $setup = []

Contains TypoScript setup part after parsing

$setup_constants

public array $setup_constants = []

$templateTitles

Ts analyzer

public array $templateTitles = []

$tsbrowser_depthKeys

public array $tsbrowser_depthKeys = []

$tsbrowser_searchKeys

Tsbrowser

public array $tsbrowser_searchKeys = []

$tt_track

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

public bool $tt_track = true

$absoluteRootLine

Rootline all the way to the root. Set but runThroughTemplates

protected array $absoluteRootLine

$categories

protected array $categories = [ 'basic' => [], // Constants of superior importance…
Show the full value[ 'basic' => [], // Constants of superior importance for the template-layout. This is dimensions, imagefiles and enabling of various features. The most basic constants, which you would almost always want to configure. 'menu' => [], // Menu setup. This includes fontfiles, sizes, background images. Depending on the menutype. 'content' => [], // All constants related to the display of pagecontent elements 'page' => [], // General configuration like metatags, link targets 'advanced' => [], // Advanced functions, which are used very seldom. 'all' => [], ]

$extensionStaticsProcessed

Indicator that extension statics are processed.

protected bool $extensionStaticsProcessed = false

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

$hierarchyInfoToRoot

For Template Analyzer in backend (setup content only)

protected array $hierarchyInfoToRoot = []

$isDefaultTypoScriptAdded

Set to TRUE after the default TypoScript was added during parsing.

protected bool $isDefaultTypoScriptAdded = false

This prevents double inclusion of the same TypoScript code.

Tags

see
addDefaultTypoScript()

$lnToScript

protected array|null $lnToScript

$matchAll

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

protected bool $matchAll = false

$processExtensionStatics

Trigger value, to ensure that extension statics are processed.

protected bool $processExtensionStatics = false

$processIncludesHasBeenRun

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

protected bool $processIncludesHasBeenRun = false

This prevents double processing of INCLUDES.

Tags

see
processIncludes()

$rootId

The Page UID of the root page

protected int $rootId

$rowSum

Array of arrays with title/uid of templates in hierarchy

protected array $rowSum

$sectionsMatch

Tracking all matching conditions found

protected array $sectionsMatch

$simulationHiddenOrTime

Set if preview of some kind is enabled.

protected bool $simulationHiddenOrTime = false

$templateIncludePaths

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

protected array $templateIncludePaths = []

$verbose

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)

protected bool $verbose = false

Methods

addExtensionStatics()

Adds the default TypoScript files for extensions if any.

public addExtensionStatics(string $idList, string $templateID, int $pid) : mixed

Parameters

$idList : string

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.

$templateID : string

The id of the current template. Same syntax as $idList ids, eg. "sys_123

$pid : int

The PID of the input template record

Tags

see
includeStaticTypoScriptSources()

ext_categorizeEditableConstants()

public ext_categorizeEditableConstants(array $editConstArray) : mixed

Parameters

$editConstArray : array

ext_depthKeys()

public ext_depthKeys(array $arr, array $settings) : array

Parameters

$arr : array
$settings : array

Return values

array

ext_fNandV()

public ext_fNandV(array $params) : array

Parameters

$params : array

Return values

array

ext_getAllTemplates()

Get an array of all template records on a page.

public ext_getAllTemplates(int $pid) : array[]

Parameters

$pid : int

Pid to fetch sys_template records for

Return values

array[] —

Array of template records

ext_getCategoryLabelArray()

public ext_getCategoryLabelArray() : array

Return values

array

ext_getFirstTemplate()

Get a single sys_template record attached to a single page.

public ext_getFirstTemplate(int $pid[, int $templateUid = 0 ]) : array|null

If multiple template records are on this page, the first (order by sorting) record will be returned, unless a specific template uid is specified via $templateUid

Parameters

$pid : int

The pid to select sys_template records from

$templateUid : int = 0

Optional template uid

Return values

array|null —

Returns the template record or null if none was found

ext_getObjTree()

Get object tree

public ext_getObjTree(array $arr, string $depth_in, string $depthData[, string $parentType = '' ][, string $parentValue = '' ][, string $alphaSort = '0' ]) : string

Parameters

$arr : array
$depth_in : string
$depthData : string
$parentType : string = ''

(unused)

$parentValue : string = ''

(unused)

$alphaSort : string = '0'

sorts the array keys / tree by alphabet when set to 1

Return values

string

ext_getRootlineNumber()

public ext_getRootlineNumber(int $pid) : int

Parameters

$pid : int

Return values

int

ext_getSearchKeys()

public ext_getSearchKeys(array $arr, string $depth_in, string $searchString, array $keyArray) : array

Parameters

$arr : array
$depth_in : string
$searchString : string
$keyArray : array

Tags

throws
Exception

Return values

array

ext_getSetup()

public ext_getSetup(array $theSetup, string $theKey) : array{0: array, 1: string}

Parameters

$theSetup : array
$theKey : string

Return values

array{0: array, 1: string}

ext_getTemplateHierarchyArr()

public ext_getTemplateHierarchyArr(array $arr, string $depthData, array $keyArray[, int $first = 0 ]) : array

Parameters

$arr : array
$depthData : string
$keyArray : array
$first : int = 0

Return values

array

ext_getTypeData()

public ext_getTypeData(string $type) : array

Parameters

$type : string

Return values

array

ext_prevPageWithTemplate()

public ext_prevPageWithTemplate(int $id, string $perms_clause) : array

Parameters

$id : int
$perms_clause : string

Return values

array

ext_printFields()

This functions returns the HTML-code that creates the editor-layout of the module.

public ext_printFields(array $theConstants, string $category) : array

Parameters

$theConstants : array
$category : string

Return values

array

ext_procesInput()

Process input

public ext_procesInput(array $http_post_vars, array $http_post_files, array $theConstants, array $tplRow) : mixed

Parameters

$http_post_vars : array
$http_post_files : array

(not used anymore)

$theConstants : array
$tplRow : array

Not used

ext_process_hierarchyInfo()

Processes the flat array from TemplateService->hierarchyInfo and turns it into a hierarchical array to show dependencies (used by TemplateAnalyzer)

public ext_process_hierarchyInfo(array $depthDataArr, int &$pointer) : array

Parameters

$depthDataArr : array

(empty array on external call)

$pointer : int

Element number (1! to count()) of $this->hierarchyInfo that should be processed.

Return values

array —

Processed hierachyInfo.

ext_putValueInConf()

public ext_putValueInConf(string $key, string $var) : mixed

Parameters

$key : string
$var : string

ext_regObjectPositions()

public ext_regObjectPositions(string $constants) : void

Parameters

$constants : string

ext_regObjects()

public ext_regObjects(string $pre) : mixed

Parameters

$pre : string

ext_removeValueInConf()

public ext_removeValueInConf(string $key) : mixed

Parameters

$key : string

generateConfig()

Generates the configuration array by replacing constants and parsing the whole thing.

public generateConfig() : mixed

Depends on $this->config and $this->constants to be set prior to this! (done by processTemplate/runThroughTemplates)

Tags

see
TypoScriptParser
see
start()

generateConfig_constants()

Parse constants with respect to the constant-editor in this module.

public generateConfig_constants() : array

In particular comments in the code are registered and the edit_divider is taken into account.

Return values

array

getCurrentPageData()

Fetches the "currentPageData" array from cache

public getCurrentPageData(int $pageId, string $mountPointValue) : array

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

$pageId : int
$mountPointValue : string

Tags

throws
NoSuchCacheException

Return values

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

getProcessExtensionStatics()

public getProcessExtensionStatics() : bool

Return values

bool

getRootId()

Returns the page ID of the rootlevel

public getRootId() : int

Return values

int

getRootlineLevel()

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

public getRootlineLevel(string $list) : int

Parameters

$list : string

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

Return values

int —

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

includeStaticTypoScriptSources()

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

public includeStaticTypoScriptSources(string $idList, string $templateID, int $pid, array $row) : mixed

Parameters

$idList : string

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.

$templateID : string

The id of the current template. Same syntax as $idList ids, eg. "sys_123

$pid : int

The PID of the input template record

$row : array

A full TypoScript template record

Tags

see
processTemplate()

lineNumberToScript()

Find the originating template name for an array of line numbers (TypoScript setup only!) Given an array of linenumbers the method will try to find the corresponding template where this line originated The linenumber indicates the *last* lineNumber that is part of the template

public lineNumberToScript(array $lnArr) : string

lineNumbers are in sync with the calculated lineNumbers '.ln..' in TypoScriptParser

Parameters

$lnArr : array

Array with linenumbers (might have some extra symbols, for example for unsetting) to be processed

Return values

string —

Imploded array of line number and template title

matching()

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

public matching(array $cc) : array

Parameters

$cc : array

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

Return values

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.

processTemplate()

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

public processTemplate(array $row, string $idList, int $pid[, string $templateID = '' ][, string $templateParent = '' ][, string $includePath = '' ]) : mixed

Parameters

$row : array

A full TypoScript template record (sys_template/forged "dummy" record made from static template file)

$idList : string

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.

$pid : int

The PID of the input template record

$templateID : string = ''

The id of the current template. Same syntax as $idList ids, eg. "sys_123

$templateParent : string = ''

Parent template id (during recursive call); Same syntax as $idList ids, eg. "sys_123

$includePath : string = ''

Specifies the path from which the template was included (used with static_includes)

Tags

see
runThroughTemplates()

runThroughTemplates()

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.

public runThroughTemplates(array $theRootLine[, int $start_template_uid = 0 ]) : mixed

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

$theRootLine : array

The rootline of the current page (going ALL the way to tree root)

$start_template_uid : int = 0

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)

Tags

see
start()

setProcessExtensionStatics()

public setProcessExtensionStatics(bool $processExtensionStatics) : mixed

Parameters

$processExtensionStatics : bool

setVerbose()

sets the verbose parameter

public setVerbose(bool $verbose) : mixed

Parameters

$verbose : bool

start()

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.

public start(array $theRootLine) : mixed

Sets $this->setup to the parsed TypoScript template array

Parameters

$theRootLine : array

The rootline of the current page (going ALL the way to tree root)

Tags

see
TypoScriptFrontendController::getConfigArray()

substituteCMarkers()

Substitute markers added in substituteConstantsCallBack() with ##6chars_B##value1##6chars_M##value2##6chars_E##

public substituteCMarkers(string $all) : string

Parameters

$all : string

Return values

string

substituteConstants()

Substitute constant

public substituteConstants(string $all) : string

Parameters

$all : string

Return values

string

substituteConstantsCallBack()

Call back method for preg_replace_callback in substituteConstants

public substituteConstantsCallBack(array $matches) : string

Parameters

$matches : array

Regular expression matches

Tags

see
substituteConstants()

Return values

string —

Replacement

updateRootlineData()

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

public updateRootlineData(array $fullRootLine) : mixed

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

Parameters

$fullRootLine : array

Array containing the FULL rootline (up to the TYPO3 root)

Tags

throws
RuntimeException

If the given $fullRootLine does not contain all pages that are in the current template rootline

addDefaultTypoScript()

Adds the TypoScript from the global array.

protected addDefaultTypoScript() : mixed

The class property isDefaultTypoScriptAdded ensures that the adding only happens once.

Tags

see
isDefaultTypoScriptAdded

getCacheEntry()

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

protected getCacheEntry(string $identifier) : mixed

Parameters

$identifier : string

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

Return values

mixed —

The data from the cache

getRootLine()

Is set by runThroughTemplates(), previously set via TemplateAnalyzerModuleFunctionController from the outside

protected getRootLine() : array

Return values

array

getTemplateQueryBuilder()

Internal helper method to prepare the query builder for getting sys_template records from a given pid

protected getTemplateQueryBuilder(int $pid) : QueryBuilder

Parameters

$pid : int

The pid to select sys_template records from

Return values

QueryBuilder —

Returns a QueryBuilder

getTypoScriptSourceFileContent()

Retrieves the content of the first existing file by extension order.

protected getTypoScriptSourceFileContent(string $filePath, string $baseName) : string

Returns the empty string if no file is found.

Parameters

$filePath : string

The location of the file.

$baseName : string

The base file name. "constants" or "setup".

Return values

string

initializeDatabaseQueryRestrictions()

Set up the query builder restrictions, optionally include hidden records

protected initializeDatabaseQueryRestrictions() : mixed

prependStaticExtra()

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

protected prependStaticExtra(array $subrow) : array

Parameters

$subrow : array

Static template record/file

Tags

see
addExtensionStatics()
see
includeStaticTypoScriptSources()

Return values

array —

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

processIncludes()

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

protected processIncludes() : mixed

Tags

see
TypoScriptParser
see
generateConfig()

setCacheEntry()

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

protected setCacheEntry(string $identifier, mixed $data, string $tag) : mixed

Parameters

$identifier : string

32 bit hash string (eg. a md5 hash of a serialized array identifying the data being stored)

$data : mixed

The data to store

$tag : string

Is just a textual identification in order to inform about the content

versionOL()

Creating versioning overlay of a sys_template record.

protected versionOL(array &$row) : mixed

Parameters

$row : array

Row to overlay (passed by reference)

On this page