Difference between revisions of "Time field"

From EPrints Documentation
Jump to: navigation, search
m
m (Properties)
Line 12: Line 12:
 
*** [[Time field]]
 
*** [[Time field]]
  
== Properties ==
+
== Additional Properties ==
As for [[date field]]s with the following differences...
+
As for [[Date field#Additional_Properties|Date fields]] except for:
  
 
{| border="1" cellpadding="3" cellspacing="0"
 
{| border="1" cellpadding="3" cellspacing="0"

Revision as of 23:07, 9 April 2023

EPrints 3 Reference: Directory Structure - Metadata Fields - Repository Configuration - XML Config Files - XML Export Format - EPrints data structure - Core API - Data Objects


Metadata Fields: Arclanguage - Base64 - Bigint - Boolean - Compound - Counter - Dataobjref - Date - Decimal - Email - Fields - Float - Id - Idci - Image - Int - Itemref - Keywords - Langid - Longtext - Longtext_counter - Multilang - Multipart - Name - Namedset - Pagerange - Recaptcha - Recaptcha3 - Relation - Search - Secret - Set - Storable - Subject - Subobject - Text - Time - Timestamp - Url - Uuid


Description

This field is very similar to date field but allows the inclusion of hours, mintues and seconds. It is used for the various timestamps associated with an eprint record.

Times are always stored in UTC and rendered in the local timezone.

Inheritance

Additional Properties

As for Date fields except for:

name default description
min_resolution second One of second/minute/hour/day/month/year. Indicates the smallest unit of measure that must be entered to make a value valid. Eg. if "day" so long as there's a year+month+day the hours,seconds and minutes are optional.
render_res day One of second/minute/hour/day/month/year. If set to "year" then the dates 1998-10-01, 1998-10 and 1998 would all be rendered as "1998". This is not too useful in configuring the field, but can be set as a print option inside citation files. Although it can be handy to store the time right down to the second, you often will just want to render the hours and minutes for day to day use.
render_style long One of short/long.

If "long" then you'll see "8 September 1998 23:12:11 +01:00".

If "short" then value is rendered as "08 Sep 1998 23:12:11".

Required Phrases

No additional phrases.

Database

fieldname_year SMALLINT(6)
fieldname_month SMALLINT(6)
fieldname_day SMALLINT(6) 
fieldname_hour SMALLINT(6)
fieldname_minute SMALLINT(6)
fieldname_second SMALLINT(6)

API

See API page.

Examples

Most basic example.

{
    name => 'timestamp',
    type => 'time',
}

Only render valyes down to the nearest minute.

{ 
    name => 'datestamp',
    type => 'time',
    render_res => 'minute',
}

Render date and time in short form.

{
    name => 'timestamp',
    type => 'time',
    render_style => 'short',
}

Render date and time in short form.

{
    name => 'datestamp',
    type => 'time',
    render_style => 'short',
}

Require minimum resolution to be to the hour.

{
    name => 'timestamp',
    typ e=> 'time',
    min_resolution => 'hour',
}