[awl] element index

Package indexes

All elements
a b c d e f g h i k l m n o p r s t u v w x y _
_
top
Method _EpochFromParts
Given a local text date, convert it to an epoch
Method _GMTEpochFromParts
Given a GMT text date, convert it to an epoch
Method _GMTTextFromEpoch
Given a GMT epoch date, convert it to text
Method _PartsFromText
Given a text date, convert it to parts
Method _TextFromEpoch
Given an epoch date, convert it to text
Method __construct
Construct a new Rfc5545Duration either from incoming seconds or a text string.
Method __construct
Method __construct
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.
Method __construct
Method __construct
CalendarInfo::__construct() in caldav-client-v2.php
Method __construct
Method __toString
CalendarInfo::__toString() in caldav-client-v2.php
Method __toString
Returns the duration as a text string of the form ^(-?)P(\d+W)|((\d+D)?(T(\d+H)?(\d+M)?(\d+S)?)?)$
Method __toString
a
top
Method AddDays
iCalDate::AddDays() in RRule.php
Add some integer number of days to a date
Method AddDuration
Add duration
Method AddMonths
Add some number of months to a date
Method ApplyBySetPos
Given set position descriptions like '1', '3', '11', '-3' or '-1' and a set, return the subset matching the list of set positions.
Method AsDate
Method asSeconds
Returns the duration as epoch seconds.
b
top
Variable $base_url
CalDAVClient::$base_url in caldav-client.php
Server, username, password, calendar
Variable $body
CalDAVClient::$body in caldav-client.php
c
top
Variable $calendar
CalDAVClient::$calendar in caldav-client.php
Method CalDAVClient
CalDAVClient::CalDAVClient() in caldav-client.php
Constructor, initialises the class
Class CalDAVClient
CalDAVClient in caldav-client.php
A class for accessing DAViCal via CalDAV, as a client
Class CalendarInfo
CalendarInfo in caldav-client-v2.php
A class for holding basic calendar information
Method current
RepeatRule::current() in RRule-v2.php
Page caldav-client-v2.php
caldav-client-v2.php in caldav-client-v2.php
Page caldav-client.php
caldav-client.php in caldav-client.php
d
top
Variable $displayname
CalendarInfo::$displayname in caldav-client-v2.php
Method DateDifference
Produce an iCalendar format DURATION for the difference between this an another iCalDate
Method date_mask
RepeatRule::date_mask() in RRule-v2.php
Method day
Method daysInMonth
Returns the number of days in a year/month pair
Method DaysInMonth
No of days in a month 1(Jan) - 12(Dec)
Constant DEBUG_RRULE
DEBUG_RRULE in RRule-v2.php
Method 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.
Method DoDELETERequest
CalDAVClient::DoDELETERequest() in caldav-client.php
DELETE a text/icalendar resource
Method DoGETRequest
CalDAVClient::DoGETRequest() in caldav-client.php
Get a single item from the server.
Method DoOptionsRequest
Send an OPTIONS request to the server
Method DoPUTRequest
CalDAVClient::DoPUTRequest() in caldav-client.php
PUT a text/icalendar resource, returning the etag
Method DoRequest
CalDAVClient::DoRequest() in caldav-client.php
Send a request to the server
Method DoXMLRequest
CalDAVClient::DoXMLRequest() in caldav-client.php
Send an XML request to the server (e.g. PROPFIND, REPORT, MKCALENDAR)
e
top
Variable $entry
CalDAVClient::$entry in caldav-client.php
Method epoch
Method equals
Return true if $this and $other are equal, false otherwise.
Function expand_event_instances
expand_event_instances() in RRule-v2.php
Expand the event instances for an iCalendar VEVENT (or VTODO)
f
top
Variable $Format
Variable $from
Method FloatOrUTC
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.
Method fromTwoDates
Factory method to return an Rfc5545Duration object from the difference between two dates.
g
top
Variable $getctag
CalendarInfo::$getctag in caldav-client-v2.php
Function getComponentRange
getComponentRange() in RRule-v2.php
Return a date range for this component.
Method getDuration
Get an Rfc5545Duration from this date range. If the from date is null it will be null.
Method GetEntryByHref
CalDAVClient::GetEntryByHref() in caldav-client.php
Get the calendar entry by HREF
Method GetEntryByUid
CalDAVClient::GetEntryByUid() in caldav-client.php
Get the calendar entry by UID
Method GetEvents
CalDAVClient::GetEvents() in caldav-client.php
Get the events in a range from $start to $finish. The dates should be in the
Method GetHttpRequest
CalDAVClient::GetHttpRequest() in caldav-client.php
Output http request headers
Method GetHttpResponse
CalDAVClient::GetHttpResponse() in caldav-client.php
Output http response headers
Method GetMonthByDay
Applies any BYDAY to the month to return a set of days
Method GetMonthByMonthDay
Applies any BYMONTHDAY to the month to return a set of days
Method GetNext
RRule::GetNext() in RRule.php
This is most of the meat of the RRULE processing, where we find the next date.
Method getTimeZone
Method GetTodos
CalDAVClient::GetTodos() in caldav-client.php
Get the todo's in a range from $start to $finish. The dates should be in the
Function getVCalendarRange
getVCalendarRange() in RRule-v2.php
Return a RepeatRuleDateRange from the earliest start to the latest end of the event.
Method GetWeekByDay
Applies any BYDAY to the week to return a set of days
Method GetXmlRequest
CalDAVClient::GetXmlRequest() in caldav-client.php
Output xml request
Method GetXmlResponse
CalDAVClient::GetXmlResponse() in caldav-client.php
Output xml response
Method GreaterThan
Test if $this is greater than the date parameter
h
top
Variable $headers
CalDAVClient::$headers in caldav-client.php
Variable $httpRequest
CalDAVClient::$httpRequest in caldav-client.php
Variable $httpResponse
CalDAVClient::$httpResponse in caldav-client.php
Method hasLeapDay
Returns a 1 if this year is a leap year, otherwise a 0
Method hasLimitedOccurrences
If this repeat rule has an UNTIL= or COUNT= then we can know it will end. Eventually.
Method hour
i
top
Method iCalDate
The constructor takes either an iCalendar date, a text string formatted as an iCalendar date, or epoch seconds.
Class 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.
Method isDate
Method isFloating
k
top
Method key
RepeatRule::key() in RRule-v2.php
l
top
Method LessThan
Test if $this is less than the date parameter
m
top
Method minute
Method modify
Method month
Method MonthDays
Given a MonthDays string like "1MO", "-2WE" return an integer day of the month.
n
top
Method next
RepeatRule::next() in RRule-v2.php
Return the next date in the repeating series.
o
top
Function 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.
Method overlaps
Assess whether this range overlaps the supplied range. null values are treated as infinity.
p
top
Variable $pass
CalDAVClient::$pass in caldav-client.php
Variable $port
CalDAVClient::$port in caldav-client.php
Variable $protocol
CalDAVClient::$protocol in caldav-client.php
Method ParseResponse
CalDAVClient::ParseResponse() in caldav-client.php
Split response into httpResponse and xmlResponse
r
top
Variable $requestMethod
CalDAVClient::$requestMethod in caldav-client.php
Page RRule-v2.php
RRule-v2.php in RRule-v2.php
Page RRule.php
RRule.php in RRule.php
Function rdate_expand
rdate_expand() in RRule-v2.php
Expand the event instances for an RDATE or EXDATE property
Method Render
iCalDate::Render() in RRule.php
Set the day of week used for calculation of week starts
Method RenderGMT
Render the date as GMT
Class 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.
Class 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.
Class 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.
Class RepeatRuleTimeZone
RepeatRuleTimeZone in RRule-v2.php
Wrap the DateTimeZone class to allow parsing some iCalendar TZID strangenesses
Method rewind
RepeatRule::rewind() in RRule-v2.php
Method RFC5545
Returns the string following a property name for an RFC5545 DATE-TIME value.
Class Rfc5545Duration
Rfc5545Duration in RRule-v2.php
Provide a useful way of dealing with RFC5545 duration strings of the form
Method RRule
RRule::RRule() in RRule.php
The constructor takes a start date and an RRULE definition. Both of these follow the iCalendar standard.
Class RRule
RRule in RRule.php
A Class for handling Events on a calendar which repeat
Method rrule_day_number
Function rrule_expand
rrule_expand() in RRule-v2.php
Expand the event instances for an RRULE property
s
top
Variable $server
CalDAVClient::$server in caldav-client.php
Method second
Method setAsDate
Method setAsFloat
Method SetContentType
CalDAVClient::SetContentType() in caldav-client.php
Add a Content-type: header.
Method setDate
Method SetDepth
CalDAVClient::SetDepth() in caldav-client.php
Method SetEpochDate
Set the date from an epoch
Method SetGMTDate
Set the date from a text string
Method SetLocalDate
Set the date from a text string
Method SetMatch
CalDAVClient::SetMatch() in caldav-client.php
Adds an If-Match or If-None-Match header
Method SetMonthDay
Set the day in the month to what we have been given
Method setTimeZone
Method SetUserAgent
CalDAVClient::SetUserAgent() in caldav-client.php
Add a Depth: header. Valid values are 1 or infinity
Method SetWeekStart
Set the day of week used for calculation of week starts
Method setYearDay
Method set_timezone
Method Start
RepeatRule::Start() in RRule-v2.php
t
top
Method TestByMonth
Test to see if our _mo matches something in the list of months we have received.
Method tzid
u
top
Variable $until
Variable $url
CalendarInfo::$url in caldav-client-v2.php
Variable $user
CalDAVClient::$user in caldav-client.php
Variable $user_agent
CalDAVClient::$user_agent in caldav-client.php
The useragent which is send to the caldav server
Method UTC
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
Method valid
RepeatRule::valid() in RRule-v2.php
w
top
Method WithinScope
Processes the array of $relative_days to $base and removes any which are not within the scope of our rule.
x
top
Variable $xmlRequest
CalDAVClient::$xmlRequest in caldav-client.php
Variable $xmlResponse
CalDAVClient::$xmlResponse in caldav-client.php
y
top
Method year
a b c d e f g h i k l m n o p r s t u v w x y _