Typo3 4.1.3 : Vue détaillée de class.t3lib

'TCEforms' - Class for creating the backend editing forms.

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

return: void

Initialize various internal variables.

return: void

getSoloField($table,$row,$theFieldToReturn) X-Ref

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

param: string        The table name
param: array        The record from the table for which to render a field.
param: string        The field name to return the TCEform element for.
return: string        HTML output

getMainFields($table,$row,$depth=0) X-Ref

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.

param: string        The table name
param: array        The record from the table for which to render a field.
param: integer        Depth level
return: string        HTML output

getListedFields($table,$row,$list) X-Ref

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.

param: string        The table name
param: array        The record array.
param: string        Commalist of fields from the table. These will be shown in the specified order in a form.
return: string        TCEform elements in a string.

getPaletteFields($table,$row,$palette,$header='',$itemList='',$collapsedHeader='') X-Ref

Creates a palette (collection of secondary options).

param: string        The table name
param: array        The row array
param: string        The palette number/pointer
param: string        Header string for the palette (used when in-form). If not set, no header item is made.
param: string        Optional alternative list of fields for the palette
param: string        Optional Link text for activating a palette (when palettes does not have another form element to belong to).
return: string        HTML code.

getSingleField($table,$field,$row,$altName='',$palette=0,$extra='',$pal=0) X-Ref

Returns the form HTML code for a database table field.

param: string        The table name
param: string        The field name
param: array        The record to edit from the database table.
param: string        Alternative field name label to show.
param: boolean        Set this if the field is on a palette (in top frame), otherwise not. (if set, field will render as a hidden field).
param: 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.
param: integer        The palette pointer.
return: mixed        String (normal) or array (palettes)

getSingleField_SW($table,$field,$row,&$PA) X-Ref

Rendering a single item for the form

param: string        Table name of record
param: string        Fieldname to render
param: array        The record
param: array        parameters array containing a lot of stuff. Value by Reference!
return: string        Returns the item as HTML code to insert

getSingleField_typeInput($table,$field,$row,&$PA) X-Ref

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

param: string        The table name of the record
param: string        The field name which this element is supposed to edit
param: array        The record data array where the value(s) for the field can be found
param: array        An array with additional configuration options.
return: string        The HTML code for the TCEform field

getSingleField_typeText($table,$field,$row,&$PA) X-Ref

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

param: string        The table name of the record
param: string        The field name which this element is supposed to edit
param: array        The record data array where the value(s) for the field can be found
param: array        An array with additional configuration options.
return: string        The HTML code for the TCEform field

getSingleField_typeCheck($table,$field,$row,&$PA) X-Ref

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

param: string        The table name of the record
param: string        The field name which this element is supposed to edit
param: array        The record data array where the value(s) for the field can be found
param: array        An array with additional configuration options.
return: string        The HTML code for the TCEform field

getSingleField_typeRadio($table,$field,$row,&$PA) X-Ref

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

param: string        The table name of the record
param: string        The field name which this element is supposed to edit
param: array        The record data array where the value(s) for the field can be found
param: array        An array with additional configuration options.
return: string        The HTML code for the TCEform field

getSingleField_typeSelect($table,$field,$row,&$PA) X-Ref

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.

param: string        The table name of the record
param: string        The field name which this element is supposed to edit
param: array        The record data array where the value(s) for the field can be found
param: array        An array with additional configuration options.
return: string        The HTML code for the TCEform field

getSingleField_typeSelect_single($table,$field,$row,&$PA,$config,$selItems,$nMV_label) X-Ref

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

param: string        See getSingleField_typeSelect()
param: string        See getSingleField_typeSelect()
param: array        See getSingleField_typeSelect()
param: array        See getSingleField_typeSelect()
param: array        (Redundant) content of $PA['fieldConf']['config'] (for convenience)
param: array        Items available for selection
param: string        Label for no-matching-value
return: string        The HTML code for the item

getSingleField_typeSelect_checkbox($table,$field,$row,&$PA,$config,$selItems,$nMV_label) X-Ref

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

param: string        See getSingleField_typeSelect()
param: string        See getSingleField_typeSelect()
param: array        See getSingleField_typeSelect()
param: array        See getSingleField_typeSelect()
param: array        (Redundant) content of $PA['fieldConf']['config'] (for convenience)
param: array        Items available for selection
param: string        Label for no-matching-value
return: string        The HTML code for the item

getSingleField_typeSelect_singlebox($table,$field,$row,&$PA,$config,$selItems,$nMV_label) X-Ref

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

param: string        See getSingleField_typeSelect()
param: string        See getSingleField_typeSelect()
param: array        See getSingleField_typeSelect()
param: array        See getSingleField_typeSelect()
param: array        (Redundant) content of $PA['fieldConf']['config'] (for convenience)
param: array        Items available for selection
param: string        Label for no-matching-value
return: string        The HTML code for the item

getSingleField_typeSelect_multiple($table,$field,$row,&$PA,$config,$selItems,$nMV_label) X-Ref

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

param: string        See getSingleField_typeSelect()
param: string        See getSingleField_typeSelect()
param: array        See getSingleField_typeSelect()
param: array        See getSingleField_typeSelect()
param: array        (Redundant) content of $PA['fieldConf']['config'] (for convenience)
param: array        Items available for selection
param: string        Label for no-matching-value
return: string        The HTML code for the item

getSingleField_typeGroup($table,$field,$row,&$PA) X-Ref

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.

param: string        The table name of the record
param: string        The field name which this element is supposed to edit
param: array        The record data array where the value(s) for the field can be found
param: array        An array with additional configuration options.
return: string        The HTML code for the TCEform field

getSingleField_typeNone($table,$field,$row,&$PA) X-Ref

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

param: string        The table name of the record
param: string        The field name which this element is supposed to edit
param: array        The record data array where the value(s) for the field can be found
param: array        An array with additional configuration options.
return: string        The HTML code for the TCEform field

getSingleField_typeNone_render($config,$itemValue) X-Ref

HTML rendering of a value which is not editable.

param: array        Configuration for the display
param: string        The value to display
return: string        The HTML code for the display

getSingleField_typeFlex($table,$field,$row,&$PA) X-Ref

Handler for Flex Forms

param: string        The table name of the record
param: string        The field name which this element is supposed to edit
param: array        The record data array where the value(s) for the field can be found
param: array        An array with additional configuration options.
return: string        The HTML code for the TCEform field

getSingleField_typeFlex_langMenu($languages,$elName,$selectedLanguage,$multi=1) X-Ref

Creates the language menu for FlexForms:

param: [type]        $languages: ...
param: [type]        $elName: ...
param: [type]        $selectedLanguage: ...
param: [type]        $multi: ...
return: string        HTML for menu

getSingleField_typeFlex_sheetMenu($sArr,$elName,$sheetKey) X-Ref

Creates the menu for selection of the sheets:

param: array        Sheet array for which to render the menu
param: string        Form element name of the field containing the sheet pointer
param: string        Current sheet key
return: string        HTML for menu

getSingleField_typeFlex_draw($dataStruct,$editData,$cmdData,$table,$field,$row,&$PA,$formPrefix='',$level=0,$tRows=array() X-Ref

[Describe function...]

param: [type]        $dataStruct: ...
param: [type]        $editData: ...
param: [type]        $cmdData: ...
param: [type]        $table: ...
param: [type]        $field: ...
param: [type]        $row: ...
param: [type]        $PA: ...
param: [type]        $formPrefix: ...
param: [type]        $level: ...
param: [type]        $tRows: ...
return: [type]        ...

getSingleField_typeUnknown($table,$field,$row,&$PA) X-Ref

Handler for unknown types.

param: string        The table name of the record
param: string        The field name which this element is supposed to edit
param: array        The record data array where the value(s) for the field can be found
param: array        An array with additional configuration options.
return: string        The HTML code for the TCEform field

getSingleField_typeUser($table,$field,$row,&$PA) X-Ref

User defined field type

param: string        The table name of the record
param: string        The field name which this element is supposed to edit
param: array        The record data array where the value(s) for the field can be found
param: array        An array with additional configuration options.
return: string        The HTML code for the TCEform field

formatValue($config, $itemValue) X-Ref

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

param: array        Configuration for the display
param: string        The value to display
return: string        Formatted Field content

getRTypeNum($table,$row) X-Ref

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

param: string        The table name. MUST be in $TCA
param: array        The row from the table, should contain at least the "type" field, if applicable.
return: string        Return the "type" value for this record, ready to pick a "types" configuration from the $TCA array.

rearrange($fields) X-Ref

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

param: array A [types][showitem] list of fields, exploded by ","
return: array Returns rearranged version (keys are changed around as well.)

getExcludeElements($table,$row,$typeNum) X-Ref

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

param: string        Table name, MUST be in $TCA
param: array        A record from table.
param: string        A "type" pointer value, probably the one calculated based on the record array.
return: array        Array with fieldnames as values. The fieldnames are those which should NOT be displayed "anyways"

getFieldsToAdd($table,$row,$typeNum) X-Ref

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

param: string        Table name, MUST be in $TCA
param: array        A record from table.
param: string        A "type" pointer value, probably the one calculated based on the record array.
return: array        An array containing two values: 1) Another array containing fieldnames to add and 2) the subtype value field.

mergeFieldsWithAddedFields($fields,$fieldsToAdd) X-Ref

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

param: array        A [types][showitem] list of fields, exploded by ","
param: array        The output from getFieldsToAdd()
return: array        Return the modified $fields array.

setTSconfig($table,$row,$field='') X-Ref

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.

param: string        The table name
param: 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.)
param: string        Optionally you can specify the field name as well. In that case the TSconfig for the field is returned.
return: mixed        The TSconfig values (probably in an array)

overrideFieldConf($fieldConfig, $TSconfig) X-Ref

Overrides the TCA field configuration by TSconfig settings.

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

param: array        $fieldConfig: TCA field configuration
param: array        $TSconfig: TSconfig
return: array        Changed TCA field configuration

getSpecConfForField($table,$row,$field) X-Ref

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

param: string        The table name
param: 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.)
param: string        Specify the field name.
return: array

getSpecConfFromString($extraString, $defaultExtras) X-Ref

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

param: string        The "Part 4" of the fields configuration in "types" "showitem" lists.
param: string        The ['defaultExtras'] value from field configuration
return: array        An array with the special options in.

registerDefaultLanguageData($table,$rec) X-Ref

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

param: string Table name of the record being edited
param: array Record array of the record being edited
return: void

getLanguageOverlayRawValue($table, $row, $field, $fieldConf) X-Ref

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.

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

renderDefaultLanguageContent($table,$field,$row,$item) X-Ref

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.

param: string        Table name of the record being edited
param: string        Field name represented by $item
param: array        Record array of the record being edited
param: string        HTML of the form field. This is what we add the content to.
return: string        Item string returned again, possibly with the original value added to.

renderDefaultLanguageDiff($table,$field,$row,$item) X-Ref

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.

param: string        Table name of the record being edited
param: string        Field name represented by $item
param: array        Record array of the record being edited
param: string        HTML of the form field. This is what we add the content to.
return: string        Item string returned again, possibly with the original value added to.

dbFileIcons($fName,$mode,$allowed,$itemArray,$selector='',$params=array() X-Ref

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

param: string        Form element name
param: string        Mode "db", "file" (internal_type for the "group" type) OR blank (then for the "select" type)
param: string        Commalist of "allowed"
param: 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.
param: string        Alternative selector box.
param: array        An array of additional parameters, eg: "size", "info", "headers" (array with "selector" and "items"), "noBrowser", "thumbnails"
param: string        On focus attribute string
param: string        $table: (optional) Table name processing for
param: string        $field: (optional) Field of table name processing for
param: string        $uid:    (optional) uid of table record processing for
return: string        The form fields for the selection.

getClipboardElements($allowed,$mode) X-Ref

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

param: string        Allowed elements, Eg "pages,tt_content", "gif,jpg,jpeg,png"
param: string        Mode of relations: "db" or "file"
return: array        Array of elements in values (keys are insignificant), if none found, empty array.

getClickMenu($str,$table,$uid='') X-Ref

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.

param: string        The icon HTML to wrap
param: string        Table name (eg. "pages" or "tt_content") OR the absolute path to the file
param: integer        The uid of the record OR if file, just blank value.
return: string        HTML

renderWizards($itemKinds,$wizConf,$table,$row,$field,&$PA,$itemName,$specConf,$RTE=0) X-Ref

Rendering wizards for form fields.

param: array        Array with the real item in the first value, and an alternative item in the second value.
param: array        The "wizard" key from the config array for the field (from TCA)
param: string        Table name
param: array        The record array
param: string        The field name
param: array        Additional configuration array. (passed by reference!)
param: string        The field name
param: array        Special configuration if available.
param: boolean        Whether the RTE could have been loaded.
return: string        The new item value.

getIcon($icon) X-Ref

Get icon (for example for selector boxes)

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

optionTagStyle($iconString) X-Ref

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)

param: string Icon string for option item
return: string Style attribute content, if any

extractValuesOnlyFromValueLabelList($itemFormElValue) X-Ref

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

param: string        Value string where values are comma separated, intermixed with labels and rawurlencoded (this is what is delivered to TCEforms normally!)
param: array        Values in an array
return: array        Input string exploded with comma and for each value only the label part is set in the array. Keys are numeric

wrapOpenPalette($header,$table,$row,$palette,$retFunc=0) X-Ref

Wraps a string with a link to the palette.

param: string        The string to wrap in an A-tag
param: string        The table name for which to open the palette.
param: array        The record array
param: integer        The palette pointer.
param: boolean        Determines the output type of the function.
return: mixed        If $retFunc is set, then returns an array with icon code and palette JavaScript function. Otherwise just the icon code.

checkBoxParams($itemName,$thisValue,$c,$iCount,$addFunc='') X-Ref

Creates checkbox parameters

param: string        Form element name
param: integer        The value of the checkbox (representing checkboxes with the bits)
param: integer        Checkbox # (0-9?)
param: integer        Total number of checkboxes in the array.
param: string        Additional JavaScript for the onclick handler.
return: string        The onclick attribute + possibly the checked-option set.

elName($itemName) X-Ref

Returns element reference for form element name

param: string Form element name
return: string Form element reference (JS)

