DateTime::Event::ICal - Perl DateTime extension for computing rfc2445 recurrences.


NAME

DateTime::Event::ICal - Perl DateTime extension for computing rfc2445 recurrences.


SYNOPSIS

 use DateTime;
 use DateTime::Event::ICal;
 
 my $dt = DateTime->new( year   => 2000,
                         month  => 6,
                         day    => 20,
                       );
 my $set = DateTime::Event::ICal->recur( 
      dtstart => $dt,
      freq =>    'daily',
      bymonth => [ 10, 12 ],
      byhour =>  [ 10 ]
 );
 my $dt_next = $set->next( $dt );
 my $dt_previous = $set->previous( $dt );
 my $bool = $set->contains( $dt );
 my @days = $set->as_list( start => $dt1, end => $dt2 );
 my $iter = $set->iterator;
 while ( my $dt = $iter->next ) {
     print ' ', $dt->datetime;
 }


DESCRIPTION

This module provides convenience methods that let you easily create DateTime::Set objects for rfc2445 style recurrences.


USAGE

recur
This method returns a DateTime::Set object representing the given recurrence.
  my $set = DateTime::Event::ICal->recur( %args );

This method takes parameters which correspond to the rule parts specified in section 4.3.10 of RFC 2445. Rather than rewrite that RFC here, you are encouraged to read that first if you want to understand what all these parameters represent.


AUTHOR

Flavio Soibelmann Glock fglock@pucrs.br


CREDITS

The API was developed with help from the people in the datetime@perl.org list.


COPYRIGHT

Copyright (c) 2003 Flavio Soibelmann Glock. All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

The full text of the license can be found in the LICENSE file included with this module.


SEE ALSO

datetime@perl.org mailing list

DateTime Web page at http://datetime.perl.org/

DateTime

DateTime::Event::Recurrence - simple rule-based recurrences

DateTime::Format::ICal - can parse rfc2445 recurrences

DateTime::Set - recurrences defined by callback subroutines

DateTime::Event::Cron - recurrences defined by ``cron'' rules

DateTime::SpanSet

RFC2445 - Internet Calendaring and Scheduling Core Object Specification - http://www.ietf.org/rfc/rfc2445.txt

 DateTime::Event::ICal - Perl DateTime extension for computing rfc2445 recurrences.