The Time FieldType

Written by Petar Spanja Updated 05/23/2014 by Petar Spanja

This field type represents a time information.

Name	Internal name	Expected input type
Time	eztime	mixed

Table of contents:

Description

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

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.

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
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:

Property	Type	Description
$time	integer\|null	Holds the the time information as a number of seconds since the beginning of a 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 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"

Hash format

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

Example:

36000

Validation

This FieldType does not perform validation of the input value.

Settings

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

Name	Type	Default value	Description
useSeconds	boolean	false	Used 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.