Skip to content
  • Documentation >
  • API >
  • Field Type >
  • Field Type reference >
  • DateAndTime Field Type

DateAndTime Field Type

This Field Type represents a full date and time information.

Name Internal name Expected input type
DateAndTime ezdatetime mixed

PHP API Field Type

Input expectations

If input value is of type string or integer, it will be passed directly to the PHP's built-in \DateTime class constructor, therefore the same input format expectations apply.

It is also possible to directly pass an instance of \DateTime.

Type Example
integer "2017-08-28 12:20 Europe/Berlin"
integer 1346149200
\DateTime new \DateTime()

Value object

Properties

The Value class of this Field Type contains the following properties:

Property Type Description
$value \DateTime The date and time value as an instance of \DateTime.
Constructor

The constructor for this value object will initialize a new Value object with the value provided. It accepts an instance of PHP's built-in \DateTime class.

String representation

String representation of the date value will generate the date string in the format D Y-d-m H:i:s as accepted by PHP's built-in date() function.

Character Description Example
D Three letter representation of a day, range Mon to Sun Wed
Y Four digit representation of a year 2016
d Two digit representation of a day, range 01 to 31 22
m Two digit representation of a month, range 01 to 12 05
H Two digit representation of an hour, 24-hour format, range 00 to 23 12
i Two digit representation of minutes, range 00 to 59 19
s Two digit representation of seconds, range 00 to 59 18

Example: Wed 2016-22-05 12:19:18

Hash format

Hash value of this Field Type is an array with two keys:

Key Type Description Example
timestamp integer Time information in Unix format timestamp. 1400856992
rfc850 string Time information as a string in RFC 850 date format. As input, this will have precedence over the timestamp value. "Friday, 23-May-14 14:56:14 GMT+0000" 
1
2
3
4
$hash = [
    "timestamp" => 1400856992,
    "rfc850" => "Friday, 23-May-14 14:56:14 GMT+0000"
];

Validation

This Field Type does not perform any special validation of the input value.

Settings

The Field definition of this Field Type can be configured with several options:

Name Type Default value Description
useSeconds boolean false Used to control displaying of seconds in the output.
defaultType mixed Type::DEFAULT_EMPTY One of the DEFAULT_* constants, used by the administration interface for setting the default Field value. See below for more details.
dateInterval null|\DateInterval null This setting complements defaultType setting and can be used only when the latter is set to Type::DEFAULT_CURRENT_DATE_ADJUSTED. In that case the default input value when using administration interface will be adjusted by the given \DateInterval.

Following defaultType default value options are available as constants in the eZ\Publish\Core\FieldType\DateAndTime\Type class:

Constant Description
DEFAULT_EMPTY Default value will be empty.
DEFAULT_CURRENT_DATE Default value will use current date.
DEFAULT_CURRENT_DATE_ADJUSTED Default value will use current date, adjusted by the interval defined in dateInterval setting. 
1
2
3
4
5
6
7
8
9
// DateAndTime FieldType example settings

use eZ\Publish\Core\FieldType\DateAndTime\Type;

$settings = [
    "useSeconds" => false,
    "defaultType" => Type::DEFAULT_EMPTY,
    "dateInterval" => null
];

Template rendering

The template called by the ez_render_field() Twig function while rendering a Date Field has access to the following parameters:

Parameter Type Default Description
locale string   n/a Internal parameter set by the system based on current request locale or if not set calculated based on the language of the Field.

Example:

1
{{ ez_render_field(content, 'datetime') }}