CalDAVClient
+
+
+A class for accessing DAViCal via CalDAV, as a client
++ Located in /inc/caldav-client.php (line 55) +
+ + + + +
+ CalDAVClient
+ CalDAVClient
+ (string $base_url, string $user, string $pass, string $calendar)
+ 
+ array
+ DoCalendarQuery
+ (string $filter, [string $relative_url = ''], [ $reponse_type = 'data'], string $report_type)
+
+ array
+ DoXMLRequest
+ ( $request_method, string $xml, [string $relative_url = ''], string $method)
+
+ array
+ GetTodos
+ (timestamp $start, timestamp $finish, [boolean $completed = false], [boolean $cancelled = false], [string $relative_url = ""])
+ 
+
+ string
+ $base_url
+ (line 61)
+
+ Server, username, password, calendar, $entry
+ + + + + +
+
+ mixed
+ $body
+ = "" (line 71)
+
+
+
+ mixed
+ $calendar
+ (line 61)
+
+
+
+ resource
+ $curl
+ (line 78)
+
+ Our cURL connection
+ + + + + +
+
+ mixed
+ $entry
+ (line 61)
+
+
+
+ mixed
+ $headers
+ = array() (line 70)
+
+
+
+ mixed
+ $pass
+ (line 61)
+
+
+
+ mixed
+ $user
+ (line 61)
+
+
+
+ string
+ $user_agent
+ = 'DAViCalClient' (line 68)
+
+ The useragent which is send to the caldav server
+ + + + + +
+ Constructor CalDAVClient (line 89)
+ Constructor, initialises the class
+ +-
+
- + string + $base_url: The URL for the calendar server +
- + string + $user: The name of the user logging in +
- + string + $pass: The password for that user +
- + string + $calendar: The name of the calendar (not currently used) +
+ DoCalendarQuery (line 301)
+ 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.
+ + +-
+
- + string + $filter: XML fragment which is the <filter> element of a calendar-query +
- + string + $relative_url: The URL relative to the base_url specified when the calendar was opened. Default ''. +
- + string + $report_type: Used as a name for the array element containing the calendar data. @deprecated +
- + + $reponse_type +
+ DoDELETERequest (line 274)
+ DELETE a text/icalendar resource
+ + +-
+
- + string + $relative_url: The URL to make the request to, relative to $base_url +
- + string + $etag: The etag of an existing resource to be deleted, or '*' for any resource at that URL. +
+ DoGETRequest (line 229)
+ Get a single item from the server.
+ +-
+
- + string + $relative_url: The part of the URL after the calendar +
+ DoOptionsRequest (line 192)
+ Send an OPTIONS request to the server
+ + +-
+
- + string + $relative_url: The URL to make the request to, relative to $base_url +
+ DoPUTRequest (line 246)
+ PUT a text/icalendar resource, returning the etag
+ + +-
+
- + string + $relative_url: The URL to make the request to, relative to $base_url +
- + string + $icalendar: The iCalendar resource to send to the server +
- + string + $etag: The etag of an existing resource to be overwritten, or '*' for a new resource. +
+ DoRequest (line 151)
+ Send a request to the server
+ + +-
+
- + string + $relative_url: The URL to make the request to, relative to $base_url +
+ DoXMLRequest (line 213)
+ Send an XML request to the server (e.g. PROPFIND, REPORT, MKCALENDAR)
+ + +-
+
- + string + $method: The method (PROPFIND, REPORT, etc) to use with the request +
- + string + $xml: The XML to send along with the request +
- + string + $relative_url: The URL to make the request to, relative to $base_url +
- + + $request_method +
+ GetEntryByHref (line 457)
+ Get the calendar entry by HREF
+ + +-
+
- + string + $href: The href from a call to GetEvents or GetTodos etc. +
- + string + $relative_url: The URL relative to the base_url specified when the calendar was opened. Default ''. +
+ GetEntryByUid (line 430)
+ Get the calendar entry by UID
+ + +-
+
- + string + $relative_url: The URL relative to the base_url specified when the calendar was opened. Default ''. +
- + uid + $uid +
+ GetEvents (line 360)
+ Get the events in a range from $start to $finish. The dates should be in the
+format yyyymmddThhmmssZ and should be in GMT. The events are returned as an array of event arrays. Each event array will have a 'href', 'etag' and 'event' part, where the 'href' is relative to the calendar and the event contains the definition of the event in iCalendar format.
+ + +-
+
- + timestamp + $start: The start time for the period +
- + timestamp + $finish: The finish time for the period +
- + string + $relative_url: The URL relative to the base_url specified when the calendar was opened. Default ''. +
+ GetTodos (line 393)
+ Get the todo's in a range from $start to $finish. The dates should be in the
+format yyyymmddThhmmssZ and should be in GMT. The events are returned as an array of event arrays. Each event array will have a 'href', 'etag' and 'event' part, where the 'href' is relative to the calendar and the event contains the definition of the event in iCalendar format.
+ + +-
+
- + timestamp + $start: The start time for the period +
- + timestamp + $finish: The finish time for the period +
- + boolean + $completed: Whether to include completed tasks +
- + boolean + $cancelled: Whether to include cancelled tasks +
- + string + $relative_url: The URL relative to the base_url specified when the calendar was opened. Default ''. +
+ SetContentType (line 139)
+ Add a Content-type: header.
+ +-
+
- + int + $type: The content type +
+ SetDepth (line 120)
+ Add a Depth: header. Valid values are 1 or infinity
+ +-
+
- + int + $depth: The depth, default to infinity +
+ SetMatch (line 111)
+ Adds an If-Match or If-None-Match header
+ +-
+
- + bool + $match: to Match or Not to Match, that is the question! +
- + string + $etag: The etag to match / not match against. +
+ SetUserAgent (line 129)
+ Add a Depth: header. Valid values are 1 or infinity
+ +-
+
- + int + $depth: The depth, default to infinity +
- + + $user_agent +
+ Documentation generated on Sun, 19 Oct 2008 21:25:37 +1300 by phpDocumentor 1.3.2 +
+
/inc/caldav-client.php
+ 
+ 
/inc/always.php
+ 
+