NAME
DateTime::Event::Recurrence - DateTime::Set extension for computing basic recurrences.
SYNOPSIS
use DateTime;
use DateTime::Event::Recurrence;
my $dt = DateTime->new( year => 2000,
month => 6,
day => 20,
);
my $daily_set = DateTime::Event::Recurrence->daily;
my $dt_next = $daily_set->next( $dt );
my $dt_previous = $daily_set->previous( $dt );
my $bool = $daily_set->contains( $dt );
my @days = $daily_set->as_list( start => $dt1, end => $dt2 );
my $iter = $daily_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 common recurrences, such as "once a month" or "every day".
USAGE
yearly monthly weekly daily hourly minutely secondly
These methods all return a
DateTime::Setobject representing the given recurrence.my $daily_set = DateTime::Event::Recurrence->daily;If no parameters are given, then the set members each occur at the beginning of each recurrence.
For example, by default the
monthly()method returns a set where each member is the first day of the month.Without parameters, the
weekly()method returns a set containing Mondays.However, you can pass in parameters to alter where these datetimes fall. The parameters are the same as those given to the
DateTime::Durationconstructor for specifying the length of a duration. For example, to create a set representing a daily recurrence at 10:30 each day, we can do:my $daily_at_10_30_set = DateTime::Event::Recurrence->daily( hours => 10, minutes => 30 );To represent every Tuesday (second day of week):
my $weekly_on_tuesday_set = DateTime::Event::Recurrence->weekly( days => 2 );A negative duration counts backwards from the end of the period. This is done in the same manner as is specified in RFC 2445 (iCal).
This is useful for creating recurrences such as the last day of month:
my $last_day_of_month_set = DateTime::Event::Recurrence->monthly( days => -1 );When days are added to a month the result is checked for month overflow (such as a nonexisting day 31 or 30), and invalid datetimes are skipped.
The behaviour when other duration overflows occur is undefined, so don't do that. An example of this would be creating a set via the
daily()method and specifyinghours => 25.Invalid parameter values are usually skipped.
Note that the "hours" duration is affected by DST changes and might return unexpected results. In particular, it would be possible to specify a recurrence that creates nonexistent datetimes. Because
DateTime.pmthrows an exception if asked to create a non-existent datetime, please be careful when specifying a duration with "hours".The best way to ensure that this is not a problem is to use the "UTC" or "floating" time zones when providing
DateTimeobjects to the set'snext()orprevious()methods.The value
60for seconds (the leap second) is ignored. If you really want the leap second, then specify the second as-1.You can also provide multiple sets of duration arguments, such as this:
my $set = DateTime::Event::Recurrence->daily ( hours => [ 10, 14, -1 ], minutes => [ 15, 30, -15 ], );This specifies a recurrence occuring every day at these 9 different times:
10:15, 10:30, 10:45, # +10h ( +15min / +30min / last 15min (-15) ) 14:15, 14:30, 14:45, # +14h ( +15min / +30min / last 15min (-15) ) 23:15, 23:30, 23:45, # last 1h (-1) ( +15min / +30min / last 15min (-15) )To create a set of recurrences occuring every thirty seconds, we could do this:
my $every_30_seconds_set = DateTime::Event::Recurrence->minutely( seconds => [ 0, 30 ] );
"interval" and "start" parameters
The "interval" parameter represents how often the recurrence rule repeats. The optional "start" parameter specifies where to start counting:
my $dt = DateTime->new( year => 2003, month => 6, day => 15 );
my $set = DateTime::Event::Recurrence->daily
( interval => 11,
hours => 10,
minutes => 30,
start => $dt,
);This specifies a recurrence that happens at 10:30 on the day specified by start => $dt, and then every 11 days before and after $dt. So we get a set like this:
...
2003-06-04T10:30:00,
2003-06-15T10:30:00,
2003-06-26T10:30:00,
...In this case, the method is used to specify the unit, so daily() means that our unit is a day, and interval => 11 specifies the quantity of our unit.
"week start day" parameter
The week_start_day parameter is intended for internal use by the DateTime::Event::ICal module, for generating RFC2445 recurrences.
The week_start_day represents how the 'first week' of a period is calculated:
"mo" - this is the default. The first week is one that starts in monday, and has the most days in this period.
"tu", "we", "th", "fr", "sa", "su" - The first week is one that starts in this week-day, and has the most days in this period. Works for weekly and yearly recurrences.
"1tu", "1we", "1th", "1fr", "1sa", "1su" - The first week is one that starts in this week-day, and has all days in this period. This works for weekly(), monthly() and yearly() recurrences.
AUTHOR
Flavio Soibelmann Glock fglock@pucrs.br
CREDITS
The API was developed with help from the people in the datetime@perl.org list.
Special thanks to Dave Rolsky, Ron Hill and Matt Sisk for being around with ideas.
If you can understand what this module does by reading the docs, you should thank Dave Rolsky. If you can't understand it, yell at him. He also helped removing weird idioms from the code.
Jerrad Pierce came with the idea to move "interval" from DateTime::Event::ICal to here.
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 - date and time :)
DateTime::Set - for recurrence-set accessors docs. You can use DateTime::Set to specify recurrences using callback subroutines.
DateTime::Event::ICal - if you need more complex recurrences.
DateTime::SpanSet - sets of intervals, including recurring sets of intervals.