text (textTable)

Table of contents:

This page describes the text type with the renderType=’textTable’.

// ...
'type' => 'text',
'renderType' => 'textTable',
// ...

The renderType = 'textTable' triggers a view to manage frontend table display in the backend. It is used for the “Table” tt_content content element.

Example

Table editor tt\_content bodytext

Table editor tt_content bodytext

'bodytext' => [
    'label' => '',
    'config' => [
        'type' => 'text',
        'renderType' => 'textTable',
        'wrap' => 'off',
        'cols' => 80,
        'rows' => 15,
    ],
],

Properties

behaviour

Datatype
array
Scope
Proc.
Description
The behaviour array contains various sub properties to specify processing options like localization overlay behaviour and children behaviour for relation types. Available properties vary by type and renderType combination.

behaviour => allowLanguageSynchronization

Datatype
boolean
Scope
Proc.
Description

Allows an editor to select in a localized record whether the value is copied over from default or source language record, or if the field has an own value in the localization. If set to true and if the table supports localization and if a localized record is edited, this setting enables FieldWizard LocalizationStateSelector: Two or three radio buttons shown below the field input. The state of this is stored in a json encoded array in the database table called l10n_state. It tells the DataHandler which fields of the localization records should be kept in sync if the underlying default or source record changes.

Example:

'aField' => [
   'config' => [
      'type' = 'sometype',
      'behaviour' => [
         'allowLanguageSynchronization' => true
      ]
   ]
]
Default
false

cols

Datatype
integer
Scope
Display
Description

Abstract value for the width of the <textarea> field. To set the textarea to the full width of the form area, use the value 50. Default is 30.

Does not apply to RTE fields.

default

Datatype
integer / string
Scope
Display / Proc.
Description
Default value set if a new record is created.

enableTabulator

Datatype
boolean
Scope
Display
Description

Enabling this allows to use tabs in a text field. This works well together with fixed-width fonts (monospace) for code editing.

Does not apply to RTE fields.

fieldControl

Datatype
array
Scope
Display
Description
Show action buttons next to the element. This is used in various type’s to add control buttons right next to the main element. They can open popus, switch the entire view and other things. All must provide a “button” icon to click on, see FormEngine docs for more details. See type=group for examples.

tableWizard

Datatype
array
Scope
fieldControl
Description

The table wizard field control is used in type='text' with renderType='textTable' elements and renders a button to the stand alone table wizard.

The table wizard is used typically with the Content Elements, type “Table”. It allows to edit the code-like configuration of the tables with a visual editor.

Note the control button is only displayed after a new record has been saved the first time.

The table wizard

The table wizard

Available options:

xmlOutput
(boolean) If set to true, the output from the wizard is XML instead of the TypoScript table configuration code. Default false.
numNewRows
(integer) Setting the number of blank rows that will be added in the bottom of the table when the plus-icon is pressed. The default is 5, the range is 1-50.

Example overriding defaults of a renderType='textTable' element:

'bodytext' => [
    'config' => [
        'fieldControl' => [
            'options' => [
                'numNewRows' => 3,
            ],
        ],
    ],
],

fieldInformation

Datatype
array
Scope
Display
Description
Show information between an element label and the main element input area. Configuration works identical to the “fieldWizard” property, no default configuration in the core exists (yet). In contrast to “fieldWizard”, HTML returned by fieldInformation is limited, see FormEngine docs for more details.

fieldWizard

Datatype
array
Scope
Display
Description

Specifies wizards rendered below the main input area of an element. Single type / renderType elements can register default wizards which are merged with this property.

As example, type=’check’ comes with this default wizards configuration:

protected $defaultFieldWizard = [
    'localizationStateSelector' => [
        'renderType' => 'localizationStateSelector',
    ],
    'otherLanguageContent' => [
        'renderType' => 'otherLanguageContent',
        'after' => [
            'localizationStateSelector'
        ],
    ],
    'defaultLanguageDifferences' => [
        'renderType' => 'defaultLanguageDifferences',
        'after' => [
            'otherLanguageContent',
        ],
    ],
];

This is be merged with the configuration from TCA, if there is any. Below example disables the default localizationStateSelector wizard.

'aField' => [
    'config' => [
        'fieldWizard' => [
            'localizationStateSelector' => [
                'disabled' => true,
            ],
        ],
    ],
],

It is possible to add own wizards by adding them to the TCA of the according field and pointing to a registered renderType, to resort wizards by overriding the before and after keys, to hand over additional options in the optional options array to specific wizards, and to disable single wizards using the disabled key. Developers should have a look at the FormEngine docs for details.

The following fieldWizards are available for this renderType:

fieldWizard => defaultLanguageDifferences

Datatype
array
Scope
fieldWizard
Description

Show a “diff-view” if the content of the default language record has been changed after the translation overlay has been created. The [‘ctrl’] section property transOrigDiffSourceField has to be specified to enable this wizard in a translated record.

This wizard is important for editors who maintain translated records: They can see what has been changed in their localization parent between the last save operation of the overlay.

A field has been changed in default language record

A field has been changed in default language record

fieldWizard => localizationStateSelector

Datatype
array
Scope
fieldWizard
Description

The localization state selector wizard displays two or three radio buttons in localized records saying: “This field has an own value distinct from my default language or source record”, “This field has the same value as the default language record” or “This field has the same value as my source record”. This wizard is especially useful for the tt_content table. It will only render, if:

  • The record is a localized record (not default language)
  • The record is in “translated” (connected), but not in “copy” (free) mode
  • The table is localization aware using the [‘ctrl’] properties languageField, transOrigPointerField. If the optional property translationSource is also set, and if the record is a translation from another localized record, the third radio appears.
  • The property [‘config’][‘behaviour’][‘allowLanguageSynchronization’] is set to true
Example localization state selector on a type=input field

Example localization state selector on an type=input field

fieldWizard => otherLanguageContent

Datatype
array
Scope
fieldWizard
Description

Show values from the default language record and other localized records if the edited row is a localized record. Often used in tt_content fields. By default, only the value of the default language record is shown, values from further translations can be shown by setting the userTsConfig property additionalPreviewLanguages.

The wizard shows content only for “simple” fields. For instance, it does not work for database relation fields, and if the field is set to readOnly. Additionally, the table has to be language aware by setting up the according fields in [‘ctrl’] section.

Header field showing values from two other languages

Header field showing values from two other languages

fixedFont

Datatype
boolean
Scope
Display
Description

Enables a fixed-width font (monospace) for the text field. This is useful when using code.

Does not apply to RTE fields.

is_in

Datatype
string
Scope
Display / Proc.
Description

If a user-defined evaluation is used for the field (see eval), then this value will be passed as argument to the user-defined evaluation function.

Does not apply to RTE fields.

max

Datatype
integer
Scope
Display
Description

Adds the HTML5 attribute “maxlength” to a textarea. Prevents the field from adding more than specified number of characters. This is a client side restriction, no server side length restriction is enforced.

Does not apply for RTE fields.

placeholder

Datatype
string
Scope
Display
Description

Placeholder text for the field. This can be a simple string or a reference to a value in the current record or another one. With a syntax like __row|field the placeholder will take the value of the given field from the current record.

This can be recursive to follow a longer patch in a table record chain. If the designated field is a relation to another table (is of type select, group or inline), the related record will be loaded and the placeholder searched within it.

Example from the “sys_file_reference” table:

'title' => [
    'label' => 'LLL:EXT:lang/locallang_tca.xlf:sys_file_reference.title',
    'config' => [
        'type' => 'input',
        'size' => 20,
        'eval' => 'null',
        'placeholder' => '__row|uid_local|metadata|title',
        'mode' => 'useOrOverridePlaceholder'
    ]
],

In the above placeholder syntax, uid_local points to the related “sys_file” record and metadata points to the “sys_file_metata” of the related “sys_file” record. From there we take the content of the title field as placeholder value.

readOnly

Datatype
boolean
Scope
Display
Description

Renders the field in a way that the user can see the values but cannot edit them. The rendering is as similar as possible to the normal rendering but may differ in layout and size.

Warning

This property affects only the display. It is still possible to write to those fields when using the DataHandler.

rows

Datatype
integer
Scope
Display
Description

The number of rows in the textarea. May be corrected for harmonization between browsers. Will also automatically be increased if the content in the field is found to be of a certain length, thus the field will automatically fit the content. Default is 5. Max value is 20.

Does not apply to RTE fields.

softref

Datatype
string
Scope
Proc.
Description

Used to attach “soft reference parsers”, typically used in type='text' fields.

The syntax for this value is key1,key2[parameter1;parameter2;…],…

See Soft references of core API for more details about softref keys.

wrap

Datatype
string (keyword)
Scope
Display
Description

Determines the wrapping of the textarea field. Does not apply to RTE fields. There are two options:

virtual (default)
The textarea automatically wraps the lines like it would be expected for editing a text.
off
The textarea will not wrap the lines as you would expect when editing some kind of code.

Example configuration to create a textarea useful for code lines since it will not wrap the lines, uses a monospace font and enables tabs:

'config' => [
    'type' => 'text',
    'cols' => '40',
    'rows' => '15',
    'wrap' => 'off',
    'fixedFont' => true,
    'enableTabulator' => true,
]