Documentation TYPO3 par Ameos

Disponible dans d'autres versions de TYPO3 -> 3.7.0 3.8.1 4.0.0 4.0.1 4.1.0 <- Available in other TYPO3 versions

t3lib_TCEmain Class Reference


Public Member Functions
	start ($data, $cmd, $altUserObject='')
	setMirror ($mirror)
	setDefaultsFromUserTS ($userTS)
	process_uploads ($postFiles)
	process_uploads_traverseArray (&$outputArr, $inputArr, $keyToSet)
	process_datamap ()
	fillInFieldArray ($table, $id, $fieldArray, $incomingFieldArray, $realPid, $status, $tscPID)
	checkModifyAccessList ($table)
	isRecordInWebMount ($table, $id)
	isInWebMount ($pid)
	checkRecordUpdateAccess ($table, $id)
	checkRecordInsertAccess ($insertTable, $pid, $action=1)
	isTableAllowedForThisPage ($page_uid, $checkTable)
	doesRecordExist ($table, $id, $perms)
	doesRecordExist_pageLookUp ($id, $perms)
	doesBranchExist ($inList, $pid, $perms, $recurse)
	pageInfo ($id, $field)
	recordInfo ($table, $id, $fieldList)
	getRecordProperties ($table, $id)
	getRecordPropertiesFromRow ($table, $row)
	setTSconfigPermissions ($fieldArray, $TSConfig_p)
	newFieldArray ($table)
	overrideFieldArray ($table, $data)
	assemblePermissions ($string)
	checkValue ($table, $field, $value, $id, $status, $realPid, $tscPID)
	checkValue_SW ($res, $value, $tcaFieldConf, $table, $id, $curValue, $status, $realPid, $recFID, $field, $uploadedFiles, $tscPID)
	checkValue_input ($res, $value, $tcaFieldConf, $PP, $field='')
	checkValue_check ($res, $value, $tcaFieldConf, $PP)
	checkValue_radio ($res, $value, $tcaFieldConf, $PP)
	checkValue_group_select ($res, $value, $tcaFieldConf, $PP, $uploadedFiles, $field)
	checkValue_group_select_file ($valueArray, $tcaFieldConf, $curValue, $uploadedFileArray, $status, $table, $id, $recFID)
	checkValue_flex ($res, $value, $tcaFieldConf, $PP, $uploadedFiles, $field)
	checkValue_flexArray2Xml ($array)
	_DELETE_FLEX_FORMdata (&$valueArrayToRemoveFrom, $deleteCMDS)
	getUnique ($table, $field, $value, $id, $newPid=0)
	checkValue_input_Eval ($value, $evalArray, $is_in)
	checkValue_group_select_processDBdata ($valueArray, $tcaFieldConf, $id, $status, $type)
	checkValue_group_select_explodeSelectGroupValue ($value)
	checkValue_flex_procInData ($dataPart, $dataPart_current, $uploadedFiles, $dataStructArray, $pParams, $callBackFunc='')
	checkValue_flex_procInData_travDS (&$dataValues, $dataValues_current, $uploadedFiles, $DSelements, $pParams, $callBackFunc='')
	updateDB ($table, $id, $fieldArray)
	compareFieldArrayWithCurrentAndUnset ($table, $id, $fieldArray)
	insertDB ($table, $id, $fieldArray, $newVersion=FALSE)
	checkStoredRecord ($table, $id, $fieldArray, $action)
	dbAnalysisStoreExec ()
	removeRegisteredFiles ()
	clear_cache ($table, $uid)
	getPID ($table, $uid)
	process_cmdmap ()
	moveRecord ($table, $uid, $destPid)
	copyRecord ($table, $uid, $destPid, $first=0, $overrideValues=array(), $excludeFields='')
	copyRecord_raw ($table, $uid, $pid, $overrideArray=array())
	insertNewCopyVersion ($table, $fieldArray, $realPid)
	copyRecord_procBasedOnFieldType ($table, $uid, $field, $value, $row, $conf)
	copyRecord_localize ($table, $uid, $language)
	copyRecord_flexFormCallBack ($pParams, $dsConf, $dataValue, $dataValue_ext1, $dataValue_ext2)
	copyRecord_procFilesRefs ($conf, $uid, $value)
	copyPages ($uid, $destPid)
	copySpecificPage ($uid, $destPid, $copyTablesArray, $first=0)
	versionizeRecord ($table, $id, $label)
	versionizePages ($uid, $label)
	rawCopyPageContent ($old_pid, $new_pid, $copyTablesArray)
	version_swap ($table, $id, $swapWith, $swapContent)
	int_pageTreeInfo ($CPtable, $pid, $counter, $rootID)
	compileAdminTables ()
	fixUniqueInPid ($table, $uid)
	fixCopyAfterDuplFields ($table, $uid, $prevUid, $update, $newData=array())
	extFileFields ($table)
	getCopyHeader ($table, $pid, $field, $value, $count, $prevTitle='')
	prependLabel ($table)
	resolvePid ($table, $pid)
	clearPrefixFromValue ($table, $value)
	remapListedDBRecords ()
	remapListedDBRecords_flexFormCallBack ($pParams, $dsConf, $dataValue, $dataValue_ext1, $dataValue_ext2)
	remapListedDBRecords_procDBRefs ($conf, $value, $MM_localUid)
	extFileFunctions ($table, $field, $filelist, $func)
	deleteRecord ($table, $uid, $noRecordCheck)
	deletePages ($uid)
	deleteSpecificPage ($uid)
	noRecordsFromUnallowedTables ($inList)
	getSortNumber ($table, $uid, $pid)
	resorting ($table, $pid, $sortRow, $return_SortNumber_After_This_Uid)
	rmComma ($input)
	convNumEntityToByteValue ($input)
	destPathFromUploadFolder ($folder)
	destNotInsideSelf ($dest, $id)
	getExcludeListArray ()
	doesPageHaveUnallowedTables ($page_uid, $doktype)
	deleteClause ($table)
	tableReadOnly ($table)
	tableAdminOnly ($table)
	getInterfacePagePositionID ($uid)
	isReferenceField ($conf)
	getTCEMAIN_TSconfig ($tscPID)
	getTableEntries ($table, $TSconfig)
	setHistory ($table, $id, $logId)
	clearHistory ($table, $id, $keepEntries=10, $maxAgeSeconds=604800)
	log ($table, $recuid, $action, $recpid, $error, $details, $details_nr=0, $data=array(), $event_pid=-1, $NEWid='')
	printLogErrorMessages ($redirect)
	clear_cacheCmd ($cacheCmd)
	removeCacheFiles ()
	start ($data, $cmd, $altUserObject='')
	setMirror ($mirror)
	setDefaultsFromUserTS ($userTS)
	process_uploads ($postFiles)
	process_uploads_traverseArray (&$outputArr, $inputArr, $keyToSet)
	process_datamap ()
	fillInFieldArray ($table, $id, $fieldArray, $incomingFieldArray, $realPid, $status, $tscPID)
	checkModifyAccessList ($table)
	isRecordInWebMount ($table, $id)
	isInWebMount ($pid)
	checkRecordUpdateAccess ($table, $id)
	checkRecordInsertAccess ($insertTable, $pid, $action=1)
	isTableAllowedForThisPage ($page_uid, $checkTable)
	doesRecordExist ($table, $id, $perms)
	doesRecordExist_pageLookUp ($id, $perms)
	doesBranchExist ($inList, $pid, $perms, $recurse)
	pageInfo ($id, $field)
	recordInfo ($table, $id, $fieldList)
	getRecordProperties ($table, $id)
	getRecordPropertiesFromRow ($table, $row)
	setTSconfigPermissions ($fieldArray, $TSConfig_p)
	newFieldArray ($table)
	overrideFieldArray ($table, $data)
	assemblePermissions ($string)
	checkValue ($table, $field, $value, $id, $status, $realPid, $tscPID)
	checkValue_SW ($res, $value, $tcaFieldConf, $table, $id, $curValue, $status, $realPid, $recFID, $field, $uploadedFiles, $tscPID)
	checkValue_input ($res, $value, $tcaFieldConf, $PP, $field='')
	checkValue_check ($res, $value, $tcaFieldConf, $PP)
	checkValue_radio ($res, $value, $tcaFieldConf, $PP)
	checkValue_group_select ($res, $value, $tcaFieldConf, $PP, $uploadedFiles, $field)
	checkValue_group_select_file ($valueArray, $tcaFieldConf, $curValue, $uploadedFileArray, $status, $table, $id, $recFID)
	checkValue_flex ($res, $value, $tcaFieldConf, $PP, $uploadedFiles, $field)
	checkValue_flexArray2Xml ($array)
	_DELETE_FLEX_FORMdata (&$valueArrayToRemoveFrom, $deleteCMDS)
	getUnique ($table, $field, $value, $id, $newPid=0)
	checkValue_input_Eval ($value, $evalArray, $is_in)
	checkValue_group_select_processDBdata ($valueArray, $tcaFieldConf, $id, $status, $type)
	checkValue_group_select_explodeSelectGroupValue ($value)
	checkValue_flex_procInData ($dataPart, $dataPart_current, $uploadedFiles, $dataStructArray, $pParams, $callBackFunc='')
	checkValue_flex_procInData_travDS (&$dataValues, $dataValues_current, $uploadedFiles, $DSelements, $pParams, $callBackFunc='')
	updateDB ($table, $id, $fieldArray)
	compareFieldArrayWithCurrentAndUnset ($table, $id, $fieldArray)
	insertDB ($table, $id, $fieldArray, $newVersion=FALSE)
	checkStoredRecord ($table, $id, $fieldArray, $action)
	dbAnalysisStoreExec ()
	removeRegisteredFiles ()
	clear_cache ($table, $uid)
	getPID ($table, $uid)
	process_cmdmap ()
	moveRecord ($table, $uid, $destPid)
	copyRecord ($table, $uid, $destPid, $first=0, $overrideValues=array(), $excludeFields='')
	copyRecord_raw ($table, $uid, $pid, $overrideArray=array())
	insertNewCopyVersion ($table, $fieldArray, $realPid)
	copyRecord_procBasedOnFieldType ($table, $uid, $field, $value, $row, $conf)
	copyRecord_localize ($table, $uid, $language)
	copyRecord_flexFormCallBack ($pParams, $dsConf, $dataValue, $dataValue_ext1, $dataValue_ext2)
	copyRecord_procFilesRefs ($conf, $uid, $value)
	copyPages ($uid, $destPid)
	copySpecificPage ($uid, $destPid, $copyTablesArray, $first=0)
	versionizeRecord ($table, $id, $label)
	versionizePages ($uid, $label)
	rawCopyPageContent ($old_pid, $new_pid, $copyTablesArray)
	version_swap ($table, $id, $swapWith, $swapContent)
	int_pageTreeInfo ($CPtable, $pid, $counter, $rootID)
	compileAdminTables ()
	fixUniqueInPid ($table, $uid)
	fixCopyAfterDuplFields ($table, $uid, $prevUid, $update, $newData=array())
	extFileFields ($table)
	getCopyHeader ($table, $pid, $field, $value, $count, $prevTitle='')
	prependLabel ($table)
	resolvePid ($table, $pid)
	clearPrefixFromValue ($table, $value)
	remapListedDBRecords ()
	remapListedDBRecords_flexFormCallBack ($pParams, $dsConf, $dataValue, $dataValue_ext1, $dataValue_ext2)
	remapListedDBRecords_procDBRefs ($conf, $value, $MM_localUid)
	extFileFunctions ($table, $field, $filelist, $func)
	deleteRecord ($table, $uid, $noRecordCheck)
	deletePages ($uid)
	deleteSpecificPage ($uid)
	noRecordsFromUnallowedTables ($inList)
	getSortNumber ($table, $uid, $pid)
	resorting ($table, $pid, $sortRow, $return_SortNumber_After_This_Uid)
	rmComma ($input)
	convNumEntityToByteValue ($input)
	destPathFromUploadFolder ($folder)
	destNotInsideSelf ($dest, $id)
	getExcludeListArray ()
	doesPageHaveUnallowedTables ($page_uid, $doktype)
	deleteClause ($table)
	tableReadOnly ($table)
	tableAdminOnly ($table)
	getInterfacePagePositionID ($uid)
	isReferenceField ($conf)
	getTCEMAIN_TSconfig ($tscPID)
	getTableEntries ($table, $TSconfig)
	setHistory ($table, $id, $logId)
	clearHistory ($table, $id, $keepEntries=10, $maxAgeSeconds=604800)
	log ($table, $recuid, $action, $recpid, $error, $details, $details_nr=0, $data=array(), $event_pid=-1, $NEWid='')
	printLogErrorMessages ($redirect)
	clear_cacheCmd ($cacheCmd)
	removeCacheFiles ()
