Solutions Open Source

Référence de la classe t3lib_flexformtools

Liste de tous les membres

Fonctions membres publiques

 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)

Attributs publics

 $convertCharset = FALSE
 $reNumberIndexesOfSectionData = FALSE
 $traverseFlexFormXMLData_DS = array()
 $traverseFlexFormXMLData_Data = array()
 $flexArray2Xml_options
 $callBackObj = NULL
 $cleanFlexFormXML = array()


Documentation des fonctions membres

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

Handler for Flex Forms

Paramètres:
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
Renvoie:
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

Paramètres:
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
Renvoie:
array

t3lib_flexformtools::getAvailableLanguages (  ) 

Returns an array of available languages to use for FlexForm operations

Renvoie:
array

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.

Paramètres:
string Table name
string Field name of the flex form field in which the XML is found that should be cleaned.
array The record
Renvoie:
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!)

Paramètres:
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
Renvoie:
void

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

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

Paramètres:
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!
Renvoie:
mixed Value returned

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

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

Paramètres:
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
Renvoie:
mixed Value returned

t3lib_flexformtools::flexArray2Xml ( array,
addPrologue = FALSE 
)

Convert FlexForm data array to XML

Paramètres:
array Array to output in <T3FlexForms> XML
boolean If set, the XML prologue is returned as well.
Renvoie:
string XML content.


Documentation des données membres

t3lib_flexformtools::$convertCharset = FALSE

t3lib_flexformtools::$reNumberIndexesOfSectionData = FALSE

t3lib_flexformtools::$traverseFlexFormXMLData_DS = array()

t3lib_flexformtools::$traverseFlexFormXMLData_Data = array()

t3lib_flexformtools::$flexArray2Xml_options

Valeur initiale :

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

t3lib_flexformtools::$callBackObj = NULL

t3lib_flexformtools::$cleanFlexFormXML = array()


La documentation de cette classe a été générée à partir du fichier suivant :
Généré le Fri Aug 31 11:42:14 2007 pour OBLADY - Typo3 API v4.1.2 par  doxygen 1.5.3