Binary.com

NAME

Time::Duration::Concise

DESCRIPTION

Time::Duration::Concise is an improved approach to convert concise time duration to string representation.

VERSION

Version 1.3

SYNOPSIS

    use Time::Duration::Concise;

    my $duration = Time::Duration::Concise->new(
        interval => '1h20m'
    );

    # Intervals can have decimal values
    1.5h etc

    my $duration = Time::Duration::Concise->new(
        interval => '1.5h'
    );

FIELDS

interval (REQUIRED)

Concise Format

The format is an integer followed immediatley by its duration identifier. White-space will be ignored.

The following table explains the format.

  identifier   duration
  ----------   --------
           d   day
           h   hour
           m   minute
           s   second

# Intervals can have decimal values Example : 1.5h

METHODS

interval

Returns the given time interval.

seconds

The number of seconds represented by this time interval.

minutes

The number of minutes represented by this time interval.

hours

The number of hours represented by this time interval.

days

The number of days represented by this time interval.

weeks

The number of week represented by this time interval.

months

The number of months represented by this time interval.

as_string

Concise time druation to string representation.

as_concise_string

Concise time druation to conscise string representation.

normalized_code

The largest division of Duration

duration_array

Concise time druation to array

[ { value => 1, unit => 'day' }, { value => 2, unit => 'hours' } ]

multiple_units_of

Shorthand to call time methods

minimum_number_of

Returns the minimum number of the given period.

duration

Returns HASH of duration with the following keys

            'time'    # Time::Seconds object
            'years'   
            'months'  
            'weeks'   
            'days'    
            'hours'   
            'minutes' 
            'seconds' 

get_time_layout

Return the duration hash with regards to precision

new

Object constructor

AUTHOR

Binary.com, <perl at binary.com>

BUGS

Please report any bugs or feature requests to bug-time-duration-concise-localize at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Time-Duration-Concise-Localize. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

    perldoc Time::Duration::Concise

You can also look for information at:

LICENSE AND COPYRIGHT

Copyright 2014 Binary.com.

This program is free software; you can redistribute it and/or modify it under the terms of the the Artistic License (2.0). You may obtain a copy of the full license at:

http://www.perlfoundation.org/artistic_license_2_0

Any use, modification, and distribution of the Standard or Modified Versions is governed by this Artistic License. By using, modifying or distributing the Package, you accept this license. Do not use, modify, or distribute the Package, if you do not accept this license.

If your Modified Version has been derived from a Modified Version made by someone other than you, you are nevertheless required to ensure that your Modified Version complies with the requirements of this license.

This license does not grant you the right to use any trademark, service mark, tradename, or logo of the Copyright Holder.

This license includes the non-exclusive, worldwide, free-of-charge patent license to make, have made, use, offer to sell, sell, import and otherwise transfer the Package with respect to any patent claims licensable by the Copyright Holder that are necessarily infringed by the Package. If you institute patent litigation (including a cross-claim or counterclaim) against any party alleging that the Package constitutes direct or contributory patent infringement, then this Artistic License to you shall terminate on the date that such litigation is filed.

Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.