"TYPO3 4.0.1: t3lib_transferData Class Reference", "datetime" => "Sat Dec 2 19:26:26 2006", "date" => "2 Dec 2006", "doxygenversion" => "1.4.6", "projectname" => "TYPO3 4.0.1", "projectnumber" => "4.0.1" ); get_header($doxygen_vars); ?>

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_flexProc_procInData ($dataPart, $dataStructArray, $pParams)
 renderRecord_flexProc_procInData_travDS (&$dataValues, $DSelements, $pParams)
 selectAddSpecial ($dataAcc, $elements, $specialKey)
 selectAddForeign ($dataAcc, $elements, $fieldConfig, $field, $TSconfig, $row)
 getDataIdList ($elements, $fieldConfig, $row)
 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 98 of file class.t3lib_transferdata.php.


Member Function Documentation

t3lib_transferData::addItems items,
iArray
 

Adding items from $iArray to $items array

Parameters:
array The array of selector box items to which key(value) / value(label) pairs from $iArray will be added.
array The 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 878 of file class.t3lib_transferdata.php.

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:
string Table name, must be found in $TCA
string Comma 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.
string If "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 137 of file class.t3lib_transferdata.php.

References t3lib_BEfunc::deleteClause(), t3lib_BEfunc::fixVersioningPid(), t3lib_div::loadTCA(), lockRecord(), renderRecord(), and t3lib_div::trimExplode().

t3lib_transferData::getDataIdList elements,
fieldConfig,
row
 

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

Parameters:
array The array of original elements - basically the field value exploded by ","
array Field configuration from TCA
array The data array, currently. Used to set the "local_uid" for selecting MM relation records.
Returns:
array An array with ids of the records from the input elements array. private

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

References t3lib_div::makeInstance().

Referenced by 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:
string The table name
integer The id of the record
integer The pid of the record
Returns:
void

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

References 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:
array The elements to process
array TCA/columns configuration
array TSconfig for the field
string The table name
array The current row
string The field name
Returns:
array The modified input $selItems array private
See also:
renderRecord_selectProc()

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

References 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:
array The array of selector box items
array TSconfig for the fields itemProcFunc
array TCA/columns configuration
string The table name
array The current row
string The field name
Returns:
array The modified input $items array private
See also:
procesItemArray()

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

References 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:
string Table name
integer Record id
string Field name
string Field content.
Returns:
void private
See also:
renderRecord()

Reimplemented in transferData.

Definition at line 952 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:
string The table name
string The uid value of the record (integer). Can also be a string (NEW-something) if the record is a NEW record.
integer The 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)
array The 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 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:
string The field value
array TCA field config
array TCEform TSconfig for the record
string Table name
array The row
string Field name
Returns:
string The processed input field value ($data) private
See also:
renderRecord()

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

References 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:
array Data array
array Data Structure array
array Various parameters to pass-through
Returns:
array Modified $dataPart array. private
See also:
t3lib_TCEmain::checkValue_flex_procInData(), renderRecord_flexProc_procInData_travDS()

Definition at line 557 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:
array Data array passed by reference.
array Data structure
array Various parameters pass-through.
Returns:
void
See also:
renderRecord_flexProc_procInData(), t3lib_TCEmain::checkValue_flex_procInData_travDS()

Definition at line 586 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:
string The field value
array TCA field config
array TCEform TSconfig for the record
string Table name
array The row
string Field name
Returns:
string The processed input field value ($data) private
See also:
renderRecord()

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

References t3lib_div::makeInstance(), 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:
string The field value
array TCA field config
array TCEform TSconfig for the record
string Table name
array The row
string Field name
Returns:
string The processed input field value ($data) private
See also:
renderRecord()

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

References 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:
string Value to process
array TCA/columns array for field (independant of TCA for flexforms - coming from XML then)
array TSconfig (blank for flexforms for now)
string Table name
array The row array, always of the real record (also for flexforms)
string The field (empty for flexforms!)
Returns:
string Modified $value

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

References renderRecord_flexProc(), renderRecord_groupProc(), 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:
array The array of values which has been processed according to their type (eg. "group" or "select")
array The "types" configuration for the current display of fields.
integer PAGE TSconfig PID
string Table name
integer PID value
Returns:
array The processed version of $totalRecordContent private

Definition at line 501 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:
string The table name
string The uid value of the record (integer). Can also be a string (NEW-something) if the record is a NEW record.
integer The 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)
array The row of the current record. If NEW record, then it may be loaded with default values (by eg. fetchRecord()).
array Tsconfig array
integer PAGE TSconfig pid
Returns:
array Processed record data
See also:
renderRecord()

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

References t3lib_BEfunc::getTCAtypes(), t3lib_div::loadTCA(), regItem(), renderRecord_SW(), and renderRecord_typesProc().

Referenced by renderRecord().

t3lib_transferData::selectAddForeign dataAcc,
elements,
fieldConfig,
field,
TSconfig,
row
 

Adds the foreign record elements to $dataAcc, if any

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

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

References 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:
array Array with numeric keys, containing values for the selector box, prepared for interface. We are going to add elements to this array as needed.
array The array of original elements - basically the field value exploded by ","
string The "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 663 of file class.t3lib_transferdata.php.

References 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:
string Language label key
Returns:
string Localized label value. private

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

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


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