PerlDoc

See PublishedAPI for packages intended to be used by Plugin and Contrib authors, or browse all packages.
See also Developing plugins, Developer's Bible, Technical Overview

public package Foswiki::Time

Time handling functions.

Since date indicates where functions or parameters have been added since the baseline of the API (TWiki release 4.2.3). The date indicates the earliest date of a Foswiki release that will support that function or parameter.

Deprecated date indicates where a function or parameters has been deprecated. Deprecated functions will still work, though they should not be called in new plugins and should be replaced in older plugins as soon as possible. Deprecated parameters are simply ignored in Foswiki releases after date.

Until date indicates where a function or parameter has been removed. The date indicates the latest date at which Foswiki releases still supported the function or parameter.

StaticMethod parseTime( $szDate, $defaultLocal ) → $iSecs

Convert string date/time string to seconds since epoch (1970-01-01T00:00:00Z).

• $sDate - date/time string

Handles the following formats:

Default Foswiki format

• 31 Dec 2001 - 23:59
• 31-Dec-2001 - 23:59

Foswiki format without time (defaults to 00:00)

• 31 Dec 2001
• 31-Dec-2001

Date separated by '/', '.' or '-', time with '.' or ':' Date and time separated by ' ', '.' and/or '-'

• 2001/12/31 23:59:59
• 2001.12.31.23.59.59
• 2001/12/31 23:59
• 2001.12.31.23.59
• 2001-12-31 23:59
• 2001-12-31 - 23:59
• 2009-1-12
• 2009-1
• 2009

ISO format

• 2001-12-31T23:59:59
• 2001-12-31T

ISO dates may have a timezone specifier, either Z or a signed difference in hh:mm format. For example:

• 2001-12-31T23:59:59+01:00
• 2001-12-31T23:59Z

The default timezone is Z, unless $defaultLocal is true in which case the local timezone will be assumed.

If the date format was not recognised, will return undef.

StaticMethod formatTime ($epochSeconds, $formatString, $outputTimeZone) → $value

• $epochSeconds epochSecs GMT
• $formatString Foswiki time date format, default $day $month $year - $hour:$min
• $outputTimeZone timezone to display, gmtime or servertime, default is whatever is set in $Foswiki::cfg{DisplayTimeValues}

$formatString supports:

StaticMethod formatDelta( $s ) → $string

Format a time in seconds as a string. For example, "1 day, 3 hours, 2 minutes, 6 seconds"

StaticMethod parseInterval( $szInterval ) → [$iSecs, $iSecs]

Convert string representing a time interval to a pair of integers representing the amount of seconds since epoch for the start and end extremes of the time interval.

• $szInterval - time interval string

in yacc syntax, grammar and actions:

interval ::= date                 { $$.start = fillStart($1); $$.end = fillEnd($1); }
         | date '/' date          { $$.start = fillStart($1); $$.end = fillEnd($3); }
         | 'P' duration '/' date  { $$.start = fillEnd($4)-$2; $$.end = fillEnd($4); }
         | date '/' 'P' duration  { $$.start = fillStart($1); $$.end = fillStart($1)+$4; }
         ;

an interval may be followed by a timezone specification string (this is not supported yet).

duration has the form (regular expression):

   P(<number><nameOfDuration>)+

nameOfDuration may be one of:

• y(year), m(month), w(week), d(day), h(hour), M(minute), S(second)

date follows ISO8601 and must include hyphens. (any amount of trailing elements may be omitted and will be filled in differently on the differents ends of the interval as to include the longest possible interval):

• 2001-01-01T00:00:00
• 2001-12-31T23:59:59

timezone is optional. Default is local time.

If the format is not recognised, will return empty interval [0,0].