Caldav-client-v2: Difference between revisions
From Supporting Role Wiki
Jump to navigationJump to search
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
This page holds some basic info on the Davical caldav-client-v2 library that ships with Davical. |
This page holds some basic info on the Davical caldav-client-v2 library that ships with Davical. |
||
== |
== CalDAVClient == |
||
=== Variables === |
|||
*<pre>protected $base_url, $user, $pass, $entry, $protocol, $server, $port;</pre> |
|||
*:Server, username, password, calendar (connection details, basically) |
|||
*<pre>protected $principal_url;</pre> |
|||
*:The principal-URL we're using |
|||
*<pre>protected $calendar_url;</pre> |
|||
*:The calendar-URL we're using |
|||
*<pre>protected $calendar_home_set;</pre> |
|||
*:The calendar-home-set we're using |
|||
*<pre>protected $calendar_urls;</pre> |
|||
*:The calendar_urls we have discovered |
|||
*<pre>public $user_agent = 'DAViCalClient';</pre> |
|||
*:The useragent which is send to the caldav server |
|||
*<pre>protected $headers = array();</pre> |
|||
*<pre>protected $body = "";</pre> |
|||
*<pre>protected $requestMethod = "GET";</pre> |
|||
*<pre>protected $httpRequest = ""; // for debugging http headers sent</pre> |
|||
*<pre>protected $xmlRequest = ""; // for debugging xml sent</pre> |
|||
*<pre>protected $httpResponse = ""; // http headers received</pre> |
|||
*<pre>protected $xmlResponse = ""; // xml received</pre> |
|||
*<pre>protected $parser; // our XML parser object</pre> |
|||
=== Functions === |
|||
*<pre>__construct</pre> |
*<pre>__construct</pre> |
||
*: |
*: |
||
*<pre>SetMatch</pre> |
*<pre>SetMatch</pre> |
||
*:Info |
*:Info |
||
Revision as of 16:48, 18 August 2014
This page holds some basic info on the Davical caldav-client-v2 library that ships with Davical.
CalDAVClient
Variables
protected $base_url, $user, $pass, $entry, $protocol, $server, $port;
- Server, username, password, calendar (connection details, basically)
protected $principal_url;
- The principal-URL we're using
protected $calendar_url;
- The calendar-URL we're using
protected $calendar_home_set;
- The calendar-home-set we're using
protected $calendar_urls;
- The calendar_urls we have discovered
public $user_agent = 'DAViCalClient';
- The useragent which is send to the caldav server
protected $headers = array();
protected $body = "";
protected $requestMethod = "GET";
protected $httpRequest = ""; // for debugging http headers sent
protected $xmlRequest = ""; // for debugging xml sent
protected $httpResponse = ""; // http headers received
protected $xmlResponse = ""; // xml received
protected $parser; // our XML parser object
Functions
__construct
SetMatch
- Info
SetDepth
- Info
SetUserAgent
SetContentType
SetCalendar
ParseResponse
GetHttpRequest
GetResponseHeaders
GetResponseBody
GetXmlRequest()
GetXmlResponse()
DoRequest( $url = null )
Unchunk()
DoOptionsRequest( $url = null )
DoXMLRequest( $request_method, $xml, $url = null )
DoGETRequest( $url )
DoHEADRequest( $url )
DoPUTRequest( $url, $icalendar, $etag = null )
DoDELETERequest( $url, $etag = null )
DoPROPFINDRequest( $url, $props, $depth = 0 )
PrincipalURL( $url = null )
CalendarHomeSet( $urls = null )
CalendarUrls( $urls = null )
HrefValueInside( $tagname )
HrefForProp( $tagname, $i = 0 )
HrefForResourcetype( $tagname, $i = 0 )
GetOKProps( $nodenum )
FindPrincipal( $url )
FindCalendarHome( $recursed=false )
FindCalendars( $recursed=false )
GetCalendarDetails( $url = null )
GetCollectionETags( $url = null )
CalendarMultiget( $event_hrefs, $url = null )
DoCalendarQuery( $filter, $url = '' )
GetEvents( $start = null, $finish = null, $relative_url = '' )
GetTodos( $start, $finish, $completed = false, $cancelled = false, $relative_url = "" )
GetEntryByUid( $uid, $relative_url = '' )
GetEntryByHref( $href )