t3lib_TCEforms Class Reference

Inheritance diagram for t3lib_TCEforms:

Inheritance graph
[legend]

List of all members.

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)
 formatValue ($config, $itemValue)
 getRTypeNum ($table, $row)
 rearrange ($fields)
 getExcludeElements ($table, $row, $typeNum)
 getFieldsToAdd ($table, $row, $typeNum)
 mergeFieldsWithAddedFields ($fields, $fieldsToAdd)
 setTSconfig ($table, $row, $field='')
 overrideFieldConf ($fieldConfig, $TSconfig)
 getSpecConfForField ($table, $row, $field)
 getSpecConfFromString ($extraString, $defaultExtras)
 registerDefaultLanguageData ($table, $rec)
 getLanguageOverlayRawValue ($table, $row, $field, $fieldConf)
 renderDefaultLanguageContent ($table, $field, $row, $item)
 renderDefaultLanguageDiff ($table, $field, $row, $item)
 dbFileIcons ($fName, $mode, $allowed, $itemArray, $selector='', $params=array(), $onFocus='', $table='', $field='', $uid='')
 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]', $update=false)
 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, $ffValueKey='')
 getTSCpid ($table, $uid, $pid)
 doLoadTableDescr ($table)
 getAvailableLanguages ($onlyIsoCoded=1, $setDefault=1)
 getLanguageIcon ($table, $row, $sys_language_uid)
 previewFieldValue ($value, $config)
 getAdditionalPreviewLanguages ()
 pushToDynNestedStack ($type, $ident)
 popFromDynNestedStack ($type=null, $ident=null)
 getDynNestedStack ($json=false, $skipFirst=false)

Public Attributes

 $palFieldArr = array()
 $disableWizards = 0
 $isPalettedoc = 0
 $paletteMargin = 1
 $defStyle = ''
 $cachedTSconfig = array()
 $cachedTSconfig_fieldLevel = array()
 $cachedLanguageFlag = array()
 $cachedAdditionalPreviewLanguages = NULL
 $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()
 $additionalPreviewLanguageData = array()
 $backPath = ''
 $returnUrl = ''
 $doSaveFieldName = ''
 $palettesCollapsed = 0
 $disableRTE = 0
 $globalShowHelp = 1
 $localizationMode = ''
 $fieldOrder = ''
 $doPrintPalette = 1
 $clipObj = FALSE
 $enableClickMenu = FALSE
 $enableTabMenu = FALSE
 $renderReadonly = FALSE
 $form_rowsToStylewidth = 9.58
 $form_largeComp = 1.33
 $charsPerRow = 40
 $maxTextareaWidth = 48
 $maxInputWidth = 48
 $defaultMultipleSelectorStyle = 'width:250px;'
 $prependFormFieldNames = 'data'
 $prependCmdFieldNames = 'cmd'
 $prependFormFieldNames_file = 'data_files'
 $formName = 'editform'
 $allowOverrideMatrix = array()
 $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()
 $dynNestedStack = array()
 $additionalCode_pre = array()
 $additionalJS_pre = array()
 $additionalJS_post = array()
 $additionalJS_submit = array()
 $inline
 $hookObjectsMainFields = array()
 $hookObjectsSingleField = array()
 $extraFormHeaders = array()

Detailed Description

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

Member Function Documentation

t3lib_TCEforms.t3lib_TCEforms (  ) 

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

Returns:
void

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

References $CLIENT, $GLOBALS, $TYPO3_CONF_VARS, t3lib_div.clientInfo(), t3lib_div.getUserObj(), t3lib_div.makeInstance(), t3lib_div.modifyHTMLColorAll(), and resetSchemes().

Here is the call graph for this function:

t3lib_TCEforms.initDefaultBEmode (  ) 

Initialize various internal variables.

Returns:
void

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

References setNewBEDesign().

Here is the call graph for this function:

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 418 of file class.t3lib_tceforms.php.

References $excludeElements, $row, $TCA, getExcludeElements(), getRTypeNum(), getSingleField(), t3lib_div.loadTCA(), and t3lib_div.trimExplode().

Here is the call graph for this function:

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 457 of file class.t3lib_tceforms.php.

References $excludeElements, $GLOBALS, $row, $TCA, $TYPO3_CONF_VARS, doLoadTableDescr(), getDivider(), getExcludeElements(), getFieldsToAdd(), getLL(), getPaletteFields(), getRTypeNum(), getSingleField(), t3lib_div.loadTCA(), mergeFieldsWithAddedFields(), popFromDynNestedStack(), pushToDynNestedStack(), rearrange(), resetSchemes(), setColorScheme(), sL(), t3lib_div.trimExplode(), and wrapBorder().

Here is the call graph for this function:

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 664 of file class.t3lib_tceforms.php.

References $GLOBALS, $row, $TCA, doLoadTableDescr(), getDivider(), getPaletteFields(), getSingleField(), t3lib_BEfunc.getTCAtypes(), t3lib_div.loadTCA(), and t3lib_div.trimExplode().

Here is the call graph for this function:

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 706 of file class.t3lib_tceforms.php.

References $row, $TCA, getExcludeElements(), getLL(), getRTypeNum(), getSingleField(), intoTemplate(), isPalettesCollapsed(), t3lib_div.loadTCA(), printPalette(), t3lib_iconWorks.skinImg(), t3lib_div.trimExplode(), and wrapOpenPalette().

Referenced by getListedFields(), and getMainFields().

Here is the call graph for this function:

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 783 of file class.t3lib_tceforms.php.

References $GLOBALS, $row, $TCA, addUserTemplateMarkers(), t3lib_div.deHSCentities(), getLL(), getSingleField_SW(), helpText(), helpTextIcon(), t3lib_div.inList(), intoTemplate(), isDisplayCondition(), isPalettesCollapsed(), t3lib_div.loadTCA(), overrideFieldConf(), renderDefaultLanguageContent(), renderDefaultLanguageDiff(), setTSconfig(), t3lib_iconWorks.skinImg(), sL(), t3lib_div.testInt(), thisReturnUrl(), and wrapOpenPalette().

Referenced by getListedFields(), getMainFields(), getPaletteFields(), and getSoloField().

Here is the call graph for this function:

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 962 of file class.t3lib_tceforms.php.

References $row, getSingleField_typeCheck(), getSingleField_typeFlex(), getSingleField_typeGroup(), getSingleField_typeInput(), getSingleField_typeNone(), getSingleField_typeRadio(), getSingleField_typeSelect(), getSingleField_typeText(), getSingleField_typeUnknown(), and getSingleField_typeUser().

Referenced by getSingleField().

Here is the call graph for this function:

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 1038 of file class.t3lib_tceforms.php.

References $row, getSingleField_typeNone_render(), getSpecConfFromString(), t3lib_div.intInRange(), and t3lib_div.trimExplode().

Referenced by getSingleField_SW().

Here is the call graph for this function:

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 1119 of file class.t3lib_tceforms.php.

Referenced by getSingleField_SW().

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 1240 of file class.t3lib_tceforms.php.

References $row, checkBoxParams(), initItemArray(), insertDefStyle(), procItems(), and wrapLabels().

Referenced by getSingleField_SW().

Here is the call graph for this function:

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 1308 of file class.t3lib_tceforms.php.

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

Referenced by getSingleField_SW().

Here is the call graph for this function:

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 1344 of file class.t3lib_tceforms.php.

References $GLOBALS, $row, $TCA, addItems(), addSelectOptionsToItemArray(), getSingleField_typeSelect_checkbox(), getSingleField_typeSelect_multiple(), getSingleField_typeSelect_single(), getSingleField_typeSelect_singlebox(), getSpecConfFromString(), initItemArray(), t3lib_div.inList(), procItems(), renderWizards(), setTSconfig(), sL(), and t3lib_div.trimExplode().

Referenced by getSingleField_SW().

Here is the call graph for this function:

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 1424 of file class.t3lib_tceforms.php.

References $row, t3lib_div.deHSCentities(), elName(), getIcon(), insertDefStyle(), and optionTagStyle().

Referenced by getSingleField_typeSelect().

Here is the call graph for this function:

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 1555 of file class.t3lib_tceforms.php.

References t3lib_div.deHSCentities(), elName(), extractValuesOnlyFromValueLabelList(), getIcon(), getLL(), and insertDefStyle().

Referenced by getSingleField_typeSelect().

Here is the call graph for this function:

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 1674 of file class.t3lib_tceforms.php.

References t3lib_div.deHSCentities(), elName(), extractValuesOnlyFromValueLabelList(), getLL(), insertDefStyle(), t3lib_div.intInRange(), and optionTagStyle().

Referenced by getSingleField_typeSelect().

Here is the call graph for this function:

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 1784 of file class.t3lib_tceforms.php.

References $GLOBALS, $row, t3lib_div.intInRange(), optionTagStyle(), sL(), and t3lib_div.trimExplode().

Referenced by getSingleField_typeSelect().

Here is the call graph for this function:

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 1888 of file class.t3lib_tceforms.php.

Referenced by getSingleField_SW().

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 2058 of file class.t3lib_tceforms.php.

Referenced by getSingleField_SW().

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 2074 of file class.t3lib_tceforms.php.

Referenced by getSingleField_typeInput().

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 2136 of file class.t3lib_tceforms.php.

Referenced by getSingleField_SW().

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 2271 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 2290 of file class.t3lib_tceforms.php.

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 2325 of file class.t3lib_tceforms.php.

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 2525 of file class.t3lib_tceforms.php.

Referenced by getSingleField_SW().

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 2540 of file class.t3lib_tceforms.php.

References $row, and t3lib_div.callUserFunction().

Referenced by getSingleField_SW().

Here is the call graph for this function:

t3lib_TCEforms.formatValue ( $  config,
$  itemValue 
)

Format field content of various types if $config['format'] is set to date, filesize, ..., user This is primarily for the field type none but can be used for user field types for example

Parameters:
array Configuration for the display
string The value to display
Returns:
string Formatted Field content

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

References $GLOBALS, $value, t3lib_div.callUserFunction(), t3lib_div.formatSize(), t3lib_div.intInRange(), and sL().

Here is the call graph for this function:

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 2665 of file class.t3lib_tceforms.php.

References $row, and $TCA.

Referenced by getMainFields(), getPaletteFields(), and getSoloField().

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 2691 of file class.t3lib_tceforms.php.

References $content, and t3lib_div.trimExplode().

Referenced by getMainFields().

Here is the call graph for this function:

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 2717 of file class.t3lib_tceforms.php.

References $excludeElements, $row, $TCA, t3lib_div.intInRange(), t3lib_div.testInt(), and t3lib_div.trimExplode().

Referenced by getMainFields(), getPaletteFields(), and getSoloField().

Here is the call graph for this function:

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 2765 of file class.t3lib_tceforms.php.

References $row, $TCA, and t3lib_div.trimExplode().

Referenced by getMainFields().

Here is the call graph for this function:

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 2790 of file class.t3lib_tceforms.php.

Referenced by getMainFields().

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 2822 of file class.t3lib_tceforms.php.

References $row, and t3lib_BEfunc.getTCEFORM_TSconfig().

Referenced by getSingleField(), and getSingleField_typeSelect().

Here is the call graph for this function:

t3lib_TCEforms.overrideFieldConf ( $  fieldConfig,
$  TSconfig 
)

Overrides the TCA field configuration by TSconfig settings.

Example TSconfig: TCEform.
<field>.config.appearance.useSortable = 1 This overrides the setting in $TCA[
['columns'][<field>]['config']['appearance']['useSortable'].

Parameters:
array $fieldConfig: TCA field configuration
array $TSconfig: TSconfig
Returns:
array Changed TCA field configuration

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

References $key, and t3lib_div.removeDotsFromTS().

Referenced by getSingleField().

Here is the call graph for this function:

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 2875 of file class.t3lib_tceforms.php.

References $row, and t3lib_BEfunc.getTCAtypes().

Here is the call graph for this function:

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 2896 of file class.t3lib_tceforms.php.

References t3lib_BEfunc.getSpecConfParts().

Referenced by getSingleField_typeInput(), and getSingleField_typeSelect().

Here is the call graph for this function:

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 2924 of file class.t3lib_tceforms.php.

References $TCA, getAdditionalPreviewLanguages(), t3lib_BEfunc.getRecordWSOL(), and t3lib_div.makeInstance().

Here is the call graph for this function:

t3lib_TCEforms.getLanguageOverlayRawValue ( $  table,
$  row,
$  field,
$  fieldConf 
)

Creates language-overlay for a field value This means the requested field value will be overridden with the data from the default language. Can be used to render read only fields for example.

Parameters:
string Table name of the record being edited
string Field name represented by $item
array Record array of the record being edited in current language
array Content of $PA['fieldConf']
Returns:
string Unprocessed field value merged with default language data if needed

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

References $row, $TCA, and $value.

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 2994 of file class.t3lib_tceforms.php.

References $GLOBALS, $row, getAdditionalPreviewLanguages(), and t3lib_BEfunc.getProcessedValue().

Referenced by getSingleField().

Here is the call graph for this function:

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 3025 of file class.t3lib_tceforms.php.

References $row, getLL(), t3lib_BEfunc.getProcessedValue(), and t3lib_div.makeInstance().

Referenced by getSingleField().

Here is the call graph for this function:

t3lib_TCEforms.dbFileIcons ( $  fName,
$  mode,
$  allowed,
$  itemArray,
$  selector = '',
$  params = array(),
$  onFocus = '',
$  table = '',
$  field = '',
$  uid = '' 
)

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
string $table: (optional) Table name processing for
string $field: (optional) Field of table name processing for
string $uid: (optional) uid of table record processing for
Returns:
string The form fields for the selection.

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

References getLL(), t3lib_BEfunc.getRecordTitle(), t3lib_BEfunc.getRecordWSOL(), insertDefStyle(), t3lib_div.intInRange(), t3lib_BEfunc.titleAltAttrib(), and wrapLabels().

Here is the call graph for this function:

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 3247 of file class.t3lib_tceforms.php.

References $output, and t3lib_div.trimExplode().

Here is the call graph for this function:

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 properties.

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 3296 of file class.t3lib_tceforms.php.

References $GLOBALS, and $uid.

Referenced by previewFieldValue().

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 3317 of file class.t3lib_tceforms.php.

References $row, blur(), elName(), t3lib_div.getFileAbsFileName(), getIcon(), t3lib_div.implodeArrayForUrl(), sL(), t3lib_div.testInt(), thisReturnUrl(), and t3lib_BEfunc.titleAltAttrib().

Referenced by getSingleField_typeSelect().

Here is the call graph for this function:

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 3521 of file class.t3lib_tceforms.php.

Referenced by getSingleField_typeSelect_checkbox(), getSingleField_typeSelect_single(), and renderWizards().

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 3548 of file class.t3lib_tceforms.php.

Referenced by getSingleField_typeSelect_multiple(), getSingleField_typeSelect_single(), and getSingleField_typeSelect_singlebox().

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 3564 of file class.t3lib_tceforms.php.

Referenced by getSingleField_typeSelect_checkbox(), and getSingleField_typeSelect_singlebox().

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 3586 of file class.t3lib_tceforms.php.

Referenced by getPaletteFields(), and getSingleField().

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 3610 of file class.t3lib_tceforms.php.

Referenced by getSingleField_typeCheck().

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 3624 of file class.t3lib_tceforms.php.

Referenced by getSingleField_typeSelect_checkbox(), getSingleField_typeSelect_single(), getSingleField_typeSelect_singlebox(), and renderWizards().

t3lib_TCEforms.noTitle ( $  str,
$  wrapParts = array() 
)

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

DEPRECATED: Use t3lib_BEfunc.getRecordTitle with the $forceResult flag set.

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
Deprecated:

Definition at line 3638 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 3647 of file class.t3lib_tceforms.php.

Referenced by renderWizards().

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 3656 of file class.t3lib_tceforms.php.

Referenced by getSingleField(), and renderWizards().

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 3669 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 3691 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 3718 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 3734 of file class.t3lib_tceforms.php.

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 3745 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 3756 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 3780 of file class.t3lib_tceforms.php.

Referenced by dbFileIcons(), getSingleField_typeCheck(), getSingleField_typeSelect_checkbox(), getSingleField_typeSelect_single(), and getSingleField_typeSelect_singlebox().

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 3799 of file class.t3lib_tceforms.php.

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 3838 of file class.t3lib_tceforms.php.

Referenced by getSingleField_typeCheck(), getSingleField_typeRadio(), and getSingleField_typeSelect().

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 3856 of file class.t3lib_tceforms.php.

Referenced by getSingleField_typeSelect().

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 3878 of file class.t3lib_tceforms.php.

Referenced by getSingleField_typeCheck(), getSingleField_typeRadio(), and getSingleField_typeSelect().

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 3902 of file class.t3lib_tceforms.php.

Referenced by getSingleField_typeSelect().

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 4122 of file class.t3lib_tceforms.php.

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 4144 of file class.t3lib_tceforms.php.

t3lib_TCEforms.setNewBEDesign (  ) 

Sets the design to the backend design. Backend

Returns:
void

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

Referenced by initDefaultBEmode().

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 4280 of file class.t3lib_tceforms.php.

Referenced by getPaletteFields(), and getSingleField().

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 4304 of file class.t3lib_tceforms.php.

Referenced by getSingleField().

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.

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

Referenced by dbFileIcons(), and getSingleField_typeCheck().

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 4328 of file class.t3lib_tceforms.php.

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 4341 of file class.t3lib_tceforms.php.

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 4378 of file class.t3lib_tceforms.php.

Referenced by getMainFields().

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 4400 of file class.t3lib_tceforms.php.

t3lib_TCEforms.getDivider (  ) 

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

Returns:
string

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

Referenced by getListedFields(), and getMainFields().

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, and formRender_vert.

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

Referenced by getPaletteFields().

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 4481 of file class.t3lib_tceforms.php.

Referenced by getSingleField(), and helpText().

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 4501 of file class.t3lib_tceforms.php.

References $GLOBALS, doLoadTableDescr(), and helpTextIcon().

Referenced by getSingleField().

Here is the call graph for this function:

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 4522 of file class.t3lib_tceforms.php.

References $class, $key, and t3lib_div.trimExplode().

Referenced by getMainFields(), and resetSchemes().

Here is the call graph for this function:

t3lib_TCEforms.resetSchemes (  ) 

Reset color schemes.

Returns:
void

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

References $GLOBALS, and setColorScheme().

Referenced by getMainFields(), and t3lib_TCEforms().

Here is the call graph for this function:

t3lib_TCEforms.storeSchemes (  ) 

Store current color scheme

Returns:
void

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

t3lib_TCEforms.restoreSchemes (  ) 

Restore the saved color scheme

Returns:
void

Definition at line 4569 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 4599 of file class.t3lib_tceforms.php.

Referenced by printNeededJSFunctions_top().

t3lib_TCEforms.JSbottom ( $  formname = 'forms[0]',
$  update = false 
)

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="typo3form.fieldGet(\'send_mail_datetime\', \'datetime\', \'\', 0,0);"'.$GLOBALS['TBE_TEMPLATE']->formWidth(20).' /><input type="hidden" value="'.time().'" name="send_mail_datetime" />
'; $this->extJSCODE.='typo3form.fieldSet("send_mail_datetime", "datetime", "", 0,0);';

... and then include the result of this function after the form

Parameters:
string $formname: The identification of the form on the page.
boolean $update: Just extend/update existing settings, e.g. for AJAX call
Returns:
string A section with JavaScript - if $update is false, embedded in <script></script>

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

References $additionalJS_submit, $GLOBALS, getLL(), t3lib_BEfunc.getNoRecordTitle(), t3lib_iconWorks.skinImg(), and sL().

Referenced by printNeededJSFunctions().

Here is the call graph for this function:

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 4761 of file class.t3lib_tceforms.php.

t3lib_TCEforms.printNeededJSFunctions (  ) 

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

Returns:
void

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

References JSbottom().

Here is the call graph for this function:

t3lib_TCEforms.printNeededJSFunctions_top (  ) 

Returns necessary JavaScript for the top

Returns:
void

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

References JStop().

Here is the call graph for this function:

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 5055 of file class.t3lib_tceforms.php.

References $GLOBALS, $pid, $res, $row, $TCA, t3lib_BEfunc.deleteClause(), and t3lib_div.loadTCA().

Here is the call graph for this function:

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 5094 of file class.t3lib_tceforms.php.

References t3lib_BEfunc.fixVersioningPid(), t3lib_BEfunc.getRecordPath(), getTSCpid(), and readPerms().

Here is the call graph for this function:

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 5108 of file class.t3lib_tceforms.php.

References $GLOBALS.

Referenced by getRecordPath().

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 5122 of file class.t3lib_tceforms.php.

References $GLOBALS.

Referenced by formatValue(), getMainFields(), getSingleField(), getSingleField_typeSelect(), getSingleField_typeSelect_multiple(), JSbottom(), and renderWizards().

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 5135 of file class.t3lib_tceforms.php.

References $content, and $GLOBALS.

Referenced by dbFileIcons(), getMainFields(), getPaletteFields(), getSingleField(), getSingleField_typeSelect_checkbox(), getSingleField_typeSelect_singlebox(), JSbottom(), and renderDefaultLanguageDiff().

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 5156 of file class.t3lib_tceforms.php.

References $TCA.

Referenced by getPaletteFields(), and getSingleField().

t3lib_TCEforms.isDisplayCondition ( $  displayCond,
$  row,
$  ffValueKey = '' 
)

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

Parameters:
string The required-field code
array The record to evaluate
string FlexForm value key, eg. vDEF
Returns:
boolean

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

References $GLOBALS, $output, $row, t3lib_div.inList(), and t3lib_extMgm.isLoaded().

Referenced by getSingleField().

Here is the call graph for this function:

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 5276 of file class.t3lib_tceforms.php.

References $key, $pid, $uid, and t3lib_BEfunc.getTSCpid().

Referenced by getLanguageIcon(), and getRecordPath().

Here is the call graph for this function:

t3lib_TCEforms.doLoadTableDescr ( $  table  ) 

Returns true if descriptions should be loaded always

Parameters:
string Table for which to check
Returns:
boolean

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

References $TCA.

Referenced by getListedFields(), getMainFields(), and helpText().

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 5302 of file class.t3lib_tceforms.php.

References $GLOBALS, $output, $res, $row, t3lib_BEfunc.deleteClause(), t3lib_BEfunc.getRecord(), and t3lib_extMgm.isLoaded().

Here is the call graph for this function:

t3lib_TCEforms.getLanguageIcon ( $  table,
$  row,
$  sys_language_uid 
)

Initializes language icons etc.

param string Table name param array Record param string Sys language uid OR ISO language code prefixed with "v", eg. "vDA"

Returns:
void

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

References $LANG, $row, $TCA, t3lib_BEfunc.fixVersioningPid(), getTSCpid(), t3lib_div.makeInstance(), and t3lib_div.testInt().

Here is the call graph for this function:

t3lib_TCEforms.previewFieldValue ( $  value,
$  config 
)

Rendering preview output of a field value which is not shown as a form field but just outputted.

Parameters:
string The value to output
array Configuration for field.
Returns:
string HTML formatted output

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

References $value, t3lib_div.formatSize(), getClickMenu(), t3lib_div.getFileAbsFileName(), t3lib_BEfunc.getFileIcon(), and t3lib_div.trimExplode().

Here is the call graph for this function:

t3lib_TCEforms.getAdditionalPreviewLanguages (  ) 

Generates and return information about which languages the current user should see in preview, configured by options.additionalPreviewLanguages

return array Array of additional languages to preview

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

References $GLOBALS, $uid, t3lib_BEfunc.getRecord(), t3lib_div.intExplode(), and t3lib_extMgm.isLoaded().

Referenced by registerDefaultLanguageData(), and renderDefaultLanguageContent().

Here is the call graph for this function:

t3lib_TCEforms.pushToDynNestedStack ( $  type,
$  ident 
)

Push a new element to the dynNestedStack. Thus, every object know, if it's nested in a tab or IRRE level and in which order this was processed.

Parameters:
string $type: Type of the level, e.g. "tab" or "inline"
string $ident: Identifier of the level
Returns:
void

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

Referenced by getMainFields().

t3lib_TCEforms.popFromDynNestedStack ( $  type = null,
$  ident = null 
)

Remove an element from the dynNestedStack. If $type and $ident are set, the last element will only be removed, if it matches what is expected to be removed.

Parameters:
string $type: Type of the level, e.g. "tab" or "inline"
string $ident: Identifier of the level
Returns:
void

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

Referenced by getMainFields().

t3lib_TCEforms.getDynNestedStack ( $  json = false,
$  skipFirst = false 
)

Get the dynNestedStack as associative array. The result is e.g. ['tab','DTM-ABCD-1'], ['inline','data[13][table][uid][field]'], ['tab','DTM-DEFG-2'], ...

Parameters:
boolean $json: Return a JSON string instead of an array - default: false
boolean $skipFirst: Skip the first element in the dynNestedStack - default: false
Returns:
mixed Returns an associative array by default. If $json is true, it will be returned as JSON string.

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

Member Data Documentation

t3lib_TCEforms.$palFieldArr = array()

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

t3lib_TCEforms.$disableWizards = 0

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

t3lib_TCEforms.$isPalettedoc = 0

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

t3lib_TCEforms.$paletteMargin = 1

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

t3lib_TCEforms.$defStyle = ''

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

t3lib_TCEforms.$cachedTSconfig = array()

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

t3lib_TCEforms.$cachedTSconfig_fieldLevel = array()

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

t3lib_TCEforms.$cachedLanguageFlag = array()

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

t3lib_TCEforms.$cachedAdditionalPreviewLanguages = NULL

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

t3lib_TCEforms.$transformedRow = array()

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

t3lib_TCEforms.$extJSCODE = ''

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

t3lib_TCEforms.$printNeededJS = array()

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

t3lib_TCEforms.$hiddenFieldAccum = array()

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

t3lib_TCEforms.$TBE_EDITOR_fieldChanged_func = ''

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

t3lib_TCEforms.$loadMD5_JS = 1

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

t3lib_TCEforms.$prevBorderStyle = '[nothing here...]'

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

t3lib_TCEforms.$allowUpload = 0

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

t3lib_TCEforms.$titleLen = 15

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

t3lib_TCEforms.$defaultLanguageData = array()

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

t3lib_TCEforms.$defaultLanguageData_diff = array()

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

t3lib_TCEforms.$additionalPreviewLanguageData = array()

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

t3lib_TCEforms.$backPath = ''

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

t3lib_TCEforms.$returnUrl = ''

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

t3lib_TCEforms.$doSaveFieldName = ''

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

t3lib_TCEforms.$palettesCollapsed = 0

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

t3lib_TCEforms.$disableRTE = 0

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

t3lib_TCEforms.$globalShowHelp = 1

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

t3lib_TCEforms.$localizationMode = ''

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

t3lib_TCEforms.$fieldOrder = ''

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

t3lib_TCEforms.$doPrintPalette = 1

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

t3lib_TCEforms.$clipObj = FALSE

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

t3lib_TCEforms.$enableClickMenu = FALSE

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

t3lib_TCEforms.$enableTabMenu = FALSE

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

t3lib_TCEforms.$renderReadonly = FALSE

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

t3lib_TCEforms.$form_rowsToStylewidth = 9.58

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

t3lib_TCEforms.$form_largeComp = 1.33

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

t3lib_TCEforms.$charsPerRow = 40

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

t3lib_TCEforms.$maxTextareaWidth = 48

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

t3lib_TCEforms.$maxInputWidth = 48

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

t3lib_TCEforms.$defaultMultipleSelectorStyle = 'width:250px;'

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

t3lib_TCEforms.$prependFormFieldNames = 'data'

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

t3lib_TCEforms.$prependCmdFieldNames = 'cmd'

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

t3lib_TCEforms.$prependFormFieldNames_file = 'data_files'

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

t3lib_TCEforms.$formName = 'editform'

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

t3lib_TCEforms.$allowOverrideMatrix = array()

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

t3lib_TCEforms.$perms_clause = ''

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

t3lib_TCEforms.$perms_clause_set = 0

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

t3lib_TCEforms.$edit_showFieldHelp = ''

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

t3lib_TCEforms.$docLarge = 0

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

t3lib_TCEforms.$clientInfo = array()

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

t3lib_TCEforms.$RTEenabled = 0

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

t3lib_TCEforms.$RTEenabled_notReasons = ''

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

t3lib_TCEforms.$RTEcounter = 0

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

t3lib_TCEforms.$colorScheme

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

t3lib_TCEforms.$classScheme

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

t3lib_TCEforms.$defColorScheme

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

t3lib_TCEforms.$defClassScheme

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

t3lib_TCEforms.$fieldStyle

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

t3lib_TCEforms.$borderStyle

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

t3lib_TCEforms.$commentMessages = array()

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

t3lib_TCEforms.$totalWrap = '<hr />|<hr />'

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

t3lib_TCEforms.$fieldTemplate = '<b>###FIELD_NAME###</b><br />###FIELD_ITEM###<hr />'

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

t3lib_TCEforms.$sectionWrap = ''

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

t3lib_TCEforms.$palFieldTemplateHeader = ''

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

t3lib_TCEforms.$palFieldTemplate = ''

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

t3lib_TCEforms.$excludeElements = ''

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

Referenced by getExcludeElements(), getMainFields(), and getSoloField().

t3lib_TCEforms.$palettesRendered = array()

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

t3lib_TCEforms.$hiddenFieldListArr = array()

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

t3lib_TCEforms.$requiredFields = array()

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

t3lib_TCEforms.$requiredElements = array()

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

t3lib_TCEforms.$renderDepth = 0

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

t3lib_TCEforms.$savedSchemes = array()

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

t3lib_TCEforms.$dynNestedStack = array()

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

t3lib_TCEforms.$additionalCode_pre = array()

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

t3lib_TCEforms.$additionalJS_pre = array()

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

t3lib_TCEforms.$additionalJS_post = array()

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

t3lib_TCEforms.$additionalJS_submit = array()

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

Referenced by JSbottom().

t3lib_TCEforms.$inline

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

t3lib_TCEforms.$hookObjectsMainFields = array()

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

t3lib_TCEforms.$hookObjectsSingleField = array()

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

t3lib_TCEforms.$extraFormHeaders = array()

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

The documentation for this class was generated from the following file:
This documentation is part of typo3-unleashed.net.
It's an automatically created code documentation of the TYPO3 Content Management System.
Created with doxygen