Public Attributes
	$log_table = 'sys_log'
	$checkStoredRecords = 1
	$checkStoredRecords_loose = 1
	$sortIntervals = 256
	$deleteTree = 0
	$copyTree = 0
	$versionizeTree = 0
	$neverHideAtCopy = 0
	$reverseOrder = 0
	$copyWhichTables = '*'
	$stripslashes_values = 1
	$storeLogMessages = 1
	$enableLogging = 1
	$checkSimilar = 1
	$dontProcessTransformations = 0
	$pMap
	$defaultPermissions
	$alternativeFileName = array()
	$data_disableFields = array()
	$defaultValues = array()
	$overrideValues = array()
	$fileFunc
	$last_log_id
	$BE_USER
	$userid
	$username
	$admin
	$exclude_array
	$data = Array()
	$datamap = Array()
	$cmd = Array()
	$cmdmap = Array()
	$uploadedFileArray = array()
	$cachedTSconfig = array()
	$substNEWwithIDs = Array()
	$substNEWwithIDs_table = Array()
	$recUpdateAccessCache = Array()
	$recInsertAccessCache = Array()
	$isRecordInWebMount_Cache = array()
	$isInWebMount_Cache = array()
	$pageCache = Array()
	$copyMappingArray = Array()
	$copyMappingArray_merged = Array()
	$registerDBList = array()
	$dbAnalysisStore = array()
	$removeFilesStore = array()
	$copiedFileMap = array()
	$checkValue_currentRecord = array()

Detailed Description

Definition at line 199 of file class.t3lib_tcemain.php.

Member Function Documentation

t3lib_TCEmain::_DELETE_FLEX_FORMdata ( &$ valueArrayToRemoveFrom,

$ deleteCMDS

)

[Describe function...]

Parameters:

[type] $$valueArrayToRemoveFrom: ...

[type] $deleteCMDS: ...

Returns:
[type] ...

Definition at line 1779 of file class.t3lib_tcemain.php.

t3lib_TCEmain::assemblePermissions ( $ string )

Calculates the bitvalue of the permissions given in a string, comma-sep

Parameters:

[type] $string: ...

Returns:
[type] ...

Definition at line 1208 of file class.t3lib_tcemain.php.
References t3lib_div::trimExplode().

t3lib_TCEmain::checkModifyAccessList ( $ table )

Checking group modify_table access list
Returns true if the user has general access to modify the $table

Parameters:

[type] $table: ...

Returns:
[type] ...

Definition at line 816 of file class.t3lib_tcemain.php.
References t3lib_div::inList(), and tableAdminOnly().

t3lib_TCEmain::checkRecordInsertAccess ( $ insertTable,

$ pid,

$ action = 1

)

Checks if user may insert a certain record.
Returns true if the user may insert a record from table $insertTable on page $pid

Parameters:

[type] $insertTable: ...

[type] $pid: ...

[type] $action: ...

Returns:
[type] ...

Definition at line 884 of file class.t3lib_tcemain.php.
References doesRecordExist(), getRecordProperties(), isTableAllowedForThisPage(), and log().

