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)
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 3327 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 3373 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 3595 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 3776 of file class.t3lib_tceforms.php.
Referenced by getSingleField().

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 3120 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 3086 of file class.t3lib_tceforms.php.
Referenced by getSingleField_typeCheck().

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 4435 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 2577 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 4920 of file class.t3lib_tceforms.php.
Referenced by getListedFields(), and getMainFields().

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 3100 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:
array Input string exploded with comma and for each value only the label part is set in the array. Keys are numeric

Definition at line 3040 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 3617 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 3218 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 3207 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 3229 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 3164 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 3191 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 4932 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 2772 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 2723 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 4712 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 3892 of file class.t3lib_tceforms.php.
Referenced by getListedFields(), and getMainFields().

t3lib_TCEforms::getDynTabMenu ( $ parts,

$ idString

)

Create dynamic 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 3270 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 2290 of file class.t3lib_tceforms.php.
References t3lib_div::intInRange(), t3lib_div::testInt(), and t3lib_div::trimExplode().
Referenced by getMainFields(), getPaletteFields(), and getSoloField().

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 2338 of file class.t3lib_tceforms.php.
References t3lib_div::trimExplode().
Referenced by getMainFields().

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 2997 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 4792 of file class.t3lib_tceforms.php.
Referenced by getMainFields(), getSingleField(), and getSingleField_typeText().

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().
Referenced by getListedFields(), and getMainFields().

t3lib_TCEforms::getRecordPath (

Documentation TYPO3 par Ameos

t3lib_TCEforms Class Reference

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation