TYPO3 API  SVNRelease
Public Member Functions | Public Attributes
t3lib_transferData Class Reference
Inheritance diagram for t3lib_transferData:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 fetchRecord ($table, $idList, $operation)
 renderRecord ($table, $id, $pid, $row)
 renderRecordRaw ($table, $id, $pid, $row, $TSconfig= '', $tscPID=0)
 renderRecord_SW ($data, $fieldConfig, $TSconfig, $table, $row, $field)
 renderRecord_groupProc ($data, $fieldConfig, $TSconfig, $table, $row, $field)
 renderRecord_selectProc ($data, $fieldConfig, $TSconfig, $table, $row, $field)
 renderRecord_flexProc ($data, $fieldConfig, $TSconfig, $table, $row, $field)
 renderRecord_typesProc ($totalRecordContent, $types_fieldConfig, $tscPID, $table, $pid)
 renderRecord_inlineProc ($data, $fieldConfig, $TSconfig, $table, $row, $field)
 renderRecord_flexProc_procInData ($dataPart, $dataStructArray, $pParams)
 renderRecord_flexProc_procInData_travDS (&$dataValues, $DSelements, $pParams)
 selectAddSpecial ($dataAcc, $elements, $specialKey)
 selectAddForeign ($dataAcc, $elements, $fieldConfig, $field, $TSconfig, $row, $table)
 getDataIdList ($elements, $fieldConfig, $row, $table)
 procesItemArray ($selItems, $config, $fieldTSConfig, $table, $row, $field)
 addItems ($items, $iArray)
 procItems ($items, $itemsProcFuncTSconfig, $config, $table, $row, $field)
 lockRecord ($table, $id, $pid=0)
 regItem ($table, $id, $field, $content)
 sL ($in)

Public Attributes

 $lockRecords = 0
 $disableRTE = 0
 $prevPageID = ''
 $defVals = array()
 $addRawData = FALSE
 $regTableItems = array()
 $regTableItems_data = array()
 $loadModules = ''

Detailed Description

Definition at line 83 of file class.t3lib_transferdata.php.


Member Function Documentation

t3lib_transferData::addItems ( items,
iArray 
)

Adding items from $iArray to $items array

Parameters:
arrayThe array of selector box items to which key(value) / value(label) pairs from $iArray will be added.
arrayThe array of elements to add. The keys will become values. The value will become the label.
Returns:
array The modified input $items array private
See also:
procesItemArray()

Definition at line 930 of file class.t3lib_transferdata.php.

References $items, and $value.

Referenced by procesItemArray().

t3lib_transferData::fetchRecord ( table,
idList,
operation 
)

A function which can be used for load a batch of records from $table into internal memory of this object. The function is also used to produce proper default data for new records Ultimately the function will call renderRecord()

Parameters:
stringTable name, must be found in $TCA
stringComma list of id values. If $idList is "prev" then the value from $this->prevPageID is used. NOTICE: If $operation is "new", then negative ids are meant to point to a "previous" record and positive ids are PID values for new records. Otherwise (for existing records that is) it is straight forward table/id pairs.
stringIf "new", then a record with default data is returned. Further, the $id values are meant to be PID values (or if negative, pointing to a previous record). If NOT new, then the table/ids are just pointing to an existing record!
Returns:
void
See also:
renderRecord()

Definition at line 114 of file class.t3lib_transferdata.php.

References $GLOBALS, $pid, $res, $row, $TCA, t3lib_BEfunc\deleteClause(), t3lib_BEfunc\fixVersioningPid(), t3lib_div\loadTCA(), lockRecord(), renderRecord(), and t3lib_div\trimExplode().

t3lib_transferData::getDataIdList ( elements,
fieldConfig,
row,
table 
)

Returning the id-list processed by loadDBgroup for the foreign tables.

Parameters:
arrayThe array of original elements - basically the field value exploded by ","
arrayField configuration from TCA
arrayThe data array, currently. Used to set the "local_uid" for selecting MM relation records.
stringCurrent table name. passed on to t3lib_loadDBGroup
Returns:
array An array with ids of the records from the input elements array. private

Definition at line 884 of file class.t3lib_transferdata.php.

References $row, and t3lib_div\makeInstance().

Referenced by renderRecord_inlineProc(), renderRecord_selectProc(), and selectAddForeign().

t3lib_transferData::lockRecord ( table,
id,
pid = 0 
)

Sets the lock for a record from table/id, IF $this->lockRecords is set!

Parameters:
stringThe table name
integerThe id of the record
integerThe pid of the record
Returns:
void

Definition at line 980 of file class.t3lib_transferdata.php.

References $pid, and t3lib_BEfunc\lockRecords().

Referenced by fetchRecord().

t3lib_transferData::procesItemArray ( selItems,
config,
fieldTSConfig,
table,
row,
field 
)

Processing of selector box items. This includes the automated adding of elements plus user-function processing.

Parameters:
arrayThe elements to process
arrayTCA/columns configuration
arrayTSconfig for the field
stringThe table name
arrayThe current row
stringThe field name
Returns:
array The modified input $selItems array private
See also:
renderRecord_selectProc()

Definition at line 913 of file class.t3lib_transferdata.php.

References $row, addItems(), and procItems().

Referenced by renderRecord_selectProc().

t3lib_transferData::procItems ( items,
itemsProcFuncTSconfig,
config,
table,
row,
field 
)

User processing of a selector box array of values.

Parameters:
arrayThe array of selector box items
arrayTSconfig for the fields itemProcFunc
arrayTCA/columns configuration
stringThe table name
arrayThe current row
stringThe field name
Returns:
array The modified input $items array private
See also:
procesItemArray()

Definition at line 952 of file class.t3lib_transferdata.php.

References $items, $row, and t3lib_div\callUserFunction().

Referenced by procesItemArray().

t3lib_transferData::regItem ( table,
id,
field,
content 
)

Dummy function, can be used to "register" records. Used by eg. the "show_item" script.

Parameters:
stringTable name
integerRecord id
stringField name
stringField content.
Returns:
void private
See also:
renderRecord()

Reimplemented in transferData.

Definition at line 997 of file class.t3lib_transferdata.php.

Referenced by renderRecordRaw().

t3lib_transferData::renderRecord ( table,
id,
pid,
row 
)

This function performs processing on the input $row array and stores internally a corresponding array which contains processed values, ready to pass on to the TCEforms rendering in the frontend! The objective with this function is to prepare the content for handling in TCEforms. Default values from outside/TSconfig is added by fetchRecord(). In this function default values from TCA is used if a field is NOT defined in $row. The resulting, processed row is stored in $this->regTableItems_data[$uniqueItemRef], where $uniqueItemRef is "[tablename]_[id-value]"

Parameters:
stringThe table name
stringThe uid value of the record (integer). Can also be a string (NEW-something) if the record is a NEW record.
integerThe pid integer. For existing records this is of course the row's "pid" field. For new records it can be either a page id (positive) or a pointer to another record from the SAME table (negative) after which the record should be inserted (or on same page)
arrayThe row of the current record. If NEW record, then it may be loaded with default values (by eg. fetchRecord()).
Returns:
void
See also:
fetchRecord()

Definition at line 224 of file class.t3lib_transferdata.php.

References $pid, $row, $TCA, t3lib_BEfunc\getTCEFORM_TSconfig(), t3lib_BEfunc\getTSCpid(), t3lib_div\loadTCA(), and renderRecordRaw().

Referenced by fetchRecord().

t3lib_transferData::renderRecord_flexProc ( data,
fieldConfig,
TSconfig,
table,
row,
field 
)

Processing of the data value in case the field type is "flex" MUST NOT be called in case of already INSIDE a flexform!

Parameters:
stringThe field value
arrayTCA field config
arrayTCEform TSconfig for the record
stringTable name
arrayThe row
stringField name
Returns:
string The processed input field value ($data) private
See also:
renderRecord()

Definition at line 477 of file class.t3lib_transferdata.php.

References $row, $TCA, t3lib_BEfunc\getFlexFormDS(), t3lib_div\makeInstance(), renderRecord_flexProc_procInData(), and t3lib_div\xml2array().

Referenced by renderRecord_SW().

t3lib_transferData::renderRecord_flexProc_procInData ( dataPart,
dataStructArray,
pParams 
)

Function traversing sheets/languages for flex form data structures

