Difference between revisions of "API:EPrints/Time"

From EPrints Documentation
Jump to: navigation, search
Line 46: Line 46:
 
This package contains functions related to time/date functionality.  
 
This package contains functions related to time/date functionality.  
  
 +
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 +
<span style='display:none'>User Comments</span>
 +
<!-- Edit below this comment -->
 +
 +
 +
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=head_methods -->
 +
==METHODS==
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
<span style='display:none'>User Comments</span>
 
<span style='display:none'>User Comments</span>
Line 54: Line 63:
 
</div>
 
</div>
 
<!-- Pod2Wiki=item_render_date -->
 
<!-- Pod2Wiki=item_render_date -->
===$xhtml = EPrints::Time::render_date( $handle, $datevalue )===
+
===render_date===
  
 +
$xhtml = EPrints::Time::render_date( $handle, $datevalue )
 
Render the given date or date and time as a chunk of XHTML.
 
Render the given date or date and time as a chunk of XHTML.
  
Line 70: Line 80:
 
</div>
 
</div>
 
<!-- Pod2Wiki=item_render_short_date -->
 
<!-- Pod2Wiki=item_render_short_date -->
===$xhtml = EPrints::Time::render_short_date( $handle, $datevalue )===
+
===render_short_date===
  
 +
$xhtml = EPrints::Time::render_short_date( $handle, $datevalue )
 
Renders a short version of the given date or date and time as a chunk of XHTML.
 
Renders a short version of the given date or date and time as a chunk of XHTML.
  
Line 86: Line 97:
 
</div>
 
</div>
 
<!-- Pod2Wiki=item_datestring_to_timet -->
 
<!-- Pod2Wiki=item_datestring_to_timet -->
===$xhtml = EPrints::Time::datestring_to_timet( $handle, $datevalue )===
+
===datestring_to_timet===
  
 +
$xhtml = EPrints::Time::datestring_to_timet( $handle, $datevalue )
 
Returns an interger number of seconds since 1970-01-01:00:00
 
Returns an interger number of seconds since 1970-01-01:00:00
  
Line 100: Line 112:
 
</div>
 
</div>
 
<!-- Pod2Wiki=item_gmt_off -->
 
<!-- Pod2Wiki=item_gmt_off -->
===$xhtml = EPrints::Time::gmt_off()===
+
===gmt_off===
  
 +
$xhtml = EPrints::Time::gmt_off()
 
Render the current time offset in seconds. This just diffs gmtime and localtime.
 
Render the current time offset in seconds. This just diffs gmtime and localtime.
  
Line 112: Line 125:
 
</div>
 
</div>
 
<!-- Pod2Wiki=item_get_month_label -->
 
<!-- Pod2Wiki=item_get_month_label -->
===$label = EPrints::Time::get_month_label( $handle, $monthid )===
+
===get_month_label===
  
 +
$label = EPrints::Time::get_month_label( $handle, $monthid )
 
Return a UTF-8 string describing the month, in the current lanugage.
 
Return a UTF-8 string describing the month, in the current lanugage.
  
Line 128: Line 142:
 
</div>
 
</div>
 
<!-- Pod2Wiki=item_get_month_label_short -->
 
<!-- Pod2Wiki=item_get_month_label_short -->
===$label = EPrints::Time::get_month_label_short( $handle, $monthid )===
+
===get_month_label_short===
  
 +
$label = EPrints::Time::get_month_label_short( $handle, $monthid )
 
Return a UTF-8 string of a short representation in  month, in the current lanugage.
 
Return a UTF-8 string of a short representation in  month, in the current lanugage.
  
Line 144: Line 159:
 
</div>
 
</div>
 
<!-- Pod2Wiki=item_get_date_array -->
 
<!-- Pod2Wiki=item_get_date_array -->
===($year,$month,$day) = EPrints::Time::get_date_array( [$time] )===
+
===get_date_array===
  
 +
($year,$month,$day) = EPrints::Time::get_date_array( [$time] )
 
Static method that returns the given time (in UNIX time, seconds  since 1.1.79) in an array.
 
Static method that returns the given time (in UNIX time, seconds  since 1.1.79) in an array.
  
Line 158: Line 174:
 
</div>
 
</div>
 
<!-- Pod2Wiki=item_get_iso_date -->
 
<!-- Pod2Wiki=item_get_iso_date -->
===$datestamp = EPrints::Time::get_iso_date( [$time] )===
+
===get_iso_date===
  
 +
$datestamp = EPrints::Time::get_iso_date( [$time] )
 
Method that returns the given time (in UNIX time, seconds  since 1.1.79) in the format used by EPrints and MySQL (YYYY-MM-DD).
 
Method that returns the given time (in UNIX time, seconds  since 1.1.79) in the format used by EPrints and MySQL (YYYY-MM-DD).
  
Line 172: Line 189:
 
</div>
 
</div>
 
<!-- Pod2Wiki=item_human_time -->
 
<!-- Pod2Wiki=item_human_time -->
===$timestamp = EPrints::Time::human_time( [$time] )===
+
===human_time===
  
 +
$timestamp = EPrints::Time::human_time( [$time] )
 
Return a string describing the current local date and time in the current locale's format (see Perl's 'localtime).
 
Return a string describing the current local date and time in the current locale's format (see Perl's 'localtime).
  
Line 184: Line 202:
 
</div>
 
</div>
 
<!-- Pod2Wiki=item_get_iso_timestamp -->
 
<!-- Pod2Wiki=item_get_iso_timestamp -->
===$timestamp = EPrints::Time::get_iso_timestamp( [$time] );===
+
===get_iso_timestamp===
  
 +
$timestamp = EPrints::Time::get_iso_timestamp( [$time] );
 
Return a UTC timestamp of the form YYYY-MM-DDTHH:MM:SSZ
 
Return a UTC timestamp of the form YYYY-MM-DDTHH:MM:SSZ
  
Line 200: Line 219:
 
</div>
 
</div>
 
<!-- Pod2Wiki=item_human_delay -->
 
<!-- Pod2Wiki=item_human_delay -->
===$timestamp = EPrints::Time::human_delay( $hours );===
+
===human_delay===
  
 +
$timestamp = EPrints::Time::human_delay( $hours );
 
Returns a human readable amount of time.  
 
Returns a human readable amount of time.  
  

Revision as of 13:20, 25 February 2010

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


API: Core API

Latest Source Code (3.3, 3.2) | Revision Log | Before editing this page please read Pod2Wiki


NAME

EPrints::Time - Time and Date-related functions

User Comments


SYNOPSIS

 EPrints::Time::render_date( $handle, "2001-01-12T00:00:00Z" ) 
 # returns XML containing 12 January 2001 00:00
 
 EPrints::Time::render_short_date( $handle, "2001-01-12T00:00:00Z" ) 
 # returns XML containing 12 Jan 2001 00:00
 
 EPrints::Time::get_iso_timestamp( ); 
 # returns NOW in the form YYYY-MM-DDTHH:MM:SSZ
 
 EPrints::Time::human_delay( 28 ); 
 # returns "1 day"
 
 EPrints::Time::get_month_label( $handle, 11 ) 
 # returns November
 
 EPrints::Time::get_month_label_short( $handle, 11 ) 
 # returns Nov
 

User Comments


DESCRIPTION

This package contains functions related to time/date functionality.

User Comments


METHODS

User Comments


render_date

$xhtml = EPrints::Time::render_date( $handle, $datevalue )

Render the given date or date and time as a chunk of XHTML.

$datevalue is given in a UTC timestamp of the form YYYY-MM-DDTHH:MM:SSZ but it will be rendered in the local offset.

e.g EPrints::Time::render_date( $handle, "2001-01-12T00:00:00Z" ) #returns XML containing 12 January 2001 00:00

User Comments


render_short_date

$xhtml = EPrints::Time::render_short_date( $handle, $datevalue )

Renders a short version of the given date or date and time as a chunk of XHTML.

$datevalue is given in UTC timestamp of the form YYYY-MM-DDTHH:MM:SSZ but it will be rendered in the local offset.

e.g EPrints::Time::render_short_date( $handle, "2001-01-12T00:00:00Z" ) #returns XML containing 12 Jan 2001 00:00

User Comments


datestring_to_timet

$xhtml = EPrints::Time::datestring_to_timet( $handle, $datevalue )

Returns an interger number of seconds since 1970-01-01:00:00

$datevalue - in the format YYYY-MM-DDTHH:MM:SSZ

User Comments


gmt_off

$xhtml = EPrints::Time::gmt_off()

Render the current time offset in seconds. This just diffs gmtime and localtime.

User Comments


get_month_label

$label = EPrints::Time::get_month_label( $handle, $monthid )

Return a UTF-8 string describing the month, in the current lanugage.

$monthid is an integer from 1 to 12.

e.g EPrints::Time::get_month_label( $handle, 11 ) # returns November

User Comments


get_month_label_short

$label = EPrints::Time::get_month_label_short( $handle, $monthid )

Return a UTF-8 string of a short representation in month, in the current lanugage.

$monthid is an integer from 1 to 12.

e.g EPrints::Time::get_month_label_short( $handle, 11 ) # returns Nov

User Comments


get_date_array

($year,$month,$day) = EPrints::Time::get_date_array( [$time] )

Static method that returns the given time (in UNIX time, seconds since 1.1.79) in an array.

This is the local date not the UTC date.

User Comments


get_iso_date

$datestamp = EPrints::Time::get_iso_date( [$time] )

Method that returns the given time (in UNIX time, seconds since 1.1.79) in the format used by EPrints and MySQL (YYYY-MM-DD).

This is the localtime date, not UTC.

User Comments


human_time

$timestamp = EPrints::Time::human_time( [$time] )

Return a string describing the current local date and time in the current locale's format (see Perl's 'localtime).

User Comments


get_iso_timestamp

$timestamp = EPrints::Time::get_iso_timestamp( [$time] );

Return a UTC timestamp of the form YYYY-MM-DDTHH:MM:SSZ

e.g. 2005-02-12T09:23:33Z

$time in seconds from 1970. If not defined then assume current time.

User Comments


human_delay

$timestamp = EPrints::Time::human_delay( $hours );

Returns a human readable amount of time.

$hours the number of hours representing the time you want to be human readable.

e.g. EPrints::Time::human_delay( 28 ); # returns "1 day"

e.g. EPrints::Time::human_delay( 400 ); # returns "2 weeks"

User Comments