formRender Klassenreferenz

Klassendiagramm für formRender:
t3lib_TCEforms

Aufstellung aller Elemente

Öffentliche Methoden

 printPalette ($palArr)
 t3lib_TCEforms ()
 initDefaultBEmode ()
 getSoloField ($table, $row, $theFieldToReturn)
 getMainFields ($table, $row, $depth=0)
 getListedFields ($table, $row, $list)
 getPaletteFields ($table, $row, $palette, $header='', $itemList='', $collapsedHeader=NULL)
 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, $table, $field, $row, &$PA, $formPrefix='', $level=0, $idPrefix='ID', $toggleClosed=FALSE)
 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)
 loadPaletteElements ($table, $row, $palette, $itemList='')
 registerDefaultLanguageData ($table, $rec)
 getLanguageOverlayRawValue ($table, $row, $field, $fieldConf)
 renderDefaultLanguageContent ($table, $field, $row, $item)
 renderDefaultLanguageDiff ($table, $field, $row, $item)
 renderVDEFDiff ($vArray, $vDEFkey)
 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)
 wrapPaletteField ($code, $table, $row, $palette, $collapsed)
 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, $dividersToTabsBehaviour=1)
 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 ()
 helpTextIcon ($table, $field, $force=0)
 helpText ($table, $field)
 helpTextIcon_typeFlex ($field, $fieldTitle, $cshFile)
 helpText_typeFlex ($field, $fieldTitle, $cshFile)
 setColorScheme ($scheme)
 resetSchemes ()
 storeSchemes ()
 restoreSchemes ()
 JStop ()
 JSbottom ($formname='forms[0]', $update=false)
 dbFileCon ($formObj='document.forms[0]')
 printNeededJSFunctions ()
 printNeededJSFunctions_top ()
 loadJavascriptLib ($lib)
 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)

Öffentliche Attribute

 $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()
 $requiredAdditional = array()
 $requiredElements = array()
 $requiredNested = array()
 $renderDepth = 0
 $savedSchemes = array()
 $dynNestedStack = array()
 $additionalCode_pre = array()
 $additionalJS_pre = array()
 $additionalJS_post = array()
 $additionalJS_submit = array()
 $additionalJS_delete = array()
 $inline
 $hookObjectsMainFields = array()
 $hookObjectsSingleField = array()
 $extraFormHeaders = array()

Geschützte Methoden

 registerRequiredProperty ($type, $name, $value)
 registerNestedElement ($itemName, $setLevel=true)

Dokumentation der Elementfunktionen

t3lib_TCEforms::addItems ( items,
iArray 
) [inherited]

Merges items into an item-array

Parameter:
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.
Rückgabe:
array The updated $item array
t3lib_TCEforms::addSelectOptionsToItemArray ( items,
fieldValue,
TSconfig,
field 
) [inherited]

Add selector box items of more exotic kinds.

Parameter:
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
Rückgabe:
array The $items array modified.
t3lib_TCEforms::addSelectOptionsToItemArray_makeModuleData ( value  )  [inherited]

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

Parameter:
string The module key
Rückgabe:
string The rawurlencoded 2-part string to transfer to interface private
Siehe auch:
addSelectOptionsToItemArray()
t3lib_TCEforms::addUserTemplateMarkers ( marker,
table,
field,
row,
&$  PA 
) [inherited]

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

Parameter:
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.
Rückgabe:
array marker array for template output
Siehe auch:
function intoTemplate()
t3lib_TCEforms::blur (  )  [inherited]

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

Rückgabe:
string If the current browser supports styles, the string 'this.blur();' is returned.
t3lib_TCEforms::checkBoxParams ( itemName,
thisValue,
c,
iCount,
addFunc = '' 
) [inherited]

Creates checkbox parameters

Parameter:
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.
Rückgabe:
string The onclick attribute + possibly the checked-option set.
t3lib_TCEforms::dbFileCon ( formObj = 'document.forms[0]'  )  [inherited]

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

Parameter:
string Form object reference (including "document.")
Rückgabe:
string JavaScript functions/code (NOT contained in a <script>-element)
t3lib_TCEforms::dbFileIcons ( fName,
mode,
allowed,
itemArray,
selector = '',
params = array(),
onFocus = '',
table = '',
field = '',
uid = '' 
) [inherited]

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

Parameter:
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
Rückgabe:
string The form fields for the selection.
t3lib_TCEforms::doLoadTableDescr ( table  )  [inherited]

Returns true if descriptions should be loaded always

Parameter:
string Table for which to check
Rückgabe:
boolean
t3lib_TCEforms::elName ( itemName  )  [inherited]

Returns element reference for form element name

Parameter:
string Form element name
Rückgabe:
string Form element reference (JS)
t3lib_TCEforms::extractValuesOnlyFromValueLabelList ( itemFormElValue  )  [inherited]

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

Parameter:
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
Rückgabe:
array Input string exploded with comma and for each value only the label part is set in the array. Keys are numeric
t3lib_TCEforms::foreignTable ( items,
fieldValue,
TSconfig,
field,
pFFlag = 0 
) [inherited]

Adds records from a foreign table (for selector boxes)

Parameter:
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.
Rückgabe:
array The $items array modified.
Siehe auch:
addSelectOptionsToItemArray(), t3lib_BEfunc::exec_foreign_table_where_query()
t3lib_TCEforms::formatValue ( config,
itemValue 
) [inherited]

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

Parameter:
array Configuration for the display
string The value to display
Rückgabe:
string Formatted Field content
t3lib_TCEforms::formElClass ( type  )  [inherited]

Get class attribute value for the current field type.

Parameter:
string Field type (eg. "check", "radio", "select")
Rückgabe:
string CSS attributes
Siehe auch:
formElStyleClassValue()
t3lib_TCEforms::formElStyle ( type  )  [inherited]

Get style CSS values for the current field type.

Parameter:
string Field type (eg. "check", "radio", "select")
Rückgabe:
string CSS attributes
Siehe auch:
formElStyleClassValue()
t3lib_TCEforms::formElStyleClassValue ( type,
class = FALSE 
) [inherited]

Get style CSS values for the current field type.

Parameter:
string Field type (eg. "check", "radio", "select")
boolean If set, will return value only if prefixed with CLASS, otherwise must not be prefixed "CLASS"
Rückgabe:
string CSS attributes
t3lib_TCEforms::formWidth ( size = 48,
textarea = 0 
) [inherited]

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

Parameter:
integer The abstract size value (1-48)
boolean If this is for a text area.
Rückgabe:
string Either a "style" attribute string or "cols"/"size" attribute string.
t3lib_TCEforms::formWidthText ( size = 48,
wrap = '' 
) [inherited]

Returns parameters to set with for a textarea field

Parameter:
integer The abstract width (1-48)
string Empty or "off" (text wrapping in the field or not)
Rückgabe:
string The "cols" attribute string (or style from formWidth())
Siehe auch:
formWidth()
t3lib_TCEforms::getAdditionalPreviewLanguages (  )  [inherited]

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

t3lib_TCEforms::getAvailableLanguages ( onlyIsoCoded = 1,
setDefault = 1 
) [inherited]

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

Parameter:
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.
Rückgabe:
array
t3lib_TCEforms::getClickMenu ( str,
table,
uid = '' 
) [inherited]

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.

Parameter:
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.
Rückgabe:
string HTML
t3lib_TCEforms::getClipboardElements ( allowed,
mode 
) [inherited]

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

Parameter:
string Allowed elements, Eg "pages,tt_content", "gif,jpg,jpeg,png"
string Mode of relations: "db" or "file"
Rückgabe:
array Array of elements in values (keys are insignificant), if none found, empty array.
t3lib_TCEforms::getDefaultRecord ( table,
pid = 0 
) [inherited]

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

Parameter:
string Database Tablename
integer PID value (positive / negative)
Rückgabe:
array "default" row.
t3lib_TCEforms::getDivider (  )  [inherited]

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

Rückgabe:
string
t3lib_TCEforms::getDynNestedStack ( json = false,
skipFirst = false 
) [inherited]

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'], ...

Parameter:
boolean $json: Return a JSON string instead of an array - default: false
boolean $skipFirst: Skip the first element in the dynNestedStack - default: false
Rückgabe:
mixed Returns an associative array by default. If $json is true, it will be returned as JSON string.
t3lib_TCEforms::getDynTabMenu ( parts,
idString,
dividersToTabsBehaviour = 1 
) [inherited]

Create dynamic tab menu

Parameter:
array Parts for the tab menu, fed to template::getDynTabMenu()
string ID string for the tab menu
integer If set to '1' empty tabs will be removed, If set to '2' empty tabs will be disabled
Rückgabe:
string HTML for the menu
t3lib_TCEforms::getExcludeElements ( table,
row,
typeNum 
) [inherited]

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

Parameter:
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.
Rückgabe:
array Array with fieldnames as values. The fieldnames are those which should NOT be displayed "anyways"
Siehe auch:
getMainFields()
t3lib_TCEforms::getFieldsToAdd ( table,
row,
typeNum 
) [inherited]

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

Parameter:
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.
Rückgabe:
array An array containing two values: 1) Another array containing fieldnames to add and 2) the subtype value field.
Siehe auch:
getMainFields()
t3lib_TCEforms::getIcon ( icon  )  [inherited]

Get icon (for example for selector boxes)

Parameter:
string Icon reference
Rückgabe:
array Array with two values; the icon file reference (relative to PATH_typo3 minus backPath), the icon file information array (getimagesize())
t3lib_TCEforms::getLanguageIcon ( table,
row,
sys_language_uid 
) [inherited]

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"

Rückgabe:
void
t3lib_TCEforms::getLanguageOverlayRawValue ( table,
row,
field,
fieldConf 
) [inherited]

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.

Parameter:
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']
Rückgabe:
string Unprocessed field value merged with default language data if needed
t3lib_TCEforms::getListedFields ( table,
row,
list 
) [inherited]

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.

Parameter:
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.
Rückgabe:
string TCEform elements in a string.
t3lib_TCEforms::getLL ( str  )  [inherited]

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

Parameter:
string The label key
Rückgabe:
string The value of the label, fetched for the current backend language.
t3lib_TCEforms::getMainFields ( table,
row,
depth = 0 
) [inherited]

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.

Parameter:
string The table name
array The record from the table for which to render a field.
integer Depth level
Rückgabe:
string HTML output
Siehe auch:
getSoloField()
t3lib_TCEforms::getPaletteFields ( table,
row,
palette,
header = '',
itemList = '',
collapsedHeader = NULL 
) [inherited]

Creates a palette (collection of secondary options).

Parameter:
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).
Rückgabe:
string HTML code.
t3lib_TCEforms::getRecordPath ( table,
rec 
) [inherited]

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

Parameter:
string Table name
array Record array
Rückgabe:
string The record path.
Siehe auch:
t3lib_BEfunc::getRecordPath()
t3lib_TCEforms::getRTypeNum ( table,
row 
) [inherited]

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

Parameter:
string The table name. MUST be in $TCA
array The row from the table, should contain at least the "type" field, if applicable.
Rückgabe:
string Return the "type" value for this record, ready to pick a "types" configuration from the $TCA array.
t3lib_TCEforms::getSingleField ( table,
field,
row,
altName = '',
palette = 0,
extra = '',
pal = 0 
) [inherited]

Returns the form HTML code for a database table field.

Parameter:
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.
Rückgabe:
mixed String (normal) or array (palettes)
t3lib_TCEforms::getSingleField_SW ( table,
field,
row,
&$  PA 
) [inherited]

Rendering a single item for the form

Parameter:
string Table name of record
string Fieldname to render
array The record
array parameters array containing a lot of stuff. Value by Reference!
Rückgabe:
string Returns the item as HTML code to insert private
Siehe auch:
getSingleField(), getSingleField_typeFlex_draw()
t3lib_TCEforms::getSingleField_typeCheck ( table,
field,
row,
&$  PA 
) [inherited]

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

Parameter:
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.
Rückgabe:
string The HTML code for the TCEform field
t3lib_TCEforms::getSingleField_typeFlex ( table,
field,
row,
&$  PA 
) [inherited]

Handler for Flex Forms

Parameter:
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.
Rückgabe:
string The HTML code for the TCEform field
t3lib_TCEforms::getSingleField_typeFlex_draw ( dataStruct,
editData,
table,
field,
row,
&$  PA,
formPrefix = '',
level = 0,
idPrefix = 'ID',
toggleClosed = FALSE 
) [inherited]

Recursive rendering of flexforms

Parameter:
array (part of) Data Structure for which to render. Keys on first level is flex-form fields
array (part of) Data array of flexform corresponding to the input DS. Keys on first level is flex-form field names
string Table name, eg. tt_content
string Field name, eg. tx_templavoila_flex
array The particular record from $table in which the field $field is found
array Array of standard information for rendering of a form field in TCEforms, see other rendering functions too
string Form field prefix, eg. "[data][sDEF][lDEF][...][...]"
integer Indicates nesting level for the function call
string Prefix for ID-values
boolean Defines whether the next flexform level is open or closed. Comes from _TOGGLE pseudo field in FlexForm xml.
Rückgabe:
string HTMl code for form.
t3lib_TCEforms::getSingleField_typeFlex_langMenu ( languages,
elName,
selectedLanguage,
multi = 1 
) [inherited]

Creates the language menu for FlexForms:

Parameter:
[type] $languages: ...
[type] $elName: ...
[type] $selectedLanguage: ...
[type] $multi: ...
Rückgabe:
string HTML for menu
t3lib_TCEforms::getSingleField_typeFlex_sheetMenu ( sArr,
elName,
sheetKey 
) [inherited]

Creates the menu for selection of the sheets:

Parameter:
array Sheet array for which to render the menu
string Form element name of the field containing the sheet pointer
string Current sheet key
Rückgabe:
string HTML for menu
t3lib_TCEforms::getSingleField_typeGroup ( table,
field,
row,
&$  PA 
) [inherited]

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.

Parameter:
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.
Rückgabe:
string The HTML code for the TCEform field
t3lib_TCEforms::getSingleField_typeInput ( table,
field,
row,
&$  PA 
) [inherited]

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

Parameter:
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.
Rückgabe:
string The HTML code for the TCEform field
t3lib_TCEforms::getSingleField_typeNone ( table,
field,
row,
&$  PA 
) [inherited]

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

Parameter:
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.
Rückgabe:
string The HTML code for the TCEform field
t3lib_TCEforms::getSingleField_typeNone_render ( config,
itemValue 
) [inherited]

HTML rendering of a value which is not editable.

Parameter:
array Configuration for the display
string The value to display
Rückgabe:
string The HTML code for the display
Siehe auch:
getSingleField_typeNone();
t3lib_TCEforms::getSingleField_typeRadio ( table,
field,
row,
&$  PA 
) [inherited]

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

Parameter:
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.
Rückgabe:
string The HTML code for the TCEform field
t3lib_TCEforms::getSingleField_typeSelect ( table,
field,
row,
&$  PA 
) [inherited]

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.

Parameter:
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.
Rückgabe:
string The HTML code for the TCEform field
t3lib_TCEforms::getSingleField_typeSelect_checkbox ( table,
field,
row,
&$  PA,
config,
selItems,
nMV_label 
) [inherited]

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

Parameter:
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
Rückgabe:
string The HTML code for the item
Siehe auch:
getSingleField_typeSelect()
t3lib_TCEforms::getSingleField_typeSelect_multiple ( table,
field,
row,
&$  PA,
config,
selItems,
nMV_label 
) [inherited]

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

Parameter:
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
Rückgabe:
string The HTML code for the item
Siehe auch:
getSingleField_typeSelect()
t3lib_TCEforms::getSingleField_typeSelect_single ( table,
field,
row,
&$  PA,
config,
selItems,
nMV_label 
) [inherited]

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

Parameter:
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
Rückgabe:
string The HTML code for the item
Siehe auch:
getSingleField_typeSelect()
t3lib_TCEforms::getSingleField_typeSelect_singlebox ( table,
field,
row,
&$  PA,
config,
selItems,
nMV_label 
) [inherited]

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

Parameter:
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
Rückgabe:
string The HTML code for the item
Siehe auch:
getSingleField_typeSelect()
t3lib_TCEforms::getSingleField_typeText ( table,
field,
row,
&$  PA 
) [inherited]

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

Parameter:
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.
Rückgabe:
string The HTML code for the TCEform field
t3lib_TCEforms::getSingleField_typeUnknown ( table,
field,
row,
&$  PA 
) [inherited]

Handler for unknown types.

Parameter:
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.
Rückgabe:
string The HTML code for the TCEform field
t3lib_TCEforms::getSingleField_typeUser ( table,
field,
row,
&$  PA 
) [inherited]

User defined field type

Parameter:
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.
Rückgabe:
string The HTML code for the TCEform field
t3lib_TCEforms::getSingleHiddenField ( table,
field,
row 
) [inherited]

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

Parameter:
string Table name
string Field name
array The row
Rückgabe:
string The hidden-field <input> tag.
t3lib_TCEforms::getSoloField ( table,
row,
theFieldToReturn 
) [inherited]

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

Parameter:
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.
Rückgabe:
string HTML output
Siehe auch:
getMainFields()
t3lib_TCEforms::getSpecConfForField ( table,
row,
field 
) [inherited]

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

Parameter:
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.
Rückgabe:
array
Siehe auch:
getSpecConfFromString(), t3lib_BEfunc::getTCAtypes()
t3lib_TCEforms::getSpecConfFromString ( extraString,
defaultExtras 
) [inherited]

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

Parameter:
string The "Part 4" of the fields configuration in "types" "showitem" lists.
string The ['defaultExtras'] value from field configuration
Rückgabe:
array An array with the special options in.
Siehe auch:
getSpecConfForField(), t3lib_BEfunc::getSpecConfParts()
t3lib_TCEforms::getTSCpid ( table,
uid,
pid 
) [inherited]

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

Parameter:
string Tablename
string UID value
string PID value
Rückgabe:
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.
Siehe auch:
t3lib_BEfunc::getTSCpid()
t3lib_TCEforms::helpText ( table,
field 
) [inherited]

Returns help text DESCRIPTION, if configured for.

Parameter:
string The table name
string The field name
Rückgabe:
string
t3lib_TCEforms::helpText_typeFlex ( field,
fieldTitle,
cshFile 
) [inherited]

Returns help text DESCRIPTION, if configured for.

Parameter:
string Field name
string CSH file name
Rückgabe:
string Description for the field with cion or empty string
t3lib_TCEforms::helpTextIcon ( table,
field,
force = 0 
) [inherited]

Returns help-text ICON if configured for.

Parameter:
string The table name
string The field name
boolean Force the return of the help-text icon.
Rückgabe:
string HTML, -tag with
t3lib_TCEforms::helpTextIcon_typeFlex ( field,
fieldTitle,
cshFile 
) [inherited]

Returns help-text ICON if configured for.

Parameter:
string Field name
string Field title
string File name with CSH labels
Rückgabe:
string HTML, -tag with
t3lib_TCEforms::initDefaultBEmode (  )  [inherited]

Initialize various internal variables.

Rückgabe:
void
t3lib_TCEforms::initItemArray ( fieldValue  )  [inherited]

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

Parameter:
array The "columns" array for the field (from TCA)
Rückgabe:
array An array of arrays with three elements; label, value, icon
t3lib_TCEforms::insertDefStyle ( type  )  [inherited]

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

Parameter:
string Field type (eg. "check", "radio", "select")
Rückgabe:
string CSS attributes
t3lib_TCEforms::intoTemplate ( inArr,
altTemplate = '' 
) [inherited]

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

Parameter:
array Array with key/value pairs to insert in the template.
string Alternative template to use instead of the default.
Rückgabe:
string
t3lib_TCEforms::isDisplayCondition ( displayCond,
row,
ffValueKey = '' 
) [inherited]

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

Parameter:
string The required-field code
array The record to evaluate
string FlexForm value key, eg. vDEF
Rückgabe:
boolean
t3lib_TCEforms::isPalettesCollapsed ( table,
palette 
) [inherited]

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

Parameter:
string The table name
integer The palette pointer/number
Rückgabe:
boolean
t3lib_TCEforms::JSbottom ( formname = 'forms[0]',
update = false 
) [inherited]

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

Parameter:
string $formname: The identification of the form on the page.
boolean $update: Just extend/update existing settings, e.g. for AJAX call
Rückgabe:
string A section with JavaScript - if $update is false, embedded in <script></script>
t3lib_TCEforms::JStop (  )  [inherited]

JavaScript code added BEFORE the form is drawn:

Rückgabe:
string A <script></script> section with JavaScript.
t3lib_TCEforms::loadJavascriptLib ( lib  )  [inherited]

Includes a javascript library that exists in the core /typo3/ directory. The backpath is automatically applied. This method acts as wrapper for $GLOBALS['SOBE']->doc->loadJavascriptLib($lib).

Parameter:
string $lib: Library name. Call it with the full path like "contrib/prototype/prototype.js" to load it
Rückgabe:
void

Erneute Implementation in t3lib_TCEforms_FE.

t3lib_TCEforms::loadPaletteElements ( table,
row,
palette,
itemList = '' 
) [inherited]

Loads the elements of a palette (collection of secondary options) in an array.

Parameter:
string The table name
array The row array
string The palette number/pointer
string Optional alternative list of fields for the palette
Rückgabe:
array The palette elements
t3lib_TCEforms::mergeFieldsWithAddedFields ( fields,
fieldsToAdd 
) [inherited]

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

Parameter:
array A [types][showitem] list of fields, exploded by ","
array The output from getFieldsToAdd()
Rückgabe:
array Return the modified $fields array.
Siehe auch:
getMainFields(),getFieldsToAdd()
t3lib_TCEforms::noTitle ( str,
wrapParts = array() 
) [inherited]

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

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

Parameter:
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])
Rückgabe:
string
Veraltet:
t3lib_TCEforms::optionTagStyle ( iconString  )  [inherited]

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)

Parameter:
string Icon string for option item
Rückgabe:
string Style attribute content, if any
t3lib_TCEforms::overrideFieldConf ( fieldConfig,
TSconfig 
) [inherited]

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'].

Parameter:
array $fieldConfig: TCA field configuration
array $TSconfig: TSconfig
Rückgabe:
array Changed TCA field configuration
t3lib_TCEforms::popFromDynNestedStack ( type = null,
ident = null 
) [inherited]

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.

Parameter:
string $type: Type of the level, e.g. "tab" or "inline"
string $ident: Identifier of the level
Rückgabe:
void
t3lib_TCEforms::previewFieldValue ( value,
config 
) [inherited]

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

Parameter:
string The value to output
array Configuration for field.
Rückgabe:
string HTML formatted output
t3lib_TCEforms::printNeededJSFunctions (  )  [inherited]

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

Rückgabe:
void
t3lib_TCEforms::printNeededJSFunctions_top (  )  [inherited]

Returns necessary JavaScript for the top

Rückgabe:
void
formRender::printPalette ( palArr  ) 

Creates the HTML content for the palette (Horizontally, for display in the top frame) (Used if GET var "backRef" IS set)

Parameter:
array Array of information from which the fields are built.
Rückgabe:
string HTML output

Erneute Implementation von t3lib_TCEforms.

t3lib_TCEforms::procItems ( items,
iArray,
config,
table,
row,
field 
) [inherited]

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

Parameter:
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
Rückgabe:
array The modified $items array
t3lib_TCEforms::pushToDynNestedStack ( type,
ident 
) [inherited]

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.

Parameter:
string $type: Type of the level, e.g. "tab" or "inline"
string $ident: Identifier of the level
Rückgabe:
void
t3lib_TCEforms::readPerms (  )  [inherited]

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.

Rückgabe:
string
t3lib_TCEforms::rearrange ( fields  )  [inherited]

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

Parameter:
array A [types][showitem] list of fields, exploded by ","
Rückgabe:
array Returns rearranged version (keys are changed around as well.)
Siehe auch:
getMainFields()
t3lib_TCEforms::registerDefaultLanguageData ( table,
rec 
) [inherited]

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

Parameter:
string Table name of the record being edited
array Record array of the record being edited
Rückgabe:
void
t3lib_TCEforms::registerNestedElement ( itemName,
setLevel = true 
) [protected, inherited]

Sets the current situation of nested tabs and inline levels for a given element.

Parameter:
string $itemName: The element the nesting should be stored for
boolean $setLevel: Set the reverse level lookup - default: true
Rückgabe:
void
t3lib_TCEforms::registerRequiredProperty ( type,
name,
value 
) [protected, inherited]

Takes care of registering properties in requiredFields and requiredElements. The current hierarchy of IRRE and/or Tabs is stored. Thus, it is possible to determine, which required field/element was filled incorrectly and show it, even if the Tab or IRRE level is hidden.

Parameter:
string $type: Type of requirement ('field' or 'range')
string $name: The name of the form field
mixed $value: For type 'field' string, for type 'range' array
Rückgabe:
void
t3lib_TCEforms::renderDefaultLanguageContent ( table,
field,
row,
item 
) [inherited]

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.

