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 @@ + + + + + + Docs For Class CalDAVSyncCalendar + + + + +
+

 Class CalDAVSyncCalendar

+ + +
+
Description
+ +
+ +

A class for holding basic information about a calendar we shall synchronize

+

+ Located in /inc/CalDAVSyncCalendar.php (line 8) +

+ + +

+	
+			
+
+ + + + +
+
Variable Summary
+ +
+
+
+  + mixed + $sync_client +
+
+  + mixed + $url +
+
+
+
+ + +
+
Method Summary
+ +
+
+
+  + CalDAVSyncCalendar + __construct + ( $sync_client,  $url) +
+
+  + void + Get + ( $key) +
+
+  + void + GetToken + () +
+
+  + void + hasSyncReport + () +
+
+  + void + Set + ( $key,  $value) +
+
+  + void + whatChangedSince + ( $old_remote_token) +
+
+  + void + __toString + () +
+
+
+
+ + +
+
Variables
+ +
+ +Strict Standards: Only variables should be passed by reference in /usr/share/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty_Compiler.class.php on line 712 + +Warning: strftime(): It is not safe to rely on the system's timezone settings. You are *required* to use the date.timezone setting or the date_default_timezone_set() function. In case you used any of those methods and you are still getting this warning, you most likely misspelled the timezone identifier. We selected the timezone 'UTC' for now, but please set date.timezone to select your timezone. in /usr/share/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty_Compiler.class.php on line 370 + + +
+ +
+ + + mixed + $sync_client + (line 9) + +
+ + +
    +
  • access: public
  • +
+ + + + + +
+ +
+ +
+ + + mixed + $url + (line 10) + +
+ + +
    +
  • access: public
  • +
+ + + + + +
+ +
+
+ + +
+
Methods
+ +
+ + +
+ +
+ + Constructor __construct (line 14) +
+ + + +
+ CalDAVSyncCalendar + + __construct + + ( $sync_client,  $url) +
+ +
    +
  • + + $sync_client
  • +
  • + + $url
  • +
+ + +
+ +
+ +
+ + Get (line 28) +
+ + +
    +
  • access: public
  • +
+ +
+ void + + Get + + ( $key) +
+ +
    +
  • + + $key
  • +
+ + +
+ +
+ +
+ + GetToken (line 33) +
+ + + +
+ void + + GetToken + + () +
+ + + +
+ +
+ +
+ + hasSyncReport (line 45) +
+ + +
    +
  • access: public
  • +
+ +
+ void + + hasSyncReport + + () +
+ + + +
+ +
+ +
+ + Set (line 24) +
+ + +
    +
  • access: public
  • +
+ +
+ void + + Set + + ( $key,  $value) +
+ +
    +
  • + + $key
  • +
  • + + $value
  • +
+ + +
+ +
+ +
+ + whatChangedSince (line 52) +
+ + +
    +
  • access: public
  • +
+ +
+ void + + whatChangedSince + + ( $old_remote_token) +
+ +
    +
  • + + $old_remote_token
  • +
+ + +
+ +
+ +
+ + __toString (line 20) +
+ + + +
+ void + + __toString + + () +
+ + + +
+ +
+
+ + +

+ Documentation generated on Sun, 08 Jul 2012 12:53:47 +0000 by phpDocumentor 1.4.3 +

+
+ \ No newline at end of file diff --git a/docs/api/awl/_inc---CalDAVSyncCalendar.php.html b/docs/api/awl/_inc---CalDAVSyncCalendar.php.html new file mode 100644 index 00000000..46a25228 --- /dev/null +++ b/docs/api/awl/_inc---CalDAVSyncCalendar.php.html @@ -0,0 +1,64 @@ + + + + + + Docs for page CalDAVSyncCalendar.php + + + + +
+

File/inc/CalDAVSyncCalendar.php

+ + +
+
Description
+ +
+ +

A class for holding basic information about a calendar we shall synchronize

+ +
+
+ + +
+
Classes
+ +
+ + + + + + + + + +
ClassDescription
+  class + 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 +

+
+ \ No newline at end of file diff --git a/docs/api/awl/caldav/CalDAVSyncClient.html b/docs/api/awl/caldav/CalDAVSyncClient.html new file mode 100644 index 00000000..a8959419 --- /dev/null +++ b/docs/api/awl/caldav/CalDAVSyncClient.html @@ -0,0 +1,2237 @@ + +Warning: strftime(): It is not safe to rely on the system's timezone settings. You are *required* to use the date.timezone setting or the date_default_timezone_set() function. In case you used any of those methods and you are still getting this warning, you most likely misspelled the timezone identifier. We selected the timezone 'UTC' for now, but please set date.timezone to select your timezone. in /usr/share/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty_Compiler.class.php on line 370 + + + + + + Docs For Class CalDAVSyncClient + + + + +
+

 Class CalDAVSyncClient

+ + +
+
Description
+ +
+ +

A class for accessing DAViCal via CalDAV, as a client

+

+ Located in /inc/CalDAVSyncClient.php (line 25) +

+ + +

