Overview

Packages

  • awl
    • caldav-client-v2
    • RRule
  • davical
    • authentication
      • drivers
    • caldav
    • DAViCalSession
    • DAVTicket
    • external-bind
    • feed
    • HTTPAuthSession
    • iSchedule
    • iSchedule-POST
    • logging
    • metrics
    • Principal
    • propfind
    • PublicSession
    • Request
    • Resource
    • tzservice
  • None

Classes

  • RepeatRule
  • RepeatRuleDateRange
  • RepeatRuleDateTime
  • RepeatRuleTimeZone
  • Rfc5545Duration

Functions

  • expand_event_instances
  • getComponentRange
  • getVCalendarRange
  • olson_from_vtimezone
  • rdate_expand
  • rrule_expand
  • Overview
  • Package
  • Class
  • Tree
  • Deprecated
  • Todo

Package awl\RRule

Classes summary
RepeatRule

This class is an implementation of RRULE parsing and expansion, as per RFC5545. It should be reasonably complete, except that it does not handle changing the WKST - there may be a few errors in unusual rules also, but all of the common cases should be handled correctly.

RepeatRuleDateRange

This class is used to hold a pair of dates defining a range. The range may be open-ended by including a null for one end or the other, or both.

RepeatRuleDateTime

Wrap the DateTime class to make it friendlier to passing in random strings from iCalendar objects, and especially the random stuff used to identify timezones. We also add some utility methods and stuff too, in order to simplify some of the operations we need to do with dates.

RepeatRuleTimeZone Wrap the DateTimeZone class to allow parsing some iCalendar TZID strangenesses
Rfc5545Duration

Provide a useful way of dealing with RFC5545 duration strings of the form ^-?P(\dW)|((\dD)?(T(\dH)?(\dM)?(\dS)?)?)$

Functions summary
expand_event_instances Expand the event instances for an iCalendar VEVENT (or VTODO)
getComponentRange Return a date range for this component.
getVCalendarRange Return a RepeatRuleDateRange from the earliest start to the latest end of the event.
olson_from_vtimezone

Try and extract something like "Pacific/Auckland" or "America/Indiana/Indianapolis" if possible, given the VTIMEZONE component that is passed in. This is much more complex than olson_from_tzstring since we start to examine the rules and work out what actual timezone this might be.

rdate_expand Expand the event instances for an RDATE or EXDATE property
rrule_expand Expand the event instances for an RRULE property
DAViCal API documentation generated by ApiGen