noTitle($str,$wrapParts=array() X-Ref

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

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

param: string The string which - if empty - will become the no-title string.
param: array Array with wrappin parts for the no-title output (in keys [0]/[1])
return: string

blur() X-Ref

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

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

thisReturnUrl() X-Ref

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

return: string Return URL of current script

getSingleHiddenField($table,$field,$row) X-Ref

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

param: string        Table name
param: string        Field name
param: array        The row
return: string        The hidden-field <input> tag.

formWidth($size=48,$textarea=0) X-Ref

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

param: integer        The abstract size value (1-48)
param: boolean        If this is for a text area.
return: string        Either a "style" attribute string or "cols"/"size" attribute string.

formWidthText($size=48,$wrap='') X-Ref

Returns parameters to set with for a textarea field

param: integer        The abstract width (1-48)
param: string        Empty or "off" (text wrapping in the field or not)
return: string        The "cols" attribute string (or style from formWidth())

formElStyle($type) X-Ref

Get style CSS values for the current field type.

param: string Field type (eg. "check", "radio", "select")
return: string CSS attributes

formElClass($type) X-Ref

Get class attribute value for the current field type.

param: string Field type (eg. "check", "radio", "select")
return: string CSS attributes

formElStyleClassValue($type, $class=FALSE) X-Ref

Get style CSS values for the current field type.

param: string        Field type (eg. "check", "radio", "select")
param: boolean        If set, will return value only if prefixed with CLASS, otherwise must not be prefixed "CLASS"
return: string        CSS attributes

insertDefStyle($type) X-Ref

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

param: string Field type (eg. "check", "radio", "select")
return: string CSS attributes

getDynTabMenu($parts, $idString) X-Ref

Create dynamic tab menu

param: array        Parts for the tab menu, fed to template::getDynTabMenu()
param: string        ID string for the tab menu
return: string        HTML for the menu

initItemArray($fieldValue) X-Ref

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

param: array The "columns" array for the field (from TCA)
return: array An array of arrays with three elements; label, value, icon

addItems($items,$iArray) X-Ref

Merges items into an item-array

param: array        The existing item array
param: 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.
return: array        The updated $item array

procItems($items,$iArray,$config,$table,$row,$field) X-Ref

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

param: array        The array of items (label,value,icon)
param: array        The "itemsProcFunc." from fieldTSconfig of the field.
param: array        The config array for the field.
param: string        Table name
param: array        Record row
param: string        Field name
return: array        The modified $items array

addSelectOptionsToItemArray($items,$fieldValue,$TSconfig,$field) X-Ref

Add selector box items of more exotic kinds.

param: array        The array of items (label,value,icon)
param: array        The "columns" array for the field (from TCA)
param: array        TSconfig for the table/row
param: string        The fieldname
return: array        The $items array modified.

addSelectOptionsToItemArray_makeModuleData($value) X-Ref

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

param: string The module key
return: string The rawurlencoded 2-part string to transfer to interface

foreignTable($items,$fieldValue,$TSconfig,$field,$pFFlag=0) X-Ref

Adds records from a foreign table (for selector boxes)

param: array        The array of items (label,value,icon)
param: array        The 'columns' array for the field (from TCA)
param: array        TSconfig for the table/row
param: string        The fieldname
param: boolean        If set, then we are fetching the 'neg_' foreign tables.
return: array        The $items array modified.

setNewBEDesign() X-Ref

Sets the design to the backend design.
Backend

return: void

intoTemplate($inArr,$altTemplate='') X-Ref

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

param: array Array with key/value pairs to insert in the template.
param: string Alternative template to use instead of the default.
return: string

addUserTemplateMarkers($marker,$table,$field,$row,&$PA) X-Ref

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

param: array        Array with key/value pairs to insert in the template.
param: string        The table name of the record
param: string        The field name which this element is supposed to edit
param: array        The record data array where the value(s) for the field can be found
param: array        An array with additional configuration options.
return: array        marker array for template output

wrapLabels($str) X-Ref

Wrapping labels
Currently not implemented - just returns input value.

param: string Input string.
return: string Output string.

wrapTotal($c,$rec,$table) X-Ref

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

param: string        Code to output between table-parts; table rows
param: array        The record
param: string        The table name
return: string

replaceTableWrap($arr,$rec,$table) X-Ref

This replaces markers in the total wrap

param: array        An array of template parts containing some markers.
param: array        The record
param: string        The table name
return: string

wrapBorder(&$out_array,&$out_pointer) X-Ref

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

param: array The array with form elements stored in (passed by reference and changed!)
param: integer The pointer to the entry in the $out_array (passed by reference and incremented!)
return: void

rplColorScheme($inTemplate) X-Ref

Replaces colorscheme markers in the template string

param: string Template string with markers to be substituted.
return: string

getDivider() X-Ref

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

return: string

printPalette($palArr) X-Ref

Creates HTML output for a palette

param: array The palette array to print
return: string HTML output

helpTextIcon($table,$field,$force=0) X-Ref

Returns help-text ICON if configured for.

param: string        The table name
param: string        The field name
param: boolean        Force the return of the help-text icon.
return: string        HTML, <a>-tag with

helpText($table,$field) X-Ref

Returns help text DESCRIPTION, if configured for.

param: string The table name
param: string The field name
return: string

setColorScheme($scheme) X-Ref

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

param: string A color scheme string.
return: void

resetSchemes() X-Ref

Reset color schemes.

return: void

storeSchemes() X-Ref

Store current color scheme

return: void

restoreSchemes() X-Ref

Restore the saved color scheme

return: void

JStop() X-Ref

JavaScript code added BEFORE the form is drawn:

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

JSbottom($formname='forms[0]', $update = false) X-Ref

JavaScript code used for input-field evaluation.

Example use:

$msg.='Distribution time (hh:mm dd-mm-yy):<br /><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" /><br />';
$this->extJSCODE.='typo3form.fieldSet("send_mail_datetime", "datetime", "", 0,0);';

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

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

dbFileCon($formObj='document.forms[0]') X-Ref

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

param: string Form object reference (including "document.")
return: string JavaScript functions/code (NOT contained in a <script>-element)

setFormValueOpenBrowser(mode,params) X-Ref

Pas de description

setFormValueFromBrowseWin(fName,value,label,exclusiveValues) X-Ref

Pas de description

setHiddenFromList(fObjSel,fObjHid) X-Ref

Pas de description

setFormValueManipulate(fName,type) X-Ref

Pas de description

setFormValue_getFObj(fName) X-Ref

Pas de description

printNeededJSFunctions() X-Ref

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

return: void

printNeededJSFunctions_top() X-Ref

Returns necessary JavaScript for the top

return: void

getDefaultRecord($table,$pid=0) X-Ref

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

param: string        Database Tablename
param: integer        PID value (positive / negative)
return: array        "default" row.

getRecordPath($table,$rec) X-Ref

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

param: string        Table name
param: array        Record array
return: string        The record path.

readPerms() X-Ref

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.

return: string

sL($str) X-Ref

Fetches language label for key

param: string Language label reference, eg. 'LLL:EXT:lang/locallang_core.php:labels.blablabla'
return: string The value of the label, fetched for the current backend language.

getLL($str) X-Ref

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

param: string The label key
return: string The value of the label, fetched for the current backend language.

isPalettesCollapsed($table,$palette) X-Ref

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

param: string The table name
param: integer The palette pointer/number
return: boolean

isDisplayCondition($displayCond,$row,$ffValueKey='') X-Ref

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

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

getTSCpid($table,$uid,$pid) X-Ref

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

param: string        Tablename
param: string        UID value
param: string        PID value
return: 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.

doLoadTableDescr($table) X-Ref

Returns true if descriptions should be loaded always

param: string Table for which to check
return: boolean

getAvailableLanguages($onlyIsoCoded=1,$setDefault=1) X-Ref

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

param: boolean If set, only languages which are paired with a static_info_table / static_language record will be returned.
param: boolean If set, an array entry for a default language is set.
return: array

getLanguageIcon($table,$row,$sys_language_uid) X-Ref

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"
return: void

previewFieldValue($value, $config) X-Ref

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

param: string        The value to output
param: array        Configuration for field.
return: string        HTML formatted output

getAdditionalPreviewLanguages() X-Ref

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

pushToDynNestedStack($type, $ident) X-Ref

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.

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

popFromDynNestedStack($type=null, $ident=null) X-Ref

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.

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

getDynNestedStack($json=false, $skipFirst=false) X-Ref

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

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

Classe: t3lib_TCEforms_FE - X-Ref

Extension class for the rendering of TCEforms in the frontend

wrapLabels($str) X-Ref

Function for wrapping labels.

param: string The string to wrap
return: string

printPalette($palArr) X-Ref

Prints the palette in the frontend editing (forms-on-page?)

param: array The palette array to print
return: string HTML output

setFancyDesign() X-Ref

Sets the fancy front-end design of the editor.
Frontend

return: void

Author:	Kasper Skaarhoj <kasperYYYY@typo3.com>
Poids:	5572 lignes (216 kb)
Inclus ou requis:	0 fois
Référencé:	0 fois
Nécessite:	0 fichiers

Code source de Typo3 4.1.3

/t3lib/ -> class.t3lib_tceforms.php (sommaire)

Définit 2 classes

Généré le : Sun Nov 25 17:13:16 2007	par Balluche grâce à PHPXref 0.7