Andrew Hicox > Time-Interval-1.0.5 > Time::Interval

Download:
Time-Interval-1.0.5.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  0
View/Report Bugs
Module Version: 1.0.5   Source   Latest Release: Time-Interval-1.233

NAME ^

Time::Interval - Converts time intervals of days, hours, minutes, and seconds

This is a rather simple perl module for dealing with time intervals. Among other things, this module can tell you the number of hours, minutes, and seconds elapsed between two dates.

SYNOPSIS ^

        use Time::Interval;
        
        $data = getInterval(
                "1/25/03 12:34:32 EDT 2003",
                "4/25/03 11:24:00 EDT 2003"
        );
        
        $string = getInterval(
                "1/25/03 12:34:32 EDT 2003",
                "4/25/03 11:24:00 EDT 2003",
                "string"
        );
        
        $number_of_minutes = convertInterval(
                days            => 5,
                hours           => 23,
                minutes         => 10,
                ConvertTo       => "minutes"
        );
        
        $data = parseInterval(seconds => 14295872);

        $string = parseInterval(
                seconds => 14295872,
                String  => 1
        );
        
        $min_intervals = coalesce([ 
                        [ '1/25/03 12:34:32 EDT 2003', '1/25/03 15:34:32 EDT 2003' ],
                        [ '1/25/03 14:34:32 EDT 2003', '1/25/03 16:34:32 EDT 2003' ],
                        [ '1/25/03 09:10:18 EDT 2003', '1/25/03 12:32:15 EDT 2003' ]
        ]);

getInterval ^

this will take two date strings in any of the formats recognized by Date::Parse, and return the number of days, hours, minutes, and seconds elapsed between the two times.

Returned Data format

getInterval returns a hash reference in the same format as parseInterval.

Catching exceptions

upon failure this routine will return the undef value, and an error string will be warn'd to stdout.

Arguments

argument 1 (required)

this should be a date string in any of the formats available to Date::Parse.

argument 2 (required)

this should be a date string in any of the formats available to Date::Parse.

argument 3 (optional)

if this argument is defined it will cause the routine to return a string containing the number of days, hours, minutes, and seconds (see 'String' named parameter to parseInterval).

convertInterval ^

this will convert a given number of days, hours, minutes, or seconds, or any combination thereof to the format specified by the ConverrtTo option.

Returned data

is a number, of time units that you specify on the ConvertTo option

Options

ConvertTo 'days'|'hours'|'minutes'|'seconds'

convert the given time interval to this unit of time measurement, if not specified, the default value is 'seconds'

days

specify number of days

hours

specify number of hours

minutes

specify number of minutes

seconds

specify number of seconds

parseInterval ^

this will convert the given time interval to the number of days, hours, minutes and seconds.

Returned Data Format

unless the 'String' option is specified, this routine returns a has reference containing the following data:

\%data = ( 'days' => $number_of_days, 'hours' => $number_of_hours, 'minutes' => $number_of_minutes, 'seconds' => $number_of_seconds );

Options

days

specify number of days

hours

specify number of hours

minutes

specify number of minutes

seconds

specify number of seconds

String

if this option is specified as a non-zero value a string containing the number of days, hours, minutes, and seconds is returned, for example:

"70 days, 16 hours, 56 minutes, 18 seconds"

coalesce ^

given a set of time intervals (start and end time pairs), this method will return the minimum set based on overlapping time spans. That is, this method will return a list of unique contiguous time intervals from the given list. As with the other methods in this package, time strings may be submitted in any of the formats supported by Date::Parse. Data is returned as it was passed in, as a reference to an array of array references (see below).

Arguments

coalesce takes only one argument, an array reference. The reference should be to an array of array references, each of which contains a start and an end time. For a quick example, take a look at the SYNOPSIS section.

Author: ^

    Andrew N. Hicox     <ahicox@hicox.com>
    http://www.hicox.com
syntax highlighting: