Common column properties

There are a number of properties which are common to all field types. They are described below.

Properties

Property Data Type
dbType string
default mixed
type string
readOnly boolean
search array
softref string

Property details

type

Key

type

Datatype

string

Description

This defines the type of the field. It has to be one of the values described in the following chapters.

Scope

Display

/ Proc.

dbType

Key

dbType

Datatype

string

Description

This defines a specific database field type for the given field.

This is currently only supported for “date” or “datetime” fields (i.e. input-type fields with the “eval” property set to “date” or “datetime”) and the dbType can be set only to “date” or “datetime”.

Scope

Database

default

Key

default

Datatype

Description

This property can be used to set a default value for the field. Its data type is whatever is appropriate for the given field.

Since TYPO3 CMS 6.2, NULL is a valid default value.

Scope

Display

/ Proc.

softref

Key

softref

Datatype

string

Description

Used to attach “soft reference parsers”. See under “Additional TCA features” for information about softref keys. The syntax for this value is key1,key2[parameter1;parameter2;…],…

Scope

Proc.

readOnly

Key

readOnly

Datatype

boolean

Description

Renders the form 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.

Note

Read-only is not implemented automatically for user-defined form items. It is up to each developer to implement read-only rendering for its own types.

Warning

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

Scope

Display