Parameters:
arrayData array
arrayData Structure array
arrayVarious parameters to pass-through
Returns:
array Modified $dataPart array. private
See also:
t3lib_TCEmain::checkValue_flex_procInData(), renderRecord_flexProc_procInData_travDS()

Definition at line 601 of file class.t3lib_transferdata.php.

References renderRecord_flexProc_procInData_travDS(), and t3lib_div\resolveSheetDefInDS().

Referenced by renderRecord_flexProc().

t3lib_transferData::renderRecord_flexProc_procInData_travDS ( &$  dataValues,
DSelements,
pParams 
)

Traverse data array / structure

Parameters:
arrayData array passed by reference.
arrayData structure
arrayVarious parameters pass-through.
Returns:
void
See also:
renderRecord_flexProc_procInData(), t3lib_TCEmain::checkValue_flex_procInData_travDS()

Definition at line 630 of file class.t3lib_transferdata.php.

References renderRecord_SW().

Referenced by renderRecord_flexProc_procInData().

t3lib_transferData::renderRecord_groupProc ( data,
fieldConfig,
TSconfig,
table,
row,
field 
)

Processing of the data value in case the field type is "group"

Parameters:
stringThe field value
arrayTCA field config
arrayTCEform TSconfig for the record
stringTable name
arrayThe row
stringField name
Returns:
string The processed input field value ($data) private
See also:
renderRecord()

Definition at line 359 of file class.t3lib_transferdata.php.

References $row, $value, t3lib_div\makeInstance(), and t3lib_div\trimExplode().

Referenced by renderRecord_SW().

t3lib_transferData::renderRecord_inlineProc ( data,
fieldConfig,
TSconfig,
table,
row,
field 
)

Processing of the data value in case the field type is "inline" In some parts nearly the same as type "select"

Parameters:
stringThe field value
arrayTCA field config
arrayTCEform TSconfig for the record
stringTable name
arrayThe row
stringField name
Returns:
string The processed input field value ($data) private
See also:
renderRecord()

Definition at line 557 of file class.t3lib_transferdata.php.

References $row, $TCA, $value, getDataIdList(), and t3lib_div\trimExplode().

Referenced by renderRecord_SW().

t3lib_transferData::renderRecord_selectProc ( data,
fieldConfig,
TSconfig,
table,
row,
field 
)

Processing of the data value in case the field type is "select"

Parameters:
stringThe field value
arrayTCA field config
arrayTCEform TSconfig for the record
stringTable name
arrayThe row
stringField name
Returns:
string The processed input field value ($data) private
See also:
renderRecord()

Definition at line 411 of file class.t3lib_transferdata.php.

References $row, $TCA, $value, getDataIdList(), procesItemArray(), selectAddForeign(), selectAddSpecial(), sL(), and t3lib_div\trimExplode().

Referenced by renderRecord_SW().

t3lib_transferData::renderRecord_SW ( data,
fieldConfig,
TSconfig,
table,
row,
field 
)

Function with the switch() construct which triggers functions for processing of the data value depending on the TCA-config field type.

Parameters:
stringValue to process
arrayTCA/columns array for field (independant of TCA for flexforms - coming from XML then)
arrayTSconfig (blank for flexforms for now)
stringTable name
arrayThe row array, always of the real record (also for flexforms)
stringThe field (empty for flexforms!)
Returns:
string Modified $value

Definition at line 327 of file class.t3lib_transferdata.php.

References $row, renderRecord_flexProc(), renderRecord_groupProc(), renderRecord_inlineProc(), and renderRecord_selectProc().

Referenced by renderRecord_flexProc_procInData_travDS(), and renderRecordRaw().

t3lib_transferData::renderRecord_typesProc ( totalRecordContent,
types_fieldConfig,
tscPID,
table,
pid 
)

Processing of the content in $totalRecordcontent based on settings in the types-configuration

Parameters:
arrayThe array of values which has been processed according to their type (eg. "group" or "select")
arrayThe "types" configuration for the current display of fields.
integerPAGE TSconfig PID
stringTable name
integerPID value
Returns:
array The processed version of $totalRecordContent private

Definition at line 516 of file class.t3lib_transferdata.php.

References t3lib_parsehtml_proc\evalWriteFile(), and t3lib_div\makeInstance().

Referenced by renderRecordRaw().

t3lib_transferData::renderRecordRaw ( table,
id,
pid,
row,
TSconfig = '',
tscPID = 0 
)

This function performs processing on the input $row array and stores internally a corresponding array which contains processed values, ready to pass on to the TCEforms rendering in the frontend! The objective with this function is to prepare the content for handling in TCEforms. In opposite to renderRecord() this function do not prepare things like fetching TSconfig and others. The resulting, processed row will be returned.

Parameters:
stringThe table name
stringThe uid value of the record (integer). Can also be a string (NEW-something) if the record is a NEW record.
integerThe pid integer. For existing records this is of course the row's "pid" field. For new records it can be either a page id (positive) or a pointer to another record from the SAME table (negative) after which the record should be inserted (or on same page)
arrayThe row of the current record. If NEW record, then it may be loaded with default values (by eg. fetchRecord()).
arrayTsconfig array
integerPAGE TSconfig pid
Returns:
array Processed record data
See also:
renderRecord()

Definition at line 269 of file class.t3lib_transferdata.php.

References $pid, $row, $TCA, t3lib_BEfunc\getTCAtypes(), t3lib_div\loadTCA(), regItem(), renderRecord_SW(), and renderRecord_typesProc().

Referenced by renderRecord().

t3lib_transferData::selectAddForeign ( dataAcc,
elements,
fieldConfig,
field,
TSconfig,
row,
table 
)

Adds the foreign record elements to $dataAcc, if any

Parameters:
arrayArray with numeric keys, containing values for the selector box, prepared for interface. We are going to add elements to this array as needed.
arrayThe array of original elements - basically the field value exploded by ","
arrayField configuration from TCA
stringThe field name
arrayTSconfig for the record
arrayThe record
arrayThe current table
Returns:
array Modified $dataAcc array private
See also:
renderRecord_selectProc()

Definition at line 828 of file class.t3lib_transferdata.php.

References $GLOBALS, $row, $TCA, $value, t3lib_BEfunc\exec_foreign_table_where_query(), t3lib_div\fixed_lgd_cs(), getDataIdList(), t3lib_BEfunc\getRecordTitle(), and sL().

Referenced by renderRecord_selectProc().

t3lib_transferData::selectAddSpecial ( dataAcc,
elements,
specialKey 
)

Adding "special" types to the $dataAcc array of selector items

Parameters:
arrayArray with numeric keys, containing values for the selector box, prepared for interface. We are going to add elements to this array as needed.
arrayThe array of original elements - basically the field value exploded by ","
stringThe "special" key from the TCA config of the field. Determines the type of processing in here.
Returns:
array Modified $dataAcc array private
See also:
renderRecord_selectProc()

Definition at line 701 of file class.t3lib_transferdata.php.

References $GLOBALS, $TCA, $value, t3lib_BEfunc\getExcludeFields(), t3lib_BEfunc\getExplicitAuthFieldValues(), t3lib_BEfunc\getSystemLanguages(), t3lib_div\makeInstance(), and sL().

Referenced by renderRecord_selectProc().

t3lib_transferData::sL ( in)

Local wrapper function for LANG->sL (returning language labels)

Parameters:
stringLanguage label key
Returns:
string Localized label value. private

Definition at line 1007 of file class.t3lib_transferdata.php.

References $GLOBALS.

Referenced by renderRecord_selectProc(), selectAddForeign(), and selectAddSpecial().


Member Data Documentation

t3lib_transferData::$addRawData = FALSE

Definition at line 89 of file class.t3lib_transferdata.php.

t3lib_transferData::$defVals = array()

Definition at line 88 of file class.t3lib_transferdata.php.

t3lib_transferData::$disableRTE = 0

Definition at line 86 of file class.t3lib_transferdata.php.

t3lib_transferData::$loadModules = ''

Definition at line 94 of file class.t3lib_transferdata.php.

t3lib_transferData::$lockRecords = 0

Definition at line 85 of file class.t3lib_transferdata.php.

t3lib_transferData::$prevPageID = ''

Definition at line 87 of file class.t3lib_transferdata.php.

t3lib_transferData::$regTableItems = array()

Definition at line 92 of file class.t3lib_transferdata.php.

t3lib_transferData::$regTableItems_data = array()

Definition at line 93 of file class.t3lib_transferdata.php.


The documentation for this class was generated from the following file: