|
Data::ICal::DateTime - convenience methods for using Data::ICal with DateTime |
Data::ICal::DateTime - convenience methods for using Data::ICal with DateTime
# performs mixin voodoo
use Data::ICal::DateTime;
my $cal = Data::ICal->new( filename => 'example.ics');
my $date1 = DateTime->new( year => 2005, month => 7, day => 01 );
my $date2 = DateTime->new( year => 2005, month => 7, day => 07 );
my $span = DateTime::Span->from_datetimes( start => $date1, end => $date2 );
my @events = $cal->events(); # all VEVENTS
my @week = $cal->events($span); # just in that week
my @week = $cal->events($span,'day');# explode long events into days
my $event = Data::ICal::Entry::Event->new();
$event->start($start); # $start is a DateTime object
$event->end($end); # so is $end
$event->all_day # is this an all day event
$event->duration($duration); # $duration is DateTime::Duration
$event->recurrence($recurrence); # $reccurence is a DateTime list,
# a DateTime::Span list,
# a DateTime::Set,
# or a DateTime::SpanSet
$event->start; # returns a DateTime object
$event->end; # ditto
$event->duration; # returns a DateTime::Duration
$event->recurrence; # returns a DateTime::Set
$event->period; # returns a DateTime::Span object
$event->rdate; # returns a DateTime::Set
$event->exrule; # returns a DateTime::Set
$event->exdate; # returns a DateTime::Set
$event->explode($span); # returns an array of sub events
# (if this is recurring);
$event->explode($span,'week'); # if any events are longer than a
# week then split them up
$event->is_in($span); # whether this event falls within a
# Set, Span, or SetSpan
$cal->add($event);
methods
Provides a the Data::ICal manpage object with a method to return all events.
If a the DateTime::Set manpage, the DateTime::Span manpage or the DateTime::SpanSet manpage object is passed then only the events that occur within that set will be returned including expansion of all recurring events. All events will be normalised to have a dtstart and dtend rather than any other method of determining their start and stop time.
Additionally you can pass a period string which can be one of the following
year month week day hour minute second
This will explode an event into as many sub events as needed e.g a period of 'day' will explode a 2-day event into 2 one day events with the second starting just after the first
Provides a the Data::ICal manpage object with a method to collapse recurrence-ids.
Given a list of events, some of which might have recurrence-ids,
return a list of events with all recurrences within span and all
recurrence-ids handled correctly.
Used internally by events.
Returns a DateTime object representing the start time of this event.
May return undef.
If passed a DateTime object will set that to be the new start time.
Returns a DateTime object representing the end time of this event.
May return undef.
If passed a DateTime object will set that to be the new end time.
Returns 1 if event is all day or 0 if not.
If no end has been set and 1 is passed then will set end to be a nanosecond before midnight the next day.
An event is considered floating if it has a start but no end. It is intended to represent an event that is associated with a given calendar date and time of day, such as an anniversary and should not be considered as taking up any amount of time.
Returns 1 if the evnt is floating and 0 if it isn't.
If passed a 1 then will set the event to be floating by deleting the end time.
If passed a 0 and no end is currently set then it will set end to be a nanosecond before midnight the next day.
Returns a the DateTime::Duration manpage object representing the duration of this event.
May return undef.
If passed a the DateTime::Duration manpage object will set that to be the new duration.
Returns a the DateTime::Span manpage object representing the period of this event.
May return undef.
If passed a the DateTime::Span manpage object will set that to be the new period.
Returns a the DateTime::Set manpage object representing the union of all the
RRULEs in this object.
May return undef.
If passed one or more DateTime lists, the DateTime::Span manpage lists, the DateTime::Set manpages, or the DateTime::SpanSet manpages then set the recurrence rules to be those.
Returns a the DateTime::Set manpage object representing the set of all RDATEs in the object.
May return undef.
Returns a the DateTime::Set manpage object representing the union of all the
EXRULEs in this object.
May return undef.
If passed one or more DateTime lists, the DateTime::Span manpage lists, the DateTime::Set manpages, or the DateTime::SpanSet manpages then set the recurrence exclusion rules to be those.
Returns a the DateTime::Set manpage object representing the set of all RDATEs in the object.
May return undef.
Returns a DateTime object representing the recurrence-id of this event.
May return undef.
If passed a DateTime object will set that to be the new recurrence-id.
Returns the uid of this event.
If passed a new value then sets that to be the new uid value.
Returns a string representing the summary of this event.
May return undef.
If passed a new value then sets that to be the new summary (and will escape all relevant characters).
Returns a string representing the summary of this event.
May return undef.
If passed a new value then sets that to be the new description (and will escape all relevant characters).
Takes the DateTime::Set manpage, the DateTime::Span manpage or the DateTime::SpanSet manpage and returns an array of events.
If this is not a recurring event, and it falls with the span, then it will return one event with the dtstart and dtend properties set and no other time information.
If this is a recurring event then it will return all times that this recurs within the span. All returned events will have the dtstart and dtend properties set and no other time information.
If period is optionally passed then events longer than period will
be exploded into multiple events.
period can be any of the following
year month week day hour minute second
Store or fetch a reference to the original event this was derived from.
Split an n-period event into n 1-period events.
Takes the DateTime::Set manpage, the DateTime::Span manpage or the DateTime::SpanSet manpage and returns whether this event can fall within that time frame.
Simon Wistow <simon@thegestalt.org>
Copyright, 2005 Simon Wistow
Distributed under the same terms as Perl itself.
Potential timezone problems?
DateTime, the DateTime::Set manpage, the Data::ICal manpage, the Text::vFile::asData manpage, the iCal::Parser manpage
|
Data::ICal::DateTime - convenience methods for using Data::ICal with DateTime |