`Web::DateTime::Duration`

Durations for Web

SYNOPSIS

  use Web::DateTime::Duration;
  $duration = Web::DateTime::Duration->new_from_seconds (6 * 60);
  warn $duration->to_duration_string;

DESCRIPTION

The Web::DateTime::Duration class represents a duration, i.e. a length of time. A duration is a tuple of (number of seconds, number of months, direction).

METHODS

$duration = Web::DateTime::Duration->new_from_seconds ($number)

Create a new duration object with the specified number of seconds. Number of months is set to zero. The direction is set by the sign of the specified number. The number of seconds can have a fractional part.

$duration = Web::DateTime::Duration->new_from_seconds_and_months_and_sign ($number, $number, $sign)

Create a new duration object. The first argument must be the number of seconds (non-negative), which can have a fractional part. The second argument must be the number of months, which is a non-negative integer. The third argument must be the direction, which is one of number +1 (positive) or number -1 (negative).

false = $duration->is_date_time

false = $duration->is_time_zone

true = $duration->is_duration

false = $duration->is_interval

Return whether the object is of the specified type or not.

$number = $duration->seconds

Return the number of seconds, which might have a fractional part. The value is always non-negative.

$number = $duration->months

Return the number of months. The value is always a non-negative integer.

$sign = $duration->sign

Return the sign of the duration. The returned value is either number +1 (positive) or -1 (negative).

$string = $duration->to_duration_string

Return an HTML valid duration string [HTML] representing the duration of the object, ignoring the direction. Please note that if the duration has a non-zero number of months, undef is returned instead, as the format cannot encode the number of months.

$string = $duration->to_vevent_duration_string

Return an HTML valid vevent duration string [HTML] representing the duration of the object, ignoring the direction and the fractional part of the seconds. Please note that of the duration has a non-zero number of months, undef is returned instead, as the format cannot encode the number of months.

$string = $duration->to_xs_duration

Return an XML Schema xs:duration string [XSDT] representing the duration of the object.

The return value is, in most cases, a valid http://schema.org/Duration item value.

SPECIFICATIONS

HTML: HTML Standard <http://www.whatwg.org/specs/web-apps/current-work/>.
XSDT: W3C XML Schema Definition Language (XSD) 1.1 Part 2: Datatypes <http://www.w3.org/TR/xmlschema11-2/>.

AUTHOR

Wakaba <wakaba@suikawiki.org>.

LICENSE

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

The manakai project

Web::DateTime::Duration