## [awl] element index

### Package indexes

- davical

All elements
_
top

_EpochFromParts
  iCalDate::_EpochFromParts() in RRule.php
  Given a local text date, convert it to an epoch
_GMTEpochFromParts
  iCalDate::_GMTEpochFromParts() in RRule.php
  Given a GMT text date, convert it to an epoch
_GMTTextFromEpoch
  iCalDate::_GMTTextFromEpoch() in RRule.php
  Given a GMT epoch date, convert it to text
_PartsFromText
  iCalDate::_PartsFromText() in RRule.php
  Given a text date, convert it to parts
_TextFromEpoch
  iCalDate::_TextFromEpoch() in RRule.php
  Given an epoch date, convert it to text
__construct
  Rfc5545Duration::__construct() in RRule-v2.php
  Construct a new Rfc5545Duration either from incoming seconds or a text string.
__construct
  RepeatRuleTimeZone::__construct() in RRule-v2.php
__construct
  RepeatRuleDateRange::__construct() in RRule-v2.php
  Construct a new RepeatRuleDateRange which will be the range between $date1 and $date2. The earliest of the two dates will be used as the start of the period, the latest as the end. If one of the dates is null then the order of the parameters is significant, with the null treated as -infinity if it is first, or +infinity if it is second.
__construct
  RepeatRule::__construct() in RRule-v2.php
__construct
  CalendarInfo::__construct() in caldav-client-v2.php
__construct
  RepeatRuleDateTime::__construct() in RRule-v2.php
__toString
  CalendarInfo::__toString() in caldav-client-v2.php
__toString
  Rfc5545Duration::__toString() in RRule-v2.php
  Returns the duration as a text string of the form ^(-?)P(\d+W)|((\d+D)?(T(\d+H)?(\d+M)?(\d+S)?)?)$
__toString
  RepeatRuleDateTime::__toString() in RRule-v2.php

a
top

AddDays
  iCalDate::AddDays() in RRule.php
  Add some integer number of days to a date
AddDuration
  iCalDate::AddDuration() in RRule.php
  Add duration
AddMonths
  iCalDate::AddMonths() in RRule.php
  Add some number of months to a date
ApplyBySetPos
  iCalDate::ApplyBySetPos() in RRule.php
  Given set position descriptions like '1', '3', '11', '-3' or '-1' and a set, return the subset matching the list of set positions.
AsDate
  RepeatRuleDateTime::AsDate() in RRule-v2.php
asSeconds
  Rfc5545Duration::asSeconds() in RRule-v2.php
  Returns the duration as epoch seconds.

b
top

$base_url
  CalDAVClient::$base_url in caldav-client.php
  Server, username, password, calendar
$body
  CalDAVClient::$body in caldav-client.php

c
top

$calendar
  CalDAVClient::$calendar in caldav-client.php
CalDAVClient
  CalDAVClient::CalDAVClient() in caldav-client.php
  Constructor, initialises the class
CalDAVClient
  CalDAVClient in caldav-client.php
  A class for accessing DAViCal via CalDAV, as a client
CalendarInfo
  CalendarInfo in caldav-client-v2.php
  A class for holding basic calendar information
current
  RepeatRule::current() in RRule-v2.php
caldav-client-v2.php
  caldav-client-v2.php in caldav-client-v2.php
caldav-client.php
  caldav-client.php in caldav-client.php

d
top

$displayname
  CalendarInfo::$displayname in caldav-client-v2.php
DateDifference
  iCalDate::DateDifference() in RRule.php
  Produce an iCalendar format DURATION for the difference between this an another iCalDate
date_mask
  RepeatRule::date_mask() in RRule-v2.php
day
  RepeatRuleDateTime::day() in RRule-v2.php
daysInMonth
  RepeatRuleDateTime::daysInMonth() in RRule-v2.php
  Returns the number of days in a year/month pair
DaysInMonth
  iCalDate::DaysInMonth() in RRule.php
  No of days in a month 1(Jan) - 12(Dec)
DEBUG_RRULE
  DEBUG_RRULE in RRule-v2.php
DoCalendarQuery
  CalDAVClient::DoCalendarQuery() in caldav-client.php
  Given XML for a calendar query, return an array of the events (/todos) in the response. Each event in the array will have a 'href', 'etag' and '$response_type' part, where the 'href' is relative to the calendar and the '$response_type' contains the definition of the calendar data in iCalendar format.
DoDELETERequest
  CalDAVClient::DoDELETERequest() in caldav-client.php
  DELETE a text/icalendar resource
DoGETRequest
  CalDAVClient::DoGETRequest() in caldav-client.php
  Get a single item from the server.
DoOptionsRequest
  CalDAVClient::DoOptionsRequest() in caldav-client.php
  Send an OPTIONS request to the server
DoPUTRequest
  CalDAVClient::DoPUTRequest() in caldav-client.php
  PUT a text/icalendar resource, returning the etag
DoRequest
  CalDAVClient::DoRequest() in caldav-client.php
  Send a request to the server
DoXMLRequest
  CalDAVClient::DoXMLRequest() in caldav-client.php
  Send an XML request to the server (e.g. PROPFIND, REPORT, MKCALENDAR)

e
top

$entry
  CalDAVClient::$entry in caldav-client.php
epoch
  RepeatRuleDateTime::epoch() in RRule-v2.php
equals
  Rfc5545Duration::equals() in RRule-v2.php
  Return true if $this and $other are equal, false otherwise.
expand_event_instances
  expand_event_instances() in RRule-v2.php
  Expand the event instances for an iCalendar VEVENT (or VTODO)

f
top

$Format
  RepeatRuleDateTime::$Format in RRule-v2.php
$from
  RepeatRuleDateRange::$from in RRule-v2.php
FloatOrUTC
  RepeatRuleDateTime::FloatOrUTC() in RRule-v2.php
  If this is a localised time then this will return the UTC equivalent. If it is a floating time, then you will just get the floating time. If it is a date then it will be returned as a date. Note that if it is a *localised* date then the answer will still be the UTC equivalent but only the date itself will be returned.
fromTwoDates
  Rfc5545Duration::fromTwoDates() in RRule-v2.php
  Factory method to return an Rfc5545Duration object from the difference between two dates.

g
top

$getctag
  CalendarInfo::$getctag in caldav-client-v2.php
getComponentRange
  getComponentRange() in RRule-v2.php
  Return a date range for this component.
getDuration
  RepeatRuleDateRange::getDuration() in RRule-v2.php
  Get an Rfc5545Duration from this date range. If the from date is null it will be null.
GetEntryByHref
  CalDAVClient::GetEntryByHref() in caldav-client.php
  Get the calendar entry by HREF
GetEntryByUid
  CalDAVClient::GetEntryByUid() in caldav-client.php
  Get the calendar entry by UID
GetEvents
  CalDAVClient::GetEvents() in caldav-client.php
  Get the events in a range from $start to $finish. The dates should be in the
GetHttpRequest
  CalDAVClient::GetHttpRequest() in caldav-client.php
  Output http request headers
GetHttpResponse
  CalDAVClient::GetHttpResponse() in caldav-client.php
  Output http response headers
GetMonthByDay
  iCalDate::GetMonthByDay() in RRule.php
  Applies any BYDAY to the month to return a set of days
GetMonthByMonthDay
  iCalDate::GetMonthByMonthDay() in RRule.php
  Applies any BYMONTHDAY to the month to return a set of days
GetNext
  RRule::GetNext() in RRule.php
  This is most of the meat of the RRULE processing, where we find the next date.
getTimeZone
  RepeatRuleDateTime::getTimeZone() in RRule-v2.php
GetTodos
  CalDAVClient::GetTodos() in caldav-client.php
  Get the todo's in a range from $start to $finish. The dates should be in the
getVCalendarRange
  getVCalendarRange() in RRule-v2.php
  Return a RepeatRuleDateRange from the earliest start to the latest end of the event.
GetWeekByDay
  iCalDate::GetWeekByDay() in RRule.php
  Applies any BYDAY to the week to return a set of days
GetXmlRequest
  CalDAVClient::GetXmlRequest() in caldav-client.php
  Output xml request
GetXmlResponse
  CalDAVClient::GetXmlResponse() in caldav-client.php
  Output xml response
GreaterThan
  iCalDate::GreaterThan() in RRule.php
  Test if $this is greater than the date parameter

h
top

$headers
  CalDAVClient::$headers in caldav-client.php
$httpRequest
  CalDAVClient::$httpRequest in caldav-client.php
$httpResponse
  CalDAVClient::$httpResponse in caldav-client.php
hasLeapDay
  RepeatRuleDateTime::hasLeapDay() in RRule-v2.php
  Returns a 1 if this year is a leap year, otherwise a 0
hasLimitedOccurrences
  RepeatRule::hasLimitedOccurrences() in RRule-v2.php
  If this repeat rule has an UNTIL= or COUNT= then we can know it will end. Eventually.
hour
  RepeatRuleDateTime::hour() in RRule-v2.php

i
top

iCalDate
  iCalDate::iCalDate() in RRule.php
  The constructor takes either an iCalendar date, a text string formatted as an iCalendar date, or epoch seconds.
iCalDate
  iCalDate in RRule.php
  A Class for handling dates in iCalendar format. We do make the simplifying assumption that all date handling in here is normalised to GMT. One day we might provide some functions to do that, but for now it is done externally.
isDate
  RepeatRuleDateTime::isDate() in RRule-v2.php
isFloating
  RepeatRuleDateTime::isFloating() in RRule-v2.php

k
top

key
  RepeatRule::key() in RRule-v2.php

l
top

LessThan
  iCalDate::LessThan() in RRule.php
  Test if $this is less than the date parameter

m
top

minute
  RepeatRuleDateTime::minute() in RRule-v2.php
modify
  RepeatRuleDateTime::modify() in RRule-v2.php
month
  RepeatRuleDateTime::month() in RRule-v2.php
MonthDays
  iCalDate::MonthDays() in RRule.php
  Given a MonthDays string like "1MO", "-2WE" return an integer day of the month.

n
top

next
  RepeatRule::next() in RRule-v2.php
  Return the next date in the repeating series.

o
top

olson_from_vtimezone
  olson_from_vtimezone() in RRule-v2.php
  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.
overlaps
  RepeatRuleDateRange::overlaps() in RRule-v2.php
  Assess whether this range overlaps the supplied range. null values are treated as infinity.

p
top

$pass
  CalDAVClient::$pass in caldav-client.php
$port
  CalDAVClient::$port in caldav-client.php
$protocol
  CalDAVClient::$protocol in caldav-client.php
ParseResponse
  CalDAVClient::ParseResponse() in caldav-client.php
  Split response into httpResponse and xmlResponse

r
top

$requestMethod
  CalDAVClient::$requestMethod in caldav-client.php
RRule-v2.php
  RRule-v2.php in RRule-v2.php
RRule.php
  RRule.php in RRule.php
rdate_expand
  rdate_expand() in RRule-v2.php
  Expand the event instances for an RDATE or EXDATE property
Render
  iCalDate::Render() in RRule.php
  Set the day of week used for calculation of week starts
RenderGMT
  iCalDate::RenderGMT() in RRule.php
  Render the date as GMT
RepeatRule
  RepeatRule in RRule-v2.php
  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
  RepeatRuleDateRange in RRule-v2.php
  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
  RepeatRuleDateTime in RRule-v2.php
  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
  RepeatRuleTimeZone in RRule-v2.php
  Wrap the DateTimeZone class to allow parsing some iCalendar TZID strangenesses
rewind
  RepeatRule::rewind() in RRule-v2.php
RFC5545
  RepeatRuleDateTime::RFC5545() in RRule-v2.php
  Returns the string following a property name for an RFC5545 DATE-TIME value.
Rfc5545Duration
  Rfc5545Duration in RRule-v2.php
  Provide a useful way of dealing with RFC5545 duration strings of the form
RRule
  RRule::RRule() in RRule.php
  The constructor takes a start date and an RRULE definition. Both of these follow the iCalendar standard.
RRule
  RRule in RRule.php
  A Class for handling Events on a calendar which repeat
rrule_day_number
  RepeatRule::rrule_day_number() in RRule-v2.php
rrule_expand
  rrule_expand() in RRule-v2.php
  Expand the event instances for an RRULE property

s
top

$server
  CalDAVClient::$server in caldav-client.php
second
  RepeatRuleDateTime::second() in RRule-v2.php
setAsDate
  RepeatRuleDateTime::setAsDate() in RRule-v2.php
setAsFloat
  RepeatRuleDateTime::setAsFloat() in RRule-v2.php
SetContentType
  CalDAVClient::SetContentType() in caldav-client.php
  Add a Content-type: header.
setDate
  RepeatRuleDateTime::setDate() in RRule-v2.php
SetDepth
  CalDAVClient::SetDepth() in caldav-client.php
SetEpochDate
  iCalDate::SetEpochDate() in RRule.php
  Set the date from an epoch
SetGMTDate
  iCalDate::SetGMTDate() in RRule.php
  Set the date from a text string
SetLocalDate
  iCalDate::SetLocalDate() in RRule.php
  Set the date from a text string
SetMatch
  CalDAVClient::SetMatch() in caldav-client.php
  Adds an If-Match or If-None-Match header
SetMonthDay
  iCalDate::SetMonthDay() in RRule.php
  Set the day in the month to what we have been given
setTimeZone
  RepeatRuleDateTime::setTimeZone() in RRule-v2.php
SetUserAgent
  CalDAVClient::SetUserAgent() in caldav-client.php
  Add a Depth: header. Valid values are 1 or infinity
SetWeekStart
  iCalDate::SetWeekStart() in RRule.php
  Set the day of week used for calculation of week starts
setYearDay
  RepeatRuleDateTime::setYearDay() in RRule-v2.php
set_timezone
  RepeatRule::set_timezone() in RRule-v2.php
Start
  RepeatRule::Start() in RRule-v2.php

t
top

TestByMonth
  iCalDate::TestByMonth() in RRule.php
  Test to see if our _mo matches something in the list of months we have received.
tzid
  RepeatRuleTimeZone::tzid() in RRule-v2.php

u
top

$until
  RepeatRuleDateRange::$until in RRule-v2.php
$url
  CalendarInfo::$url in caldav-client-v2.php
$user
  CalDAVClient::$user in caldav-client.php
$user_agent
  CalDAVClient::$user_agent in caldav-client.php
  The useragent which is send to the caldav server
UTC
  RepeatRuleDateTime::UTC() in RRule-v2.php
  Always returns a time localised to UTC. Even floating times are converted to UTC using the server's currently configured PHP timezone. Even dates will include a time, which will be non-zero if they were localised dates.

v
top

valid
  RepeatRule::valid() in RRule-v2.php

w
top

WithinScope
  RRule::WithinScope() in RRule.php
  Processes the array of $relative_days to $base and removes any which are not within the scope of our rule.

x
top

$xmlRequest
  CalDAVClient::$xmlRequest in caldav-client.php
$xmlResponse
  CalDAVClient::$xmlResponse in caldav-client.php

y
top

year
  RepeatRuleDateTime::year() in RRule-v2.php