Navigation
eZ Documentation Center
 

This is outdated documentation made for eZ Publish Platform 5.2. It is being moved into the eZ Publish 5.x documentation, so please go there for most up-to-date documentation.

Skip to end of metadata
Go to start of metadata

Time

This field type represents a time information.

NameInternal nameExpected input type
Timeeztimemixed

Description

This FieldType makes possible to store and retrieve a time information.

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()

Date information is not stored.

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

Validation

This FieldType does not use any special validation of the input value.

Settings

The field definition of this FieldType 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 FieldType example settings

Value object

Properties

The Value class of this field type contains the following properties:

PropertyTypeDescription
$timeinteger|nullHolds the the time information as a number of seconds since the beginning of a 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

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 a day.

  • No labels