t3lib_TSparser Klassenreferenz

Aufstellung aller Elemente

Öffentliche Methoden
	parse ($string, $matchObj='')
	nextDivider ()
	parseSub (&$setup)
	rollParseSub ($string, &$setup)
	getVal ($string, $setup)
	setVal ($string, &$setup, $value, $wipeOut=0)
	error ($err, $num=2)
	checkIncludeLines_array ($array)
	doSyntaxHighlight ($string, $lineNum='', $highlightBlockMode=0)
	regHighLight ($code, $pointer, $strlen=-1)
	syntaxHighlight_print ($lineNumDat, $highlightBlockMode)
Öffentliche, statische Methoden
	checkIncludeLines ($string, $cycle_counter=1)
Öffentliche Attribute
	$strict = 1
	$setup = Array()
	$raw
	$rawP
	$lastComment = ''
	$commentSet = 0
	$multiLineEnabled = 0
	$multiLineObject = ''
	$multiLineValue = array()
	$inBrace = 0
	$lastConditionTrue = 1
	$sections = array()
	$sectionsMatch = array()
	$syntaxHighLight = 0
	$highLightData = array()
	$highLightData_bracelevel = array()
	$regComments = 0
	$regLinenumbers = 0
	$errors = array()
	$lineNumberOffset = 0
	$breakPointLN = 0
	$highLightStyles
	$highLightBlockStyles = ''
	$highLightBlockStyles_basecolor = '#cccccc'

---

Dokumentation der Elementfunktionen

t3lib_TSparser::checkIncludeLines	(	$	string,
		$	cycle_counter = 1
	)			[static]

Checks the input string (un-parsed TypoScript) for include-commands ("<INCLUDE_TYPOSCRIPT: ....") Use: t3lib_TSparser::checkIncludeLines()

Parameter:

	string	Unparsed TypoScript
	integer	Counter for detecting endless loops

Rückgabe:

string Complete TypoScript with includes added.

t3lib_TSparser::checkIncludeLines_array

(

$

array

)

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

Parameter:

array

Array with TypoScript in each value

Rückgabe:

array Same array but where the values has been parsed for include-commands

t3lib_TSparser::doSyntaxHighlight	(	$	string,
		$	lineNum = '',
		$	highlightBlockMode = 0
	)

Syntax highlight a TypoScript text Will parse the content. Remember, the internal setup array may contain invalid parsed content since conditions are ignored!

Parameter:

	string	The TypoScript text
	mixed	If blank, linenumbers are NOT printed. If array then the first key is the linenumber offset to add to the internal counter.
	boolean	If set, then the highlighted output will be formatted in blocks based on the brace levels. prespace will be ignored and empty lines represented with a single no-break-space.

Rückgabe:

string HTML code for the syntax highlighted string

t3lib_TSparser::error	(	$	err,
		$	num = 2
	)

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.

Parameter:

	string	The error message string
	integer	The error severity (in the scale of $GLOBALS['TT']->setTSlogMessage: Approx: 2=warning, 1=info, 0=nothing, 3=fatal.)

Rückgabe:

void

t3lib_TSparser::getVal	(	$	string,
		$	setup
	)

Get a value/property pair for an object path in TypoScript, eg. "myobject.myvalue.mysubproperty". Here: Used by the "copy" operator, <

Parameter:

	string	Object path for which to get the value
	array	Global setup code if $string points to a global object path. But if string is prefixed with "." then its the local setup array.

Rückgabe:

array An array with keys 0/1 being value/property respectively

t3lib_TSparser::nextDivider

(

)

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.

Rückgabe:

string The condition value

Siehe auch:

parse()

t3lib_TSparser::parse	(	$	string,
		$	matchObj = ''
	)

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

Parameter:

	string	The TypoScript text
	object	If is object (instance of t3lib_matchcondition), then this is used to match conditions found in the TypoScript code. If matchObj not specified, then no conditions will work! (Except [GLOBAL])

Rückgabe:

void

t3lib_TSparser::parseSub

(

&$

setup

)

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

Parameter:

array

Reference to the setup array in which to accumulate the values.

Rückgabe:

string Returns the string of the condition found, the exit signal or possible nothing (if it completed parsing with no interruptions)

t3lib_TSparser::regHighLight	(	$	code,
		$	pointer,
		$	strlen = -1
	)

Registers a part of a TypoScript line for syntax highlighting.

Parameter:

	string	Key from the internal array $this->highLightStyles
	integer	Pointer to the line in $this->raw which this is about
	integer	The number of chars LEFT on this line before the end is reached.

Rückgabe:

void private

Siehe auch:

parse()

t3lib_TSparser::rollParseSub	(	$	string,
		&$	setup
	)

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

Parameter:

	string	The object sub-path, eg "thisprop.another_prot"
	array	The local setup array from the function calling this function

Rückgabe:

string Returns the exitSignal

Siehe auch:

parseSub()

t3lib_TSparser::setVal	(	$	string,
		&$	setup,
		$	value,
		$	wipeOut = 0
	)

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

Parameter:

	string	The object sub-path, eg "thisprop.another_prot"
	array	The local setup array from the function calling this function.
	array	The value/property pair array to set. If only one of them is set, then the other is not touched (unless $wipeOut is set, which it is when copies are made which must include both value and property)
	boolean	If set, then both value and property is wiped out when a copy is made of another value.

Rückgabe:

void

t3lib_TSparser::syntaxHighlight_print	(	$	lineNumDat,
		$	highlightBlockMode
	)

Formatting the TypoScript code in $this->raw based on the data collected by $this->regHighLight in $this->highLightData

Parameter:

	mixed	If blank, linenumbers are NOT printed. If array then the first key is the linenumber offset to add to the internal counter.
	boolean	If set, then the highlighted output will be formatted in blocks based on the brace levels. prespace will be ignored and empty lines represented with a single no-break-space.

Rückgabe:

string HTML content private

Siehe auch:

doSyntaxHighlight()

---

Dokumentation der Datenelemente

t3lib_TSparser::$highLightStyles

Initialisierung:

array(
                'prespace'                      => array('<span class="ts-prespace">','</span>'),       
                'objstr_postspace'      => array('<span class="ts-objstr_postspace">','</span>'),       
                'operator_postspace' => array('<span class="ts-operator_postspace">','</span>'),        
                'operator'                      => array('<span class="ts-operator">','</span>'),       
                'value'                         => array('<span class="ts-value">','</span>'),  
                'objstr'                        => array('<span class="ts-objstr">','</span>'), 
                'value_copy'            => array('<span class="ts-value_copy">','</span>'),     
                'value_unset'           => array('<span class="ts-value_unset">','</span>'),    
                'ignored'                       => array('<span class="ts-ignored">','</span>'),        
                'default'                       => array('<span class="ts-default">','</span>'),        
                'comment'                       => array('<span class="ts-comment">','</span>'),        
                'condition'                     => array('<span class="ts-condition">','</span>'),      
                'error'                         => array('<span class="ts-error">','</span>'),  
                'linenum'                       => array('<span class="ts-linenum">','</span>'),        
        )

---

Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei:

• /srv/www/vhosts/typo3.local/typo3_src-4.2.10/t3lib/class.t3lib_tsparser.php