t3lib_TCEmain::checkRecordUpdateAccess ( $ table,

$ id

)

Checks if user may update a certain record.
Returns true if the user may update the record given by $table and $id

Parameters:

[type] $table: ...

[type] $id: ...

Returns:
[type] ...

Definition at line 859 of file class.t3lib_tcemain.php.
References doesRecordExist().

t3lib_TCEmain::checkStoredRecord ( $ table,

$ id,

$ fieldArray,

$ action

)

Checking stored record to see if the written values are properly updated.

Parameters:

string Record table name

integer Record uid

array Array of field=>value pairs to insert/update

string Action, for logging only.

Returns:
array Selected row

See also:
insertDB(), updateDB()

Definition at line 2340 of file class.t3lib_tcemain.php.

t3lib_TCEmain::checkValue ( $ table,

$ field,

$ value,

$ id,

$ status,

$ realPid,

$ tscPID

)

Evaluates a value according to $table/$field settings. This function is for real database fields - NOT FlexForm "pseudo" fields. NOTICE: Calling this function expects this: 1) That the data is saved! (files are copied and so on) 2) That files registered for deletion IS deleted at the end (with ->removeRegisteredFiles() )

Parameters:

string Table name

string Field name

string Value to be evaluated. Notice, this is the INPUT value from the form. The original value (from any existing record) must be manually looked up inside the function if needed - or taken from $currentRecord array.

string The record-uid, mainly - but not exclusively - used for logging

string 'update' or 'new' flag

integer The real PID value of the record. For updates, this is just the pid of the record. For new records this is the PID of the page where it is inserted. If $realPid is -1 it means that a new version of the record is being inserted.

integer $tscPID

Returns:
array Returns the evaluated $value as key "value" in this array. Can be checked with isset($res['value']) ...

Definition at line 1258 of file class.t3lib_tcemain.php.
References t3lib_div::inList(), and t3lib_div::loadTCA().

t3lib_TCEmain::checkValue_check ( $ res,

$ value,

$ tcaFieldConf,

$ PP

)

Evaluates 'check' type values.

Parameters:

array The result array. The processed value (if any!) is set in the 'value' key.

string The value to set.

array Field configuration from TCA

array Additional parameters in a numeric array: $table,$id,$curValue,$status,$realPid,$recFID

Returns:
array Modified $res array

Definition at line 1402 of file class.t3lib_tcemain.php.

t3lib_TCEmain::checkValue_flex ( $ res,

$ value,

$ tcaFieldConf,

$ PP,

$ uploadedFiles,

$ field

)

Evaluates 'flex' type values.

Parameters:

array The result array. The processed value (if any!) is set in the 'value' key.

string The value to set.

array Field configuration from TCA

array Additional parameters in a numeric array: $table,$id,$curValue,$status,$realPid,$recFID

array Uploaded files for the field

array Current record array.

string Field name

Returns:
array Modified $res array

Definition at line 1704 of file class.t3lib_tcemain.php.
References t3lib_div::_GP(), t3lib_div::array_merge_recursive_overrule(), t3lib_BEfunc::getFlexFormDS(), and t3lib_div::xml2array().

t3lib_TCEmain::checkValue_flex_procInData ( $ dataPart,

$ dataPart_current,

$ uploadedFiles,

$ dataStructArray,

$ pParams,

$ callBackFunc = ''

)

Starts the processing the input data for flexforms. This will traverse all sheets / languages and for each it will traverse the sub-structure. See checkValue_flex_procInData_travDS() for more details.

Parameters:

array The 'data' part of the INPUT flexform data

array The 'data' part of the CURRENT flexform data

array The uploaded files for the 'data' part of the INPUT flexform data

array Data structure for the form (might be sheets or not). Only values in the data array which has a configuration in the data structure will be processed.

array A set of parameters to pass through for the calling of the evaluation functions

string Optional call back function, see checkValue_flex_procInData_travDS()

Returns:
array The modified 'data' part.

See also:
checkValue_flex_procInData_travDS()

Definition at line 2009 of file class.t3lib_tcemain.php.
References t3lib_div::resolveSheetDefInDS().

t3lib_TCEmain::checkValue_flex_procInData_travDS ( &$ dataValues,

$ dataValues_current,

$ uploadedFiles,

$ DSelements,

$ pParams,

$ callBackFunc = ''

)

Processing of the sheet/language data array When it finds a field with a value the processing is done by ->checkValue_SW() by default but if a call back function name is given that method in this class will be called for the processing instead.

Parameters:

array New values (those being processed): Multidimensional Data array for sheet/language, passed by reference!

array Current values: Multidimensional Data array. May be empty array() if not needed (for callBackFunctions)

array Uploaded files array for sheet/language. May be empty array() if not needed (for callBackFunctions)

array Data structure which fits the data array

array A set of parameters to pass through for the calling of the evaluation functions / call back function

string Call back function, default is checkValue_SW().

Returns:
void

See also:
checkValue_flex_procInData()

Definition at line 2046 of file class.t3lib_tcemain.php.
References t3lib_BEfunc::getPagesTSconfig(), t3lib_BEfunc::getSpecConfParts(), t3lib_BEfunc::getTCAtypeValue(), t3lib_BEfunc::RTEgetObj(), and t3lib_BEfunc::RTEsetup().

t3lib_TCEmain::checkValue_flexArray2Xml ( $ array )

[Describe function...]

Parameters:

[type] $array: ...

Returns:
[type] ...

Definition at line 1762 of file class.t3lib_tcemain.php.
References t3lib_div::array2xml().

t3lib_TCEmain::checkValue_group_select ( $ res,

$ value,

$ tcaFieldConf,

$ PP,

$ uploadedFiles,

$ field

)

Evaluates 'group' or 'select' type values.

Parameters:

array The result array. The processed value (if any!) is set in the 'value' key.

string The value to set.

array Field configuration from TCA

array Additional parameters in a numeric array: $table,$id,$curValue,$status,$realPid,$recFID

[type] $uploadedFiles: ...

string Field name

Returns:
array Modified $res array

Definition at line 1451 of file class.t3lib_tcemain.php.

t3lib_TCEmain::checkValue_group_select_explodeSelectGroupValue ( $ value )

Explodes the $value, which is a list of files/uids (group select)

Parameters:

string Input string, comma separated values. For each part it will also be detected if a '|' is found and the first part will then be used if that is the case. Further the value will be rawurldecoded.

Returns:
array The value array.

Definition at line 1986 of file class.t3lib_tcemain.php.
References t3lib_div::trimExplode().

t3lib_TCEmain::checkValue_group_select_file ( $ valueArray,

$ tcaFieldConf,

$ curValue,

$ uploadedFileArray,

$ status,

$ table,

$ id,

$ recFID

)

Handling files for group/select function

Parameters:

[type] $valueArray: ...

[type] $tcaFieldConf: ...

[type] $curValue: ...

[type] $uploadedFileArray: ...

[type] $status: ...

[type] $table: ...

[type] $id: ...

[type] $recFID: ...

Returns:
array Modified value array

See also:
checkValue_group_select()

Definition at line 1551 of file class.t3lib_tcemain.php.
References t3lib_div::fixWindowsFilePath(), t3lib_div::formatSize(), t3lib_div::makeInstance(), t3lib_div::removeArrayEntryByValue(), t3lib_div::split_fileref(), t3lib_div::trimExplode(), and t3lib_div::upload_copy_move().

t3lib_TCEmain::checkValue_group_select_processDBdata ( $ valueArray,

$ tcaFieldConf,

$ id,

$ status,

$ type

)

Returns data for group/db and select fields

Parameters:

array Current value array

array TCA field config

integer Record id, used for look-up of MM relations (local_uid)

string Status string ('update' or 'new')

string The type, either 'select' or 'group'

Returns:
array Modified value array

Definition at line 1953 of file class.t3lib_tcemain.php.
References t3lib_div::makeInstance().

t3lib_TCEmain::checkValue_input ( $ res,

$ value,

$ tcaFieldConf,

$ PP,

$ field = ''

)

Evaluate "input" type values.

Parameters:

array The result array. The processed value (if any!) is set in the "value" key.

string The value to set.

array Field configuration from TCA

array Additional parameters in a numeric array: $table,$id,$curValue,$status,$realPid,$recFID

string Field name

Returns:
array Modified $res array

Definition at line 1364 of file class.t3lib_tcemain.php.
References t3lib_div::trimExplode().

t3lib_TCEmain::checkValue_input_Eval ( $ value,

$ evalArray,

$ is_in

)

Evaluation of 'input'-type values based on 'eval' list

Parameters:

string Value

array Array of evaluations to traverse.

string Is-in string

Returns:
string Modified $value

Definition at line 1865 of file class.t3lib_tcemain.php.

t3lib_TCEmain::checkValue_radio ( $ res,

$ value,

$ tcaFieldConf,

$ PP

)

Evaluates 'radio' type values.

Parameters:

array The result array. The processed value (if any!) is set in the 'value' key.

string The value to set.

array Field configuration from TCA

array Additional parameters in a numeric array: $table,$id,$curValue,$status,$realPid,$recFID

Returns:
array Modified $res array

Definition at line 1425 of file class.t3lib_tcemain.php.

t3lib_TCEmain::checkValue_SW ( $ res,

$ value,

$ tcaFieldConf,

$ table,

$ id,

$ curValue,

$ status,

$ realPid,

$ recFID,

$ field,

$ uploadedFiles,

$ tscPID

)

Branches out evaluation of a field value based on its type as configured in TCA Can be called for FlexForm pseudo fields as well, BUT must not have $field set if so.

Parameters:

array The result array. The processed value (if any!) is set in the "value" key.

string The value to set.

array Field configuration from TCA

string Table name

integer Return UID

[type] $curValue: ...

[type] $status: ...

integer The real PID value of the record. For updates, this is just the pid of the record. For new records this is the PID of the page where it is inserted. If $realPid is -1 it means that a new version of the record is being inserted.

[type] $recFID: ...

string Field name. Must NOT be set if the call is for a flexform field (since flexforms are not allowed within flexforms).

[type] $uploadedFiles: ...

[type] $tscPID: ...

Returns:
array Returns the evaluated $value as key "value" in this array.

Definition at line 1318 of file class.t3lib_tcemain.php.

t3lib_TCEmain::clear_cache ( $ table,

$ uid

)

Clearing the cache based on a page being updated If the $table is 'pages' then cache is cleared for all pages on the same level (and subsequent?) Else just clear the cache for the parent page of the record.

Parameters:

string Table name of record that was just updated.

integer UID of updated / inserted record

Returns:
void

Definition at line 2408 of file class.t3lib_tcemain.php.
References t3lib_div::callUserFunction(), t3lib_BEfunc::getTSCpid(), t3lib_extMgm::isLoaded(), and t3lib_div::trimExplode().

t3lib_TCEmain::clear_cacheCmd ( $ cacheCmd )

Clears the cache based on a command, $cacheCmd
$cacheCmd='pages': Clears cache for all pages. Requires admin-flag to be set for BE_USER $cacheCmd='all': Clears all cache_tables. This is necessary if templates are updated. Requires admin-flag to be set for BE_USER $cacheCmd=[integer]: Clears cache for the page pointed to by $cacheCmd (an integer).
Can call a list of post processing functions as defined in $TYPO3_CONF_VARS['SC_OPTIONS']['t3lib/class.t3lib_tcemain.php']['clearCachePostProc'] (num array with values being the function references, called by t3lib_div::callUserFunction())

Parameters:

string The cache comment, see above description.

Returns:
void

Definition at line 4596 of file class.t3lib_tcemain.php.
References t3lib_extMgm::isLoaded().

t3lib_TCEmain::clearHistory ( $ table,

$ id,

$ keepEntries = 10,

$ maxAgeSeconds = 604800

)

604800 = 60*60*24*7 $keepEntries (int+) defines the number of current entries from sys_history table to keep in addition to the new one which is put in. $maxAgeSeconds (int+) however will set a max age in seconds so that any entry older than current time minus the age removed no matter what. If zero, this is not effective. All snapshots are excluded of course.

Parameters:

[type] $table: ...

[type] $id: ...

[type] $keepEntries: ...

[type] $maxAgeSeconds: ...

Returns:
[type] ...

Definition at line 4472 of file class.t3lib_tcemain.php.

t3lib_TCEmain::clearPrefixFromValue ( $ table,

$ value

)

Removes the prependAtCopy prefix on values

Parameters:

[type] $table: ...

[type] $value: ...

Returns:
[type] ...

Definition at line 3719 of file class.t3lib_tcemain.php.

t3lib_TCEmain::compareFieldArrayWithCurrentAndUnset ( $ table,

$ id,

$ fieldArray

)

Compares the incoming field array with the current record and unsets all fields which are the same. If the returned array is empty, then the record should not be updated! $fieldArray must be an array.

Parameters:

string Record table name

integer Record uid

array Array of field=>value pairs intended to be inserted into the database. All keys with values matching exactly the current value will be unset!

Returns:
array Returns $fieldArray

Definition at line 2232 of file class.t3lib_tcemain.php.

t3lib_TCEmain::compileAdminTables ( )

List of all tables (those administrators has access to)

Returns:
[type] ...

Definition at line 3551 of file class.t3lib_tcemain.php.

t3lib_TCEmain::convNumEntityToByteValue ( $ input )

Converts a HTML entity (like {) to the character '123'

Parameters:

string Input string

Returns:
string Output string

Definition at line 4206 of file class.t3lib_tcemain.php.

t3lib_TCEmain::copyPages ( $ uid,

$ destPid

)

Copying pages Main function for copying pages.

Parameters:

integer Page UID to copy

integer Destination PID: >=0 then it points to a page-id on which to insert the record (as the first element). <0 then it points to a uid from its own table after which to insert it (works if

Returns:
void

Definition at line 3186 of file class.t3lib_tcemain.php.
References t3lib_div::inList().

t3lib_TCEmain::copyRecord ( $ table,

$ uid,

$ destPid,

$ first = 0,

$ overrideValues = array(),

$ excludeFields = ''

)

Copying records

Parameters:

string Element table

integer Element UID

integer $destPid: >=0 then it points to a page-id on which to insert the record (as the first element). <0 then it points to a uid from its own table after which to insert it (works if

boolean $first is a flag set, if the record copied is NOT a 'slave' to another record copied. That is, if this record was asked to be copied in the cmd-array

array Associative array with field/value pairs to override directly. Notice; Fields must exist in the table record and NOT be among excluded fields!

string Commalist of fields to exclude from the copy process (might get default values)

Returns:
void

Definition at line 2779 of file class.t3lib_tcemain.php.
References t3lib_BEfunc::getTSconfig_pidValue(), t3lib_div::inList(), t3lib_div::loadTCA(), t3lib_div::makeInstance(), and t3lib_div::trimExplode().

t3lib_TCEmain::copyRecord_flexFormCallBack ( $ pParams,

$ dsConf,

$ dataValue,

$ dataValue_ext1,

$ dataValue_ext2

)

Callback function for traversing the FlexForm structure in relation to creating copied files of file relations inside of flex form structures.

Parameters:

array Array of parameters in num-indexes: table, uid, field

array TCA field configuration (from Data Structure XML)

string The value of the flexForm field

string Not used.

string Not used.

Returns:
array Result array with key "value" containing the value of the processing.

See also:
copyRecord(), checkValue_flex_procInData_travDS()

Definition at line 3107 of file class.t3lib_tcemain.php.

t3lib_TCEmain::copyRecord_localize ( $ table,

$ uid,

$ language

)

Localizes a record to another system language

Parameters:

string Table name

integer Record uid (to be localized)

integer Language ID (from sys_language table)

Returns:

Definition at line 3048 of file class.t3lib_tcemain.php.
References t3lib_BEfunc::getRecord(), t3lib_BEfunc::getRecordsByField(), t3lib_div::inList(), and t3lib_div::loadTCA().

t3lib_TCEmain::copyRecord_procBasedOnFieldType ( $ table,

$ uid,

$ field,

$ value,

$ row,

$ conf

)

Processing/Preparing content for copyRecord() function

Parameters:

string Table name

integer Record uid

string Field name being processed

string Input value to be processed.

array Record array

array TCA field configuration

Returns:
mixed Processed value. Normally a string/integer, but can be an array for flexforms! private

See also:
copyRecord()

Definition at line 2995 of file class.t3lib_tcemain.php.
References t3lib_BEfunc::getFlexFormDS(), t3lib_div::makeInstance(), and t3lib_div::xml2array().

t3lib_TCEmain::copyRecord_procFilesRefs ( $ conf,

$ uid,

$ value

)

Modifying a field value for any situation regarding files/references: For attached files: take current filenames and prepend absolute paths so they get copied. For DB references: Nothing done.

Parameters:

array TCE field config

integer Record UID

string Field value (eg. list of files)

Returns:
string The (possibly modified) value

See also:
copyRecord(), copyRecord_flexFormCallBack()

Definition at line 3135 of file class.t3lib_tcemain.php.
References t3lib_div::makeInstance(), and t3lib_div::trimExplode().

t3lib_TCEmain::copyRecord_raw ( $ table,

$ uid,

$ pid,

$ overrideArray = array()

)

Copying records, but makes a "raw" copy of a record. Basically the only thing observed is field processing like the copying of files and correct of ids. All other fields are 1-1 copied. Technically the copy is made with THIS instance of the tcemain class contrary to copyRecord() which creates a new instance and uses the processData() function. The copy is created by insertNewCopyVersion() which bypasses most of the regular input checking associated with processData() - maybe copyRecord() should even do this as well!? This function is used to create new versions of a record. NOTICE: DOES NOT CHECK PERMISSIONS to create! And since page permissions are just passed through and not changed to the user who executes the copy we cannot enforce permissions without getting an incomplete copy - unless we change permissions of course.

Parameters:

string Element table

integer Element UID

integer Element PID (real PID, not checked)

array Override array - must NOT contain any fields not in the table!

Returns:
integer Returns the new ID of the record (if applicable)

Definition at line 2888 of file class.t3lib_tcemain.php.
References t3lib_div::loadTCA().

t3lib_TCEmain::copySpecificPage ( $ uid,

$ destPid,

$ copyTablesArray,

$ first = 0

)

Copying a single page ($uid) to $destPid and all tables in the array copyTablesArray.

Parameters:

integer Page uid

integer Destination PID: >=0 then it points to a page-id on which to insert the record (as the first element). <0 then it points to a uid from its own table after which to insert it (works if

array Table on pages to copy along with the page.

boolean Set if this the the root page being copied.

Returns:
void

Definition at line 3241 of file class.t3lib_tcemain.php.

t3lib_TCEmain::dbAnalysisStoreExec ( )

Executing dbAnalysisStore

Returns:
[type] ...

Definition at line 2375 of file class.t3lib_tcemain.php.

t3lib_TCEmain::dbAnalysisStoreExec ( )

Executing dbAnalysisStore

Returns:
[type] ...

Definition at line 2375 of file class.t3lib_tcemain.php.
Referenced by process_datamap().

t3lib_TCEmain::deleteClause ( $ table )

Returns delete-clause for the $table

Parameters:

[type] $table: ...

Returns:
[type] ...

Definition at line 4322 of file class.t3lib_tcemain.php.

t3lib_TCEmain::deletePages ( $ uid )

[Describe function...]

Parameters:

[type] $uid: ...

Returns:
[type] ...

Definition at line 3974 of file class.t3lib_tcemain.php.

t3lib_TCEmain::deleteRecord ( $ table,

$ uid,

$ noRecordCheck

)

[Describe function...]

Parameters:

[type] $table: ...

[type] $uid: ...

[type] $noRecordCheck: ...

Returns:
[type] ...

Definition at line 3916 of file class.t3lib_tcemain.php.

t3lib_TCEmain::deleteSpecificPage ( $ uid )

[Describe function...]

Parameters:

[type] $uid: ...

Returns:
[type] ...

Definition at line 4016 of file class.t3lib_tcemain.php.

t3lib_TCEmain::destNotInsideSelf ( $ dest,

$ id

)

Checks if $id is a uid in the rootline from $dest

Parameters:

[type] $dest: ...

[type] $id: ...

Returns:
[type] ...

Definition at line 4239 of file class.t3lib_tcemain.php.

t3lib_TCEmain::destPathFromUploadFolder ( $ folder )

Returns absolute destination path for the uploadfolder, $folder

Parameters:

[type] $folder: ...

Returns:
[type] ...

Definition at line 4228 of file class.t3lib_tcemain.php.

t3lib_TCEmain::doesBranchExist ( $ inList,

$ pid,

$ perms,

$ recurse

)

Checks if a whole branch of pages exists
Tests the branch under $pid (like doesRecordExist). It doesn't test the page with $pid as uid. Use doesRecordExist() for this purpose Returns an ID-list or "" if OK. Else -1 which means that somewhere there was no permission (eg. to delete). if $recurse is set, then the function will follow subpages. This MUST be set, if we need the idlist for deleting pages or else we get an incomplete list

Parameters:

[type] $inList: ...

[type] $pid: ...

[type] $perms: ...

[type] $recurse: ...

Returns:
[type] ...

Definition at line 1044 of file class.t3lib_tcemain.php.
References deleteClause(), and doesBranchExist().

t3lib_TCEmain::doesPageHaveUnallowedTables ( $ page_uid,

$ doktype

)

Checks if there are records on a page from tables that are not allowed
Returns a list of the tables that are 'present' on the page but not allowed with the page_uid/doktype

Parameters:

[type] $page_uid: ...

[type] $doktype: ...

Returns:
[type] ...

Definition at line 4289 of file class.t3lib_tcemain.php.
References t3lib_div::trimExplode().

t3lib_TCEmain::doesRecordExist ( $ table,

$ id,

$ perms

)

Checks if record exists
Returns true if the record given by $table, $id and $perms

Parameters:

string Record table name

integer Record UID

mixed Permission restrictions to observe: Either an integer that will be bitwise AND'ed or a string, which points to a key in the ->pMap array

Returns:
[type] ...

Definition at line 955 of file class.t3lib_tcemain.php.
References deleteClause(), doesRecordExist_pageLookUp(), t3lib_BEfunc::fixVersioningPid(), isRecordInWebMount(), and t3lib_div::testInt().

t3lib_TCEmain::doesRecordExist_pageLookUp ( $ id,

$ perms

)

Looks up a page based on permissions.

Parameters:

integer Page id

integer Permission integer

Returns:
pointer MySQL result pointer (from exec_SELECTquery()) private

See also:
doesRecordExist()

Definition at line 1018 of file class.t3lib_tcemain.php.
References deleteClause().

t3lib_TCEmain::extFileFields ( $ table )

Returns all fieldnames from a table which are a list of files

Parameters:

[type] $table: ...

Returns:
[type] ...

Definition at line 3629 of file class.t3lib_tcemain.php.
References t3lib_div::loadTCA().

t3lib_TCEmain::extFileFunctions ( $ table,

$ field,

$ filelist,

$ func

)

[Describe function...]

Parameters:

[type] $table: ...

[type] $field: ...

[type] $filelist: ...

[type] $func: ...

Returns:
[type] ...

Definition at line 3884 of file class.t3lib_tcemain.php.
References t3lib_div::loadTCA().

t3lib_TCEmain::fillInFieldArray ( $ table,

$ id,

$ fieldArray,

$ incomingFieldArray,

$ realPid,

$ status,

$ tscPID

)

Filling in the field array $this->exclude_array is used to filter fields if needed.

Parameters:

string Table name

[type] $id: ...

array Default values, Preset $fieldArray with 'pid' maybe (pid and uid will be not be overridden anyway)

array $incomingFieldArray is which fields/values you want to set. There are processed and put into $fieldArray if OK

integer The real PID value of the record. For updates, this is just the pid of the record. For new records this is the PID of the page where it is inserted.

string $status = 'new' or 'update'

[type] $tscPID: ...

Returns:
[type] ...

Definition at line 625 of file class.t3lib_tcemain.php.
References t3lib_div::array_merge_recursive_overrule(), checkValue(), t3lib_parsehtml_proc::evalWriteFile(), t3lib_BEfunc::getPagesTSconfig(), t3lib_BEfunc::getTCAtypes(), t3lib_BEfunc::getTCAtypeValue(), t3lib_div::loadTCA(), log(), t3lib_div::makeInstance(), pageInfo(), recordInfo(), t3lib_BEfunc::RTEgetObj(), t3lib_BEfunc::RTEsetup(), t3lib_div::stripSlashesOnArray(), and t3lib_div::writeFile().

t3lib_TCEmain::fixCopyAfterDuplFields ( $ table,

$ uid,

$ prevUid,

$ update,

$ newData = array()

)

When er record is copied you can specify fields from the previous record which should be copied into the new one This function is also called with new elements. But then $update must be set to zero and $newData containing the data array. In that case data in the incoming array is NOT overridden. (250202)

Parameters:

[type] $table: ...

[type] $uid: ...

[type] $prevUid: ...

[type] $update: ...

[type] $newData: ...

Returns:
[type] ...

Definition at line 3604 of file class.t3lib_tcemain.php.
References t3lib_div::loadTCA(), and t3lib_div::trimExplode().

t3lib_TCEmain::fixUniqueInPid ( $ table,

$ uid

)

Checks if any uniqueInPid eval input fields are in the record and if so, they are re-written to be correct.

Parameters:

[type] $table: ...

[type] $uid: ...

Returns:
[type] ...

Definition at line 3568 of file class.t3lib_tcemain.php.
References t3lib_div::loadTCA(), and t3lib_div::trimExplode().

t3lib_TCEmain::getCopyHeader ( $ table,

$ pid,

$ field,

$ value,

$ count,

$ prevTitle = ''

)

Get copy header

Parameters:

string Table name

integer PID value in which other records to test might be

string Field name to get header value for.

string Current field value

integer Counter (number of recursions)

string Previous title we checked for (in previous recursion)

Returns:
string The field value, possibly appended with a "copy label"

Definition at line 3655 of file class.t3lib_tcemain.php.

t3lib_TCEmain::getExcludeListArray ( )

Generate an array of fields to be excluded from editing for the user.

Returns:
[type] ...

Definition at line 4265 of file class.t3lib_tcemain.php.
References t3lib_div::inList(), and t3lib_div::loadTCA().

t3lib_TCEmain::getInterfacePagePositionID ( $ uid )

Finds the Position-ID for this page. This is very handy when we need to update a page in the pagetree in the TYPO3 interface. OBSOLETE WITH the new backend? Usage: 2 (class t3lib_tcemain)

Parameters:

[type] $uid: ...

Returns:
[type] ...

Definition at line 4364 of file class.t3lib_tcemain.php.

t3lib_TCEmain::getPID ( $ table,

$ uid

)

Returns the pid of a record from $table with $uid

Parameters:

string Table name

integer Record uid

Returns:
integer PID value (unless the record did not exist in which case FALSE)

Definition at line 2504 of file class.t3lib_tcemain.php.

t3lib_TCEmain::getRecordProperties ( $ table,

$ id

)

Returns an array with record properties, like header and pid

Parameters:

[type] $table: ...

[type] $id: ...

Returns:
[type] ...

Definition at line 1116 of file class.t3lib_tcemain.php.
References t3lib_BEfunc::fixVersioningPid().

t3lib_TCEmain::getRecordPropertiesFromRow ( $ table,

$ row

)

Returns an array with record properties, like header and pid, based on the row

Parameters:

[type] $table: ...

[type] $row: ...

Returns:
[type] ...

Definition at line 1129 of file class.t3lib_tcemain.php.

t3lib_TCEmain::getSortNumber ( $ table,

$ uid,

$ pid

)

Returning sorting number
$table is the tablename, $uid is set, if the record exists already, $pid is the pointer to the position, neg=before other record, pos=on-top of page. $pid must be an integer
Returns false if the sortby field does not exist.

Parameters:

[type] $table: ...

[type] $uid: ...

[type] $pid: ...

Returns:
[type] ...

Definition at line 4102 of file class.t3lib_tcemain.php.

t3lib_TCEmain::getTableEntries ( $ table,

$ TSconfig

)

[Describe function...]

Parameters:

[type] $table: ...

[type] $TSconfig: ...

Returns:
[type] ...

Definition at line 4421 of file class.t3lib_tcemain.php.
References t3lib_div::array_merge_recursive_overrule().

t3lib_TCEmain::getTCEMAIN_TSconfig ( $ tscPID )

[Describe function...]

Parameters:

[type] $tscPID: ...

Returns:
[type] ...

Definition at line 4407 of file class.t3lib_tcemain.php.
References t3lib_BEfunc::getPagesTSconfig().

t3lib_TCEmain::getUnique ( $ table,

$ field,

$ value,

$ id,

$ newPid = 0

)

Gets a unique value for $table/$id/$field based on $value

Parameters:

string Table name

string Field name for which $value must be unique

string Value string.

integer UID to filter out in the lookup (the record itself...)

integer If set, the value will be unique for this PID

Returns:
string Modified value (if not-unique). Will be the value appended with a number (until 100, then the function just breaks).

Definition at line 1827 of file class.t3lib_tcemain.php.
References t3lib_div::loadTCA().

t3lib_TCEmain::insertDB ( $ table,

$ id,

$ fieldArray,

$ newVersion = FALSE

)

Insert into database Does not check permissions but expects them to be verified on beforehand

Parameters:

string Record table name

string "NEW...." uid string

array Array of field=>value pairs to insert. FIELDS MUST MATCH the database FIELDS. No check is done. "pid" must point to the destination of the record!

boolean Set to true if new version is created.

Returns:
void

Definition at line 2282 of file class.t3lib_tcemain.php.

t3lib_TCEmain::insertNewCopyVersion ( $ table,

$ fieldArray,

$ realPid

)

Inserts a record in the database, passing TCA configuration values through checkValue() but otherwise does NOTHING and checks nothing regarding permissions. Passes the "version" parameter to insertDB() so the copy will look like a new version in the log - should probably be changed or modified a bit for more broad usage...

Parameters:

string Table name

array Field array to insert as a record

integer The value of PID field. -1 is indication that we are creating a new version!

Returns:
integer Returns the new ID of the record (if applicable)

Definition at line 2944 of file class.t3lib_tcemain.php.

t3lib_TCEmain::int_pageTreeInfo ( $ CPtable,

$ pid,

$ counter,

$ rootID

)

Returns array, $CPtable, of pages under the $pid going down to $counter levels

Parameters:

[type] $CPtable: ...

[type] $pid: ...

[type] $counter: ...

[type] $rootID: ...

Returns:
[type] ...

Definition at line 3530 of file class.t3lib_tcemain.php.

t3lib_TCEmain::isInWebMount ( $ pid )

[Describe function...]

Parameters:

[type] $pid: ...

Returns:
[type] ...

Definition at line 842 of file class.t3lib_tcemain.php.

t3lib_TCEmain::isInWebMount ( $ pid )

[Describe function...]

Parameters:

[type] $pid: ...

Returns:
[type] ...

Definition at line 842 of file class.t3lib_tcemain.php.
Referenced by isRecordInWebMount().

t3lib_TCEmain::isRecordInWebMount ( $ table,

$ id

)

[Describe function...]

Parameters:

[type] $table: ...

[type] $id: ...

Returns:
[type] ...

Definition at line 828 of file class.t3lib_tcemain.php.
References getRecordProperties(), and isInWebMount().

t3lib_TCEmain::isReferenceField ( $ conf )

[Describe function...]

Parameters:

[type] $conf: ...

Returns:
[type] ...

Definition at line 4397 of file class.t3lib_tcemain.php.

t3lib_TCEmain::isTableAllowedForThisPage ( $ page_uid,

$ checkTable

)

Checks is a table is allowed on a certain page.
$checkTable is the tablename $page_uid is the uid of the page to check

Parameters:

[type] $page_uid: ...

[type] $checkTable: ...

Returns:
[type] ...

Definition at line 920 of file class.t3lib_tcemain.php.
References pageInfo(), and t3lib_div::trimExplode().

t3lib_TCEmain::log ( $ table,

$ recuid,

$ action,

$ recpid,

$ error,

$ details,

$ details_nr = 0,

$ data = array(),

$ event_pid = -1,

$ NEWid = ''

)

Logging actions
$table: The table name $recuid: The record uid
$action: The action number. 1=new record, 2=update record, 3= delete record, 4= move record, 5= Check/evaluate $recpid: Normally 0 (zero). If set, it indicates that this log-entry is used to notify the backend of a record which is moved to another location
$error: The severity: 0 = message, 1 = error, 2 = System Error, 3 = security notice (admin) $details: This is the default, raw error message in english
details_nr
This number is unique for every combination of
type and $action. This is the error-message number, which can later be used to translate error messages.
data
Array with special information that may go into
details by 's' marks / sprintf() when the log is shown $event_pid: The page_uid (pid) where the event occurred. Used to select log-content for specific pages.

Parameters:

[type] $table: ...

[type] $recuid: ...

[type] $action: ...

[type] $recpid: ...

[type] $error: ...

[type] $details: ...

[type] $details_nr: ...

[type] $data: ...

[type] $event_pid: ...

[type] $NEWid: ...

Returns:
[type] ...

See also:
class.t3lib_userauthgroup.php

Definition at line 4520 of file class.t3lib_tcemain.php.

t3lib_TCEmain::moveRecord ( $ table,

$ uid,

$ destPid

)

Moving records

Parameters:

string Table name to move

integer Record uid to move

integer Position to move to: $destPid: >=0 then it points to a page-id on which to insert the record (as the first element). <0 then it points to a uid from its own table after which to insert it (works if

Returns:
void

Definition at line 2635 of file class.t3lib_tcemain.php.

t3lib_TCEmain::newFieldArray ( $ table )

Returns a fieldArray with default values.

Parameters:

[type] $table: ...

Returns:
[type] ...

Definition at line 1164 of file class.t3lib_tcemain.php.
References t3lib_div::loadTCA().

t3lib_TCEmain::noRecordsFromUnallowedTables ( $ inList )

[Describe function...]

Parameters:

[type] $inList: ...

Returns:
[type] ...

Definition at line 4040 of file class.t3lib_tcemain.php.

t3lib_TCEmain::overrideFieldArray ( $ table,

$ data

)

Returns the $data array from $table overridden in the fields defined in ->overrideValues.

Parameters:

[type] $table: ...

[type] $data: ...

Returns:
[type] ...

Definition at line 1195 of file class.t3lib_tcemain.php.

t3lib_TCEmain::pageInfo ( $ id,

$ field

)

Returns the value of the $field from page $id NOTICE; the function caches the result for faster delivery next time. You can use this function repeatedly without performanceloss since it doesn't look up the same record twice!

Parameters:

integer Page uid

string Field name for which to return value

Returns:
string Value of the field. Result is cached in $this->pageCache[$id][$field] and returned from there next time!

Definition at line 1079 of file class.t3lib_tcemain.php.

t3lib_TCEmain::prependLabel ( $ table )

Return "copy" label for a table. Although the name is "prepend" it actually APPENDs the label (after ...)

Parameters:

string Table name

Returns:
string Label to append, containing "%s" for the number

See also:
getCopyHeader()

Definition at line 3684 of file class.t3lib_tcemain.php.

t3lib_TCEmain::printLogErrorMessages ( $ redirect )

Print log error messages from the operations of this script instance

Parameters:

string Redirect URL (for creating link in message)

Returns:
void (Will exit on error)

Definition at line 4534 of file class.t3lib_tcemain.php.
References t3lib_div::makeInstance().

t3lib_TCEmain::process_cmdmap ( )

Processing the cmd-array See "TYPO3 Core API" for a description of the options.

Returns:
void

Definition at line 2547 of file class.t3lib_tcemain.php.
References t3lib_div::array_merge_recursive_overrule(), and t3lib_div::intInRange().

t3lib_TCEmain::process_datamap ( )

Processing the data-array Call this function to process the data-array set by start()

Returns:
void

Definition at line 432 of file class.t3lib_tcemain.php.
References checkModifyAccessList(), checkRecordInsertAccess(), checkRecordUpdateAccess(), compareFieldArrayWithCurrentAndUnset(), dbAnalysisStoreExec(), fillInFieldArray(), getRecordProperties(), getSortNumber(), getTCEMAIN_TSconfig(), t3lib_BEfunc::getTSCpid(), t3lib_div::getUserObj(), insertDB(), log(), newFieldArray(), overrideFieldArray(), recordInfo(), removeRegisteredFiles(), setTSconfigPermissions(), tableReadOnly(), t3lib_div::testInt(), and updateDB().

t3lib_TCEmain::process_uploads ( $ postFiles )

Processing of uploaded files. It turns out that some versions of PHP arranges submitted data for files different if sent in an array. This function will unify this so the internal array $this->uploadedFileArray will always contain files arranged in the same structure.

Parameters:

array $_FILES array

Returns:
void

Definition at line 366 of file class.t3lib_tcemain.php.
References process_uploads_traverseArray().

t3lib_TCEmain::process_uploads_traverseArray ( &$ outputArr,

$ inputArr,

$ keyToSet

)

Traverse the upload array if needed to rearrange values.

Parameters:

array $this->uploadedFileArray passed by reference

array Input array ($_FILES parts)

string The current $_FILES array key to set on the outermost level.

Returns:
void private

See also:
process_uploads()

Definition at line 396 of file class.t3lib_tcemain.php.
References process_uploads_traverseArray().

t3lib_TCEmain::rawCopyPageContent ( $ old_pid,

$ new_pid,

$ copyTablesArray

)

Copies all records from tables in $copyTablesArray from page with $old_pid to page with $new_pid Uses raw-copy for the operation (meant for versioning!)

Parameters:

integer Current page id.

integer New page id

array Array of tables from which to copy

Returns:
void

See also:
versionizePages()

Definition at line 3381 of file class.t3lib_tcemain.php.

t3lib_TCEmain::recordInfo ( $ table,

$ id,

$ fieldList

)

Returns the row of a record given by $table and $id and $fieldList (list of fields, may be '*') NOTICE: No check for deleted or access!

Parameters:

string Table name

integer UID of the record from $table

string Field list for the SELECT query, eg. "*" or "uid,pid,..."

Returns:
mixed Returns the selected record on success, otherwise false.

Definition at line 1099 of file class.t3lib_tcemain.php.

t3lib_TCEmain::remapListedDBRecords ( )

Processes the fields with references as registered during the copy process. This includes all FlexForm fields which had references.

Returns:
void

Definition at line 3730 of file class.t3lib_tcemain.php.
References t3lib_BEfunc::getFlexFormDS(), t3lib_div::loadTCA(), and t3lib_div::xml2array().

t3lib_TCEmain::remapListedDBRecords_flexFormCallBack ( $ pParams,

$ dsConf,

$ dataValue,

$ dataValue_ext1,

$ dataValue_ext2

)

Callback function for traversing the FlexForm structure in relation to creating copied files of file relations inside of flex form structures.

Parameters:

array Set of parameters in numeric array: table, uid, field

array TCA config for field (from Data Structure of course)

string Field value (from FlexForm XML)

string Not used

string Not used

Returns:
array Array where the "value" key carries the value.

See also:
checkValue_flex_procInData_travDS(), remapListedDBRecords()

Definition at line 3813 of file class.t3lib_tcemain.php.

t3lib_TCEmain::remapListedDBRecords_procDBRefs ( $ conf,

$ value,

$ MM_localUid

)

Performs remapping of old UID values to NEW uid values for a DB reference field.

Parameters:

array TCA field config

string Field value

integer UID of local record (for MM relations - might need to change if support for FlexForms should be done!)

Returns:
array Returns array of items ready to implode for field content.

See also:
remapListedDBRecords()

Definition at line 3839 of file class.t3lib_tcemain.php.
References t3lib_div::makeInstance(), and t3lib_div::trimExplode().

t3lib_TCEmain::removeCacheFiles ( )

Unlink (delete) typo3conf/temp_CACHED_*.php cache files

Returns:
integer The number of files deleted

Definition at line 4656 of file class.t3lib_tcemain.php.
References t3lib_extMgm::currentCacheFiles().

t3lib_TCEmain::removeRegisteredFiles ( )

Executing dbAnalysisStore

Returns:
[type] ...

Definition at line 2391 of file class.t3lib_tcemain.php.

t3lib_TCEmain::removeRegisteredFiles ( )

Executing dbAnalysisStore

Returns:
[type] ...

Definition at line 2391 of file class.t3lib_tcemain.php.
Referenced by process_datamap().

t3lib_TCEmain::resolvePid ( $ table,

$ pid

)

Get the final pid based on $table and $pid ($destPid type... pos/neg)

Parameters:

string Table name

integer "Destination pid" : If the value is >= 0 it's just returned directly (through intval() though) but if the value is <0 then the method looks up the record with the uid equal to abs($pid) (positive number) and returns the PID of that record! The idea is that negative numbers point to the record AFTER WHICH the position is supposed to be!

Returns:
integer

Definition at line 3701 of file class.t3lib_tcemain.php.

t3lib_TCEmain::resorting ( $ table,

$ pid,

$ sortRow,

$ return_SortNumber_After_This_Uid

)

Resorts a table.
Used internally by getSortNumber()

Parameters:

[type] $table: ...

[type] $pid: ...

[type] $sortRow: ...

[type] $return_SortNumber_After_This_Uid: ...

Returns:
[type] ...

Definition at line 4167 of file class.t3lib_tcemain.php.

t3lib_TCEmain::rmComma ( $ input )

Returns the $input string without a comma in the end

Parameters:

[type] $input: ...

Returns:
[type] ...

Definition at line 4196 of file class.t3lib_tcemain.php.

t3lib_TCEmain::setDefaultsFromUserTS ( $ userTS )

Initializes default values coming from User TSconfig

Parameters:

array User TSconfig array

Returns:
void

Definition at line 343 of file class.t3lib_tcemain.php.

t3lib_TCEmain::setHistory ( $ table,

$ id,

$ logId

)

[Describe function...]

Parameters:

[type] $table: ...

[type] $id: ...

[type] $logId: ...

Returns:
[type] ...

Definition at line 4435 of file class.t3lib_tcemain.php.
References t3lib_BEfunc::getTSCpid(), and t3lib_div::intInRange().

t3lib_TCEmain::setMirror ( $ mirror )

[Describe function...]

Parameters:

array This array has the syntax $mirror[table_name][uid] = [list of uids to copy data-value TO!]

Returns:
void

Definition at line 318 of file class.t3lib_tcemain.php.
References t3lib_div::trimExplode().

t3lib_TCEmain::setTSconfigPermissions ( $ fieldArray,

$ TSConfig_p

)

[Describe function...]

Parameters:

[type] $fieldArray: ...

[type] $TSConfig_p: ...

Returns:
[type] ...

Definition at line 1148 of file class.t3lib_tcemain.php.
References t3lib_div::testInt().

t3lib_TCEmain::start ( $ data,

$ cmd,

$ altUserObject = ''

)

Initializing. For details, see 'TYPO3 Core API' document. This function does not start the processing of data, but merely initializes the object

Parameters:

array Data to be modified or inserted in the database

array Commands to copy, move, delete records.

object An alternative userobject you can set instead of the default, which is $GLOBALS['BE_USER']

Returns:
void

Definition at line 285 of file class.t3lib_tcemain.php.
References $cmd, $data, $defaultPermissions, and getExcludeListArray().

t3lib_TCEmain::tableAdminOnly ( $ table )

Checks if the $table is only editable by admin-users

Parameters:

[type] $table: ...

Returns:
[type] ...

Definition at line 4350 of file class.t3lib_tcemain.php.

t3lib_TCEmain::tableReadOnly ( $ table )

Checks if the $table is readOnly

Parameters:

[type] $table: ...

Returns:
[type] ...

Definition at line 4338 of file class.t3lib_tcemain.php.

t3lib_TCEmain::tableReadOnly ( $ table )

Checks if the $table is readOnly

Parameters:

[type] $table: ...

Returns:
[type] ...

Definition at line 4338 of file class.t3lib_tcemain.php.
Referenced by process_datamap().

t3lib_TCEmain::updateDB ( $ table,

$ id,

$ fieldArray

)

Update database record Does not check permissions but expects them to be verified on beforehand

Parameters:

string Record table name

integer Record uid

array Array of field=>value pairs to insert. FIELDS MUST MATCH the database FIELDS. No check is done.

Returns:
void

Definition at line 2186 of file class.t3lib_tcemain.php.

t3lib_TCEmain::version_swap ( $ table,

$ id,

$ swapWith,

$ swapContent

)

Swapping versions of a record Version from archive (future/past, called "swap version") will get the uid of the "t3ver_oid", the official element with uid = "t3ver_oid" will get the new versions old uid. PIDs are swapped also

Parameters:

string Table name

integer UID of the online record to swap

integer UID of the archived version to swap with!

string If set, swap content; If set then - for pages - the page content PIDs are swapped as well. If set to "ALL" then subpages are swapped as well!

Returns:
void

Definition at line 3406 of file class.t3lib_tcemain.php.
References t3lib_BEfunc::getRecord().

t3lib_TCEmain::versionizePages ( $ uid,

$ label

)

Creates a new version of a page including content and possible subpages.

Parameters:

integer Page uid to create new version of.

string Version label

Returns:
void

See also:
copyPages()

Definition at line 3324 of file class.t3lib_tcemain.php.

t3lib_TCEmain::versionizeRecord ( $ table,

$ id,

$ label

)

Creates a new version of a record (Requires support in the table)

Parameters:

string Table name

integer Record uid to versionize

string Version label

Returns:
integer Returns the id of the new version (if any)

See also:
copyRecord()

Definition at line 3271 of file class.t3lib_tcemain.php.

Member Data Documentation

t3lib_TCEmain::$defaultPermissions

Initial value:
array( // Can be overridden from $TYPO3_CONF_VARS 'user' => 'show,edit,delete,new,editcontent', 'group' => 'show,edit,new,editcontent', 'everybody' => '' )

Definition at line 228 of file class.t3lib_tcemain.php.
Referenced by start().

t3lib_TCEmain::$pMap

Initial value:
Array( // Permission mapping 'show' => 1, // 1st bit 'edit' => 2, // 2nd bit 'delete' => 4, // 3rd bit 'new' => 8, // 4th bit 'editcontent' => 16 // 5th bit )

Definition at line 221 of file class.t3lib_tcemain.php.

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

typo3_src-3.7.0/t3lib/class.t3lib_tcemain.php
typo3_src-3.7.0/typo3/t3lib/class.t3lib_tcemain.php

Généré par Le spécialiste TYPO3 avec doxygen

1.4.6

Documentation TYPO3 par Ameos

t3lib_TCEmain Class Reference

Public Member Functions

Public Attributes

Detailed Description

Member Function Documentation

Member Data Documentation