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.

dtstart

This datetime is not included in the recurrence, unless it satisfies the recurrence's rules.

A set can thus be used for creating exclusion rules (rfc2445 exrule), which don't include dtstart.

until

count

freq

   "yearly", "monthly", "weekly", "daily",
   "hourly", "minutely", "secondly"

See the DateTime::Event::Recurrence documentation for more details on what these mean.

interval

So if you specify a ``freq'' of ``yearly'' and an ``interval'' of 3, that means a recurrence that occurs every three years.

wkst

Note: this parameter is not yet implemented

bysecond => [ list ], byminute => [ list ], byhour => [ list ]