NAME

Net::ICal::Timezone -- class for representing VTIMEZONEs

DESCRIPTION

This module represents VTIMEZONEs, which detail important information about timezones. For any timezone, you need to know some important factors related to it, namely:

• What UTC offset it's in now ('8 hours before GMT')
• What UTC offset it'll be in at the next daylight/standard time shift
• When the shifts to and from daylight savings time take place

This object represents those concepts with arrays of Net::ICal::Standard and Net::ICal::Daylight objects. For more detail on why, see RFC2445 4.6.5.

If you want some real data to test this module against, see http://primates.ximian.com/~damon/icalendar/zoneinfo.tgz , which is a set of VTIMEZONE files that aims to describe every timezone in the world. We'll be relying on those files in a future release as a master timezone database. They're a translation of the Olsen timezone database found on Unix systems.

SYNOPSIS

    use Net::ICal::Timezone;

    # we know this works
    my $tz = Net::ICal::Timezone->new_from_ical($ical_text);
    
    # we haven't tested this yet, patches welcome
    my $tz = Net::ICal::Timezone->new(
        tzid => 'America/New_York',
        standards => [
            (Net::ICal::Standard objects)                    
        ],
        daylights => [
            (Net::ICal::Daylight objects)
        ]
        );

METHODS

new(%args)

Makes a new Timezone object. Permissible arguments are:

• tzid - a unique identifier for this timezone
• lastmod - the last date/time this timezone info was updated
• tzurl - an URL where you can find a newer version of this infi
• standards - an array of Net::ICal::Timezone::Standard objects.
• daylights - an array of N::I::Timezone::Daylight objects.

}; =end testing

new_from_ical ($text)

Takes iCalendar text as a parameter; returns a Net::ICal::Timezone object.

INTERNAL METHODS ONLY

Use these outside this module at your own peril.

validate($self)

This routine validates the creation arguments we were given to make sure that we have all the necessary elements to create a valid VTIMEZONE.

create($class, %args)

This is an internal function that sets up the object. It mainly establishes a Class::MethodMapper data map and hands off creation of the object to Net::ICal::Component.

SEE ALSO

More documentation pointers can be found in Net::ICal.