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_TCEforms Class Reference

Inheritance diagram for t3lib_TCEforms:


Public Member Functions
	t3lib_TCEforms ()
	initDefaultBEmode ()
	getSoloField ($table, $row, $theFieldToReturn)
	getMainFields ($table, $row, $depth=0)
	getListedFields ($table, $row, $list)
	getPaletteFields ($table, $row, $palette, $header='', $itemList='', $collapsedHeader='')
	getSingleField ($table, $field, $row, $altName='', $palette=0, $extra='', $pal=0)
	getSingleField_SW ($table, $field, $row, &$PA)
	getSingleField_typeInput ($table, $field, $row, &$PA)
	getSingleField_typeText ($table, $field, $row, &$PA)
	getSingleField_typeCheck ($table, $field, $row, &$PA)
	getSingleField_typeRadio ($table, $field, $row, &$PA)
	getSingleField_typeSelect ($table, $field, $row, &$PA)
	getSingleField_typeSelect_single ($table, $field, $row, &$PA, $config, $selItems, $nMV_label)
	getSingleField_typeSelect_checkbox ($table, $field, $row, &$PA, $config, $selItems, $nMV_label)
	getSingleField_typeSelect_singlebox ($table, $field, $row, &$PA, $config, $selItems, $nMV_label)
	getSingleField_typeSelect_multiple ($table, $field, $row, &$PA, $config, $selItems, $nMV_label)
	getSingleField_typeGroup ($table, $field, $row, &$PA)
	getSingleField_typeNone ($table, $field, $row, &$PA)
	getSingleField_typeNone_render ($config, $itemValue)
	getSingleField_typeFlex ($table, $field, $row, &$PA)
	getSingleField_typeFlex_langMenu ($languages, $elName, $selectedLanguage, $multi=1)
	getSingleField_typeFlex_sheetMenu ($sArr, $elName, $sheetKey)
	getSingleField_typeFlex_draw ($dataStruct, $editData, $cmdData, $table, $field, $row, &$PA, $formPrefix='', $level=0, $tRows=array())
	getSingleField_typeUnknown ($table, $field, $row, &$PA)
	getSingleField_typeUser ($table, $field, $row, &$PA)
	getRTypeNum ($table, $row)
	rearrange ($fields)
	getExcludeElements ($table, $row, $typeNum)
	getFieldsToAdd ($table, $row, $typeNum)
	mergeFieldsWithAddedFields ($fields, $fieldsToAdd)
	setTSconfig ($table, $row, $field='')
	getSpecConfForField ($table, $row, $field)
	getSpecConfFromString ($extraString, $defaultExtras)
	registerDefaultLanguageData ($table, $rec)
	renderDefaultLanguageContent ($table, $field, $row, $item)
	renderDefaultLanguageDiff ($table, $field, $row, $item)
	dbFileIcons ($fName, $mode, $allowed, $itemArray, $selector='', $params=array(), $onFocus='')
	getClipboardElements ($allowed, $mode)
	getClickMenu ($str, $table, $uid='')
	renderWizards ($itemKinds, $wizConf, $table, $row, $field, &$PA, $itemName, $specConf, $RTE=0)
	getIcon ($icon)
	optionTagStyle ($iconString)
	extractValuesOnlyFromValueLabelList ($itemFormElValue)
	wrapOpenPalette ($header, $table, $row, $palette, $retFunc=0)
	checkBoxParams ($itemName, $thisValue, $c, $iCount, $addFunc='')
	elName ($itemName)
	noTitle ($str, $wrapParts=array())
	blur ()
	thisReturnUrl ()
	getSingleHiddenField ($table, $field, $row)
	formWidth ($size=48, $textarea=0)
	formWidthText ($size=48, $wrap='')
	formElStyle ($type)
	formElClass ($type)
	formElStyleClassValue ($type, $class=FALSE)
	insertDefStyle ($type)
	getDynTabMenu ($parts, $idString)
	initItemArray ($fieldValue)
	addItems ($items, $iArray)
	procItems ($items, $iArray, $config, $table, $row, $field)
	addSelectOptionsToItemArray ($items, $fieldValue, $TSconfig, $field)
	addSelectOptionsToItemArray_makeModuleData ($value)
	foreignTable ($items, $fieldValue, $TSconfig, $field, $pFFlag=0)
	setNewBEDesign ()
	intoTemplate ($inArr, $altTemplate='')
	addUserTemplateMarkers ($marker, $table, $field, $row, &$PA)
	wrapLabels ($str)
	wrapTotal ($c, $rec, $table)
	replaceTableWrap ($arr, $rec, $table)
	wrapBorder (&$out_array, &$out_pointer)
	rplColorScheme ($inTemplate)
	getDivider ()
	printPalette ($palArr)
	helpTextIcon ($table, $field, $force=0)
	helpText ($table, $field)
	setColorScheme ($scheme)
	resetSchemes ()
	storeSchemes ()
	restoreSchemes ()
	JStop ()
	JSbottom ($formname='forms[0]')
	dbFileCon ($formObj='document.forms[0]')
	printNeededJSFunctions ()
	printNeededJSFunctions_top ()
	getDefaultRecord ($table, $pid=0)
	getRecordPath ($table, $rec)
	readPerms ()
	sL ($str)
	getLL ($str)
	isPalettesCollapsed ($table, $palette)
	isDisplayCondition ($displayCond, $row)
	getTSCpid ($table, $uid, $pid)
	doLoadTableDescr ($table)
	getAvailableLanguages ($onlyIsoCoded=1, $setDefault=1)
	t3lib_TCEforms ()
	initDefaultBEmode ()
	getSoloField ($table, $row, $theFieldToReturn)
	getMainFields ($table, $row, $depth=0)
	getListedFields ($table, $row, $list)
	getPaletteFields ($table, $row, $palette, $header='', $itemList='', $collapsedHeader='')
	getSingleField ($table, $field, $row, $altName='', $palette=0, $extra='', $pal=0)
	getSingleField_SW ($table, $field, $row, &$PA)
	getSingleField_typeInput ($table, $field, $row, &$PA)
	getSingleField_typeText ($table, $field, $row, &$PA)
	getSingleField_typeCheck ($table, $field, $row, &$PA)
	getSingleField_typeRadio ($table, $field, $row, &$PA)
	getSingleField_typeSelect ($table, $field, $row, &$PA)
	getSingleField_typeSelect_single ($table, $field, $row, &$PA, $config, $selItems, $nMV_label)
	getSingleField_typeSelect_checkbox ($table, $field, $row, &$PA, $config, $selItems, $nMV_label)
	getSingleField_typeSelect_singlebox ($table, $field, $row, &$PA, $config, $selItems, $nMV_label)
	getSingleField_typeSelect_multiple ($table, $field, $row, &$PA, $config, $selItems, $nMV_label)
	getSingleField_typeGroup ($table, $field, $row, &$PA)
	getSingleField_typeNone ($table, $field, $row, &$PA)
	getSingleField_typeNone_render ($config, $itemValue)
	getSingleField_typeFlex ($table, $field, $row, &$PA)
	getSingleField_typeFlex_langMenu ($languages, $elName, $selectedLanguage, $multi=1)
	getSingleField_typeFlex_sheetMenu ($sArr, $elName, $sheetKey)
	getSingleField_typeFlex_draw ($dataStruct, $editData, $cmdData, $table, $field, $row, &$PA, $formPrefix='', $level=0, $tRows=array())
	getSingleField_typeUnknown ($table, $field, $row, &$PA)
	getSingleField_typeUser ($table, $field, $row, &$PA)
	getRTypeNum ($table, $row)
	rearrange ($fields)
	getExcludeElements ($table, $row, $typeNum)
	getFieldsToAdd ($table, $row, $typeNum)
	mergeFieldsWithAddedFields ($fields, $fieldsToAdd)
	setTSconfig ($table, $row, $field='')
	getSpecConfForField ($table, $row, $field)
	getSpecConfFromString ($extraString, $defaultExtras)
	registerDefaultLanguageData ($table, $rec)
	renderDefaultLanguageContent ($table, $field, $row, $item)
	renderDefaultLanguageDiff ($table, $field, $row, $item)
	dbFileIcons ($fName, $mode, $allowed, $itemArray, $selector='', $params=array(), $onFocus='')
	getClipboardElements ($allowed, $mode)
	getClickMenu ($str, $table, $uid='')
	renderWizards ($itemKinds, $wizConf, $table, $row, $field, &$PA, $itemName, $specConf, $RTE=0)
	getIcon ($icon)
	optionTagStyle ($iconString)
	extractValuesOnlyFromValueLabelList ($itemFormElValue)
	wrapOpenPalette ($header, $table, $row, $palette, $retFunc=0)
	checkBoxParams ($itemName, $thisValue, $c, $iCount, $addFunc='')
	elName ($itemName)
	noTitle ($str, $wrapParts=array())
	blur ()
	thisReturnUrl ()
	getSingleHiddenField ($table, $field, $row)
	formWidth ($size=48, $textarea=0)
	formWidthText ($size=48, $wrap='')
	formElStyle ($type)
	formElClass ($type)
	formElStyleClassValue ($type, $class=FALSE)
	insertDefStyle ($type)
	getDynTabMenu ($parts, $idString)
	initItemArray ($fieldValue)
	addItems ($items, $iArray)
	procItems ($items, $iArray, $config, $table, $row, $field)
	addSelectOptionsToItemArray ($items, $fieldValue, $TSconfig, $field)
	addSelectOptionsToItemArray_makeModuleData ($value)
	foreignTable ($items, $fieldValue, $TSconfig, $field, $pFFlag=0)
	setNewBEDesign ()
	intoTemplate ($inArr, $altTemplate='')
	addUserTemplateMarkers ($marker, $table, $field, $row, &$PA)
	wrapLabels ($str)
	wrapTotal ($c, $rec, $table)
	replaceTableWrap ($arr, $rec, $table)
	wrapBorder (&$out_array, &$out_pointer)
	rplColorScheme ($inTemplate)
	getDivider ()
	printPalette ($palArr)
	helpTextIcon ($table, $field, $force=0)
	helpText ($table, $field)
	setColorScheme ($scheme)
	resetSchemes ()
	storeSchemes ()
	restoreSchemes ()
	JStop ()
	JSbottom ($formname='forms[0]')
	dbFileCon ($formObj='document.forms[0]')
	printNeededJSFunctions ()
	printNeededJSFunctions_top ()
	getDefaultRecord ($table, $pid=0)
	getRecordPath ($table, $rec)
	readPerms ()
	sL ($str)
	getLL ($str)
	isPalettesCollapsed ($table, $palette)
	isDisplayCondition ($displayCond, $row)
	getTSCpid ($table, $uid, $pid)
	doLoadTableDescr ($table)
	getAvailableLanguages ($onlyIsoCoded=1, $setDefault=1)
Public Attributes
	$palFieldArr = array()
	$disableWizards = 0
	$isPalettedoc = 0
	$paletteMargin = 1
	$defStyle = ''
	$cachedTSconfig = array()
	$cachedTSconfig_fieldLevel = array()
	$transformedRow = array()
	$extJSCODE = ''
	$printNeededJS = array()
	$hiddenFieldAccum = array()
	$TBE_EDITOR_fieldChanged_func = ''
	$loadMD5_JS = 1
	$prevBorderStyle = '[nothing here...]'
	$allowUpload = 0
	$titleLen = 15
	$defaultLanguageData = array()
	$defaultLanguageData_diff = array()
	$backPath = ''
	$returnUrl = ''
	$doSaveFieldName = ''
	$palettesCollapsed = 0
	$disableRTE = 0
	$globalShowHelp = 1
	$fieldOrder = ''
	$doPrintPalette = 1
	$clipObj = FALSE
	$enableClickMenu = FALSE
	$enableTabMenu = FALSE
	$form_rowsToStylewidth = 9.58
	$form_largeComp = 1.33
	$charsPerRow = 40
	$maxTextareaWidth = 48
	$maxInputWidth = 48
	$defaultMultipleSelectorStyle = 'width:250px;'
	$prependFormFieldNames = 'data'
	$prependFormFieldNames_file = 'data_files'
	$formName = 'editform'
	$perms_clause = ''
	$perms_clause_set = 0
	$edit_showFieldHelp = ''
	$docLarge = 0
	$clientInfo = array()
	$RTEenabled = 0
	$RTEenabled_notReasons = ''
	$RTEcounter = 0
	$colorScheme
	$classScheme
	$defColorScheme
	$defClassScheme
	$fieldStyle
	$borderStyle
	$commentMessages = array()
	$totalWrap = '<hr />\|<hr />'
	$fieldTemplate = '<b>###FIELD_NAME###</b><br />###FIELD_ITEM###<hr />'
	$sectionWrap = ''
	$palFieldTemplateHeader = ''
	$palFieldTemplate = ''
	$excludeElements = ''
	$palettesRendered = array()
	$hiddenFieldListArr = array()
	$requiredFields = array()
	$requiredElements = array()
	$renderDepth = 0
	$savedSchemes = array()
	$additionalCode_pre = array()
	$additionalJS_pre = array()
	$additionalJS_post = array()
	$additionalJS_submit = array()

Detailed Description

Definition at line 191 of file class.t3lib_tceforms.php.

Constructor & Destructor Documentation

t3lib_TCEforms::t3lib_TCEforms ( )

Constructor function, setting internal variables, loading the styles used.

Returns:
void

Definition at line 294 of file class.t3lib_tceforms.php.
References t3lib_div::clientInfo(), t3lib_div::modifyHTMLColorAll(), and resetSchemes().

Member Function Documentation

t3lib_TCEforms::addItems ( $ items,

$ iArray

)

Merges items into an item-array

Parameters:

array The existing item array

array An array of items to add. NOTICE: The keys are mapped to values, and the values and mapped to be labels. No possibility of adding an icon.

Returns:
array The updated $item array

Definition at line 3306 of file class.t3lib_tceforms.php.

t3lib_TCEforms::addSelectOptionsToItemArray ( $ items,

$ fieldValue,

$ TSconfig,

$ field

)

Add selector box items of more exotic kinds.

Parameters:

array The array of items (label,value,icon)

array The "columns" array for the field (from TCA)

array TSconfig for the table/row

string The fieldname

Returns:
array The $items array modified.

Definition at line 3352 of file class.t3lib_tceforms.php.
References t3lib_div::getAllFilesAndFoldersInPath(), t3lib_BEfunc::getExcludeFields(), t3lib_BEfunc::getExplicitAuthFieldValues(), t3lib_div::getFileAbsFileName(), t3lib_iconWorks::getIcon(), t3lib_BEfunc::getSystemLanguages(), t3lib_div::inList(), t3lib_div::intInRange(), t3lib_div::makeInstance(), t3lib_div::removePrefixPathFromList(), and t3lib_iconWorks::skinImg().

t3lib_TCEforms::addSelectOptionsToItemArray_makeModuleData ( $ value )

Creates value/label pair for a backend module (main and sub)

Parameters:

string The module key

Returns:
string The rawurlencoded 2-part string to transfer to interface private

See also:
addSelectOptionsToItemArray()

Definition at line 3574 of file class.t3lib_tceforms.php.

t3lib_TCEforms::addUserTemplateMarkers ( $ marker,

$ table,

$ field,

$ row,

&$ PA

)

Overwrite this function in own extended class to add own markers for output

Parameters:

array Array with key/value pairs to insert in the template.

string The table name of the record

string The field name which this element is supposed to edit

array The record data array where the value(s) for the field can be found

array An array with additional configuration options.

Returns:
array marker array for template output

See also:
function intoTemplate()

Definition at line 3755 of file class.t3lib_tceforms.php.

t3lib_TCEforms::blur ( )

Returns 'this.blur();' string, if supported.

Returns:
string If the current browser supports styles, the string 'this.blur();' is returned.

Definition at line 3099 of file class.t3lib_tceforms.php.

t3lib_TCEforms::checkBoxParams ( $ itemName,

$ thisValue,

$ c,

$ iCount,

$ addFunc = ''

)

Creates checkbox parameters

Parameters:

string Form element name

integer The value of the checkbox (representing checkboxes with the bits)

integer Checkbox # (0-9?)

integer Total number of checkboxes in the array.

string Additional JavaScript for the onclick handler.

Returns:
string The onclick attribute + possibly the checked-option set.

Definition at line 3065 of file class.t3lib_tceforms.php.

t3lib_TCEforms::dbFileCon ( $ formObj = 'document.forms[0]' )

Used to connect the db/file browser with this document and the formfields on it!

Parameters:

string Form object reference (including "document.")

Returns:
string JavaScript functions/code (NOT contained in a <script>-element)

Definition at line 4414 of file class.t3lib_tceforms.php.

t3lib_TCEforms::dbFileIcons ( $ fName,

$ mode,

$ allowed,

$ itemArray,

$ selector = '',

$ params = array(),

$ onFocus = ''

)

Prints the selector box form-field for the db/file/select elements (multiple)

Parameters:

string Form element name

string Mode "db", "file" (internal_type for the "group" type) OR blank (then for the "select" type)

string Commalist of "allowed"

array The array of items. For "select" and "group"/"file" this is just a set of value. For "db" its an array of arrays with table/uid pairs.

string Alternative selector box.

array An array of additional parameters, eg: "size", "info", "headers" (array with "selector" and "items"), "noBrowser", "thumbnails"

string On focus attribute string

Returns:
string The form fields for the selection.

Definition at line 2569 of file class.t3lib_tceforms.php.
References t3lib_div::fixed_lgd_cs(), t3lib_BEfunc::getRecord(), t3lib_BEfunc::getRecordTitle(), and t3lib_div::intInRange().

t3lib_TCEforms::doLoadTableDescr ( $ table )

Returns true if descriptions should be loaded always

Parameters:

string Table for which to check

Returns:
boolean

Definition at line 4805 of file class.t3lib_tceforms.php.

t3lib_TCEforms::elName ( $ itemName )

Returns element reference for form element name

Parameters:

string Form element name

Returns:
string Form element reference (JS)

Definition at line 3079 of file class.t3lib_tceforms.php.

t3lib_TCEforms::extractValuesOnlyFromValueLabelList ( $ itemFormElValue )

Extracting values from a value/label list (as made by transferData class)

Parameters:

string Value string where values are comma separated, intermixed with labels and rawurlencoded (this is what is delivered to TCEforms normally!)

array Values in an array

Returns:
[type] ...

Definition at line 3019 of file class.t3lib_tceforms.php.
References t3lib_div::trimExplode().

t3lib_TCEforms::foreignTable ( $ items,

$ fieldValue,

$ TSconfig,

$ field,

$ pFFlag = 0

)

Adds records from a foreign table (for selector boxes)

Parameters:

array The array of items (label,value,icon)

array The 'columns' array for the field (from TCA)

array TSconfig for the table/row

string The fieldname

boolean If set, then we are fetching the 'neg_' foreign tables.

Returns:
array The $items array modified.

See also:
addSelectOptionsToItemArray(), t3lib_BEfunc::exec_foreign_table_where_query()

Definition at line 3596 of file class.t3lib_tceforms.php.
References t3lib_BEfunc::exec_foreign_table_where_query(), t3lib_div::fixed_lgd_cs(), t3lib_iconWorks::getIcon(), t3lib_BEfunc::getRecordTitle(), t3lib_div::inList(), and t3lib_div::trimExplode().

t3lib_TCEforms::formElClass ( $ type )

Get class attribute value for the current field type.

Parameters:

string Field type (eg. "check", "radio", "select")

Returns:
string CSS attributes

See also:
formElStyleClassValue()

Definition at line 3197 of file class.t3lib_tceforms.php.

t3lib_TCEforms::formElStyle ( $ type )

Get style CSS values for the current field type.

Parameters:

string Field type (eg. "check", "radio", "select")

Returns:
string CSS attributes

See also:
formElStyleClassValue()

Definition at line 3186 of file class.t3lib_tceforms.php.

t3lib_TCEforms::formElStyleClassValue ( $ type,

$ class = FALSE

)

Get style CSS values for the current field type.

Parameters:

string Field type (eg. "check", "radio", "select")

boolean If set, will return value only if prefixed with CLASS, otherwise must not be prefixed "CLASS"

Returns:
string CSS attributes

Definition at line 3208 of file class.t3lib_tceforms.php.

t3lib_TCEforms::formWidth ( $ size = 48,

$ textarea = 0

)

Returns parameters to set the width for a <input>/<textarea>-element

Parameters:

integer The abstract size value (1-48)

boolean If this is for a text area.

Returns:
string Either a "style" attribute string or "cols"/"size" attribute string.

Definition at line 3143 of file class.t3lib_tceforms.php.

t3lib_TCEforms::formWidthText ( $ size = 48,

$ wrap = ''

)

Returns parameters to set with for a textarea field

Parameters:

integer The abstract width (1-48)

string Empty or "off" (text wrapping in the field or not)

Returns:
string The "cols" attribute string (or style from formWidth())

See also:
formWidth()

Definition at line 3170 of file class.t3lib_tceforms.php.

t3lib_TCEforms::getAvailableLanguages ( $ onlyIsoCoded = 1,

$ setDefault = 1

)

Returns an array of available languages (to use for FlexForms)

Parameters:

boolean If set, only languages which are paired with a static_info_table / static_language record will be returned.

boolean If set, an array entry for a default language is set.

Returns:
array

Definition at line 4817 of file class.t3lib_tceforms.php.
References t3lib_BEfunc::deleteClause(), t3lib_BEfunc::getRecord(), and t3lib_extMgm::isLoaded().

t3lib_TCEforms::getClickMenu ( $ str,

$ table,

$ uid = ''

)

Wraps the icon of a relation item (database record or file) in a link opening the context menu for the item. Icons will be wrapped only if $this->enableClickMenu is set. This must be done only if a global SOBE object exists and if the necessary JavaScript for displaying the context menus has been added to the page header.

Parameters:

string The icon HTML to wrap

string Table name (eg. "pages" or "tt_content") OR the absolute path to the file

integer The uid of the record OR if file, just blank value.

Returns:
string HTML

Definition at line 2751 of file class.t3lib_tceforms.php.

t3lib_TCEforms::getClipboardElements ( $ allowed,

$ mode

)

Returns array of elements from clipboard to insert into GROUP element box.

Parameters:

string Allowed elements, Eg "pages,tt_content", "gif,jpg,jpeg,png"

string Mode of relations: "db" or "file"

Returns:
array Array of elements in values (keys are insignificant), if none found, empty array.

Definition at line 2702 of file class.t3lib_tceforms.php.
References t3lib_div::trimExplode().

t3lib_TCEforms::getDefaultRecord ( $ table,

$ pid = 0

)

Gets default record. Maybe not used anymore. FE-editor?

Parameters:

string Database Tablename

integer PID value (positive / negative)

Returns:
array "default" row.

Definition at line 4597 of file class.t3lib_tceforms.php.
References t3lib_BEfunc::deleteClause(), and t3lib_div::loadTCA().

t3lib_TCEforms::getDivider ( )

Returns divider. Currently not implemented and returns only blank value.

Returns:
string

Definition at line 3871 of file class.t3lib_tceforms.php.

t3lib_TCEforms::getDivider ( )

Returns divider. Currently not implemented and returns only blank value.

Returns:
string

Definition at line 3871 of file class.t3lib_tceforms.php.
Referenced by getListedFields(), and getMainFields().

t3lib_TCEforms::getDynTabMenu ( $ parts,

$ idString

)

Create tab menu

Parameters:

array Parts for the tab menu, fed to template::getDynTabMenu()

string ID string for the tab menu

Returns:
string HTML for the menu

Definition at line 3249 of file class.t3lib_tceforms.php.

t3lib_TCEforms::getExcludeElements ( $ table,

$ row,

$ typeNum

)

Producing an array of field names NOT to display in the form, based on settings from subtype_value_field, bitmask_excludelist_bits etc. Notice, this list is in NO way related to the "excludeField" flag

Parameters:

string Table name, MUST be in $TCA

array A record from table.

string A "type" pointer value, probably the one calculated based on the record array.

Returns:
array Array with fieldnames as values. The fieldnames are those which should NOT be displayed "anyways"

See also:
getMainFields()

Definition at line 2282 of file class.t3lib_tceforms.php.
References t3lib_div::intInRange(), t3lib_div::testInt(), and t3lib_div::trimExplode().

t3lib_TCEforms::getFieldsToAdd ( $ table,

$ row,

$ typeNum

)

Finds possible field to add to the form, based on subtype fields.

Parameters:

string Table name, MUST be in $TCA

array A record from table.

string A "type" pointer value, probably the one calculated based on the record array.

Returns:
array An array containing two values: 1) Another array containing fieldnames to add and 2) the subtype value field.

See also:
getMainFields()

Definition at line 2330 of file class.t3lib_tceforms.php.
References t3lib_div::trimExplode().

t3lib_TCEforms::getIcon ( $ icon )

Get icon (for example for selector boxes)

Parameters:

string Icon reference

Returns:
array Array with two values; the icon file reference (relative to PATH_typo3 minus backPath), the icon file information array (getimagesize())

Definition at line 2976 of file class.t3lib_tceforms.php.
References t3lib_div::getFileAbsFileName().

t3lib_TCEforms::getListedFields ( $ table,

$ row,

$ list

)

Will return the TCEform elements for a pre-defined list of fields. Notice that this will STILL use the configuration found in the list [types][showitem] for those fields which are found there. So ideally the list of fields given as argument to this function should also be in the current [types][showitem] list of the record. Used for displaying forms for the frontend edit icons for instance.

Parameters:

string The table name

array The record array.

string Commalist of fields from the table. These will be shown in the specified order in a form.

Returns:
string TCEform elements in a string.

Definition at line 579 of file class.t3lib_tceforms.php.
References doLoadTableDescr(), getDivider(), getPaletteFields(), getSingleField(), t3lib_BEfunc::getTCAtypes(), t3lib_div::loadTCA(), and t3lib_div::trimExplode().

t3lib_TCEforms::getLL ( $ str )

Returns language label from locallang_core.php Labels must be prefixed with either "l_" or "m_". The prefix "l_" maps to the prefix "labels." inside locallang_core.php The prefix "m_" maps to the prefix "mess." inside locallang_core.php

Parameters:

string The label key

Returns:
string The value of the label, fetched for the current backend language.

Definition at line 4677 of file class.t3lib_tceforms.php.

t3lib_TCEforms::getMainFields ( $ table,

$ row,

$ depth = 0

)

Based on the $table and $row of content, this displays the complete TCEform for the record. The input-$row is required to be preprocessed if necessary by eg. the t3lib_transferdata class. For instance the RTE content should be transformed through this class first.

Parameters:

string The table name

array The record from the table for which to render a field.

integer Depth level

Returns:
string HTML output

See also:
getSoloField()

Definition at line 412 of file class.t3lib_tceforms.php.
References $excludeElements, doLoadTableDescr(), getDivider(), getExcludeElements(), getFieldsToAdd(), getLL(), getPaletteFields(), getRTypeNum(), getSingleField(), t3lib_div::loadTCA(), mergeFieldsWithAddedFields(), rearrange(), resetSchemes(), setColorScheme(), sL(), t3lib_div::trimExplode(), and wrapBorder().

t3lib_TCEforms::getPaletteFields ( $ table,

$ row,

$ palette,

$ header = '',

$ itemList = '',

$ collapsedHeader = ''

)

Creates a palette (collection of secondary options).

Parameters:

string The table name

array The row array

string The palette number/pointer

string Header string for the palette (used when in-form). If not set, no header item is made.

string Optional alternative list of fields for the palette

string Optional Link text for activating a palette (when palettes does not have another form element to belong to).

Returns:
string HTML code.

Definition at line 620 of file class.t3lib_tceforms.php.
References getExcludeElements(), getRTypeNum(), getSingleField(), intoTemplate(), isPalettesCollapsed(), t3lib_div::loadTCA(), printPalette(), t3lib_iconWorks::skinImg(), t3lib_div::trimExplode(), and wrapOpenPalette().

t3lib_TCEforms::getRecordPath ( $ table,

$ rec

)

Return record path (visually formatted, using t3lib_BEfunc::getRecordPath() )

Parameters:

string Table name

array Record array

Returns:
string The record path.

See also:
t3lib_BEfunc::getRecordPath()

Definition at line 4636 of file class.t3lib_tceforms.php.
References t3lib_BEfunc::fixVersioningPid(), and t3lib_BEfunc::getRecordPath().

t3lib_TCEforms::getRTypeNum ( $ table,

$ row

)

Calculate and return the current "types" pointer value for a record

Parameters:

string The table name. MUST be in $TCA

array The row from the table, should contain at least the "type" field, if applicable.

Returns:
string Return the "type" value for this record, ready to pick a "types" configuration from the $TCA array.

Definition at line 2230 of file class.t3lib_tceforms.php.

t3lib_TCEforms::getSingleField ( $ table,

$ field,

$ row,

$ altName = '',

$ palette = 0,

$ extra = '',

$ pal = 0

)

Returns the form HTML code for a database table field.

Parameters:

string The table name

string The field name

array The record to edit from the database table.

string Alternative field name label to show.

boolean Set this if the field is on a palette (in top frame), otherwise not. (if set, field will render as a hidden field).

string The "extra" options from "Part 4" of the field configurations found in the "types" "showitem" list. Typically parsed by $this->getSpecConfFromString() in order to get the options as an associative array.

integer The palette pointer.

Returns:
mixed String (normal) or array (palettes)

Definition at line 696 of file class.t3lib_tceforms.php.
References addUserTemplateMarkers(), t3lib_div::deHSCentities(), getLL(), getSingleField_SW(), helpText(), helpTextIcon(), t3lib_div::inList(), intoTemplate(), isDisplayCondition(), isPalettesCollapsed(), t3lib_div::loadTCA(), renderDefaultLanguageContent(), renderDefaultLanguageDiff(), setTSconfig(), t3lib_iconWorks::skinImg(), sL(), t3lib_div::testInt(), thisReturnUrl(), and wrapOpenPalette().

t3lib_TCEforms::getSingleField_SW ( $ table,

$ field,

$ row,

&$ PA

)

Rendering a single item for the form

Parameters:

string Table name of record

string Fieldname to render

array The record

array parameters array containing a lot of stuff. Value by Reference!

Returns:
string Returns the item as HTML code to insert private

See also:
getSingleField(), getSingleField_typeFlex_draw()

Definition at line 830 of file class.t3lib_tceforms.php.
References getSingleField_typeCheck(), getSingleField_typeFlex(), getSingleField_typeGroup(), getSingleField_typeInput(), getSingleField_typeNone(), getSingleField_typeRadio(), getSingleField_typeSelect(), getSingleField_typeText(), getSingleField_typeUnknown(), and getSingleField_typeUser().

t3lib_TCEforms::getSingleField_typeCheck ( $ table,

$ field,

$ row,

&$ PA

)

Generation of TCEform elements of the type "check" This will render a check-box OR an array of checkboxes

Parameters:

string The table name of the record

string The field name which this element is supposed to edit

array The record data array where the value(s) for the field can be found

array An array with additional configuration options.

Returns:
string The HTML code for the TCEform field

Definition at line 1054 of file class.t3lib_tceforms.php.
References checkBoxParams(), initItemArray(), procItems(), and wrapLabels().

t3lib_TCEforms::getSingleField_typeFlex ( $ table,

$ field,

$ row,

&$ PA

)

Handler for Flex Forms

Parameters:

string The table name of the record

string The field name which this element is supposed to edit

array The record data array where the value(s) for the field can be found

array An array with additional configuration options.

Returns:
string The HTML code for the TCEform field

Definition at line 1856 of file class.t3lib_tceforms.php.
References t3lib_div::_GP(), t3lib_BEfunc::getFlexFormDS(), t3lib_div::resolveSheetDefInDS(), t3lib_div::xml2array(), and t3lib_div::xmlGetHeaderAttribs().

t3lib_TCEforms::getSingleField_typeFlex_draw ( $ dataStruct,

$ editData,

$ cmdData,

$ table,

$ field,

$ row,

&$ PA,

$ formPrefix = '',

$ level = 0,

$ tRows = array()

)

[Describe function...]

Parameters:

[type] $dataStruct: ...

[type] $editData: ...

[type] $cmdData: ...

[type] $table: ...

[type] $field: ...

[type] $row: ...

[type] $PA: ...

[type] $formPrefix: ...

[type] $level: ...

[type] $tRows: ...

Returns:
[type] ...

Definition at line 2029 of file class.t3lib_tceforms.php.
References t3lib_div::fixed_lgd_cs().

t3lib_TCEforms::getSingleField_typeFlex_langMenu ( $ languages,

$ elName,

$ selectedLanguage,

$ multi = 1

)

Creates the language menu for FlexForms:

Parameters:

[type] $languages: ...

[type] $elName: ...

[type] $selectedLanguage: ...

[type] $multi: ...

Returns:
string HTML for menu

Definition at line 1980 of file class.t3lib_tceforms.php.

t3lib_TCEforms::getSingleField_typeFlex_sheetMenu ( $ sArr,

$ elName,

$ sheetKey

)

Creates the menu for selection of the sheets:

Parameters:

array Sheet array for which to render the menu

string Form element name of the field containing the sheet pointer

string Current sheet key

Returns:
string HTML for menu

Definition at line 1999 of file class.t3lib_tceforms.php.

t3lib_TCEforms::getSingleField_typeGroup ( $ table,

$ field,

$ row,

&$ PA

)

Generation of TCEform elements of the type "group" This will render a selectorbox into which elements from either the file system or database can be inserted. Relations.

Parameters:

string The table name of the record

string The field name which this element is supposed to edit

array The record data array where the value(s) for the field can be found

array An array with additional configuration options.

Returns:
string The HTML code for the TCEform field

Definition at line 1627 of file class.t3lib_tceforms.php.
References t3lib_div::getFileAbsFileName(), t3lib_BEfunc::getFileIcon(), t3lib_iconWorks::getIconImage(), t3lib_BEfunc::getRecord(), t3lib_div::intInRange(), t3lib_BEfunc::splitTable_Uid(), and t3lib_div::trimExplode().

t3lib_TCEforms::getSingleField_typeInput ( $ table,

$ field,

$ row,

&$ PA

)

Generation of TCEform elements of the type "input" This will render a single-line input form field, possibly with various control/validation features

Parameters:

string The table name of the record

string The field name which this element is supposed to edit

array The record data array where the value(s) for the field can be found

array An array with additional configuration options.

Returns:
string The HTML code for the TCEform field

Definition at line 903 of file class.t3lib_tceforms.php.
References getSpecConfFromString(), t3lib_div::intInRange(), renderWizards(), and t3lib_div::trimExplode().

t3lib_TCEforms::getSingleField_typeNone ( $ table,

$ field,

$ row,

&$ PA

)

Generation of TCEform elements of the type "none" This will render a non-editable display of the content of the field.

Parameters:

string The table name of the record

string The field name which this element is supposed to edit

array The record data array where the value(s) for the field can be found

array An array with additional configuration options.

Returns:
string The HTML code for the TCEform field

Definition at line 1781 of file class.t3lib_tceforms.php.

t3lib_TCEforms::getSingleField_typeNone_render ( $ config,

$ itemValue

)

HTML rendering of a value which is not editable.

Parameters:

array Configuration for the display

string The value to display

Returns:
string The HTML code for the display

See also:
getSingleField_typeNone();

Definition at line 1797 of file class.t3lib_tceforms.php.
References t3lib_div::intInRange().

t3lib_TCEforms::getSingleField_typeRadio ( $ table,

$ field,

$ row,

&$ PA

)

Generation of TCEform elements of the type "radio" This will render a series of radio buttons.

Parameters:

string The table name of the record

string The field name which this element is supposed to edit

array The record data array where the value(s) for the field can be found

array An array with additional configuration options.

Returns:
string The HTML code for the TCEform field

Definition at line 1113 of file class.t3lib_tceforms.php.

t3lib_TCEforms::getSingleField_typeSelect ( $ table,

$ field,

$ row,

&$ PA

)

Generation of TCEform elements of the type "select" This will render a selector box element, or possibly a special construction with two selector boxes. That depends on configuration.

Parameters:

string The table name of the record

string The field name which this element is supposed to edit

array The record data array where the value(s) for the field can be found

array An array with additional configuration options.

Returns:
string The HTML code for the TCEform field

Definition at line 1143 of file class.t3lib_tceforms.php.
References t3lib_div::inList(), and t3lib_div::trimExplode().

t3lib_TCEforms::getSingleField_typeSelect_checkbox ( $ table,

$ field,

$ row,

&$ PA,

$ config,

$ selItems,

$ nMV_label

)

Creates a checkbox list (renderMode = "checkbox") (Render function for getSingleField_typeSelect())

Parameters:

string See getSingleField_typeSelect()

string See getSingleField_typeSelect()

array See getSingleField_typeSelect()

array See getSingleField_typeSelect()

array (Redundant) content of $PA['fieldConf']['config'] (for convenience)

array Items available for selection

string Label for no-matching-value

Returns:
string The HTML code for the item

See also:
getSingleField_typeSelect()

Definition at line 1323 of file class.t3lib_tceforms.php.
References t3lib_div::deHSCentities().

t3lib_TCEforms::getSingleField_typeSelect_multiple ( $ table,

$ field,

$ row,

&$ PA,

$ config,

$ selItems,

$ nMV_label

)

Creates a multiple-selector box (two boxes, side-by-side) (Render function for getSingleField_typeSelect())

Parameters:

string See getSingleField_typeSelect()

string See getSingleField_typeSelect()

array See getSingleField_typeSelect()

array See getSingleField_typeSelect()

array (Redundant) content of $PA['fieldConf']['config'] (for convenience)

array Items available for selection

string Label for no-matching-value

Returns:
string The HTML code for the item

See also:
getSingleField_typeSelect()

Definition at line 1537 of file class.t3lib_tceforms.php.
References t3lib_div::intInRange(), and t3lib_div::trimExplode().

t3lib_TCEforms::getSingleField_typeSelect_single ( $ table,

$ field,

$ row,

&$ PA,

$ config,

$ selItems,

$ nMV_label

)

Creates a single-selector box (Render function for getSingleField_typeSelect())

Parameters:

string See getSingleField_typeSelect()

string See getSingleField_typeSelect()

array See getSingleField_typeSelect()

array See getSingleField_typeSelect()

array (Redundant) content of $PA['fieldConf']['config'] (for convenience)

array Items available for selection

string Label for no-matching-value

Returns:
string The HTML code for the item

See also:
getSingleField_typeSelect()

Definition at line 1214 of file class.t3lib_tceforms.php.

t3lib_TCEforms::getSingleField_typeSelect_singlebox ( $ table,

$ field,

$ row,

&$ PA,

$ config,

$ selItems,

$ nMV_label

)

Creates a selectorbox list (renderMode = "singlebox") (Render function for getSingleField_typeSelect())

Parameters:

string See getSingleField_typeSelect()

string See getSingleField_typeSelect()

array See getSingleField_typeSelect()

array See getSingleField_typeSelect()

array (Redundant) content of $PA['fieldConf']['config'] (for convenience)

array Items available for selection

string Label for no-matching-value

Returns:
string The HTML code for the item

See also:
getSingleField_typeSelect()

Definition at line 1435 of file class.t3lib_tceforms.php.
References t3lib_div::deHSCentities(), and t3lib_div::intInRange().

t3lib_TCEforms::getSingleField_typeText ( $ table,

$ field,

$ row,

&$ PA

)

Generation of TCEform elements of the type "text" This will render a <textarea> OR RTE area form field, possibly with various control/validation features

Parameters:

string The table name of the record

string The field name which this element is supposed to edit

array The record data array where the value(s) for the field can be found

array An array with additional configuration options.

Returns:
string The HTML code for the TCEform field

Definition at line 955 of file class.t3lib_tceforms.php.
References t3lib_parsehtml_proc::evalWriteFile(), t3lib_div::formatForTextarea(), getLL(), t3lib_BEfunc::getPagesTSconfig(), getSpecConfFromString(), t3lib_BEfunc::getSpecConfParametersFromArray(), t3lib_BEfunc::getTCAtypeValue(), getTSCpid(), t3lib_div::intInRange(), renderWizards(), t3lib_BEfunc::RTEgetObj(), and t3lib_BEfunc::RTEsetup().

t3lib_TCEforms::getSingleField_typeUnknown ( $ table,

$ field,

$ row,

&$ PA

)

Handler for unknown types.

Parameters:

string The table name of the record

string The field name which this element is supposed to edit

array The record data array where the value(s) for the field can be found

array An array with additional configuration options.

Returns:
string The HTML code for the TCEform field

Definition at line 2181 of file class.t3lib_tceforms.php.

t3lib_TCEforms::getSingleField_typeUser ( $ table,

$ field,

$ row,

&$ PA

)

User defined field type

Parameters:

string The table name of the record

string The field name which this element is supposed to edit

array The record data array where the value(s) for the field can be found

array An array with additional configuration options.

Returns:
string The HTML code for the TCEform field

Definition at line 2196 of file class.t3lib_tceforms.php.
References t3lib_div::callUserFunction().

t3lib_TCEforms::getSingleHiddenField ( $ table,

$ field,

$ row

)

Returns the form field for a single HIDDEN field. (Not used anywhere...?)

Parameters:

string Table name

string Field name

array The row

Returns:
string The hidden-field <input> tag.

Definition at line 3121 of file class.t3lib_tceforms.php.
References t3lib_div::loadTCA().

t3lib_TCEforms::getSoloField ( $ table,

$ row,

$ theFieldToReturn

)

Will return the TCEform element for just a single field from a record. The field must be listed in the currently displayed fields (as found in [types][showitem]) for the record. This also means that the $table/$row supplied must be complete so the list of fields to show can be found correctly

Parameters:

string The table name

array The record from the table for which to render a field.

string The field name to return the TCEform element for.

Returns:
string HTML output

See also:
getMainFields()

Definition at line 373 of file class.t3lib_tceforms.php.
References $excludeElements, getExcludeElements(), getRTypeNum(), getSingleField(), t3lib_div::loadTCA(), and t3lib_div::trimExplode().

t3lib_TCEforms::getSpecConfForField ( $ table,

$ row,

$ field

)

Returns the "special" configuration (from the "types" "showitem" list) for a fieldname based on input table/record (Not used anywhere...?)

Parameters:

string The table name

array The table row (Should at least contain the "uid" value, even if "NEW..." string. The "pid" field is important as well, and negative values will be intepreted as pointing to a record from the same table.)

string Specify the field name.

Returns:
array

See also:
getSpecConfFromString(), t3lib_BEfunc::getTCAtypes()

Definition at line 2409 of file class.t3lib_tceforms.php.
References t3lib_BEfunc::getTCAtypes().

t3lib_TCEforms::getSpecConfFromString ( $ extraString,

$ defaultExtras

)

Returns the "special" configuration of an "extra" string (non-parsed)

Parameters:

string The "Part 4" of the fields configuration in "types" "showitem" lists.

string The ['defaultExtras'] value from field configuration

Returns:
array An array with the special options in.

See also:
getSpecConfForField(), t3lib_BEfunc::getSpecConfParts()

Definition at line 2430 of file class.t3lib_tceforms.php.
References t3lib_BEfunc::getSpecConfParts().

t3lib_TCEforms::getTSCpid ( $ table,

$ uid,

$ pid

)

Return TSCpid (cached) Using t3lib_BEfunc::getTSCpid()

Parameters:

string Tablename

string UID value

string PID value

Returns:
integer Returns the REAL pid of the record, if possible. If both $uid and $pid is strings, then pid=-1 is returned as an error indication.

See also:
t3lib_BEfunc::getTSCpid()

Definition at line 4791 of file class.t3lib_tceforms.php.
References t3lib_BEfunc::getTSCpid().

t3lib_TCEforms::helpText ( $ table,

$ field

)

Returns help text DESCRIPTION, if configured for.

Parameters:

string The table name

string The field name

Returns:
string

Definition at line 3952 of file class.t3lib_tceforms.php.

t3lib_TCEforms::helpTextIcon ( $ table,

$ field,

$ force = 0

)

Returns help-text ICON if configured for.

Parameters:

string The table name

string The field name

boolean Force the return of the help-text icon.

Returns:
string HTML, -tag with

Definition at line 3932 of file class.t3lib_tceforms.php.

t3lib_TCEforms::initDefaultBEmode ( )

Initialize various internal variables.

Returns:
void

Definition at line 328 of file class.t3lib_tceforms.php.
References setNewBEDesign().

t3lib_TCEforms::initItemArray ( $ fieldValue )

Initialize item array (for checkbox, selectorbox, radio buttons) Will resolve the label value.

Parameters:

array The "columns" array for the field (from TCA)

Returns:
array An array of arrays with three elements; label, value, icon

Definition at line 3288 of file class.t3lib_tceforms.php.

t3lib_TCEforms::insertDefStyle ( $ type )

Return default "style" / "class" attribute line.

Parameters:

string Field type (eg. "check", "radio", "select")

Returns:
string CSS attributes

Definition at line 3230 of file class.t3lib_tceforms.php.

t3lib_TCEforms::intoTemplate ( $ inArr,

$ altTemplate = ''

)

This inserts the content of $inArr into the field-template

Parameters:

array Array with key/value pairs to insert in the template.

string Alternative template to use instead of the default.

Returns:
string

Definition at line 3731 of file class.t3lib_tceforms.php.

t3lib_TCEforms::isDisplayCondition ( $ displayCond,

$ row

)

Returns true, if the evaluation of the required-field code is OK.

Parameters:

string The required-field code

array The record to evaluate

Returns:
boolean

Definition at line 4710 of file class.t3lib_tceforms.php.
References t3lib_div::inList(), and t3lib_extMgm::isLoaded().

t3lib_TCEforms::isPalettesCollapsed ( $ table,

$ palette

)

Returns true, if the palette, $palette, is collapsed (not shown, but found in top-frame) for the table.

Parameters:

string The table name

integer The palette pointer/number

Returns:
boolean

Definition at line 4695 of file class.t3lib_tceforms.php.

t3lib_TCEforms::JSbottom ( $ formname = 'forms[0]' )

JavaScript code used for input-field evaluation.
Example use:
$msg.='Distribution time (hh:mm dd-mm-yy):
<input type="text" name="send_mail_datetime_hr" onchange="typo3FormFieldGet(\'send_mail_datetime\', \'datetime\', \'\', 0,0);"'.$GLOBALS['TBE_TEMPLATE']->formWidth(20).' /><input type="hidden" value="'.time().'" name="send_mail_datetime" />
'; $this->extJSCODE.='typo3FormFieldSet("send_mail_datetime", "datetime", "", 0,0);';
... and then include the result of this function after the form

Parameters:

string The identification of the form on the page.

Returns:
string A <script></script> section with JavaScript.

Definition at line 4101 of file class.t3lib_tceforms.php.

t3lib_TCEforms::JStop ( )

JavaScript code added BEFORE the form is drawn:

Returns:
string A <script></script> section with JavaScript.

Definition at line 4050 of file class.t3lib_tceforms.php.

t3lib_TCEforms::mergeFieldsWithAddedFields ( $ fields,

$ fieldsToAdd

)

Merges the current [types][showitem] array with the array of fields to add for the current subtype field of the "type" value.

Parameters:

array A [types][showitem] list of fields, exploded by ","

array The output from getFieldsToAdd()

Returns:
array Return the modified $fields array.

See also:
getMainFields(),getFieldsToAdd()

Definition at line 2355 of file class.t3lib_tceforms.php.

t3lib_TCEforms::noTitle ( $ str,

$ wrapParts = array()

)

Returns the "No title" string if the input $str is empty.

Parameters:

string The string which - if empty - will become the no-title string.

array Array with wrappin parts for the no-title output (in keys [0]/[1])

Returns:
string

Definition at line 3090 of file class.t3lib_tceforms.php.

t3lib_TCEforms::optionTagStyle ( $ iconString )

Creates style attribute content for option tags in a selector box, primarily setting it up to show the icon of an element as background image (works in mozilla)

Parameters:

string Icon string for option item

Returns:
string Style attribute content, if any

Definition at line 3003 of file class.t3lib_tceforms.php.
References t3lib_div::intInRange().

t3lib_TCEforms::printNeededJSFunctions ( )

Prints necessary JavaScript for TCEforms (after the form HTML).

Returns:
void

Definition at line 4522 of file class.t3lib_tceforms.php.

t3lib_TCEforms::printNeededJSFunctions_top ( )

Returns necessary JavaScript for the top

Returns:
void

Definition at line 4549 of file class.t3lib_tceforms.php.

t3lib_TCEforms::printPalette ( $ palArr )

Creates HTML output for a palette

Parameters:

array The palette array to print

Returns:
string HTML output

Reimplemented in t3lib_TCEforms_FE, formRender, formRender_vert, and t3lib_TCEforms_FE.
Definition at line 3881 of file class.t3lib_tceforms.php.

t3lib_TCEforms::procItems ( $ items,

$ iArray,

$ config,

$ table,

$ row,

$ field

)

Perform user processing of the items arrays of checkboxes, selectorboxes and radio buttons.

Parameters:

array The array of items (label,value,icon)

array The "itemsProcFunc." from fieldTSconfig of the field.

array The config array for the field.

string Table name

array Record row

string Field name

Returns:
array The modified $items array

Definition at line 3328 of file class.t3lib_tceforms.php.
References t3lib_div::callUserFunction().

t3lib_TCEforms::readPerms ( )

Returns the select-page read-access SQL clause. Returns cached string, so you can call this function as much as you like without performance loss.

Returns:
string

Definition at line 4650 of file class.t3lib_tceforms.php.

t3lib_TCEforms::rearrange ( $ fields )

Used to adhoc-rearrange the field order normally set in the [types][showitem] list

Parameters:

array A [types][showitem] list of fields, exploded by ","

Returns:
array Returns rearranged version (keys are changed around as well.)

See also:
getMainFields()

Definition at line 2256 of file class.t3lib_tceforms.php.
References t3lib_div::trimExplode().

t3lib_TCEforms::registerDefaultLanguageData ( $ table,

$ rec

)

Will register data from original language records if the current record is a translation of another. The original data is shown with the edited record in the form. The information also includes possibly diff-views of what changed in the original record. Function called from outside (see alt_doc.php + quick edit) before rendering a form for a record

Parameters:

string Table name of the record being edited

array Record array of the record being edited

Returns:
void

Definition at line 2458 of file class.t3lib_tceforms.php.
References t3lib_BEfunc::getRecord().

t3lib_TCEforms::renderDefaultLanguageContent ( $ table,

$ field,

$ row,

$ item

)

Renders the display of default language record content around current field. Will render content if any is found in the internal array, $this->defaultLanguageData, depending on registerDefaultLanguageData() being called prior to this.

Parameters:

string Table name of the record being edited

string Field name represented by $item

array Record array of the record being edited

string HTML of the form field. This is what we add the content to.

Returns:
string Item string returned again, possibly with the original value added to.

See also:
getSingleField(), registerDefaultLanguageData()

Definition at line 2490 of file class.t3lib_tceforms.php.
References t3lib_BEfunc::getProcessedValue().

t3lib_TCEforms::renderDefaultLanguageDiff ( $ table,

$ field,

$ row,

$ item

)

Renders the diff-view of default language record content compared with what the record was originally translated from. Will render content if any is found in the internal array, $this->defaultLanguageData, depending on registerDefaultLanguageData() being called prior to this.

Parameters:

string Table name of the record being edited

string Field name represented by $item

array Record array of the record being edited

string HTML of the form field. This is what we add the content to.

Returns:
string Item string returned again, possibly with the original value added to.

See also:
getSingleField(), registerDefaultLanguageData()

Definition at line 2513 of file class.t3lib_tceforms.php.
References t3lib_BEfunc::getProcessedValue(), and t3lib_div::makeInstance().

t3lib_TCEforms::renderWizards ( $ itemKinds,

$ wizConf,

$ table,

$ row,

$ field,

&$ PA,

$ itemName,

$ specConf,

$ RTE = 0

)

Rendering wizards for form fields.

Parameters:

array Array with the real item in the first value, and an alternative item in the second value.

array The "wizard" key from the config array for the field (from TCA)

string Table name

array The record array

string The field name

array Additional configuration array. (passed by reference!)

string The field name

array Special configuration if available.

boolean Whether the RTE could have been loaded.

Returns:
string The new item value.

Definition at line 2772 of file class.t3lib_tceforms.php.
References t3lib_div::callUserFunction(), t3lib_div::getFileAbsFileName(), t3lib_div::implodeArrayForUrl(), t3lib_div::intExplode(), t3lib_div::intInRange(), and t3lib_div::testInt().

t3lib_TCEforms::replaceTableWrap ( $ arr,

$ rec,

$ table

)

This replaces markers in the total wrap

Parameters:

array An array of template parts containing some markers.

array The record

string The table name

Returns:
string

Definition at line 3792 of file class.t3lib_tceforms.php.
References t3lib_div::fixed_lgd_cs(), t3lib_iconWorks::getIconImage(), t3lib_BEfunc::getRecord(), t3lib_BEfunc::getRecordTitle(), t3lib_BEfunc::getTSconfig_pidValue(), and t3lib_BEfunc::titleAltAttrib().

t3lib_TCEforms::resetSchemes ( )

Reset color schemes.

Returns:
void

Definition at line 3997 of file class.t3lib_tceforms.php.

t3lib_TCEforms::resetSchemes ( )

Reset color schemes.

Returns:
void

Definition at line 3997 of file class.t3lib_tceforms.php.
Referenced by getMainFields(), and t3lib_TCEforms().

t3lib_TCEforms::restoreSchemes ( )

Restore the saved color scheme

Returns:
void

Definition at line 4020 of file class.t3lib_tceforms.php.

t3lib_TCEforms::rplColorScheme ( $ inTemplate )

Replaces colorscheme markers in the template string

Parameters:

string Template string with markers to be substituted.

Returns:
string

Definition at line 3851 of file class.t3lib_tceforms.php.

t3lib_TCEforms::setColorScheme ( $ scheme )

Setting the current color scheme ($this->colorScheme) based on $this->defColorScheme plus input string.

Parameters:

string A color scheme string.

Returns:
void

Definition at line 3973 of file class.t3lib_tceforms.php.
References t3lib_div::trimExplode().

t3lib_TCEforms::setNewBEDesign ( )

Sets the design to the backend design. Backend

Returns:
void

Definition at line 3676 of file class.t3lib_tceforms.php.

t3lib_TCEforms::setNewBEDesign ( )

Sets the design to the backend design. Backend

Returns:
void

Definition at line 3676 of file class.t3lib_tceforms.php.
Referenced by initDefaultBEmode().

t3lib_TCEforms::setTSconfig ( $ table,

$ row,

$ field = ''

)

Returns TSconfig for table/row Multiple requests to this function will return cached content so there is no performance loss in calling this many times since the information is looked up only once.

Parameters:

string The table name

array The table row (Should at least contain the "uid" value, even if "NEW..." string. The "pid" field is important as well, and negative values will be intepreted as pointing to a record from the same table.)

string Optionally you can specify the field name as well. In that case the TSconfig for the field is returned.

Returns:
mixed The TSconfig values (probably in an array)

See also:
t3lib_BEfunc::getTCEFORM_TSconfig()

Definition at line 2387 of file class.t3lib_tceforms.php.
References t3lib_BEfunc::getTCEFORM_TSconfig().

t3lib_TCEforms::sL ( $ str )

Fetches language label for key

Parameters:

string Language label reference, eg. 'LLL:EXT:lang/locallang_core.php:labels.blablabla'

Returns:
string The value of the label, fetched for the current backend language.

Definition at line 4664 of file class.t3lib_tceforms.php.

t3lib_TCEforms::storeSchemes ( )

Store current color scheme

Returns:
void

Definition at line 4008 of file class.t3lib_tceforms.php.

t3lib_TCEforms::thisReturnUrl ( )

Returns the "returnUrl" of the form. Can be set externally or will be taken from "t3lib_div::linkThisScript()"

Returns:
string Return URL of current script

Definition at line 3108 of file class.t3lib_tceforms.php.
References t3lib_div::linkThisScript().

t3lib_TCEforms::wrapBorder ( &$ out_array,

&$ out_pointer

)

Wraps an element in the $out_array with the template row for a "section" ($this->sectionWrap)

Parameters:

array The array with form elements stored in (passed by reference and changed!)

integer The pointer to the entry in the $out_array (passed by reference and incremented!)

Returns:
void

Definition at line 3829 of file class.t3lib_tceforms.php.

t3lib_TCEforms::wrapLabels ( $ str )

Wrapping labels Currently not implemented - just returns input value.

Parameters:

string Input string.

Returns:
string Output string.

Reimplemented in t3lib_TCEforms_FE, and t3lib_TCEforms_FE.
Definition at line 3766 of file class.t3lib_tceforms.php.

t3lib_TCEforms::wrapOpenPalette ( $ header,

$ table,

$ row,

$ palette,

$ retFunc = 0

)

Wraps a string with a link to the palette.

Parameters:

string The string to wrap in an A-tag

string The table name for which to open the palette.

array The record array

integer The palette pointer.

boolean Determines the output type of the function.

Returns:
mixed If $retFunc is set, then returns an array with icon code and palette JavaScript function. Otherwise just the icon code.

Definition at line 3041 of file class.t3lib_tceforms.php.

t3lib_TCEforms::wrapTotal ( $ c,

$ rec,

$ table

)

Wraps all the table rows into a single table. Used externally from scripts like alt_doc.php and db_layout.php (which uses TCEforms...)

Parameters:

string Code to output between table-parts; table rows

array The record

string The table name

Returns:
string

Definition at line 3779 of file class.t3lib_tceforms.php.

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

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

Généré par Les spécialistes TYPO3 avec doxygen

1.4.6

Documentation TYPO3 par Ameos

t3lib_TCEforms Class Reference

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation