TypoScriptParser

The TypoScript parser

Table of Contents

Properties

$breakPointLN  : mixed

$errors  : array<string|int, mixed>

Error accumulation array.

$lineNumberOffset  : int

Used for the error messages line number reporting. Set externally.

$parentObject  : mixed

$regComments  : bool

DO NOT register the comments. This is default for the ordinary sitetemplate!

$regLinenumbers  : bool

DO NOT register the linenumbers. This is default for the ordinary sitetemplate!

$sections  : array<string|int, mixed>

Tracking all conditions found

$sectionsMatch  : array<string|int, mixed>

Tracking all matching conditions found

$setup  : array<string|int, mixed>

TypoScript hierarchy being build during parsing.

$commentSet  : bool

Internally set, used as internal flag to create a multi-line comment (one of those like /* ... * /

$inBrace  : int

Internally set, when in brace. Counter.

$lastComment  : string

Holding the value of the last comment

$lastConditionTrue  : bool

For each condition this flag is set, if the condition is TRUE, else it's cleared. Then it's used by the [ELSE] condition to determine if the next part should be parsed.

$multiLineEnabled  : bool

Internally set, when multiline value is accumulated

$multiLineObject  : string

Internally set, when multiline value is accumulated

$multiLineValue  : array<string|int, mixed>

Internally set, when multiline value is accumulated

$raw  : array<string|int, string>

Raw data, the input string exploded by LF

$rawP  : int

Pointer to entry in raw data array

Methods

checkIncludeLines()  : string|array<string|int, mixed>

Checks the input string (un-parsed TypoScript) for include-commands ("<INCLUDE_TYPOSCRIPT: ....") Use: \TYPO3\CMS\Core\TypoScript\Parser\TypoScriptParser::checkIncludeLines()

checkIncludeLines_array()  : array<string|int, mixed>

Parses the string in each value of the input array for include-commands

doSyntaxHighlight()  : string

extractIncludes()  : string

Search for commented INCLUDE_TYPOSCRIPT statements and save the content between the BEGIN and the END line to the specified file

extractIncludes_array()  : array<string|int, mixed>

Processes the string in each value of the input array with extractIncludes

getVal()  : array<string|int, mixed>

Get a value/property pair for an object path in TypoScript, eg. "myobject.myvalue.mysubproperty".

includeFile()  : mixed

Include file $filename. Contents of the file will be prepended to &$newstring, filename to &$includedFiles Further include_typoscript tags in the contents are processed recursively

parse()  : mixed

Start parsing the input TypoScript text piece. The result is stored in $this->setup

addImportsFromExternalFiles()  : string

Splits the unparsed TypoScript content into import statements

error()  : mixed

Stacks errors/messages from the TypoScript parser into an internal array, $this->error If "TT" is a global object (as it is in the frontend when backend users are logged in) the message will be registered here as well.

executeValueModifier()  : string|null

Executes operator functions, called from TypoScript example: page.10.value := appendString(!)

getLogger()  : LoggerInterface

Get a logger instance

getTimeTracker()  : TimeTracker

importExternalTypoScriptFile()  : string

Include file $filename. Contents of the file will be returned, filename is added to &$includedFiles.

includeDirectory()  : mixed

Include all files with matching Typoscript extensions in directory $dirPath. Contents of the files are prepended to &$newstring, filename to &$includedFiles.

nextDivider()  : string

Will search for the next condition. When found it will return the line content (the condition value) and have advanced the internal $this->rawP pointer to point to the next line after the condition.

parseNextKeySegment()  : array<string|int, mixed>

Determines the first key segment of a TypoScript key by searching for the first unescaped dot in the given key string.

parseSub()  : string

Parsing the $this->raw TypoScript lines from pointer, $this->rawP

rollParseSub()  : string

Parsing of TypoScript keys inside a curly brace where the key is composite of at least two keys, thus having to recursively call itself to get the value

setVal()  : mixed

Setting a value/property of an object string in the setup array.

typoscriptIncludeError()  : string

Process errors in INCLUDE_TYPOSCRIPT tags Errors are logged and printed in the concatenated TypoScript result (as can be seen in Template Analyzer)