General

  eZ Systems Website
  Editor documentation


  Developer documentation

  Back to the top

The documentation is moving!

We're moving our developer docs to Github and a new site.
The migration is still in progress, so please contact us in #documentation-contrib on eZ Community Slack if you have any questions or feedback.

This space will not be updated from now on except for critical fixes.

Skip to end of metadata
Go to start of metadata

This Field Type represents time information.

NameInternal nameExpected input type
Timeeztimemixed

Description

This Field Type makes possible to store and retrieve time information.

Date information is not stored.

What is stored is the number of seconds, calculated from the beginning of the day in the given or the environment timezone.

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.

TypeExample
string"2012-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:

PropertyTypeDescription
$timeinteger|nullHolds the time information as a number of seconds since the beginning of the day.
Constructor

The constructor for this value object will initialize a new Value object with the value provided. It accepts an integer representing the number of seconds since the beginning of the day.

String representation

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

Example:

"12:14:56"

Hash format

Value in hash format is an integer representing a number of seconds since the beginning of the day.

Example:

36000

Validation

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

Settings

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

NameTypeDefault valueDescription
useSeconds
booleanfalseUsed to control displaying of seconds in the output.
defaultType
Type::DEFAULT_EMPTY
Type::DEFAULT_CURRENT_TIME
Type::DEFAULT_EMPTY
The constant used here defines default input value when using administration interface.
Time Field Type example settings

Template rendering

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

ParameterTypeDefaultDescription
localestring Internal parameter set by the system based on current request locale or if not set calculated based on the language of the field.

Example: