t3lib_flexformtools Klassenreferenz

Aufstellung aller Elemente

Öffentliche Methoden
	traverseFlexFormXMLData ($table, $field, $row, &$callBackObj, $callBackMethod_value)
	traverseFlexFormXMLData_recurse ($dataStruct, $editData, &$PA, $path='')
	getAvailableLanguages ()
	cleanFlexFormXML ($table, $field, $row)
	cleanFlexFormXML_callBackFunction ($dsArr, $data, $PA, $path, &$pObj)
&	getArrayValueByPath ($pathArray, &$array)
	setArrayValueByPath ($pathArray, &$array, $value)
	flexArray2Xml ($array, $addPrologue=FALSE)
Öffentliche Attribute
	$convertCharset = FALSE
	$reNumberIndexesOfSectionData = FALSE
	$traverseFlexFormXMLData_DS = array()
	$traverseFlexFormXMLData_Data = array()
	$flexArray2Xml_options
	$callBackObj = NULL
	$cleanFlexFormXML = array()

---

Dokumentation der Elementfunktionen

t3lib_flexformtools::cleanFlexFormXML	(	$	table,
		$	field,
		$	row
	)

Cleaning up FlexForm XML to hold only the values it may according to its Data Structure. Also the order of tags will follow that of the data structure. BE CAREFUL: DO not clean records in workspaces unless IN the workspace! The Data Structure might resolve falsely on a workspace record when cleaned from Live workspace.

Parameter:

	string	Table name
	string	Field name of the flex form field in which the XML is found that should be cleaned.
	array	The record

Rückgabe:

string Clean XML from FlexForm field

t3lib_flexformtools::cleanFlexFormXML_callBackFunction	(	$	dsArr,
		$	data,
		$	PA,
		$	path,
		&$	pObj
	)

Call back function for t3lib_flexformtools class Basically just setting the value in a new array (thus cleaning because only values that are valid are visited!)

Parameter:

	array	Data structure for the current value
	mixed	Current value
	array	Additional configuration used in calling function
	string	Path of value in DS structure
	object	Object reference to caller

Rückgabe:

void

t3lib_flexformtools::flexArray2Xml	(	$	array,
		$	addPrologue = FALSE
	)

Convert FlexForm data array to XML

Parameter:

	array	Array to output in <T3FlexForms> XML
	boolean	If set, the XML prologue is returned as well.

Rückgabe:

string XML content.

& t3lib_flexformtools::getArrayValueByPath	(	$	pathArray,
		&$	array
	)

Get a value from a multi-dimensional array by giving a path "../../.." pointing to the element

Parameter:

	string	The path pointing to the value field, eg. test/2/title to access $array['test'][2]['title']
	array	Array to get value from. Passed by reference so the value returned can be used to change the value in the array!

Rückgabe:

mixed Value returned

t3lib_flexformtools::getAvailableLanguages

(

)

Returns an array of available languages to use for FlexForm operations

Rückgabe:

array

t3lib_flexformtools::setArrayValueByPath	(	$	pathArray,
		&$	array,
		$	value
	)

Set a value in a multi-dimensional array by giving a path "../../.." pointing to the element

Parameter:

	string	The path pointing to the value field, eg. test/2/title to access $array['test'][2]['title']
	array	Array to set value in. Passed by reference so the value returned can be used to change the value in the array!
	mixed	Value to set

Rückgabe:

mixed Value returned

t3lib_flexformtools::traverseFlexFormXMLData	(	$	table,
		$	field,
		$	row,
		&$	callBackObj,
		$	callBackMethod_value
	)

Handler for Flex Forms

Parameter:

	string	The table name of the record
	string	The field name of the flexform field to work on
	array	The record data array
	object	Object (passed by reference) in which the call back function is located
	string	Method name of call back function in object for values

Rückgabe:

boolean If true, error happened (error string returned)

t3lib_flexformtools::traverseFlexFormXMLData_recurse	(	$	dataStruct,
		$	editData,
		&$	PA,
		$	path = ''
	)

Recursively traversing flexform data according to data structure and element data

Parameter:

	array	(Part of) data structure array that applies to the sub section of the flexform data we are processing
	array	(Part of) edit data array, reflecting current part of data structure
	array	Additional parameters passed.
	string	Telling the "path" to the element in the flexform XML

Rückgabe:

array

---

Dokumentation der Datenelemente

t3lib_flexformtools::$callBackObj = NULL

Reference to object called

t3lib_flexformtools::$flexArray2Xml_options

Initialisierung:

 array(
                        'parentTagMap' => array(
                                'data' => 'sheet',
                                'sheet' => 'language',
                                'language' => 'field',
                                'el' => 'field',
                                'field' => 'value',
                                'field:el' => 'el',
                                'el:_IS_NUM' => 'section',
                                'section' => 'itemType'
                        ),
                        'disableTypeAttrib' => 2
                )

---

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

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