diff --git a/docs/api/awl/CalDAVSyncCalendar.html b/docs/api/awl/CalDAVSyncCalendar.html new file mode 100644 index 00000000..a8a4ad51 --- /dev/null +++ b/docs/api/awl/CalDAVSyncCalendar.html @@ -0,0 +1,396 @@ + + + +
+ +
CalDAVSyncCalendarA class for holding basic information about a calendar we shall synchronize
++ Located in /inc/CalDAVSyncCalendar.php (line 8) +
+ + + + +
+
+ mixed
+ $sync_client
+ (line 9)
+
+
+
+ mixed
+ $url
+ (line 10)
+
+
+ Constructor __construct (line 14)
+
+ Get (line 28)
+
+ GetToken (line 33)
+
+ hasSyncReport (line 45)
+
+ Set (line 24)
+
+ whatChangedSince (line 52)
+
+ __toString (line 20)
+ + Documentation generated on Sun, 08 Jul 2012 12:53:47 +0000 by phpDocumentor 1.4.3 +
+
/inc/CalDAVSyncCalendar.phpA class for holding basic information about a calendar we shall synchronize
+ +| Class | +Description | +
|---|---|
+
+ CalDAVSyncCalendar
+ |
+ + A class for holding basic information about a calendar we shall synchronize + | +
+ Documentation generated on Sun, 08 Jul 2012 12:53:47 +0000 by phpDocumentor 1.4.3 +
+
CalDAVSyncClientA class for accessing DAViCal via CalDAV, as a client
++ Located in /inc/CalDAVSyncClient.php (line 25) +
+ + + + +
+ array
+ GetEntryByUid
+ (uid $uid, [string $relative_url = ''], [string $component_type = 'VEVENT'])
+
+ array
+ GetEvents
+ ([timestamp $start = null], [timestamp $finish = null], [string $relative_url = ''])
+
+ array
+ GetTodos
+ (timestamp $start, timestamp $finish, [boolean $completed = false], [boolean $cancelled = false], [string $relative_url = ""])
+
+
+ string
+ $base_url
+ (line 31)
+
+ Server, username, password, calendar
+ + + + + + +
+
+ mixed
+ $body
+ = "" (line 61)
+
+
+
+ mixed
+ $calendar_home_set
+ (line 46)
+
+ The calendar-home-set we're using
+ + + + + + +
+
+ mixed
+ $calendar_url
+ (line 41)
+
+ The calendar-URL we're using
+ + + + + + +
+
+ mixed
+ $calendar_urls
+ (line 51)
+
+ The calendar_urls we have discovered
+ + + + + + +
+
+ mixed
+ $entry
+ (line 31)
+
+
+
+ mixed
+ $headers
+ = array() (line 60)
+
+
+
+ mixed
+ $httpParsedHeaders
+ (line 68)
+
+
+
+ mixed
+ $httpRequest
+ = "" (line 63)
+
+
+
+ mixed
+ $httpResponseBody
+ = "" (line 69)
+
+
+
+ mixed
+ $httpResponseCode
+ = 0 (line 66)
+
+
+
+ mixed
+ $httpResponseHeaders
+ = "" (line 67)
+
+
+
+ mixed
+ $parser
+ (line 71)
+
+
+
+ mixed
+ $pass
+ (line 31)
+
+
+
+ mixed
+ $port
+ (line 31)
+
+
+
+ mixed
+ $principal_url
+ (line 36)
+
+ The principal-URL we're using
+ + + + + + +
+
+ mixed
+ $protocol
+ (line 31)
+
+
+
+ mixed
+ $requestMethod
+ = "GET" (line 62)
+
+
+
+ mixed
+ $server
+ (line 31)
+
+
+
+ mixed
+ $user
+ (line 31)
+
+
+
+ string
+ $user_agent
+ = 'DAViCalClient' (line 58)
+
+ The useragent which is send to the caldav server
+ + + + + + +
+
+ mixed
+ $xmlRequest
+ = "" (line 64)
+
+
+
+ mixed
+ $xmlResponse
+ = "" (line 65)
+
+
+ Constructor __construct (line 85)
+ Constructor, initialises the class
+ +
+ CalendarHomeSet (line 528)
+ Get/Set the calendar-home-set URL
+ +
+ CalendarMultiget (line 798)
+ Get a bunch of events for a calendar with a calendar-multiget report
+ +
+ CalendarUrls (line 542)
+ Get/Set the calendar-home-set URL
+ +
+ DoCalendarQuery (line 885)
+ 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 (line 476)
+ DELETE a text/icalendar resource
+ + +
+ DoGETRequest (line 412)
+ Get a single item from the server.
+ +
+ DoHEADRequest (line 424)
+ Get the HEAD of a single item from the server.
+ +
+ DoOptionsRequest (line 374)
+ Send an OPTIONS request to the server
+ + +
+ DoPROPFINDRequest (line 493)
+ Get a single item from the server.
+ +
+ DoPUTRequest (line 440)
+ PUT a text/icalendar resource, returning the etag
+ + +
+ DoRequest (line 273)
+ Send a request to the server
+ + +
+ doSyncReport (line 838)
+
+ DoXMLRequest (line 398)
+ Send an XML request to the server (e.g. PROPFIND, REPORT, MKCALENDAR)
+ + +
+ FindCalendarHome (line 675)
+ Attack the given URL in an attempt to find a principal URL
+ +
+ FindCalendars (line 704)
+ Find the calendars, from the calendar_home_set
+ +
+ FindPrincipal (line 652)
+ Attack the given URL in an attempt to find a principal URL
+ +
+ GetCalendarDetails (line 748)
+ Find the calendars, from the calendar_home_set
+ +
+ GetCollectionETags (line 778)
+ Get all etags for a calendar
+ +
+ GetEntryByHref (line 1045)
+ Get the calendar entry by HREF
+ + +
+ GetEntryByUid (line 1018)
+ Get the calendar entry by UID
+ + +
+ GetEvents (line 942)
+ 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.
+ + +
+ GetHttpRequest (line 230)
+ Output http request headers
+ + +
+ GetOKProps (line 619)
+ Return the <prop> ... </prop> of a propstat where the status is OK
+ +
+ GetResponseBody (line 246)
+ Output http response body
+ + +
+ GetResponseHeaders (line 238)
+ Output http response headers
+ + +
+ GetTodos (line 978)
+ 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.
+ + +
+ GetXmlRequest (line 254)
+ Output xml request
+ + +
+ GetXmlResponse (line 262)
+ Output xml response
+ + +
+ HrefForProp (line 573)
+ Return the href containing this property. Except only if it's inside a status != 200
+ +
+ HrefForResourcetype (line 599)
+ Return the href which has a resourcetype of the specified type
+ +
+ HrefValueInside (line 556)
+ Return the first occurrence of an href inside the named tag.
+ +
+ ParseResponse (line 179)
+ Split response into httpResponse and xmlResponse
+ +
+ ParseResponseHeaders (line 205)
+ Split httpResponseHeaders into an array of headers
+ + +
+ PrincipalURL (line 515)
+ Get/Set the Principal URL
+ +
+ SetCalendar (line 170)
+ Set the calendar_url we will be using for a while.
+ +
+ SetContentType (line 161)
+ Add a Content-type: header.
+ +
+ SetDebug (line 116)
+ Call this to enable / disable debugging. It will return the prior value of the debugging flag.
+ + +
+ SetDepth (line 142)
+ Add a Depth: header. Valid values are 0, 1 or infinity
+ +
+ SetMatch (line 133)
+ Adds an If-Match or If-None-Match header
+ +
+ SetUserAgent (line 151)
+ Add a Depth: header. Valid values are 1 or infinity
+ +
+ Unchunk (line 339)
+ Unchunk a chunked response
+ ++ Documentation generated on Sun, 08 Jul 2012 12:53:47 +0000 by phpDocumentor 1.4.3 +
+
/inc/CalDAVSyncClient.phpA Class for connecting to a caldav server
+ + +| Class | +Description | +
|---|---|
+
+ CalDAVSyncClient
+ |
+ + A class for accessing DAViCal via CalDAV, as a client + | +
+
+ require_once
+ ('XMLDocument.php')
+ (line 13)
+
+ A Class for connecting to a caldav server
+ + +
+
+ require_once
+ ('CalDAVSyncCalendar.php')
+ (line 14)
+
+ + Documentation generated on Sun, 08 Jul 2012 12:53:47 +0000 by phpDocumentor 1.4.3 +
+
CalDAVSyncCacheOur SyncCache holds
++ Located in /inc/CalDAVSyncCache.php (line 11) +
+ + + + +
+ CalDAVSyncCache
+ __construct
+ ( $cache_dir, $username, $caldav, $remote_calendar, WritableCollection $local_calendar)
+
+ Constructor __construct (line 23)
+
+ applyLocalChangesToRemote (line 89)
+ Put/Delete to the remote server as appropriate
+ +
+ applyRemoteChangesToLocal (line 112)
+ Apply remote changes to local database
+ +
+ deleteRemote (line 80)
+ Delete this from the remote server
+ +
+ finish (line 41)
+
+ localChanges (line 52)
+
+ needsSync (line 56)
+
+ putRemote (line 66)
+ Write this change to the remote server
+ +
+ remoteChanges (line 48)
+
+ resolveConflicts (line 121)
+
+ updateETags (line 126)
+ + Documentation generated on Sun, 08 Jul 2012 12:53:47 +0000 by phpDocumentor 1.4.3 +
+
CalDAVSyncState+ Implements interfaces: +
The CalDAVSyncState is a very lightweight object holding the data from the last sync process.
++ Located in /inc/CalDAVSyncState.php (line 5) +
+ + + + +
+ Constructor __construct (line 11)
+
+ serialize (line 18)
+
+ unserialize (line 22)
+ + Documentation generated on Sun, 08 Jul 2012 12:53:48 +0000 by phpDocumentor 1.4.3 +
+
FakeSessionSometimes we need a fake session when we are using the DAViCal libraries from a script POV.
+This FakeSession grants complete privileges and access - normally what you want, in a script context - so you should know what you're doing and why you're using it.
+ ++ Located in /inc/FakeSession.php (line 12) +
+ + + + +
+ Constructor __construct (line 14)
+
+ AllowedTo (line 35)
+ + Documentation generated on Sun, 08 Jul 2012 12:53:49 +0000 by phpDocumentor 1.4.3 +
+
/inc/CalDAVSyncCache.php| Class | +Description | +
|---|---|
+
+ CalDAVSyncCache
+ |
+ + Our SyncCache holds + | +
+
+ require_once
+ ('CalDAVSyncClient.php')
+ (line 3)
+
+
+
+ require_once
+ ('CalDAVSyncState.php')
+ (line 4)
+
+
+
+ require_once
+ ('CalDAVSyncCalendar.php')
+ (line 5)
+
+
+
+ require_once
+ ('WritableCollection.php')
+ (line 6)
+
+ + Documentation generated on Sun, 08 Jul 2012 12:53:47 +0000 by phpDocumentor 1.4.3 +
+
/inc/CalDAVSyncState.php| Class | +Description | +
|---|---|
+
+ CalDAVSyncState
+ |
+ + The CalDAVSyncState is a very lightweight object holding the data from the last sync process. + | +
+ Documentation generated on Sun, 08 Jul 2012 12:53:48 +0000 by phpDocumentor 1.4.3 +
+
/inc/FakeSession.php| Class | +Description | +
|---|---|
+
+ FakeSession
+ |
+ + Sometimes we need a fake session when we are using the DAViCal libraries from a script POV. + | +
+
+ require_once
+ ('Principal.php')
+ (line 2)
+
+ + Documentation generated on Sun, 08 Jul 2012 12:53:49 +0000 by phpDocumentor 1.4.3 +
+