Perl 5 version documentation

Time::Seconds

NAME

Time::Seconds - a simple API to convert seconds to other date values

SYNOPSIS

  1.     use Time::Piece;
  2.     use Time::Seconds;
  3.     
  4.     my $t = localtime;
  5.     $t += ONE_DAY;
  6.     
  7.     my $t2 = localtime;
  8.     my $s = $t - $t2;
  9.     
  10.     print "Difference is: ", $s->days, "\n";

DESCRIPTION

This module is part of the Time::Piece distribution. It allows the user to find out the number of minutes, hours, days, weeks or years in a given number of seconds. It is returned by Time::Piece when you delta two Time::Piece objects.

Time::Seconds also exports the following constants:

  1.     ONE_DAY
  2.     ONE_WEEK
  3.     ONE_HOUR
  4.     ONE_MINUTE
  5.     ONE_MONTH
  6.     ONE_YEAR
  7.     ONE_FINANCIAL_MONTH
  8.     LEAP_YEAR
  9.     NON_LEAP_YEAR

Since perl does not (yet?) support constant objects, these constants are in seconds only, so you cannot, for example, do this: print ONE_WEEK->minutes;

METHODS

The following methods are available:

  1.     my $val = Time::Seconds->new(SECONDS)
  2.     $val->seconds;
  3.     $val->minutes;
  4.     $val->hours;
  5.     $val->days;
  6.     $val->weeks;
  7.     $val->months;
  8.     $val->financial_months; # 30 days
  9.     $val->years;
  10.     $val->pretty; # gives English representation of the delta

The usual arithmetic (+,-,+=,-=) is also available on the objects.

The methods make the assumption that there are 24 hours in a day, 7 days in a week, 365.24225 days in a year and 12 months in a year. (from The Calendar FAQ at http://www.tondering.dk/claus/calendar.html)

AUTHOR

Matt Sergeant, matt@sergeant.org

Tobias Brox, tobiasb@tobiasb.funcom.com

Balázs Szabó (dLux), dlux@kapu.hu

COPYRIGHT AND LICENSE

Copyright 2001, Larry Wall.

This module is free software, you may distribute it under the same terms as Perl.

Bugs

Currently the methods aren't as efficient as they could be, for reasons of clarity. This is probably a bad idea.