Caldav-client-v2 - Revision history

Mvanbeek: /* Usage and Examples */

2014-08-18T17:22:42Z

Usage and Examples

← Older revision		Revision as of 17:22, 18 August 2014
Line 4:		Line 4:

	=== Usage and Examples ===		=== Usage and Examples ===
			Connect to the resource.
			<code>$cal = new CalDAVClient(server, username, password, calendar);</code>


	<pre>		<pre>
	/**		/**
Line 78:		Line 82:
	*/		*/
	</pre>		</pre>


	=== Variables ===		=== Variables ===

Mvanbeek at 17:18, 18 August 2014

2014-08-18T17:18:18Z

← Older revision		Revision as of 17:18, 18 August 2014
Line 2:		Line 2:

	== CalDAVClient ==		== CalDAVClient ==

			=== Usage and Examples ===
			<pre>
			/**
			* Usage example
			*
			* $cal = new CalDAVClient( "http://calendar.example.com/caldav.php/username/calendar/", "username", "password", "calendar" );
			* $options = $cal->DoOptionsRequest();
			* if ( isset($options["PROPFIND"]) ) {
			* // Fetch some information about the events in that calendar
			* $cal->SetDepth(1);
			* $folder_xml = $cal->DoXMLRequest("PROPFIND", '<?xml version="1.0" encoding="utf-8" ?><propfind xmlns="DAV:"><prop><getcontentleng
			th/><getcontenttype/><resourcetype/><getetag/></prop></propfind>' );
			* }
			* // Fetch all events for February
			* $events = $cal->GetEvents("20070101T000000Z","20070201T000000Z");
			* foreach ( $events AS $k => $event ) {
			* do_something_with_event_data( $event['data'] );
			* }
			* $acc = array();
			* $acc["google"] = array(
			* "user"=>"kunsttherapie@gmail.com",
			* "pass"=>"xxxxx",
			* "server"=>"ssl://www.google.com",
			* "port"=>"443",
			* "uri"=>"https://www.google.com/calendar/dav/kunsttherapie@gmail.com/events/",
			* );
			*
			* $acc["davical"] = array(
			* "user"=>"some_user",
			* "pass"=>"big secret",
			* "server"=>"calendar.foo.bar",
			* "port"=>"80",
			* "uri"=>"http://calendar.foo.bar/caldav.php/some_user/home/",
			* );
			* //*******************************
			*
			* $account = $acc["davical"];
			*
			* //*******************************
			* $cal = new CalDAVClient( $account["uri"], $account["user"], $account["pass"], "", $account["server"], $account["port"] );
			* $options = $cal->DoOptionsRequest();
			* print_r($options);
			*
			* //*******************************
			* //*******************************
			*
			* $xmlC = <<<PROPP
			* <?xml version="1.0" encoding="utf-8" ?>
			* <D:propfind xmlns:D="DAV:" xmlns:C="http://calendarserver.org/ns/">
			* <D:prop>
			* <D:displayname />
			* <C:getctag />
			* <D:resourcetype />
			*
			* </D:prop>
			* </D:propfind>
			* PROPP;
			* //if ( isset($options["PROPFIND"]) ) {
			* // Fetch some information about the events in that calendar
			* // $cal->SetDepth(1);
			* // $folder_xml = $cal->DoXMLRequest("PROPFIND", $xmlC);
			* // print_r( $folder_xml);
			* //}
			*
			* // Fetch all events for February
			* $events = $cal->GetEvents("20090201T000000Z","20090301T000000Z");
			* foreach ( $events as $k => $event ) {
			* print_r($event['data']);
			* print "\n---------------------------------------------\n";
			* }
			*
			* //*******************************
			* //*******************************
			*/
			</pre>


	=== Variables ===		=== Variables ===

Mvanbeek: /* Functions */

2014-08-18T17:15:07Z

Functions

← Older revision		Revision as of 17:15, 18 August 2014
Line 69:		Line 69:
	** @return array The allowed options		** @return array The allowed options

	*<pre>DoXMLRequest( $request_method, $xml, $url = null ) // Send an XML request to the server (~~e.g.~~ PROPFIND, REPORT, MKCALENDAR)</pre>		*<pre>DoXMLRequest( $request_method, $xml, $url = null ) // Send an XML request to the server (PROPFIND, REPORT, MKCALENDAR)</pre>
	** @param string $method The method (PROPFIND, REPORT, etc) to use with the request		** @param string $method The method (PROPFIND, REPORT, etc) to use with the request
	** @param string $xml The XML to send along with the request		** @param string $xml The XML to send along with the request
Line 75:		Line 75:
	** @return array An array of the allowed methods		** @return array An array of the allowed methods

	*<pre>DoGETRequest( $url )</pre>		*<pre>DoGETRequest( $url ) // Get a single item from the server.</pre>
			** @param string $url The URL to GET
	*<pre>DoHEADRequest( $url )</pre>

			*<pre>DoHEADRequest( $url ) // Get the HEAD of a single item from the server.</pre>
			** @param string $url The URL to HEAD

	*<pre>DoPUTRequest( $url, $icalendar, $etag = null )</pre>		*<pre>DoPUTRequest( $url, $icalendar, $etag = null )</pre>


	*<pre>DoDELETERequest( $url, $etag = null )</pre>		*<pre>DoDELETERequest( $url, $etag = null )</pre>
	*<pre>DoPROPFINDRequest( $url, $props, $depth = 0 )</pre>		*<pre>DoPROPFINDRequest( $url, $props, $depth = 0 )</pre>

Mvanbeek: /* Functions */

2014-08-18T17:10:05Z

Functions

@@ Line 41: / Line 41: @@
 ** @param string $url The calendar_url
-*<pre>ParseResponse</pre>
+*<pre>ParseResponse( $response )  //  Split response into httpResponse and xmlResponse</pre>
 *<pre>DoGETRequest( $url )</pre>
 *<pre>DoHEADRequest( $url )</pre>

Mvanbeek: /* Functions */

2014-08-18T17:00:00Z

Functions

← Older revision		Revision as of 17:00, 18 August 2014
Line 24:		Line 24:
	** @param string $user The name of the user logging in		** @param string $user The name of the user logging in
	** @param string $pass The password for that user		** @param string $pass The password for that user

	<pre>SetMatch( $match, $etag = '' ) // Adds an If-Match or If-None-Match header</pre>		<pre>SetMatch( $match, $etag = '' ) // Adds an If-Match or If-None-Match header</pre>
	** @param bool $match to Match or Not to Match, that is the question!		** @param bool $match to Match or Not to Match, that is the question!
	** @param string $etag The etag to match / not match against.		** @param string $etag The etag to match / not match against.

	*<pre>SetDepth</pre>		*<pre>SetDepth( $depth = '0' ) // Add a Depth: header. Valid values are 0, 1 or infinity</pre>
			** @param int $depth The depth, default to infinity
	*:Info

	*<pre>SetUserAgent</pre>
			*<pre>SetUserAgent( $user_agent = null ) // Sets User Agent</pre>
	*<pre>SetContentType</pre>
			** @param int $user_agent The User Agent String to set. Defaults to predefined class variable if blank
	*<pre>SetCalendar</pre>

			*<pre>SetContentType( $type ) // Add a Content-type: header</pre>
			** @param string $type The content type

			*<pre>SetCalendar( $url ) // Set the calendar_url we will be using for a while.</pre>
			** @param string $url The calendar_url

	*<pre>ParseResponse</pre>		*<pre>ParseResponse</pre>


	*<pre>GetHttpRequest</pre>		*<pre>GetHttpRequest</pre>
	*<pre>GetResponseHeaders</pre>		*<pre>GetResponseHeaders</pre>

Mvanbeek: /* Functions */

2014-08-18T16:54:14Z

Functions

← Older revision		Revision as of 16:54, 18 August 2014
Line 24:		Line 24:
	** @param string $user The name of the user logging in		** @param string $user The name of the user logging in
	** @param string $pass The password for that user		** @param string $pass The password for that user
	*<pre>SetMatch</pre>		<pre>SetMatch( $match, $etag = '' ) // Adds an If-Match or If-None-Match header</pre>
			** @param bool $match to Match or Not to Match, that is the question!
	*:Info
			** @param string $etag The etag to match / not match against.

	*<pre>SetDepth</pre>		*<pre>SetDepth</pre>
	*:Info		*:Info

Mvanbeek: /* Functions */

2014-08-18T16:52:51Z

Functions

← Older revision		Revision as of 16:52, 18 August 2014
Line 20:		Line 20:

	=== Functions ===		=== Functions ===
	*<pre>__construct( $base_url, $user, $pass )</pre>		*<pre>__construct( $base_url, $user, $pass ) // Constructor, initialises the class</pre>
	*:Constructor, initialises the class
	** @param string $base_url The URL for the calendar server		** @param string $base_url The URL for the calendar server
	** @param string $user The name of the user logging in		** @param string $user The name of the user logging in

Mvanbeek: /* Functions */

2014-08-18T16:52:12Z

Functions

← Older revision		Revision as of 16:52, 18 August 2014
Line 20:		Line 20:

	=== Functions ===		=== Functions ===
	*<pre>__construct</pre>		*<pre>__construct( $base_url, $user, $pass )</pre>
			*:Constructor, initialises the class
	*:
			** @param string $base_url The URL for the calendar server
			** @param string $user The name of the user logging in
			** @param string $pass The password for that user
	*<pre>SetMatch</pre>		*<pre>SetMatch</pre>
	*:Info		*:Info

Mvanbeek: /* Variables */

2014-08-18T16:50:59Z

Variables

← Older revision		Revision as of 16:50, 18 August 2014
Line 4:		Line 4:

	=== Variables ===		=== Variables ===
	*<pre>protected $base_url, $user, $pass, $entry, $protocol, $server, $port;</pre>		*<pre>protected $base_url, $user, $pass, $entry, $protocol, $server, $port; // Connection details</pre>
	*:Server, username, password, calendar (connection details, basically)
	*<pre>protected $principal_url; // The principal-URL we're using</pre>		*<pre>protected $principal_url; // The principal-URL we're using</pre>
	*<pre>protected $calendar_url; // The calendar-URL we're using</pre>		*<pre>protected $calendar_url; // The calendar-URL we're using</pre>

Mvanbeek at 16:50, 18 August 2014

2014-08-18T16:50:19Z

← Older revision		Revision as of 16:50, 18 August 2014
Line 6:		Line 6:
	*<pre>protected $base_url, $user, $pass, $entry, $protocol, $server, $port;</pre>		*<pre>protected $base_url, $user, $pass, $entry, $protocol, $server, $port;</pre>
	*:Server, username, password, calendar (connection details, basically)		*:Server, username, password, calendar (connection details, basically)
	*<pre>protected $principal_url;</pre>		*<pre>protected $principal_url; // The principal-URL we're using</pre>
	*:The ~~principal~~-URL we're using		*<pre>protected $calendar_url; // The calendar-URL we're using</pre>
	*<pre>protected $~~calendar_url~~;</pre>		*<pre>protected $calendar_home_set; // The calendar-home-set we're using</pre>
		⚫	*<pre>protected $calendar_urls; // The calendar_urls we have discovered</pre>
	*:The calendar-URL we're using
		⚫	*<pre>public $user_agent = 'DAViCalClient'; // The useragent which is send to the caldav server</pre>
	*<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 $headers = array();</pre>
	*<pre>protected $body = "";</pre>		*<pre>protected $body = "";</pre>