+	
+			
+
+ + + + +
+
Variable Summary
+ +
+
+
+  + string + $base_url +
+
+  + mixed + $body +
+
+  + mixed + $calendar_home_set +
+
+  + mixed + $calendar_url +
+
+  + mixed + $calendar_urls +
+
+  + mixed + $entry +
+
+  + mixed + $headers +
+
+  + mixed + $httpParsedHeaders +
+
+  + mixed + $httpRequest +
+
+  + mixed + $httpResponseBody +
+
+  + mixed + $httpResponseCode +
+
+  + mixed + $httpResponseHeaders +
+
+  + mixed + $parser +
+
+  + mixed + $pass +
+
+  + mixed + $port +
+
+  + mixed + $principal_url +
+
+  + mixed + $protocol +
+
+  + mixed + $requestMethod +
+
+  + mixed + $server +
+
+  + mixed + $user +
+
+  + string + $user_agent +
+
+  + mixed + $xmlRequest +
+
+  + mixed + $xmlResponse +
+
+
+
+ + +
+
Method Summary
+ +
+
+
+  + CalDAVSyncClient + __construct + (string $base_url, string $user, string $pass) +
+
+  + void + CalendarHomeSet + ([$url $urls = null]) +
+
+  + void + CalendarMultiget + ( $event_hrefs, [ $url = null]) +
+
+  + void + CalendarUrls + ([$urls $urls = null]) +
+
+  + array + DoCalendarQuery + (string $filter, [string $url = '']) +
+
+  + int + DoDELETERequest + (string $url, [string $etag = null]) +
+
+  + void + DoGETRequest + (string $url) +
+
+  + void + DoHEADRequest + (string $url) +
+
+  + array + DoOptionsRequest + ([string $url = null]) +
+
+  + void + DoPROPFINDRequest + (string $url,  $props, [ $depth = 0]) +
+
+  + string + DoPUTRequest + (string $url, string $icalendar, [string $etag = null]) +
+
+  + string + DoRequest + ([string $url = null]) +
+
+  + void + doSyncReport + ([ $previous_token = null], [ $url = null]) +
+
+  + array + DoXMLRequest + ( $request_method, string $xml, [string $url = null], string $method) +
+
+  + void + FindCalendarHome + ([ $recursed = false], string $url) +
+
+  + void + FindCalendars + ([ $recursed = false]) +
+
+  + void + FindPrincipal + ([string $url = null]) +
+
+  + void + GetCalendarDetails + ([ $url = null]) +
+
+  + void + GetCollectionETags + ([ $url = null]) +
+
+  + string + GetEntryByHref + (string $href) +
+
+  + array + GetEntryByUid + (uid $uid, [string $relative_url = ''], [string $component_type = 'VEVENT']) +
+
+  + array + GetEvents + ([timestamp $start = null], [timestamp $finish = null], [string $relative_url = '']) +
+
+  + HTTP + GetHttpRequest + () +
+
+  + void + GetOKProps + (string $nodenum) +
+
+  + HTTP + GetResponseBody + () +
+
+  + HTTP + GetResponseHeaders + () +
+
+  + array + GetTodos + (timestamp $start, timestamp $finish, [boolean $completed = false], [boolean $cancelled = false], [string $relative_url = ""]) +
+
+  + raw + GetXmlRequest + () +
+
+  + raw + GetXmlResponse + () +
+
+  + void + HrefForProp + (string $tagname, [ $i = 0], integer $which) +
+
+  + void + HrefForResourcetype + (string $tagname, [ $i = 0], integer $which) +
+
+  + void + HrefValueInside + (string $tagname) +
+
+  + void + ParseResponse + (string $response) +
+
+  + array + ParseResponseHeaders + () +
+
+  + void + PrincipalURL + ([$url $url = null]) +
+
+  + void + SetCalendar + (string $url) +
+
+  + void + SetContentType + (string $type) +
+
+  + boolean + SetDebug + (boolean $new_value) +
+
+  + void + SetDepth + ([int $depth = '0']) +
+
+  + void + SetMatch + (bool $match, [string $etag = '*']) +
+
+  + void + SetUserAgent + ([ $user_agent = null], int $depth) +
+
+  + void + Unchunk + () +
+
+
+
+ + +
+
Variables
+ +
+ +Strict Standards: Only variables should be passed by reference in /usr/share/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty_Compiler.class.php on line 712 + +Warning: strftime(): It is not safe to rely on the system's timezone settings. You are *required* to use the date.timezone setting or the date_default_timezone_set() function. In case you used any of those methods and you are still getting this warning, you most likely misspelled the timezone identifier. We selected the timezone 'UTC' for now, but please set date.timezone to select your timezone. in /usr/share/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty_Compiler.class.php on line 370 + + +
+ +
+ + + string + $base_url + (line 31) + +
+ + +

Server, username, password, calendar

+
    +
  • access: protected
  • +
+ + + + + +
+ +
+ +
+ + + mixed + $body + = "" (line 61) + +
+ + +
    +
  • access: protected
  • +
+ + + + + +
+ +
+ +
+ + + mixed + $calendar_home_set + (line 46) + +
+ + +

The calendar-home-set we're using

+
    +
  • access: protected
  • +
+ + + + + +
+ +
+ +
+ + + mixed + $calendar_url + (line 41) + +
+ + +

The calendar-URL we're using

+
    +
  • access: protected
  • +
+ + + + + +
+ +
+ +
+ + + mixed + $calendar_urls + (line 51) + +
+ + +

The calendar_urls we have discovered

+
    +
  • access: protected
  • +
+ + + + + +
+ +
+ +
+ + + mixed + $entry + (line 31) + +
+ + +
    +
  • access: protected
  • +
+ + + + + +
+ +
+ +
+ + + mixed + $headers + = array() (line 60) + +
+ + +
    +
  • access: protected
  • +
+ + + + + +
+ +
+ +
+ + + mixed + $httpParsedHeaders + (line 68) + +
+ + +
    +
  • access: protected
  • +
+ + + + + +
+ +
+ +
+ + + mixed + $httpRequest + = "" (line 63) + +
+ + +
    +
  • access: protected
  • +
+ + + + + +
+ +
+ +
+ + + mixed + $httpResponseBody + = "" (line 69) + +
+ + +
    +
  • access: protected
  • +
+ + + + + +
+ +
+ +
+ + + mixed + $httpResponseCode + = 0 (line 66) + +
+ + +
    +
  • access: protected
  • +
+ + + + + +
+ +
+ +
+ + + mixed + $httpResponseHeaders + = "" (line 67) + +
+ + +
    +
  • access: protected
  • +
+ + + + + +
+ +
+ +
+ + + mixed + $parser + (line 71) + +
+ + +
    +
  • access: protected
  • +
+ + + + + +
+ +
+ +
+ + + mixed + $pass + (line 31) + +
+ + +
    +
  • access: protected
  • +
+ + + + + +
+ +
+ +
+ + + mixed + $port + (line 31) + +
+ + +
    +
  • access: protected
  • +
+ + + + + +
+ +
+ +
+ + + mixed + $principal_url + (line 36) + +
+ + +

The principal-URL we're using

+
    +
  • access: protected
  • +
+ + + + + +
+ +
+ +
+ + + mixed + $protocol + (line 31) + +
+ + +
    +
  • access: protected
  • +
+ + + + + +
+ +
+ +
+ + + mixed + $requestMethod + = "GET" (line 62) + +
+ + +
    +
  • access: protected
  • +
+ + + + + +
+ +
+ +
+ + + mixed + $server + (line 31) + +
+ + +
    +
  • access: protected
  • +
+ + + + + +
+ +
+ +
+ + + mixed + $user + (line 31) + +
+ + +
    +
  • access: protected
  • +
+ + + + + +
+ +
+ +
+ + + string + $user_agent + = 'DAViCalClient' (line 58) + +
+ + +

The useragent which is send to the caldav server

+
    +
  • access: public
  • +
+ + + + + +
+ +
+ +
+ + + mixed + $xmlRequest + = "" (line 64) + +
+ + +
    +
  • access: protected
  • +
+ + + + + +
+ +
+ +
+ + + mixed + $xmlResponse + = "" (line 65) + +
+ + +
    +
  • access: protected
  • +
+ + + + + +
+ +
+
+ + +
+
Methods
+ +
+ +Strict Standards: Only variables should be passed by reference in /usr/share/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty_Compiler.class.php on line 712 + +Warning: strftime(): It is not safe to rely on the system's timezone settings. You are *required* to use the date.timezone setting or the date_default_timezone_set() function. In case you used any of those methods and you are still getting this warning, you most likely misspelled the timezone identifier. We selected the timezone 'UTC' for now, but please set date.timezone to select your timezone. in /usr/share/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty_Compiler.class.php on line 370 + + +
+ +
+ + Constructor __construct (line 85) +
+ + +

Constructor, initialises the class

+ +
+ CalDAVSyncClient + + __construct + + (string $base_url, string $user, string $pass) +
+ +
    +
  • + 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
  • +
+ + +
+ +
+ +
+ + CalendarHomeSet (line 528) +
+ + +

Get/Set the calendar-home-set URL

+ +
+ void + + CalendarHomeSet + + ([$url $urls = null]) +
+ +
    +
  • + $url + $urls: array of string The calendar-home-set URLs to set
  • +
+ + +
+ +
+ +
+ + CalendarMultiget (line 798) +
+ + +

Get a bunch of events for a calendar with a calendar-multiget report

+ +
+ void + + CalendarMultiget + + ( $event_hrefs, [ $url = null]) +
+ +
    +
  • + + $event_hrefs
  • +
  • + + $url
  • +
+ + +
+ +
+ +
+ + CalendarUrls (line 542) +
+ + +

Get/Set the calendar-home-set URL

+ +
+ void + + CalendarUrls + + ([$urls $urls = null]) +
+ +
    +
  • + $urls + $urls: array of string The calendar URLs to set
  • +
+ + +
+ +
+ +
+ + 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.

+
    +
  • return: An array of the relative URLs, etags, and events from the server. Each element of the array will be an array with 'href', 'etag' and 'data' elements, corresponding to the URL, the server-supplied etag (which only varies when the data changes) and the calendar data in iCalendar format.
  • +
+ +
+ array + + DoCalendarQuery + + (string $filter, [string $url = '']) +
+ +
    +
  • + string + $filter: XML fragment which is the <filter> element of a calendar-query
  • +
  • + string + $url: The URL of the calendar, or empty/null to use the 'current' calendar_url
  • +
+ + +
+ +
+ +
+ + DoDELETERequest (line 476) +
+ + +

DELETE a text/icalendar resource

+
    +
  • return: The HTTP Result Code for the DELETE
  • +
+ +
+ int + + DoDELETERequest + + (string $url, [string $etag = null]) +
+ +
    +
  • + string + $url: The URL to make the request to
  • +
  • + string + $etag: The etag of an existing resource to be deleted, or '*' for any resource at that URL.
  • +
+ + +
+ +
+ +
+ + DoGETRequest (line 412) +
+ + +

Get a single item from the server.

+ +
+ void + + DoGETRequest + + (string $url) +
+ +
    +
  • + string + $url: The URL to GET
  • +
+ + +
+ +
+ +
+ + DoHEADRequest (line 424) +
+ + +

Get the HEAD of a single item from the server.

+ +
+ void + + DoHEADRequest + + (string $url) +
+ +
    +
  • + string + $url: The URL to HEAD
  • +
+ + +
+ +
+ +
+ + DoOptionsRequest (line 374) +
+ + +

Send an OPTIONS request to the server

+
    +
  • return: The allowed options
  • +
+ +
+ array + + DoOptionsRequest + + ([string $url = null]) +
+ +
    +
  • + string + $url: The URL to make the request to
  • +
+ + +
+ +
+ +
+ + DoPROPFINDRequest (line 493) +
+ + +

Get a single item from the server.

+ +
+ void + + DoPROPFINDRequest + + (string $url,  $props, [ $depth = 0]) +
+ +
    +
  • + string + $url: The URL to PROPFIND on
  • +
  • + + $props
  • +
  • + + $depth
  • +
+ + +
+ +
+ +
+ + DoPUTRequest (line 440) +
+ + +

PUT a text/icalendar resource, returning the etag

+
    +
  • return: The content of the response from the server
  • +
+ +
+ string + + DoPUTRequest + + (string $url, string $icalendar, [string $etag = null]) +
+ +
    +
  • + string + $url: The URL to make the request to
  • +
  • + 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 273) +
+ + +

Send a request to the server

+
    +
  • return: The content of the response from the server
  • +
+ +
+ string + + DoRequest + + ([string $url = null]) +
+ +
    +
  • + string + $url: The URL to make the request to
  • +
+ + +
+ +
+ +
+ + doSyncReport (line 838) +
+ + + +
+ void + + doSyncReport + + ([ $previous_token = null], [ $url = null]) +
+ +
    +
  • + + $previous_token
  • +
  • + + $url
  • +
+ + +
+ +
+ +
+ + DoXMLRequest (line 398) +
+ + +

Send an XML request to the server (e.g. PROPFIND, REPORT, MKCALENDAR)

+
    +
  • return: An array of the allowed methods
  • +
+ +
+ array + + DoXMLRequest + + ( $request_method, string $xml, [string $url = null], string $method) +
+ +
    +
  • + string + $method: The method (PROPFIND, REPORT, etc) to use with the request
  • +
  • + string + $xml: The XML to send along with the request
  • +
  • + string + $url: The URL to make the request to
  • +
  • + + $request_method
  • +
+ + +
+ +
+ +
+ + FindCalendarHome (line 675) +
+ + +

Attack the given URL in an attempt to find a principal URL

+ +
+ void + + FindCalendarHome + + ([ $recursed = false], string $url) +
+ +
    +
  • + string + $url: The URL to find the calendar-home-set from
  • +
  • + + $recursed
  • +
+ + +
+ +
+ +
+ + FindCalendars (line 704) +
+ + +

Find the calendars, from the calendar_home_set

+ +
+ void + + FindCalendars + + ([ $recursed = false]) +
+ +
    +
  • + + $recursed
  • +
+ + +
+ +
+ +
+ + FindPrincipal (line 652) +
+ + +

Attack the given URL in an attempt to find a principal URL

+ +
+ void + + FindPrincipal + + ([string $url = null]) +
+ +
    +
  • + string + $url: The URL to find the principal-URL from
  • +
+ + +
+ +
+ +
+ + GetCalendarDetails (line 748) +
+ + +

Find the calendars, from the calendar_home_set

+ +
+ void + + GetCalendarDetails + + ([ $url = null]) +
+ +
    +
  • + + $url
  • +
+ + +
+ +
+ +
+ + GetCollectionETags (line 778) +
+ + +

Get all etags for a calendar

+ +
+ void + + GetCollectionETags + + ([ $url = null]) +
+ +
    +
  • + + $url
  • +
+ + +
+ +
+ +
+ + GetEntryByHref (line 1045) +
+ + +

Get the calendar entry by HREF

+
    +
  • return: The iCalendar of the calendar entry
  • +
+ +
+ string + + GetEntryByHref + + (string $href) +
+ +
    +
  • + string + $href: The href from a call to GetEvents or GetTodos etc.
  • +
+ + +
+ +
+ +
+ + GetEntryByUid (line 1018) +
+ + +

Get the calendar entry by UID

+
    +
  • return: An array of the relative URL, etag, and calendar data returned from DoCalendarQuery() @see DoCalendarQuery()
  • +
+ +
+ array + + GetEntryByUid + + (uid $uid, [string $relative_url = ''], [string $component_type = 'VEVENT']) +
+ +
    +
  • + string + $relative_url: The URL relative to the base_url specified when the calendar was opened. Default ''.
  • +
  • + string + $component_type: The component type inside the VCALENDAR. Default 'VEVENT'.
  • +
  • + uid + $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.

+
    +
  • return: An array of the relative URLs, etags, and events, returned from DoCalendarQuery() @see DoCalendarQuery()
  • +
+ +
+ array + + GetEvents + + ([timestamp $start = null], [timestamp $finish = null], [string $relative_url = '']) +
+ +
    +
  • + 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 ''.
  • +
+ + +
+ +
+ +
+ + GetHttpRequest (line 230) +
+ + +

Output http request headers

+
    +
  • return: headers
  • +
+ +
+ HTTP + + GetHttpRequest + + () +
+ + + +
+ +
+ +
+ + GetOKProps (line 619) +
+ + +

Return the <prop> ... </prop> of a propstat where the status is OK

+ +
+ void + + GetOKProps + + (string $nodenum) +
+ +
    +
  • + string + $nodenum: The node number in the xmlnodes which is the href
  • +
+ + +
+ +
+ +
+ + GetResponseBody (line 246) +
+ + +

Output http response body

+
    +
  • return: body
  • +
+ +
+ HTTP + + GetResponseBody + + () +
+ + + +
+ +
+ +
+ + GetResponseHeaders (line 238) +
+ + +

Output http response headers

+
    +
  • return: headers
  • +
+ +
+ HTTP + + GetResponseHeaders + + () +
+ + + +
+ +
+ +
+ + 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.

+
    +
  • return: An array of the relative URLs, etags, and events, returned from DoCalendarQuery() @see DoCalendarQuery()
  • +
+ +
+ array + + GetTodos + + (timestamp $start, timestamp $finish, [boolean $completed = false], [boolean $cancelled = false], [string $relative_url = ""]) +
+ +
    +
  • + 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 ''.
  • +
+ + +
+ +
+ +
+ + GetXmlRequest (line 254) +
+ + +

Output xml request

+
    +
  • return: xml
  • +
+ +
+ raw + + GetXmlRequest + + () +
+ + + +
+ +
+ +
+ + GetXmlResponse (line 262) +
+ + +

Output xml response

+
    +
  • return: xml
  • +
+ +
+ raw + + GetXmlResponse + + () +
+ + + +
+ +
+ +
+ + HrefForProp (line 573) +
+ + +

Return the href containing this property. Except only if it's inside a status != 200

+ +
+ void + + HrefForProp + + (string $tagname, [ $i = 0], integer $which) +
+ +
    +
  • + string + $tagname: The tag name of the property to find the href for
  • +
  • + integer + $which: Which instance of the tag should we use
  • +
  • + + $i
  • +
+ + +
+ +
+ +
+ + HrefForResourcetype (line 599) +
+ + +

Return the href which has a resourcetype of the specified type

+ +
+ void + + HrefForResourcetype + + (string $tagname, [ $i = 0], integer $which) +
+ +
    +
  • + string + $tagname: The tag name of the resourcetype to find the href for
  • +
  • + integer + $which: Which instance of the tag should we use
  • +
  • + + $i
  • +
+ + +
+ +
+ +
+ + HrefValueInside (line 556) +
+ + +

Return the first occurrence of an href inside the named tag.

+ +
+ void + + HrefValueInside + + (string $tagname) +
+ +
    +
  • + string + $tagname: The tag name to find the href inside of
  • +
+ + +
+ +
+ +
+ + ParseResponse (line 179) +
+ + +

Split response into httpResponse and xmlResponse

+ +
+ void + + ParseResponse + + (string $response) +
+ +
    +
  • + string + $response: Response from server
  • +
+ + +
+ +
+ +
+ + ParseResponseHeaders (line 205) +
+ + +

Split httpResponseHeaders into an array of headers

+
    +
  • return: of arrays of header lines
  • +
+ +
+ array + + ParseResponseHeaders + + () +
+ + + +
+ +
+ +
+ + PrincipalURL (line 515) +
+ + +

Get/Set the Principal URL

+ +
+ void + + PrincipalURL + + ([$url $url = null]) +
+ +
    +
  • + $url + $url: string The Principal URL to set
  • +
+ + +
+ +
+ +
+ + SetCalendar (line 170) +
+ + +

Set the calendar_url we will be using for a while.

+ +
+ void + + SetCalendar + + (string $url) +
+ +
    +
  • + string + $url: The calendar_url
  • +
+ + +
+ +
+ +
+ + SetContentType (line 161) +
+ + +

Add a Content-type: header.

+ +
+ void + + SetContentType + + (string $type) +
+ +
    +
  • + string + $type: The content type
  • +
+ + +
+ +
+ +
+ + SetDebug (line 116) +
+ + +

Call this to enable / disable debugging. It will return the prior value of the debugging flag.

+
    +
  • return: The previous value, in case you want to restore it later.
  • +
+ +
+ boolean + + SetDebug + + (boolean $new_value) +
+ +
    +
  • + boolean + $new_value: The new value for debugging.
  • +
+ + +
+ +
+ +
+ + SetDepth (line 142) +
+ + +

Add a Depth: header. Valid values are 0, 1 or infinity

+ +
+ void + + SetDepth + + ([int $depth = '0']) +
+ +
    +
  • + int + $depth: The depth, default to infinity
  • +
+ + +
+ +
+ +
+ + SetMatch (line 133) +
+ + +

Adds an If-Match or If-None-Match header

+ +
+ void + + SetMatch + + (bool $match, [string $etag = '*']) +
+ +
    +
  • + bool + $match: to Match or Not to Match, that is the question!
  • +
  • + string + $etag: The etag to match / not match against.
  • +
+ + +
+ +
+ +
+ + SetUserAgent (line 151) +
+ + +

Add a Depth: header. Valid values are 1 or infinity

+ +
+ void + + SetUserAgent + + ([ $user_agent = null], int $depth) +
+ +
    +
  • + int + $depth: The depth, default to infinity
  • +
  • + + $user_agent
  • +
+ + +
+ +
+ +
+ + Unchunk (line 339) +
+ + +

Unchunk a chunked response

+ +
+ void + + Unchunk + + () +
+ + + +
+ +
+
+ + + +Warning: strftime(): It is not safe to rely on the system's timezone settings. You are *required* to use the date.timezone setting or the date_default_timezone_set() function. In case you used any of those methods and you are still getting this warning, you most likely misspelled the timezone identifier. We selected the timezone 'UTC' for now, but please set date.timezone to select your timezone. in /usr/share/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty_Compiler.class.php on line 370 +

+ Documentation generated on Sun, 08 Jul 2012 12:53:47 +0000 by phpDocumentor 1.4.3 +

+
+ \ No newline at end of file diff --git a/docs/api/awl/caldav/_inc---CalDAVSyncClient.php.html b/docs/api/awl/caldav/_inc---CalDAVSyncClient.php.html new file mode 100644 index 00000000..93663a5e --- /dev/null +++ b/docs/api/awl/caldav/_inc---CalDAVSyncClient.php.html @@ -0,0 +1,124 @@ + +Warning: strftime(): It is not safe to rely on the system's timezone settings. You are *required* to use the date.timezone setting or the date_default_timezone_set() function. In case you used any of those methods and you are still getting this warning, you most likely misspelled the timezone identifier. We selected the timezone 'UTC' for now, but please set date.timezone to select your timezone. in /usr/share/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty_Compiler.class.php on line 370 + + + + + + Docs for page CalDAVSyncClient.php + + + + +
+

File/inc/CalDAVSyncClient.php

+ + +
+
Description
+ +
+ +

A Class for connecting to a caldav server

+ + +
+
+ + +
+
Classes
+ +
+ + + + + + + + + +
ClassDescription
+  class + CalDAVSyncClient + + A class for accessing DAViCal via CalDAV, as a client +
+
+
+ + +
+
Includes
+ +
+ +Strict Standards: Only variables should be passed by reference in /usr/share/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty_Compiler.class.php on line 712 + +Warning: strftime(): It is not safe to rely on the system's timezone settings. You are *required* to use the date.timezone setting or the date_default_timezone_set() function. In case you used any of those methods and you are still getting this warning, you most likely misspelled the timezone identifier. We selected the timezone 'UTC' for now, but please set date.timezone to select your timezone. in /usr/share/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty_Compiler.class.php on line 370 + +
+ +
+  + + 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 +

+
+ \ No newline at end of file diff --git a/docs/api/davical/CalDAVSyncCache.html b/docs/api/davical/CalDAVSyncCache.html new file mode 100644 index 00000000..9f5118f8 --- /dev/null +++ b/docs/api/davical/CalDAVSyncCache.html @@ -0,0 +1,418 @@ + +Warning: strftime(): It is not safe to rely on the system's timezone settings. You are *required* to use the date.timezone setting or the date_default_timezone_set() function. In case you used any of those methods and you are still getting this warning, you most likely misspelled the timezone identifier. We selected the timezone 'UTC' for now, but please set date.timezone to select your timezone. in /usr/share/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty_Compiler.class.php on line 370 + + + + + + Docs For Class CalDAVSyncCache + + + + +
+

 Class CalDAVSyncCache

+ + +
+
Description
+ +
+ +

Our SyncCache holds

+

+ Located in /inc/CalDAVSyncCache.php (line 11) +

+ + +

+	
+			
+
+ + + + + +
+
Method Summary
+ +
+
+
+  + CalDAVSyncCache + __construct + ( $cache_dir,  $username,  $caldav,  $remote_calendar, WritableCollection $local_calendar) +
+
+  + void + applyLocalChangesToRemote + () +
+
+  + void + applyRemoteChangesToLocal + () +
+
+  + void + deleteRemote + ( $change) +
+
+  + void + finish + () +
+
+  + void + localChanges + () +
+
+  + void + needsSync + ( $new_local_token,  $new_remote_token) +
+
+  + void + putRemote + ( $change) +
+
+  + void + remoteChanges + () +
+
+  + void + resolveConflicts + () +
+
+  + void + updateETags + () +
+
+
+
+ + + +
+
Methods
+ +
+ +Strict Standards: Only variables should be passed by reference in /usr/share/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty_Compiler.class.php on line 712 + +Warning: strftime(): It is not safe to rely on the system's timezone settings. You are *required* to use the date.timezone setting or the date_default_timezone_set() function. In case you used any of those methods and you are still getting this warning, you most likely misspelled the timezone identifier. We selected the timezone 'UTC' for now, but please set date.timezone to select your timezone. in /usr/share/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty_Compiler.class.php on line 370 + + +
+ +
+ + Constructor __construct (line 23) +
+ + + +
+ CalDAVSyncCache + + __construct + + ( $cache_dir,  $username,  $caldav,  $remote_calendar, WritableCollection $local_calendar) +
+ + + + +
+ +
+ +
+ + applyLocalChangesToRemote (line 89) +
+ + +

Put/Delete to the remote server as appropriate

+ +
+ void + + applyLocalChangesToRemote + + () +
+ + + +
+ +
+ +
+ + applyRemoteChangesToLocal (line 112) +
+ + +

Apply remote changes to local database

+ +
+ void + + applyRemoteChangesToLocal + + () +
+ + + +
+ +
+ +
+ + deleteRemote (line 80) +
+ + +

Delete this from the remote server

+ +
+ void + + deleteRemote + + ( $change) +
+ +
    +
  • + + $change
  • +
+ + +
+ +
+ +
+ + finish (line 41) +
+ + + +
+ void + + finish + + () +
+ + + +
+ +
+ +
+ + localChanges (line 52) +
+ + + +
+ void + + localChanges + + () +
+ + + +
+ +
+ +
+ + needsSync (line 56) +
+ + + +
+ void + + needsSync + + ( $new_local_token,  $new_remote_token) +
+ +
    +
  • + + $new_local_token
  • +
  • + + $new_remote_token
  • +
+ + +
+ +
+ +
+ + putRemote (line 66) +
+ + +

Write this change to the remote server

+ +
+ void + + putRemote + + ( $change) +
+ +
    +
  • + + $change
  • +
+ + +
+ +
+ +
+ + remoteChanges (line 48) +
+ + + +
+ void + + remoteChanges + + () +
+ + + +
+ +
+ +
+ + resolveConflicts (line 121) +
+ + + +
+ void + + resolveConflicts + + () +
+ + + +
+ +
+ +
+ + updateETags (line 126) +
+ + + +
+ void + + updateETags + + () +
+ + + +
+ +
+
+ + + +Warning: strftime(): It is not safe to rely on the system's timezone settings. You are *required* to use the date.timezone setting or the date_default_timezone_set() function. In case you used any of those methods and you are still getting this warning, you most likely misspelled the timezone identifier. We selected the timezone 'UTC' for now, but please set date.timezone to select your timezone. in /usr/share/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty_Compiler.class.php on line 370 +

+ Documentation generated on Sun, 08 Jul 2012 12:53:47 +0000 by phpDocumentor 1.4.3 +

+
+ \ No newline at end of file diff --git a/docs/api/davical/CalDAVSyncState.html b/docs/api/davical/CalDAVSyncState.html new file mode 100644 index 00000000..e87bfbe3 --- /dev/null +++ b/docs/api/davical/CalDAVSyncState.html @@ -0,0 +1,340 @@ + + + + + + Docs For Class CalDAVSyncState + + + + +
+

 Class CalDAVSyncState

+ + +
+
Description
+ +
+

+ Implements interfaces: +

    +
  • Serializable (internal interface)
+

+ +

The CalDAVSyncState is a very lightweight object holding the data from the last sync process.

+

+ Located in /inc/CalDAVSyncState.php (line 5) +

+ + +

+	
+			
+
+ + + + +
+
Variable Summary
+ +
+
+
+  + mixed + $local_etags +
+
+  + mixed + $local_token +
+
+  + mixed + $remote_etags +
+
+  + mixed + $remote_token +
+
+
+
+ + +
+
Method Summary
+ +
+
+
+  + CalDAVSyncState + __construct + ( $rtoken,  $retags,  $ltoken,  $letags) +
+
+  + void + serialize + () +
+
+  + void + unserialize + ( $data) +
+
+
+
+ + +
+
Variables
+ +
+ + +
+ +
+ + + mixed + $local_etags + (line 9) + +
+ + +
    +
  • access: public
  • +
+ + + + + +
+ +
+ +
+ + + mixed + $local_token + (line 8) + +
+ + +
    +
  • access: public
  • +
+ + + + + +
+ +
+ +
+ + + mixed + $remote_etags + (line 7) + +
+ + +
    +
  • access: public
  • +
+ + + + + +
+ +
+ +
+ + + mixed + $remote_token + (line 6) + +
+ + +
    +
  • access: public
  • +
+ + + + + +
+ +
+
+ + +
+
Methods
+ +
+ + +
+ +
+ + Constructor __construct (line 11) +
+ + + +
+ CalDAVSyncState + + __construct + + ( $rtoken,  $retags,  $ltoken,  $letags) +
+ +
    +
  • + + $rtoken
  • +
  • + + $retags
  • +
  • + + $ltoken
  • +
  • + + $letags
  • +
+ + +
+ +
+ +
+ + serialize (line 18) +
+ + +
    +
  • access: public
  • +
+ +
+ void + + serialize + + () +
+ + +
+
Implementation of:
+
+
Serializable::serialize
+
+ +
+ +
+ +
+ + unserialize (line 22) +
+ + +
    +
  • access: public
  • +
+ +
+ void + + unserialize + + ( $data) +
+ +
    +
  • + + $data
  • +
+ +
+
Implementation of:
+
+
Serializable::unserialize
+
+ +
+ +
+
+ + +

+ Documentation generated on Sun, 08 Jul 2012 12:53:48 +0000 by phpDocumentor 1.4.3 +

+
+ \ No newline at end of file diff --git a/docs/api/davical/FakeSession.html b/docs/api/davical/FakeSession.html new file mode 100644 index 00000000..ed1dedf9 --- /dev/null +++ b/docs/api/davical/FakeSession.html @@ -0,0 +1,150 @@ + +Warning: strftime(): It is not safe to rely on the system's timezone settings. You are *required* to use the date.timezone setting or the date_default_timezone_set() function. In case you used any of those methods and you are still getting this warning, you most likely misspelled the timezone identifier. We selected the timezone 'UTC' for now, but please set date.timezone to select your timezone. in /usr/share/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty_Compiler.class.php on line 370 + + + + + + Docs For Class FakeSession + + + + +
+

 Class FakeSession

+ + +
+
Description
+ +
+ +

Sometimes 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.

+
    +
  • author: karora
  • +
+

+ Located in /inc/FakeSession.php (line 12) +

+ + +

+	
+			
+
+ + + + + +
+
Method Summary
+ +
+
+
+  + FakeSession + __construct + ( $user_no) +
+
+  + void + AllowedTo + ( $do_something) +
+
+
+
+ + + +
+
Methods
+ +
+ +Strict Standards: Only variables should be passed by reference in /usr/share/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty_Compiler.class.php on line 712 + +Warning: strftime(): It is not safe to rely on the system's timezone settings. You are *required* to use the date.timezone setting or the date_default_timezone_set() function. In case you used any of those methods and you are still getting this warning, you most likely misspelled the timezone identifier. We selected the timezone 'UTC' for now, but please set date.timezone to select your timezone. in /usr/share/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty_Compiler.class.php on line 370 + + +
+ +
+ + Constructor __construct (line 14) +
+ + + +
+ FakeSession + + __construct + + ( $user_no) +
+ +
    +
  • + + $user_no
  • +
+ + +
+ +
+ +
+ + AllowedTo (line 35) +
+ + + +
+ void + + AllowedTo + + ( $do_something) +
+ +
    +
  • + + $do_something
  • +
+ + +
+ +
+
+ + + +Warning: strftime(): It is not safe to rely on the system's timezone settings. You are *required* to use the date.timezone setting or the date_default_timezone_set() function. In case you used any of those methods and you are still getting this warning, you most likely misspelled the timezone identifier. We selected the timezone 'UTC' for now, but please set date.timezone to select your timezone. in /usr/share/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty_Compiler.class.php on line 370 +

+ Documentation generated on Sun, 08 Jul 2012 12:53:49 +0000 by phpDocumentor 1.4.3 +

+
+ \ No newline at end of file diff --git a/docs/api/davical/_inc---CalDAVSyncCache.php.html b/docs/api/davical/_inc---CalDAVSyncCache.php.html new file mode 100644 index 00000000..701b8f25 --- /dev/null +++ b/docs/api/davical/_inc---CalDAVSyncCache.php.html @@ -0,0 +1,142 @@ + +Warning: strftime(): It is not safe to rely on the system's timezone settings. You are *required* to use the date.timezone setting or the date_default_timezone_set() function. In case you used any of those methods and you are still getting this warning, you most likely misspelled the timezone identifier. We selected the timezone 'UTC' for now, but please set date.timezone to select your timezone. in /usr/share/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty_Compiler.class.php on line 370 + + + + + + Docs for page CalDAVSyncCache.php + + + + +
+

File/inc/CalDAVSyncCache.php

+ + +
+
Description
+ +
+ + +
+
+ + +
+
Classes
+ +
+ + + + + + + + + +
ClassDescription
+  class + CalDAVSyncCache + + Our SyncCache holds +
+
+
+ + +
+
Includes
+ +
+ +Strict Standards: Only variables should be passed by reference in /usr/share/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty_Compiler.class.php on line 712 + +Warning: strftime(): It is not safe to rely on the system's timezone settings. You are *required* to use the date.timezone setting or the date_default_timezone_set() function. In case you used any of those methods and you are still getting this warning, you most likely misspelled the timezone identifier. We selected the timezone 'UTC' for now, but please set date.timezone to select your timezone. in /usr/share/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty_Compiler.class.php on line 370 + +
+ +
+  + + 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 +

+
+ \ No newline at end of file diff --git a/docs/api/davical/_inc---CalDAVSyncState.php.html b/docs/api/davical/_inc---CalDAVSyncState.php.html new file mode 100644 index 00000000..7916bf84 --- /dev/null +++ b/docs/api/davical/_inc---CalDAVSyncState.php.html @@ -0,0 +1,63 @@ + + + + + + Docs for page CalDAVSyncState.php + + + + +
+

File/inc/CalDAVSyncState.php

+ + +
+
Description
+ +
+ + +
+
+ + +
+
Classes
+ +
+ + + + + + + + + +
ClassDescription
+  class + 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 +

+
+ \ No newline at end of file diff --git a/docs/api/davical/_inc---FakeSession.php.html b/docs/api/davical/_inc---FakeSession.php.html new file mode 100644 index 00000000..ac6a8955 --- /dev/null +++ b/docs/api/davical/_inc---FakeSession.php.html @@ -0,0 +1,97 @@ + +Warning: strftime(): It is not safe to rely on the system's timezone settings. You are *required* to use the date.timezone setting or the date_default_timezone_set() function. In case you used any of those methods and you are still getting this warning, you most likely misspelled the timezone identifier. We selected the timezone 'UTC' for now, but please set date.timezone to select your timezone. in /usr/share/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty_Compiler.class.php on line 370 + + + + + + Docs for page FakeSession.php + + + + +
+

File/inc/FakeSession.php

+ + +
+
Description
+ +
+ + +
+
+ + +
+
Classes
+ +
+ + + + + + + + + +
ClassDescription
+  class + FakeSession + + Sometimes we need a fake session when we are using the DAViCal libraries from a script POV. +
+
+
+ + +
+
Includes
+ +
+ +Strict Standards: Only variables should be passed by reference in /usr/share/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty_Compiler.class.php on line 712 + +Warning: strftime(): It is not safe to rely on the system's timezone settings. You are *required* to use the date.timezone setting or the date_default_timezone_set() function. In case you used any of those methods and you are still getting this warning, you most likely misspelled the timezone identifier. We selected the timezone 'UTC' for now, but please set date.timezone to select your timezone. in /usr/share/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty_Compiler.class.php on line 370 + +
+ +
+  + + require_once + ('Principal.php') + (line 2) + +
+ + + +
+
+
+ + + + +

+ Documentation generated on Sun, 08 Jul 2012 12:53:49 +0000 by phpDocumentor 1.4.3 +

+
+ \ No newline at end of file