DateTime

type => 'datetime' // TCA

The DateTime type provides a date picker. If not configured otherwise, the value is stored as a timestamp.

Settings

default
Required

false

Type

string

Default

''

Default value in Y-m-d format. Set if a new record is created. For example 2023-01-01.

format
Required

false

Type

string

Default

''

Defines how the date should be formatted in the backend. Possible values are datetime, date or time and timesec.

dbType
Required

false

Type

string

Default

''

This option changes the date field to a native MySql DATETIME, DATE or TIME field. Possible values are datetime, date or time respectively.

range
Required

false

Type

array

An array which defines an integer range within which the value must be. Keys:

lower (string in format Y-m-d H:i:s)
Defines the min date.
upper (string in format Y-m-d H:i:s)
Defines the max date.

It is allowed to specify only one of both of them.

Example:

range:
  lower: '2020-01-01'
  upper: '2020-12-31'
Copied!
disableAgeDisplay
Required

false

Type

boolean

Default

false

Disable the display of the age in the backend view.

required
Required

false

Type

boolean

Default

false

If set, the field becomes mandatory.

For more advanced configuration refer to the TCA documentation.

Examples

Minimal

name: example/datetime
fields:
  - identifier: datetime
    type: DateTime
    format: date
Copied! 
name: example/datetime
fields:
  - identifier: datetime
    type: DateTime
    format: datetime
    dbType: datetime
Copied!

Advanced / use case

name: example/datetime
fields:
  - identifier: datetime
    type: DateTime
    format: datetime
    default: '2023-02-11 12:00:00'
    disableAgeDisplay: true
    size: 20
    range:
      lower: '2019-01-31 12:00:00'
      upper: '2040-01-31 12:00:00'
    required: true
Copied!