Parameter:
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.
Rückgabe:
string Item string returned again, possibly with the original value added to.
Siehe auch:
getSingleField(), registerDefaultLanguageData()
t3lib_TCEforms::renderDefaultLanguageDiff ( table,
field,
row,
item 
) [inherited]

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.

Parameter:
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.
Rückgabe:
string Item string returned again, possibly with the original value added to.
Siehe auch:
getSingleField(), registerDefaultLanguageData()
t3lib_TCEforms::renderVDEFDiff ( vArray,
vDEFkey 
) [inherited]

Renders the diff-view of vDEF fields in flexforms

Parameter:
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.
Rückgabe:
string Item string returned again, possibly with the original value added to.
Siehe auch:
getSingleField(), registerDefaultLanguageData()
t3lib_TCEforms::renderWizards ( itemKinds,
wizConf,
table,
row,
field,
&$  PA,
itemName,
specConf,
RTE = 0 
) [inherited]

Rendering wizards for form fields.

Parameter:
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.
Rückgabe:
string The new item value.
t3lib_TCEforms::replaceTableWrap ( arr,
rec,
table 
) [inherited]

This replaces markers in the total wrap

Parameter:
array An array of template parts containing some markers.
array The record
string The table name
Rückgabe:
string
t3lib_TCEforms::resetSchemes (  )  [inherited]

Reset color schemes.

Rückgabe:
void
t3lib_TCEforms::restoreSchemes (  )  [inherited]

Restore the saved color scheme

Rückgabe:
void
t3lib_TCEforms::rplColorScheme ( inTemplate  )  [inherited]

Replaces colorscheme markers in the template string

Parameter:
string Template string with markers to be substituted.
Rückgabe:
string
t3lib_TCEforms::setColorScheme ( scheme  )  [inherited]

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

Parameter:
string A color scheme string.
Rückgabe:
void
t3lib_TCEforms::setNewBEDesign (  )  [inherited]

Sets the design to the backend design. Backend

Rückgabe:
void
t3lib_TCEforms::setTSconfig ( table,
row,
field = '' 
) [inherited]

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.

Parameter:
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.
Rückgabe:
mixed The TSconfig values (probably in an array)
Siehe auch:
t3lib_BEfunc::getTCEFORM_TSconfig()
t3lib_TCEforms::sL ( str  )  [inherited]

Fetches language label for key

Parameter:
string Language label reference, eg. 'LLL:EXT:lang/locallang_core.php:labels.blablabla'
Rückgabe:
string The value of the label, fetched for the current backend language.
t3lib_TCEforms::storeSchemes (  )  [inherited]

Store current color scheme

Rückgabe:
void
t3lib_TCEforms::t3lib_TCEforms (  )  [inherited]

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

Rückgabe:
void
t3lib_TCEforms::thisReturnUrl (  )  [inherited]

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

Rückgabe:
string Return URL of current script
t3lib_TCEforms::wrapBorder ( &$  out_array,
&$  out_pointer 
) [inherited]

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

Parameter:
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!)
Rückgabe:
void
t3lib_TCEforms::wrapLabels ( str  )  [inherited]

Wrapping labels Currently not implemented - just returns input value.

Parameter:
string Input string.
Rückgabe:
string Output string.

Erneute Implementation in t3lib_TCEforms_FE.

t3lib_TCEforms::wrapOpenPalette ( header,
table,
row,
palette,
retFunc 
) [inherited]

Wraps a string with a link to the palette.

Parameter:
string The string to wrap in an A-tag
string The table name for which to open the palette.
array The palette pointer.
integer The record array
t3lib_TCEforms::wrapPaletteField ( code,
table,
row,
palette,
collapsed 
) [inherited]

Add the id and the style property to the field palette

Parameter:
string Palette Code
string The table name for which to open the palette.
string Palette ID
string The record array
Rückgabe:
boolean is collapsed
t3lib_TCEforms::wrapTotal ( c,
rec,
table 
) [inherited]

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

Parameter:
string Code to output between table-parts; table rows
array The record
string The table name
Rückgabe:
string

Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei:
 Alle Klassen Namensbereiche Funktionen Variablen

Erzeugt am Wed Oct 28 16:40:21 2009 für Typo3 von  doxygen 1.6.1