?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
Release 0.9.9
[davical.git] / docs / api / awl / caldav / CalDAVClient.html
blobed25e3858165ada92b19d5f2ec427435ad5aed54
1 <?xml version="1.0" encoding="iso-8859-1"?>
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml">
4 <head>
5 <!-- template designed by Marco Von Ballmoos -->
6 <title>Docs For Class CalDAVClient</title>
7 <link rel="stylesheet" href="../../media/stylesheet.css" />
8 <meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
9 </head>
10 <body>
11 <div class="page-body">
12 <h2 class="class-name"><img src="../../media/images/Class_logo.png"
13 alt=" Class"
14 title=" Class"
15 style="vertical-align: middle"> CalDAVClient</h2>
16
17 <a name="sec-description"></a>
18 <div class="info-box">
19 <div class="info-box-title">Description</div>
20 <div class="nav-bar">
21 <span class="disabled">Description</span> |
22 <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
23 | <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
24
25 </div>
26 <div class="info-box-body">
27 <!-- ========== Info from phpDoc block ========= -->
28 <p class="short-description">A class for accessing DAViCal via CalDAV, as a client</p>
29 <p class="notes">
30 Located in <a class="field" href="_inc---caldav-client-v2.php.html">/inc/caldav-client-v2.php</a> (line <span class="field">39</span>)
31 </p>
32
33
34 <pre></pre>
35
36 </div>
37 </div>
38
39
40
41 <a name="sec-var-summary"></a>
42 <div class="info-box">
43 <div class="info-box-title">Variable Summary</span></div>
44 <div class="nav-bar">
45 <a href="#sec-description">Description</a> |
46 <span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
47 |
48 <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
49
50 </div>
51 <div class="info-box-body">
52 <div class="var-summary">
53 <div class="var-title">
54 <img src="../../media/images/Variable.png" alt=" " />
55 <span class="var-type">string</span>
56 <a href="#$base_url" title="details" class="var-name">$base_url</a>
57 </div>
58 <div class="var-title">
59 <img src="../../media/images/Variable.png" alt=" " />
60 <span class="var-type">mixed</span>
61 <a href="#$body" title="details" class="var-name">$body</a>
62 </div>
63 <div class="var-title">
64 <img src="../../media/images/Variable.png" alt=" " />
65 <span class="var-type">mixed</span>
66 <a href="#$calendar_home_set" title="details" class="var-name">$calendar_home_set</a>
67 </div>
68 <div class="var-title">
69 <img src="../../media/images/Variable.png" alt=" " />
70 <span class="var-type">mixed</span>
71 <a href="#$calendar_url" title="details" class="var-name">$calendar_url</a>
72 </div>
73 <div class="var-title">
74 <img src="../../media/images/Variable.png" alt=" " />
75 <span class="var-type">mixed</span>
76 <a href="#$calendar_urls" title="details" class="var-name">$calendar_urls</a>
77 </div>
78 <div class="var-title">
79 <img src="../../media/images/Variable.png" alt=" " />
80 <span class="var-type">mixed</span>
81 <a href="#$entry" title="details" class="var-name">$entry</a>
82 </div>
83 <div class="var-title">
84 <img src="../../media/images/Variable.png" alt=" " />
85 <span class="var-type">mixed</span>
86 <a href="#$headers" title="details" class="var-name">$headers</a>
87 </div>
88 <div class="var-title">
89 <img src="../../media/images/Variable.png" alt=" " />
90 <span class="var-type">mixed</span>
91 <a href="#$httpRequest" title="details" class="var-name">$httpRequest</a>
92 </div>
93 <div class="var-title">
94 <img src="../../media/images/Variable.png" alt=" " />
95 <span class="var-type">mixed</span>
96 <a href="#$httpResponse" title="details" class="var-name">$httpResponse</a>
97 </div>
98 <div class="var-title">
99 <img src="../../media/images/Variable.png" alt=" " />
100 <span class="var-type">mixed</span>
101 <a href="#$parser" title="details" class="var-name">$parser</a>
102 </div>
103 <div class="var-title">
104 <img src="../../media/images/Variable.png" alt=" " />
105 <span class="var-type">mixed</span>
106 <a href="#$pass" title="details" class="var-name">$pass</a>
107 </div>
108 <div class="var-title">
109 <img src="../../media/images/Variable.png" alt=" " />
110 <span class="var-type">mixed</span>
111 <a href="#$port" title="details" class="var-name">$port</a>
112 </div>
113 <div class="var-title">
114 <img src="../../media/images/Variable.png" alt=" " />
115 <span class="var-type">mixed</span>
116 <a href="#$principal_url" title="details" class="var-name">$principal_url</a>
117 </div>
118 <div class="var-title">
119 <img src="../../media/images/Variable.png" alt=" " />
120 <span class="var-type">mixed</span>
121 <a href="#$protocol" title="details" class="var-name">$protocol</a>
122 </div>
123 <div class="var-title">
124 <img src="../../media/images/Variable.png" alt=" " />
125 <span class="var-type">mixed</span>
126 <a href="#$requestMethod" title="details" class="var-name">$requestMethod</a>
127 </div>
128 <div class="var-title">
129 <img src="../../media/images/Variable.png" alt=" " />
130 <span class="var-type">mixed</span>
131 <a href="#$server" title="details" class="var-name">$server</a>
132 </div>
133 <div class="var-title">
134 <img src="../../media/images/Variable.png" alt=" " />
135 <span class="var-type">mixed</span>
136 <a href="#$user" title="details" class="var-name">$user</a>
137 </div>
138 <div class="var-title">
139 <img src="../../media/images/Variable.png" alt=" " />
140 <span class="var-type">string</span>
141 <a href="#$user_agent" title="details" class="var-name">$user_agent</a>
142 </div>
143 <div class="var-title">
144 <img src="../../media/images/Variable.png" alt=" " />
145 <span class="var-type">mixed</span>
146 <a href="#$xmlRequest" title="details" class="var-name">$xmlRequest</a>
147 </div>
148 <div class="var-title">
149 <img src="../../media/images/Variable.png" alt=" " />
150 <span class="var-type">mixed</span>
151 <a href="#$xmlResponse" title="details" class="var-name">$xmlResponse</a>
152 </div>
153 </div>
154 </div>
155 </div>
156
157 <a name="sec-method-summary"></a>
158 <div class="info-box">
159 <div class="info-box-title">Method Summary</span></div>
160 <div class="nav-bar">
161 <a href="#sec-description">Description</a> |
162 <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
163
164 |
165 <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
166 </div>
167 <div class="info-box-body">
168 <div class="method-summary">
169 <div class="method-definition">
170 <img src="../../media/images/Constructor.png" alt=" "/>
171 <span class="method-result">CalDAVClient</span>
172 <a href="#__construct" title="details" class="method-name">__construct</a>
173 (<span class="var-type">string</span>&nbsp;<span class="var-name">$base_url</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$user</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$pass</span>)
174 </div>
175 <div class="method-definition">
176 <img src="../../media/images/Method.png" alt=" "/>
177 <span class="method-result">void</span>
178 <a href="#CalendarHomeSet" title="details" class="method-name">CalendarHomeSet</a>
179 ([<span class="var-type">$url</span>&nbsp;<span class="var-name">$urls</span> = <span class="var-default">null</span>])
180 </div>
181 <div class="method-definition">
182 <img src="../../media/images/Method.png" alt=" "/>
183 <span class="method-result">void</span>
184 <a href="#CalendarMultiget" title="details" class="method-name">CalendarMultiget</a>
185 (<span class="var-type"></span>&nbsp;<span class="var-name">$event_hrefs</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$url</span> = <span class="var-default">null</span>])
186 </div>
187 <div class="method-definition">
188 <img src="../../media/images/Method.png" alt=" "/>
189 <span class="method-result">void</span>
190 <a href="#CalendarUrls" title="details" class="method-name">CalendarUrls</a>
191 ([<span class="var-type">$urls</span>&nbsp;<span class="var-name">$urls</span> = <span class="var-default">null</span>])
192 </div>
193 <div class="method-definition">
194 <img src="../../media/images/Method.png" alt=" "/>
195 <span class="method-result">array</span>
196 <a href="#DoCalendarQuery" title="details" class="method-name">DoCalendarQuery</a>
197 (<span class="var-type">string</span>&nbsp;<span class="var-name">$filter</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$url</span> = <span class="var-default">null</span>])
198 </div>
199 <div class="method-definition">
200 <img src="../../media/images/Method.png" alt=" "/>
201 <span class="method-result">int</span>
202 <a href="#DoDELETERequest" title="details" class="method-name">DoDELETERequest</a>
203 (<span class="var-type">string</span>&nbsp;<span class="var-name">$url</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$etag</span> = <span class="var-default">null</span>])
204 </div>
205 <div class="method-definition">
206 <img src="../../media/images/Method.png" alt=" "/>
207 <span class="method-result">void</span>
208 <a href="#DoGETRequest" title="details" class="method-name">DoGETRequest</a>
209 (<span class="var-type">string</span>&nbsp;<span class="var-name">$url</span>)
210 </div>
211 <div class="method-definition">
212 <img src="../../media/images/Method.png" alt=" "/>
213 <span class="method-result">void</span>
214 <a href="#DoHEADRequest" title="details" class="method-name">DoHEADRequest</a>
215 (<span class="var-type">string</span>&nbsp;<span class="var-name">$url</span>)
216 </div>
217 <div class="method-definition">
218 <img src="../../media/images/Method.png" alt=" "/>
219 <span class="method-result">array</span>
220 <a href="#DoOptionsRequest" title="details" class="method-name">DoOptionsRequest</a>
221 ([<span class="var-type">string</span>&nbsp;<span class="var-name">$url</span> = <span class="var-default">null</span>])
222 </div>
223 <div class="method-definition">
224 <img src="../../media/images/Method.png" alt=" "/>
225 <span class="method-result">void</span>
226 <a href="#DoPROPFINDRequest" title="details" class="method-name">DoPROPFINDRequest</a>
227 (<span class="var-type">string</span>&nbsp;<span class="var-name">$url</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$props</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$depth</span> = <span class="var-default">0</span>])
228 </div>
229 <div class="method-definition">
230 <img src="../../media/images/Method.png" alt=" "/>
231 <span class="method-result">string</span>
232 <a href="#DoPUTRequest" title="details" class="method-name">DoPUTRequest</a>
233 (<span class="var-type">string</span>&nbsp;<span class="var-name">$url</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$icalendar</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$etag</span> = <span class="var-default">null</span>])
234 </div>
235 <div class="method-definition">
236 <img src="../../media/images/Method.png" alt=" "/>
237 <span class="method-result">string</span>
238 <a href="#DoRequest" title="details" class="method-name">DoRequest</a>
239 ([<span class="var-type">string</span>&nbsp;<span class="var-name">$url</span> = <span class="var-default">null</span>])
240 </div>
241 <div class="method-definition">
242 <img src="../../media/images/Method.png" alt=" "/>
243 <span class="method-result">array</span>
244 <a href="#DoXMLRequest" title="details" class="method-name">DoXMLRequest</a>
245 (<span class="var-type"></span>&nbsp;<span class="var-name">$request_method</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$xml</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$url</span> = <span class="var-default">null</span>], <span class="var-type">string</span>&nbsp;<span class="var-name">$method</span>)
246 </div>
247 <div class="method-definition">
248 <img src="../../media/images/Method.png" alt=" "/>
249 <span class="method-result">void</span>
250 <a href="#FindCalendarHome" title="details" class="method-name">FindCalendarHome</a>
251 ([<span class="var-type"></span>&nbsp;<span class="var-name">$recursed</span> = <span class="var-default">false</span>], <span class="var-type">string</span>&nbsp;<span class="var-name">$url</span>)
252 </div>
253 <div class="method-definition">
254 <img src="../../media/images/Method.png" alt=" "/>
255 <span class="method-result">void</span>
256 <a href="#FindCalendars" title="details" class="method-name">FindCalendars</a>
257 ([<span class="var-type"></span>&nbsp;<span class="var-name">$recursed</span> = <span class="var-default">false</span>])
258 </div>
259 <div class="method-definition">
260 <img src="../../media/images/Method.png" alt=" "/>
261 <span class="method-result">void</span>
262 <a href="#FindPrincipal" title="details" class="method-name">FindPrincipal</a>
263 (<span class="var-type">string</span>&nbsp;<span class="var-name">$url</span>)
264 </div>
265 <div class="method-definition">
266 <img src="../../media/images/Method.png" alt=" "/>
267 <span class="method-result">void</span>
268 <a href="#GetCalendarDetails" title="details" class="method-name">GetCalendarDetails</a>
269 ([<span class="var-type"></span>&nbsp;<span class="var-name">$url</span> = <span class="var-default">null</span>])
270 </div>
271 <div class="method-definition">
272 <img src="../../media/images/Method.png" alt=" "/>
273 <span class="method-result">void</span>
274 <a href="#GetCollectionETags" title="details" class="method-name">GetCollectionETags</a>
275 ([<span class="var-type"></span>&nbsp;<span class="var-name">$url</span> = <span class="var-default">null</span>])
276 </div>
277 <div class="method-definition">
278 <img src="../../media/images/Method.png" alt=" "/>
279 <span class="method-result">string</span>
280 <a href="#GetEntryByHref" title="details" class="method-name">GetEntryByHref</a>
281 (<span class="var-type">string</span>&nbsp;<span class="var-name">$href</span>)
282 </div>
283 <div class="method-definition">
284 <img src="../../media/images/Method.png" alt=" "/>
285 <span class="method-result">array</span>
286 <a href="#GetEntryByUid" title="details" class="method-name">GetEntryByUid</a>
287 (<span class="var-type">uid</span>&nbsp;<span class="var-name">$uid</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$relative_url</span> = <span class="var-default">''</span>])
288 </div>
289 <div class="method-definition">
290 <img src="../../media/images/Method.png" alt=" "/>
291 <span class="method-result">array</span>
292 <a href="#GetEvents" title="details" class="method-name">GetEvents</a>
293 ([<span class="var-type">timestamp</span>&nbsp;<span class="var-name">$start</span> = <span class="var-default">null</span>], [<span class="var-type">timestamp</span>&nbsp;<span class="var-name">$finish</span> = <span class="var-default">null</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$relative_url</span> = <span class="var-default">''</span>])
294 </div>
295 <div class="method-definition">
296 <img src="../../media/images/Method.png" alt=" "/>
297 <span class="method-result">HTTP</span>
298 <a href="#GetHttpRequest" title="details" class="method-name">GetHttpRequest</a>
299 ()
300 </div>
301 <div class="method-definition">
302 <img src="../../media/images/Method.png" alt=" "/>
303 <span class="method-result">void</span>
304 <a href="#GetOKProps" title="details" class="method-name">GetOKProps</a>
305 (<span class="var-type">string</span>&nbsp;<span class="var-name">$nodenum</span>)
306 </div>
307 <div class="method-definition">
308 <img src="../../media/images/Method.png" alt=" "/>
309 <span class="method-result">HTTP</span>
310 <a href="#GetResponseBody" title="details" class="method-name">GetResponseBody</a>
311 ()
312 </div>
313 <div class="method-definition">
314 <img src="../../media/images/Method.png" alt=" "/>
315 <span class="method-result">HTTP</span>
316 <a href="#GetResponseHeaders" title="details" class="method-name">GetResponseHeaders</a>
317 ()
318 </div>
319 <div class="method-definition">
320 <img src="../../media/images/Method.png" alt=" "/>
321 <span class="method-result">array</span>
322 <a href="#GetTodos" title="details" class="method-name">GetTodos</a>
323 (<span class="var-type">timestamp</span>&nbsp;<span class="var-name">$start</span>, <span class="var-type">timestamp</span>&nbsp;<span class="var-name">$finish</span>, [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$completed</span> = <span class="var-default">false</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$cancelled</span> = <span class="var-default">false</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$relative_url</span> = <span class="var-default">&quot;&quot;</span>])
324 </div>
325 <div class="method-definition">
326 <img src="../../media/images/Method.png" alt=" "/>
327 <span class="method-result">raw</span>
328 <a href="#GetXmlRequest" title="details" class="method-name">GetXmlRequest</a>
329 ()
330 </div>
331 <div class="method-definition">
332 <img src="../../media/images/Method.png" alt=" "/>
333 <span class="method-result">raw</span>
334 <a href="#GetXmlResponse" title="details" class="method-name">GetXmlResponse</a>
335 ()
336 </div>
337 <div class="method-definition">
338 <img src="../../media/images/Method.png" alt=" "/>
339 <span class="method-result">void</span>
340 <a href="#HrefForProp" title="details" class="method-name">HrefForProp</a>
341 (<span class="var-type">string</span>&nbsp;<span class="var-name">$tagname</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$i</span> = <span class="var-default">0</span>], <span class="var-type">integer</span>&nbsp;<span class="var-name">$which</span>)
342 </div>
343 <div class="method-definition">
344 <img src="../../media/images/Method.png" alt=" "/>
345 <span class="method-result">void</span>
346 <a href="#HrefForResourcetype" title="details" class="method-name">HrefForResourcetype</a>
347 (<span class="var-type">string</span>&nbsp;<span class="var-name">$tagname</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$i</span> = <span class="var-default">0</span>], <span class="var-type">integer</span>&nbsp;<span class="var-name">$which</span>)
348 </div>
349 <div class="method-definition">
350 <img src="../../media/images/Method.png" alt=" "/>
351 <span class="method-result">void</span>
352 <a href="#HrefValueInside" title="details" class="method-name">HrefValueInside</a>
353 (<span class="var-type">string</span>&nbsp;<span class="var-name">$tagname</span>)
354 </div>
355 <div class="method-definition">
356 <img src="../../media/images/Method.png" alt=" "/>
357 <span class="method-result">void</span>
358 <a href="#ParseResponse" title="details" class="method-name">ParseResponse</a>
359 (<span class="var-type">string</span>&nbsp;<span class="var-name">$response</span>)
360 </div>
361 <div class="method-definition">
362 <img src="../../media/images/Method.png" alt=" "/>
363 <span class="method-result">void</span>
364 <a href="#PrincipalURL" title="details" class="method-name">PrincipalURL</a>
365 ([<span class="var-type">$url</span>&nbsp;<span class="var-name">$url</span> = <span class="var-default">null</span>])
366 </div>
367 <div class="method-definition">
368 <img src="../../media/images/Method.png" alt=" "/>
369 <span class="method-result">void</span>
370 <a href="#SetCalendar" title="details" class="method-name">SetCalendar</a>
371 (<span class="var-type">string</span>&nbsp;<span class="var-name">$url</span>)
372 </div>
373 <div class="method-definition">
374 <img src="../../media/images/Method.png" alt=" "/>
375 <span class="method-result">void</span>
376 <a href="#SetContentType" title="details" class="method-name">SetContentType</a>
377 (<span class="var-type">string</span>&nbsp;<span class="var-name">$type</span>)
378 </div>
379 <div class="method-definition">
380 <img src="../../media/images/Method.png" alt=" "/>
381 <span class="method-result">void</span>
382 <a href="#SetDepth" title="details" class="method-name">SetDepth</a>
383 ([<span class="var-type">int</span>&nbsp;<span class="var-name">$depth</span> = <span class="var-default">'0'</span>])
384 </div>
385 <div class="method-definition">
386 <img src="../../media/images/Method.png" alt=" "/>
387 <span class="method-result">void</span>
388 <a href="#SetMatch" title="details" class="method-name">SetMatch</a>
389 (<span class="var-type">bool</span>&nbsp;<span class="var-name">$match</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$etag</span> = <span class="var-default">'*'</span>])
390 </div>
391 <div class="method-definition">
392 <img src="../../media/images/Method.png" alt=" "/>
393 <span class="method-result">void</span>
394 <a href="#SetUserAgent" title="details" class="method-name">SetUserAgent</a>
395 ([<span class="var-type"></span>&nbsp;<span class="var-name">$user_agent</span> = <span class="var-default">null</span>], <span class="var-type">int</span>&nbsp;<span class="var-name">$depth</span>)
396 </div>
397 </div>
398 </div>
399 </div>
400
401 <a name="sec-vars"></a>
402 <div class="info-box">
403 <div class="info-box-title">Variables</div>
404 <div class="nav-bar">
405 <a href="#sec-description">Description</a> |
406 <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
407
408
409 |
410 <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
411
412 </div>
413 <div class="info-box-body">
414
415 <a name="var$base_url" id="$base_url"><!-- --></A>
416 <div class="evenrow">
417
418 <div class="var-header">
419 <img src="../../media/images/Variable.png" />
420 <span class="var-title">
421 <span class="var-type">string</span>
422 <span class="var-name">$base_url</span>
423 (line <span class="line-number">45</span>)
424 </span>
425 </div>
426
427 <!-- ========== Info from phpDoc block ========= -->
428 <p class="short-description">Server, username, password, calendar</p>
429 <ul class="tags">
430 <li><span class="field">access:</span> protected</li>
431 </ul>
432
433
434
435
436
437 </div>
438 <a name="var$body" id="$body"><!-- --></A>
439 <div class="oddrow">
440
441 <div class="var-header">
442 <img src="../../media/images/Variable.png" />
443 <span class="var-title">
444 <span class="var-type">mixed</span>
445 <span class="var-name">$body</span>
446 = <span class="var-default"> &quot;&quot;</span> (line <span class="line-number">75</span>)
447 </span>
448 </div>
449
450 <!-- ========== Info from phpDoc block ========= -->
451 <ul class="tags">
452 <li><span class="field">access:</span> protected</li>
453 </ul>
454
455
456
457
458
459 </div>
460 <a name="var$calendar_home_set" id="$calendar_home_set"><!-- --></A>
461 <div class="evenrow">
462
463 <div class="var-header">
464 <img src="../../media/images/Variable.png" />
465 <span class="var-title">
466 <span class="var-type">mixed</span>
467 <span class="var-name">$calendar_home_set</span>
468 (line <span class="line-number">60</span>)
469 </span>
470 </div>
471
472 <!-- ========== Info from phpDoc block ========= -->
473 <p class="short-description">The calendar-home-set we're using</p>
474 <ul class="tags">
475 <li><span class="field">access:</span> protected</li>
476 </ul>
477
478
479
480
481
482 </div>
483 <a name="var$calendar_url" id="$calendar_url"><!-- --></A>
484 <div class="oddrow">
485
486 <div class="var-header">
487 <img src="../../media/images/Variable.png" />
488 <span class="var-title">
489 <span class="var-type">mixed</span>
490 <span class="var-name">$calendar_url</span>
491 (line <span class="line-number">55</span>)
492 </span>
493 </div>
494
495 <!-- ========== Info from phpDoc block ========= -->
496 <p class="short-description">The calendar-URL we're using</p>
497 <ul class="tags">
498 <li><span class="field">access:</span> protected</li>
499 </ul>
500
501
502
503
504
505 </div>
506 <a name="var$calendar_urls" id="$calendar_urls"><!-- --></A>
507 <div class="evenrow">
508
509 <div class="var-header">
510 <img src="../../media/images/Variable.png" />
511 <span class="var-title">
512 <span class="var-type">mixed</span>
513 <span class="var-name">$calendar_urls</span>
514 (line <span class="line-number">65</span>)
515 </span>
516 </div>
517
518 <!-- ========== Info from phpDoc block ========= -->
519 <p class="short-description">The calendar_urls we have discovered</p>
520 <ul class="tags">
521 <li><span class="field">access:</span> protected</li>
522 </ul>
523
524
525
526
527
528 </div>
529 <a name="var$entry" id="$entry"><!-- --></A>
530 <div class="oddrow">
531
532 <div class="var-header">
533 <img src="../../media/images/Variable.png" />
534 <span class="var-title">
535 <span class="var-type">mixed</span>
536 <span class="var-name">$entry</span>
537 (line <span class="line-number">45</span>)
538 </span>
539 </div>
540
541 <!-- ========== Info from phpDoc block ========= -->
542 <ul class="tags">
543 <li><span class="field">access:</span> protected</li>
544 </ul>
545
546
547
548
549
550 </div>
551 <a name="var$headers" id="$headers"><!-- --></A>
552 <div class="evenrow">
553
554 <div class="var-header">
555 <img src="../../media/images/Variable.png" />
556 <span class="var-title">
557 <span class="var-type">mixed</span>
558 <span class="var-name">$headers</span>
559 = <span class="var-default">array()</span> (line <span class="line-number">74</span>)
560 </span>
561 </div>
562
563 <!-- ========== Info from phpDoc block ========= -->
564 <ul class="tags">
565 <li><span class="field">access:</span> protected</li>
566 </ul>
567
568
569
570
571
572 </div>
573 <a name="var$httpRequest" id="$httpRequest"><!-- --></A>
574 <div class="oddrow">
575
576 <div class="var-header">
577 <img src="../../media/images/Variable.png" />
578 <span class="var-title">
579 <span class="var-type">mixed</span>
580 <span class="var-name">$httpRequest</span>
581 = <span class="var-default"> &quot;&quot;</span> (line <span class="line-number">77</span>)
582 </span>
583 </div>
584
585 <!-- ========== Info from phpDoc block ========= -->
586 <ul class="tags">
587 <li><span class="field">access:</span> protected</li>
588 </ul>
589
590
591
592
593
594 </div>
595 <a name="var$httpResponse" id="$httpResponse"><!-- --></A>
596 <div class="evenrow">
597
598 <div class="var-header">
599 <img src="../../media/images/Variable.png" />
600 <span class="var-title">
601 <span class="var-type">mixed</span>
602 <span class="var-name">$httpResponse</span>
603 = <span class="var-default"> &quot;&quot;</span> (line <span class="line-number">79</span>)
604 </span>
605 </div>
606
607 <!-- ========== Info from phpDoc block ========= -->
608 <ul class="tags">
609 <li><span class="field">access:</span> protected</li>
610 </ul>
611
612
613
614
615
616 </div>
617 <a name="var$parser" id="$parser"><!-- --></A>
618 <div class="oddrow">
619
620 <div class="var-header">
621 <img src="../../media/images/Variable.png" />
622 <span class="var-title">
623 <span class="var-type">mixed</span>
624 <span class="var-name">$parser</span>
625 (line <span class="line-number">82</span>)
626 </span>
627 </div>
628
629 <!-- ========== Info from phpDoc block ========= -->
630 <ul class="tags">
631 <li><span class="field">access:</span> protected</li>
632 </ul>
633
634
635
636
637
638 </div>
639 <a name="var$pass" id="$pass"><!-- --></A>
640 <div class="evenrow">
641
642 <div class="var-header">
643 <img src="../../media/images/Variable.png" />
644 <span class="var-title">
645 <span class="var-type">mixed</span>
646 <span class="var-name">$pass</span>
647 (line <span class="line-number">45</span>)
648 </span>
649 </div>
650
651 <!-- ========== Info from phpDoc block ========= -->
652 <ul class="tags">
653 <li><span class="field">access:</span> protected</li>
654 </ul>
655
656
657
658
659
660 </div>
661 <a name="var$port" id="$port"><!-- --></A>
662 <div class="oddrow">
663
664 <div class="var-header">
665 <img src="../../media/images/Variable.png" />
666 <span class="var-title">
667 <span class="var-type">mixed</span>
668 <span class="var-name">$port</span>
669 (line <span class="line-number">45</span>)
670 </span>
671 </div>
672
673 <!-- ========== Info from phpDoc block ========= -->
674 <ul class="tags">
675 <li><span class="field">access:</span> protected</li>
676 </ul>
677
678
679
680
681
682 </div>
683 <a name="var$principal_url" id="$principal_url"><!-- --></A>
684 <div class="evenrow">
685
686 <div class="var-header">
687 <img src="../../media/images/Variable.png" />
688 <span class="var-title">
689 <span class="var-type">mixed</span>
690 <span class="var-name">$principal_url</span>
691 (line <span class="line-number">50</span>)
692 </span>
693 </div>
694
695 <!-- ========== Info from phpDoc block ========= -->
696 <p class="short-description">The principal-URL we're using</p>
697 <ul class="tags">
698 <li><span class="field">access:</span> protected</li>
699 </ul>
700
701
702
703
704
705 </div>
706 <a name="var$protocol" id="$protocol"><!-- --></A>
707 <div class="oddrow">
708
709 <div class="var-header">
710 <img src="../../media/images/Variable.png" />
711 <span class="var-title">
712 <span class="var-type">mixed</span>
713 <span class="var-name">$protocol</span>
714 (line <span class="line-number">45</span>)
715 </span>
716 </div>
717
718 <!-- ========== Info from phpDoc block ========= -->
719 <ul class="tags">
720 <li><span class="field">access:</span> protected</li>
721 </ul>
722
723
724
725
726
727 </div>
728 <a name="var$requestMethod" id="$requestMethod"><!-- --></A>
729 <div class="evenrow">
730
731 <div class="var-header">
732 <img src="../../media/images/Variable.png" />
733 <span class="var-title">
734 <span class="var-type">mixed</span>
735 <span class="var-name">$requestMethod</span>
736 = <span class="var-default"> &quot;GET&quot;</span> (line <span class="line-number">76</span>)
737 </span>
738 </div>
739
740 <!-- ========== Info from phpDoc block ========= -->
741 <ul class="tags">
742 <li><span class="field">access:</span> protected</li>
743 </ul>
744
745
746
747
748
749 </div>
750 <a name="var$server" id="$server"><!-- --></A>
751 <div class="oddrow">
752
753 <div class="var-header">
754 <img src="../../media/images/Variable.png" />
755 <span class="var-title">
756 <span class="var-type">mixed</span>
757 <span class="var-name">$server</span>
758 (line <span class="line-number">45</span>)
759 </span>
760 </div>
761
762 <!-- ========== Info from phpDoc block ========= -->
763 <ul class="tags">
764 <li><span class="field">access:</span> protected</li>
765 </ul>
766
767
768
769
770
771 </div>
772 <a name="var$user" id="$user"><!-- --></A>
773 <div class="evenrow">
774
775 <div class="var-header">
776 <img src="../../media/images/Variable.png" />
777 <span class="var-title">
778 <span class="var-type">mixed</span>
779 <span class="var-name">$user</span>
780 (line <span class="line-number">45</span>)
781 </span>
782 </div>
783
784 <!-- ========== Info from phpDoc block ========= -->
785 <ul class="tags">
786 <li><span class="field">access:</span> protected</li>
787 </ul>
788
789
790
791
792
793 </div>
794 <a name="var$user_agent" id="$user_agent"><!-- --></A>
795 <div class="oddrow">
796
797 <div class="var-header">
798 <img src="../../media/images/Variable.png" />
799 <span class="var-title">
800 <span class="var-type">string</span>
801 <span class="var-name">$user_agent</span>
802 = <span class="var-default"> 'DAViCalClient'</span> (line <span class="line-number">72</span>)
803 </span>
804 </div>
805
806 <!-- ========== Info from phpDoc block ========= -->
807 <p class="short-description">The useragent which is send to the caldav server</p>
808 <ul class="tags">
809 <li><span class="field">access:</span> public</li>
810 </ul>
811
812
813
814
815
816 </div>
817 <a name="var$xmlRequest" id="$xmlRequest"><!-- --></A>
818 <div class="evenrow">
819
820 <div class="var-header">
821 <img src="../../media/images/Variable.png" />
822 <span class="var-title">
823 <span class="var-type">mixed</span>
824 <span class="var-name">$xmlRequest</span>
825 = <span class="var-default"> &quot;&quot;</span> (line <span class="line-number">78</span>)
826 </span>
827 </div>
828
829 <!-- ========== Info from phpDoc block ========= -->
830 <ul class="tags">
831 <li><span class="field">access:</span> protected</li>
832 </ul>
833
834
835
836
837
838 </div>
839 <a name="var$xmlResponse" id="$xmlResponse"><!-- --></A>
840 <div class="oddrow">
841
842 <div class="var-header">
843 <img src="../../media/images/Variable.png" />
844 <span class="var-title">
845 <span class="var-type">mixed</span>
846 <span class="var-name">$xmlResponse</span>
847 = <span class="var-default"> &quot;&quot;</span> (line <span class="line-number">80</span>)
848 </span>
849 </div>
850
851 <!-- ========== Info from phpDoc block ========= -->
852 <ul class="tags">
853 <li><span class="field">access:</span> protected</li>
854 </ul>
855
856
857
858
859
860 </div>
861
862 </div>
863 </div>
864
865 <a name="sec-methods"></a>
866 <div class="info-box">
867 <div class="info-box-title">Methods</div>
868 <div class="nav-bar">
869 <a href="#sec-description">Description</a> |
870 <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
871 <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
872
873 </div>
874 <div class="info-box-body">
875 <A NAME='method_detail'></A>
876 <a name="method__construct" id="__construct"><!-- --></a>
877 <div class="evenrow">
878
879 <div class="method-header">
880 <img src="../../media/images/Constructor.png" />
881 <span class="method-title">Constructor __construct</span> (line <span class="line-number">91</span>)
882 </div>
883
884 <!-- ========== Info from phpDoc block ========= -->
885 <p class="short-description">Constructor, initialises the class</p>
886
887 <div class="method-signature">
888 <span class="method-result">CalDAVClient</span>
889 <span class="method-name">
890 __construct
891 </span>
892 (<span class="var-type">string</span>&nbsp;<span class="var-name">$base_url</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$user</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$pass</span>)
893 </div>
894
895 <ul class="parameters">
896 <li>
897 <span class="var-type">string</span>
898 <span class="var-name">$base_url</span><span class="var-description">: The URL for the calendar server</span> </li>
899 <li>
900 <span class="var-type">string</span>
901 <span class="var-name">$user</span><span class="var-description">: The name of the user logging in</span> </li>
902 <li>
903 <span class="var-type">string</span>
904 <span class="var-name">$pass</span><span class="var-description">: The password for that user</span> </li>
905 </ul>
906
907
908 </div>
909 <a name="methodCalendarHomeSet" id="CalendarHomeSet"><!-- --></a>
910 <div class="oddrow">
911
912 <div class="method-header">
913 <img src="../../media/images/Method.png" />
914 <span class="method-title">CalendarHomeSet</span> (line <span class="line-number">445</span>)
915 </div>
916
917 <!-- ========== Info from phpDoc block ========= -->
918 <p class="short-description">Get/Set the calendar-home-set URL</p>
919
920 <div class="method-signature">
921 <span class="method-result">void</span>
922 <span class="method-name">
923 CalendarHomeSet
924 </span>
925 ([<span class="var-type">$url</span>&nbsp;<span class="var-name">$urls</span> = <span class="var-default">null</span>])
926 </div>
927
928 <ul class="parameters">
929 <li>
930 <span class="var-type">$url</span>
931 <span class="var-name">$urls</span><span class="var-description">: array of string The calendar-home-set URLs to set</span> </li>
932 </ul>
933
934
935 </div>
936 <a name="methodCalendarMultiget" id="CalendarMultiget"><!-- --></a>
937 <div class="evenrow">
938
939 <div class="method-header">
940 <img src="../../media/images/Method.png" />
941 <span class="method-title">CalendarMultiget</span> (line <span class="line-number">710</span>)
942 </div>
943
944 <!-- ========== Info from phpDoc block ========= -->
945 <p class="short-description">Get a bunch of events for a calendar with a calendar-multiget report</p>
946
947 <div class="method-signature">
948 <span class="method-result">void</span>
949 <span class="method-name">
950 CalendarMultiget
951 </span>
952 (<span class="var-type"></span>&nbsp;<span class="var-name">$event_hrefs</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$url</span> = <span class="var-default">null</span>])
953 </div>
954
955 <ul class="parameters">
956 <li>
957 <span class="var-type"></span>
958 <span class="var-name">$event_hrefs</span> </li>
959 <li>
960 <span class="var-type"></span>
961 <span class="var-name">$url</span> </li>
962 </ul>
963
964
965 </div>
966 <a name="methodCalendarUrls" id="CalendarUrls"><!-- --></a>
967 <div class="oddrow">
968
969 <div class="method-header">
970 <img src="../../media/images/Method.png" />
971 <span class="method-title">CalendarUrls</span> (line <span class="line-number">459</span>)
972 </div>
973
974 <!-- ========== Info from phpDoc block ========= -->
975 <p class="short-description">Get/Set the calendar-home-set URL</p>
976
977 <div class="method-signature">
978 <span class="method-result">void</span>
979 <span class="method-name">
980 CalendarUrls
981 </span>
982 ([<span class="var-type">$urls</span>&nbsp;<span class="var-name">$urls</span> = <span class="var-default">null</span>])
983 </div>
984
985 <ul class="parameters">
986 <li>
987 <span class="var-type">$urls</span>
988 <span class="var-name">$urls</span><span class="var-description">: array of string The calendar URLs to set</span> </li>
989 </ul>
990
991
992 </div>
993 <a name="methodDoCalendarQuery" id="DoCalendarQuery"><!-- --></a>
994 <div class="evenrow">
995
996 <div class="method-header">
997 <img src="../../media/images/Method.png" />
998 <span class="method-title">DoCalendarQuery</span> (line <span class="line-number">762</span>)
999 </div>
1000
1001 <!-- ========== Info from phpDoc block ========= -->
1002 <p class="short-description">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.</p>
1003 <ul class="tags">
1004 <li><span class="field">return:</span> 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.</li>
1005 </ul>
1006
1007 <div class="method-signature">
1008 <span class="method-result">array</span>
1009 <span class="method-name">
1010 DoCalendarQuery
1011 </span>
1012 (<span class="var-type">string</span>&nbsp;<span class="var-name">$filter</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$url</span> = <span class="var-default">null</span>])
1013 </div>
1014
1015 <ul class="parameters">
1016 <li>
1017 <span class="var-type">string</span>
1018 <span class="var-name">$filter</span><span class="var-description">: XML fragment which is the &lt;filter&gt; element of a calendar-query</span> </li>
1019 <li>
1020 <span class="var-type">string</span>
1021 <span class="var-name">$url</span><span class="var-description">: The URL of the calendar, or null to use the 'current' calendar_url</span> </li>
1022 </ul>
1023
1024
1025 </div>
1026 <a name="methodDoDELETERequest" id="DoDELETERequest"><!-- --></a>
1027 <div class="oddrow">
1028
1029 <div class="method-header">
1030 <img src="../../media/images/Method.png" />
1031 <span class="method-title">DoDELETERequest</span> (line <span class="line-number">393</span>)
1032 </div>
1033
1034 <!-- ========== Info from phpDoc block ========= -->
1035 <p class="short-description">DELETE a text/icalendar resource</p>
1036 <ul class="tags">
1037 <li><span class="field">return:</span> The HTTP Result Code for the DELETE</li>
1038 </ul>
1039
1040 <div class="method-signature">
1041 <span class="method-result">int</span>
1042 <span class="method-name">
1043 DoDELETERequest
1044 </span>
1045 (<span class="var-type">string</span>&nbsp;<span class="var-name">$url</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$etag</span> = <span class="var-default">null</span>])
1046 </div>
1047
1048 <ul class="parameters">
1049 <li>
1050 <span class="var-type">string</span>
1051 <span class="var-name">$url</span><span class="var-description">: The URL to make the request to</span> </li>
1052 <li>
1053 <span class="var-type">string</span>
1054 <span class="var-name">$etag</span><span class="var-description">: The etag of an existing resource to be deleted, or '*' for any resource at that URL.</span> </li>
1055 </ul>
1056
1057
1058 </div>
1059 <a name="methodDoGETRequest" id="DoGETRequest"><!-- --></a>
1060 <div class="evenrow">
1061
1062 <div class="method-header">
1063 <img src="../../media/images/Method.png" />
1064 <span class="method-title">DoGETRequest</span> (line <span class="line-number">333</span>)
1065 </div>
1066
1067 <!-- ========== Info from phpDoc block ========= -->
1068 <p class="short-description">Get a single item from the server.</p>
1069
1070 <div class="method-signature">
1071 <span class="method-result">void</span>
1072 <span class="method-name">
1073 DoGETRequest
1074 </span>
1075 (<span class="var-type">string</span>&nbsp;<span class="var-name">$url</span>)
1076 </div>
1077
1078 <ul class="parameters">
1079 <li>
1080 <span class="var-type">string</span>
1081 <span class="var-name">$url</span><span class="var-description">: The URL to GET</span> </li>
1082 </ul>
1083
1084
1085 </div>
1086 <a name="methodDoHEADRequest" id="DoHEADRequest"><!-- --></a>
1087 <div class="oddrow">
1088
1089 <div class="method-header">
1090 <img src="../../media/images/Method.png" />
1091 <span class="method-title">DoHEADRequest</span> (line <span class="line-number">345</span>)
1092 </div>
1093
1094 <!-- ========== Info from phpDoc block ========= -->
1095 <p class="short-description">Get the HEAD of a single item from the server.</p>
1096
1097 <div class="method-signature">
1098 <span class="method-result">void</span>
1099 <span class="method-name">
1100 DoHEADRequest
1101 </span>
1102 (<span class="var-type">string</span>&nbsp;<span class="var-name">$url</span>)
1103 </div>
1104
1105 <ul class="parameters">
1106 <li>
1107 <span class="var-type">string</span>
1108 <span class="var-name">$url</span><span class="var-description">: The URL to HEAD</span> </li>
1109 </ul>
1110
1111
1112 </div>
1113 <a name="methodDoOptionsRequest" id="DoOptionsRequest"><!-- --></a>
1114 <div class="evenrow">
1115
1116 <div class="method-header">
1117 <img src="../../media/images/Method.png" />
1118 <span class="method-title">DoOptionsRequest</span> (line <span class="line-number">299</span>)
1119 </div>
1120
1121 <!-- ========== Info from phpDoc block ========= -->
1122 <p class="short-description">Send an OPTIONS request to the server</p>
1123 <ul class="tags">
1124 <li><span class="field">return:</span> The allowed options</li>
1125 </ul>
1126
1127 <div class="method-signature">
1128 <span class="method-result">array</span>
1129 <span class="method-name">
1130 DoOptionsRequest
1131 </span>
1132 ([<span class="var-type">string</span>&nbsp;<span class="var-name">$url</span> = <span class="var-default">null</span>])
1133 </div>
1134
1135 <ul class="parameters">
1136 <li>
1137 <span class="var-type">string</span>
1138 <span class="var-name">$url</span><span class="var-description">: The URL to make the request to</span> </li>
1139 </ul>
1140
1141
1142 </div>
1143 <a name="methodDoPROPFINDRequest" id="DoPROPFINDRequest"><!-- --></a>
1144 <div class="oddrow">
1145
1146 <div class="method-header">
1147 <img src="../../media/images/Method.png" />
1148 <span class="method-title">DoPROPFINDRequest</span> (line <span class="line-number">410</span>)
1149 </div>
1150
1151 <!-- ========== Info from phpDoc block ========= -->
1152 <p class="short-description">Get a single item from the server.</p>
1153
1154 <div class="method-signature">
1155 <span class="method-result">void</span>
1156 <span class="method-name">
1157 DoPROPFINDRequest
1158 </span>
1159 (<span class="var-type">string</span>&nbsp;<span class="var-name">$url</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$props</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$depth</span> = <span class="var-default">0</span>])
1160 </div>
1161
1162 <ul class="parameters">
1163 <li>
1164 <span class="var-type">string</span>
1165 <span class="var-name">$url</span><span class="var-description">: The URL to PROPFIND on</span> </li>
1166 <li>
1167 <span class="var-type"></span>
1168 <span class="var-name">$props</span> </li>
1169 <li>
1170 <span class="var-type"></span>
1171 <span class="var-name">$depth</span> </li>
1172 </ul>
1173
1174
1175 </div>
1176 <a name="methodDoPUTRequest" id="DoPUTRequest"><!-- --></a>
1177 <div class="evenrow">
1178
1179 <div class="method-header">
1180 <img src="../../media/images/Method.png" />
1181 <span class="method-title">DoPUTRequest</span> (line <span class="line-number">361</span>)
1182 </div>
1183
1184 <!-- ========== Info from phpDoc block ========= -->
1185 <p class="short-description">PUT a text/icalendar resource, returning the etag</p>
1186 <ul class="tags">
1187 <li><span class="field">return:</span> The content of the response from the server</li>
1188 </ul>
1189
1190 <div class="method-signature">
1191 <span class="method-result">string</span>
1192 <span class="method-name">
1193 DoPUTRequest
1194 </span>
1195 (<span class="var-type">string</span>&nbsp;<span class="var-name">$url</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$icalendar</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$etag</span> = <span class="var-default">null</span>])
1196 </div>
1197
1198 <ul class="parameters">
1199 <li>
1200 <span class="var-type">string</span>
1201 <span class="var-name">$url</span><span class="var-description">: The URL to make the request to</span> </li>
1202 <li>
1203 <span class="var-type">string</span>
1204 <span class="var-name">$icalendar</span><span class="var-description">: The iCalendar resource to send to the server</span> </li>
1205 <li>
1206 <span class="var-type">string</span>
1207 <span class="var-name">$etag</span><span class="var-description">: The etag of an existing resource to be overwritten, or '*' for a new resource.</span> </li>
1208 </ul>
1209
1210
1211 </div>
1212 <a name="methodDoRequest" id="DoRequest"><!-- --></a>
1213 <div class="oddrow">
1214
1215 <div class="method-header">
1216 <img src="../../media/images/Method.png" />
1217 <span class="method-title">DoRequest</span> (line <span class="line-number">241</span>)
1218 </div>
1219
1220 <!-- ========== Info from phpDoc block ========= -->
1221 <p class="short-description">Send a request to the server</p>
1222 <ul class="tags">
1223 <li><span class="field">return:</span> The content of the response from the server</li>
1224 </ul>
1225
1226 <div class="method-signature">
1227 <span class="method-result">string</span>
1228 <span class="method-name">
1229 DoRequest
1230 </span>
1231 ([<span class="var-type">string</span>&nbsp;<span class="var-name">$url</span> = <span class="var-default">null</span>])
1232 </div>
1233
1234 <ul class="parameters">
1235 <li>
1236 <span class="var-type">string</span>
1237 <span class="var-name">$url</span><span class="var-description">: The URL to make the request to</span> </li>
1238 </ul>
1239
1240
1241 </div>
1242 <a name="methodDoXMLRequest" id="DoXMLRequest"><!-- --></a>
1243 <div class="evenrow">
1244
1245 <div class="method-header">
1246 <img src="../../media/images/Method.png" />
1247 <span class="method-title">DoXMLRequest</span> (line <span class="line-number">319</span>)
1248 </div>
1249
1250 <!-- ========== Info from phpDoc block ========= -->
1251 <p class="short-description">Send an XML request to the server (e.g. PROPFIND, REPORT, MKCALENDAR)</p>
1252 <ul class="tags">
1253 <li><span class="field">return:</span> An array of the allowed methods</li>
1254 </ul>
1255
1256 <div class="method-signature">
1257 <span class="method-result">array</span>
1258 <span class="method-name">
1259 DoXMLRequest
1260 </span>
1261 (<span class="var-type"></span>&nbsp;<span class="var-name">$request_method</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$xml</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$url</span> = <span class="var-default">null</span>], <span class="var-type">string</span>&nbsp;<span class="var-name">$method</span>)
1262 </div>
1263
1264 <ul class="parameters">
1265 <li>
1266 <span class="var-type">string</span>
1267 <span class="var-name">$method</span><span class="var-description">: The method (PROPFIND, REPORT, etc) to use with the request</span> </li>
1268 <li>
1269 <span class="var-type">string</span>
1270 <span class="var-name">$xml</span><span class="var-description">: The XML to send along with the request</span> </li>
1271 <li>
1272 <span class="var-type">string</span>
1273 <span class="var-name">$url</span><span class="var-description">: The URL to make the request to</span> </li>
1274 <li>
1275 <span class="var-type"></span>
1276 <span class="var-name">$request_method</span> </li>
1277 </ul>
1278
1279
1280 </div>
1281 <a name="methodFindCalendarHome" id="FindCalendarHome"><!-- --></a>
1282 <div class="oddrow">
1283
1284 <div class="method-header">
1285 <img src="../../media/images/Method.png" />
1286 <span class="method-title">FindCalendarHome</span> (line <span class="line-number">589</span>)
1287 </div>
1288
1289 <!-- ========== Info from phpDoc block ========= -->
1290 <p class="short-description">Attack the given URL in an attempt to find a principal URL</p>
1291
1292 <div class="method-signature">
1293 <span class="method-result">void</span>
1294 <span class="method-name">
1295 FindCalendarHome
1296 </span>
1297 ([<span class="var-type"></span>&nbsp;<span class="var-name">$recursed</span> = <span class="var-default">false</span>], <span class="var-type">string</span>&nbsp;<span class="var-name">$url</span>)
1298 </div>
1299
1300 <ul class="parameters">
1301 <li>
1302 <span class="var-type">string</span>
1303 <span class="var-name">$url</span><span class="var-description">: The URL to find the calendar-home-set from</span> </li>
1304 <li>
1305 <span class="var-type"></span>
1306 <span class="var-name">$recursed</span> </li>
1307 </ul>
1308
1309
1310 </div>
1311 <a name="methodFindCalendars" id="FindCalendars"><!-- --></a>
1312 <div class="evenrow">
1313
1314 <div class="method-header">
1315 <img src="../../media/images/Method.png" />
1316 <span class="method-title">FindCalendars</span> (line <span class="line-number">618</span>)
1317 </div>
1318
1319 <!-- ========== Info from phpDoc block ========= -->
1320 <p class="short-description">Find the calendars, from the calendar_home_set</p>
1321
1322 <div class="method-signature">
1323 <span class="method-result">void</span>
1324 <span class="method-name">
1325 FindCalendars
1326 </span>
1327 ([<span class="var-type"></span>&nbsp;<span class="var-name">$recursed</span> = <span class="var-default">false</span>])
1328 </div>
1329
1330 <ul class="parameters">
1331 <li>
1332 <span class="var-type"></span>
1333 <span class="var-name">$recursed</span> </li>
1334 </ul>
1335
1336
1337 </div>
1338 <a name="methodFindPrincipal" id="FindPrincipal"><!-- --></a>
1339 <div class="oddrow">
1340
1341 <div class="method-header">
1342 <img src="../../media/images/Method.png" />
1343 <span class="method-title">FindPrincipal</span> (line <span class="line-number">566</span>)
1344 </div>
1345
1346 <!-- ========== Info from phpDoc block ========= -->
1347 <p class="short-description">Attack the given URL in an attempt to find a principal URL</p>
1348
1349 <div class="method-signature">
1350 <span class="method-result">void</span>
1351 <span class="method-name">
1352 FindPrincipal
1353 </span>
1354 (<span class="var-type">string</span>&nbsp;<span class="var-name">$url</span>)
1355 </div>
1356
1357 <ul class="parameters">
1358 <li>
1359 <span class="var-type">string</span>
1360 <span class="var-name">$url</span><span class="var-description">: The URL to find the principal-URL from</span> </li>
1361 </ul>
1362
1363
1364 </div>
1365 <a name="methodGetCalendarDetails" id="GetCalendarDetails"><!-- --></a>
1366 <div class="evenrow">
1367
1368 <div class="method-header">
1369 <img src="../../media/images/Method.png" />
1370 <span class="method-title">GetCalendarDetails</span> (line <span class="line-number">662</span>)
1371 </div>
1372
1373 <!-- ========== Info from phpDoc block ========= -->
1374 <p class="short-description">Find the calendars, from the calendar_home_set</p>
1375
1376 <div class="method-signature">
1377 <span class="method-result">void</span>
1378 <span class="method-name">
1379 GetCalendarDetails
1380 </span>
1381 ([<span class="var-type"></span>&nbsp;<span class="var-name">$url</span> = <span class="var-default">null</span>])
1382 </div>
1383
1384 <ul class="parameters">
1385 <li>
1386 <span class="var-type"></span>
1387 <span class="var-name">$url</span> </li>
1388 </ul>
1389
1390
1391 </div>
1392 <a name="methodGetCollectionETags" id="GetCollectionETags"><!-- --></a>
1393 <div class="oddrow">
1394
1395 <div class="method-header">
1396 <img src="../../media/images/Method.png" />
1397 <span class="method-title">GetCollectionETags</span> (line <span class="line-number">690</span>)
1398 </div>
1399
1400 <!-- ========== Info from phpDoc block ========= -->
1401 <p class="short-description">Get all etags for a calendar</p>
1402
1403 <div class="method-signature">
1404 <span class="method-result">void</span>
1405 <span class="method-name">
1406 GetCollectionETags
1407 </span>
1408 ([<span class="var-type"></span>&nbsp;<span class="var-name">$url</span> = <span class="var-default">null</span>])
1409 </div>
1410
1411 <ul class="parameters">
1412 <li>
1413 <span class="var-type"></span>
1414 <span class="var-name">$url</span> </li>
1415 </ul>
1416
1417
1418 </div>
1419 <a name="methodGetEntryByHref" id="GetEntryByHref"><!-- --></a>
1420 <div class="evenrow">
1421
1422 <div class="method-header">
1423 <img src="../../media/images/Method.png" />
1424 <span class="method-title">GetEntryByHref</span> (line <span class="line-number">916</span>)
1425 </div>
1426
1427 <!-- ========== Info from phpDoc block ========= -->
1428 <p class="short-description">Get the calendar entry by HREF</p>
1429 <ul class="tags">
1430 <li><span class="field">return:</span> The iCalendar of the calendar entry</li>
1431 </ul>
1432
1433 <div class="method-signature">
1434 <span class="method-result">string</span>
1435 <span class="method-name">
1436 GetEntryByHref
1437 </span>
1438 (<span class="var-type">string</span>&nbsp;<span class="var-name">$href</span>)
1439 </div>
1440
1441 <ul class="parameters">
1442 <li>
1443 <span class="var-type">string</span>
1444 <span class="var-name">$href</span><span class="var-description">: The href from a call to GetEvents or GetTodos etc.</span> </li>
1445 </ul>
1446
1447
1448 </div>
1449 <a name="methodGetEntryByUid" id="GetEntryByUid"><!-- --></a>
1450 <div class="oddrow">
1451
1452 <div class="method-header">
1453 <img src="../../media/images/Method.png" />
1454 <span class="method-title">GetEntryByUid</span> (line <span class="line-number">890</span>)
1455 </div>
1456
1457 <!-- ========== Info from phpDoc block ========= -->
1458 <p class="short-description">Get the calendar entry by UID</p>
1459 <ul class="tags">
1460 <li><span class="field">return:</span> An array of the relative URL, etag, and calendar data returned from DoCalendarQuery() @see DoCalendarQuery()</li>
1461 </ul>
1462
1463 <div class="method-signature">
1464 <span class="method-result">array</span>
1465 <span class="method-name">
1466 GetEntryByUid
1467 </span>
1468 (<span class="var-type">uid</span>&nbsp;<span class="var-name">$uid</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$relative_url</span> = <span class="var-default">''</span>])
1469 </div>
1470
1471 <ul class="parameters">
1472 <li>
1473 <span class="var-type">string</span>
1474 <span class="var-name">$relative_url</span><span class="var-description">: The URL relative to the base_url specified when the calendar was opened. Default ''.</span> </li>
1475 <li>
1476 <span class="var-type">uid</span>
1477 <span class="var-name">$uid</span> </li>
1478 </ul>
1479
1480
1481 </div>
1482 <a name="methodGetEvents" id="GetEvents"><!-- --></a>
1483 <div class="evenrow">
1484
1485 <div class="method-header">
1486 <img src="../../media/images/Method.png" />
1487 <span class="method-title">GetEvents</span> (line <span class="line-number">818</span>)
1488 </div>
1489
1490 <!-- ========== Info from phpDoc block ========= -->
1491 <p class="short-description">Get the events in a range from $start to $finish. The dates should be in the</p>
1492 <p class="description"><p>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.</p></p>
1493 <ul class="tags">
1494 <li><span class="field">return:</span> An array of the relative URLs, etags, and events, returned from DoCalendarQuery() @see DoCalendarQuery()</li>
1495 </ul>
1496
1497 <div class="method-signature">
1498 <span class="method-result">array</span>
1499 <span class="method-name">
1500 GetEvents
1501 </span>
1502 ([<span class="var-type">timestamp</span>&nbsp;<span class="var-name">$start</span> = <span class="var-default">null</span>], [<span class="var-type">timestamp</span>&nbsp;<span class="var-name">$finish</span> = <span class="var-default">null</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$relative_url</span> = <span class="var-default">''</span>])
1503 </div>
1504
1505 <ul class="parameters">
1506 <li>
1507 <span class="var-type">timestamp</span>
1508 <span class="var-name">$start</span><span class="var-description">: The start time for the period</span> </li>
1509 <li>
1510 <span class="var-type">timestamp</span>
1511 <span class="var-name">$finish</span><span class="var-description">: The finish time for the period</span> </li>
1512 <li>
1513 <span class="var-type">string</span>
1514 <span class="var-name">$relative_url</span><span class="var-description">: The URL relative to the base_url specified when the calendar was opened. Default ''.</span> </li>
1515 </ul>
1516
1517
1518 </div>
1519 <a name="methodGetHttpRequest" id="GetHttpRequest"><!-- --></a>
1520 <div class="oddrow">
1521
1522 <div class="method-header">
1523 <img src="../../media/images/Method.png" />
1524 <span class="method-title">GetHttpRequest</span> (line <span class="line-number">198</span>)
1525 </div>
1526
1527 <!-- ========== Info from phpDoc block ========= -->
1528 <p class="short-description">Output http request headers</p>
1529 <ul class="tags">
1530 <li><span class="field">return:</span> headers</li>
1531 </ul>
1532
1533 <div class="method-signature">
1534 <span class="method-result">HTTP</span>
1535 <span class="method-name">
1536 GetHttpRequest
1537 </span>
1538 ()
1539 </div>
1540
1541
1542
1543 </div>
1544 <a name="methodGetOKProps" id="GetOKProps"><!-- --></a>
1545 <div class="evenrow">
1546
1547 <div class="method-header">
1548 <img src="../../media/images/Method.png" />
1549 <span class="method-title">GetOKProps</span> (line <span class="line-number">536</span>)
1550 </div>
1551
1552 <!-- ========== Info from phpDoc block ========= -->
1553 <p class="short-description">Return the &lt;prop&gt; ... &lt;/prop&gt; of a propstat where the status is OK</p>
1554
1555 <div class="method-signature">
1556 <span class="method-result">void</span>
1557 <span class="method-name">
1558 GetOKProps
1559 </span>
1560 (<span class="var-type">string</span>&nbsp;<span class="var-name">$nodenum</span>)
1561 </div>
1562
1563 <ul class="parameters">
1564 <li>
1565 <span class="var-type">string</span>
1566 <span class="var-name">$nodenum</span><span class="var-description">: The node number in the xmlnodes which is the href</span> </li>
1567 </ul>
1568
1569
1570 </div>
1571 <a name="methodGetResponseBody" id="GetResponseBody"><!-- --></a>
1572 <div class="oddrow">
1573
1574 <div class="method-header">
1575 <img src="../../media/images/Method.png" />
1576 <span class="method-title">GetResponseBody</span> (line <span class="line-number">214</span>)
1577 </div>
1578
1579 <!-- ========== Info from phpDoc block ========= -->
1580 <p class="short-description">Output http response body</p>
1581 <ul class="tags">
1582 <li><span class="field">return:</span> body</li>
1583 </ul>
1584
1585 <div class="method-signature">
1586 <span class="method-result">HTTP</span>
1587 <span class="method-name">
1588 GetResponseBody
1589 </span>
1590 ()
1591 </div>
1592
1593
1594
1595 </div>
1596 <a name="methodGetResponseHeaders" id="GetResponseHeaders"><!-- --></a>
1597 <div class="evenrow">
1598
1599 <div class="method-header">
1600 <img src="../../media/images/Method.png" />
1601 <span class="method-title">GetResponseHeaders</span> (line <span class="line-number">206</span>)
1602 </div>
1603
1604 <!-- ========== Info from phpDoc block ========= -->
1605 <p class="short-description">Output http response headers</p>
1606 <ul class="tags">
1607 <li><span class="field">return:</span> headers</li>
1608 </ul>
1609
1610 <div class="method-signature">
1611 <span class="method-result">HTTP</span>
1612 <span class="method-name">
1613 GetResponseHeaders
1614 </span>
1615 ()
1616 </div>
1617
1618
1619
1620 </div>
1621 <a name="methodGetTodos" id="GetTodos"><!-- --></a>
1622 <div class="oddrow">
1623
1624 <div class="method-header">
1625 <img src="../../media/images/Method.png" />
1626 <span class="method-title">GetTodos</span> (line <span class="line-number">853</span>)
1627 </div>
1628
1629 <!-- ========== Info from phpDoc block ========= -->
1630 <p class="short-description">Get the todo's in a range from $start to $finish. The dates should be in the</p>
1631 <p class="description"><p>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.</p></p>
1632 <ul class="tags">
1633 <li><span class="field">return:</span> An array of the relative URLs, etags, and events, returned from DoCalendarQuery() @see DoCalendarQuery()</li>
1634 </ul>
1635
1636 <div class="method-signature">
1637 <span class="method-result">array</span>
1638 <span class="method-name">
1639 GetTodos
1640 </span>
1641 (<span class="var-type">timestamp</span>&nbsp;<span class="var-name">$start</span>, <span class="var-type">timestamp</span>&nbsp;<span class="var-name">$finish</span>, [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$completed</span> = <span class="var-default">false</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$cancelled</span> = <span class="var-default">false</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$relative_url</span> = <span class="var-default">&quot;&quot;</span>])
1642 </div>
1643
1644 <ul class="parameters">
1645 <li>
1646 <span class="var-type">timestamp</span>
1647 <span class="var-name">$start</span><span class="var-description">: The start time for the period</span> </li>
1648 <li>
1649 <span class="var-type">timestamp</span>
1650 <span class="var-name">$finish</span><span class="var-description">: The finish time for the period</span> </li>
1651 <li>
1652 <span class="var-type">boolean</span>
1653 <span class="var-name">$completed</span><span class="var-description">: Whether to include completed tasks</span> </li>
1654 <li>
1655 <span class="var-type">boolean</span>
1656 <span class="var-name">$cancelled</span><span class="var-description">: Whether to include cancelled tasks</span> </li>
1657 <li>
1658 <span class="var-type">string</span>
1659 <span class="var-name">$relative_url</span><span class="var-description">: The URL relative to the base_url specified when the calendar was opened. Default ''.</span> </li>
1660 </ul>
1661
1662
1663 </div>
1664 <a name="methodGetXmlRequest" id="GetXmlRequest"><!-- --></a>
1665 <div class="evenrow">
1666
1667 <div class="method-header">
1668 <img src="../../media/images/Method.png" />
1669 <span class="method-title">GetXmlRequest</span> (line <span class="line-number">222</span>)
1670 </div>
1671
1672 <!-- ========== Info from phpDoc block ========= -->
1673 <p class="short-description">Output xml request</p>
1674 <ul class="tags">
1675 <li><span class="field">return:</span> xml</li>
1676 </ul>
1677
1678 <div class="method-signature">
1679 <span class="method-result">raw</span>
1680 <span class="method-name">
1681 GetXmlRequest
1682 </span>
1683 ()
1684 </div>
1685
1686
1687
1688 </div>
1689 <a name="methodGetXmlResponse" id="GetXmlResponse"><!-- --></a>
1690 <div class="oddrow">
1691
1692 <div class="method-header">
1693 <img src="../../media/images/Method.png" />
1694 <span class="method-title">GetXmlResponse</span> (line <span class="line-number">230</span>)
1695 </div>
1696
1697 <!-- ========== Info from phpDoc block ========= -->
1698 <p class="short-description">Output xml response</p>
1699 <ul class="tags">
1700 <li><span class="field">return:</span> xml</li>
1701 </ul>
1702
1703 <div class="method-signature">
1704 <span class="method-result">raw</span>
1705 <span class="method-name">
1706 GetXmlResponse
1707 </span>
1708 ()
1709 </div>
1710
1711
1712
1713 </div>
1714 <a name="methodHrefForProp" id="HrefForProp"><!-- --></a>
1715 <div class="evenrow">
1716
1717 <div class="method-header">
1718 <img src="../../media/images/Method.png" />
1719 <span class="method-title">HrefForProp</span> (line <span class="line-number">490</span>)
1720 </div>
1721
1722 <!-- ========== Info from phpDoc block ========= -->
1723 <p class="short-description">Return the href containing this property. Except only if it's inside a status != 200</p>
1724
1725 <div class="method-signature">
1726 <span class="method-result">void</span>
1727 <span class="method-name">
1728 HrefForProp
1729 </span>
1730 (<span class="var-type">string</span>&nbsp;<span class="var-name">$tagname</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$i</span> = <span class="var-default">0</span>], <span class="var-type">integer</span>&nbsp;<span class="var-name">$which</span>)
1731 </div>
1732
1733 <ul class="parameters">
1734 <li>
1735 <span class="var-type">string</span>
1736 <span class="var-name">$tagname</span><span class="var-description">: The tag name of the property to find the href for</span> </li>
1737 <li>
1738 <span class="var-type">integer</span>
1739 <span class="var-name">$which</span><span class="var-description">: Which instance of the tag should we use</span> </li>
1740 <li>
1741 <span class="var-type"></span>
1742 <span class="var-name">$i</span> </li>
1743 </ul>
1744
1745
1746 </div>
1747 <a name="methodHrefForResourcetype" id="HrefForResourcetype"><!-- --></a>
1748 <div class="oddrow">
1749
1750 <div class="method-header">
1751 <img src="../../media/images/Method.png" />
1752 <span class="method-title">HrefForResourcetype</span> (line <span class="line-number">516</span>)
1753 </div>
1754
1755 <!-- ========== Info from phpDoc block ========= -->
1756 <p class="short-description">Return the href which has a resourcetype of the specified type</p>
1757
1758 <div class="method-signature">
1759 <span class="method-result">void</span>
1760 <span class="method-name">
1761 HrefForResourcetype
1762 </span>
1763 (<span class="var-type">string</span>&nbsp;<span class="var-name">$tagname</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$i</span> = <span class="var-default">0</span>], <span class="var-type">integer</span>&nbsp;<span class="var-name">$which</span>)
1764 </div>
1765
1766 <ul class="parameters">
1767 <li>
1768 <span class="var-type">string</span>
1769 <span class="var-name">$tagname</span><span class="var-description">: The tag name of the resourcetype to find the href for</span> </li>
1770 <li>
1771 <span class="var-type">integer</span>
1772 <span class="var-name">$which</span><span class="var-description">: Which instance of the tag should we use</span> </li>
1773 <li>
1774 <span class="var-type"></span>
1775 <span class="var-name">$i</span> </li>
1776 </ul>
1777
1778
1779 </div>
1780 <a name="methodHrefValueInside" id="HrefValueInside"><!-- --></a>
1781 <div class="evenrow">
1782
1783 <div class="method-header">
1784 <img src="../../media/images/Method.png" />
1785 <span class="method-title">HrefValueInside</span> (line <span class="line-number">473</span>)
1786 </div>
1787
1788 <!-- ========== Info from phpDoc block ========= -->
1789 <p class="short-description">Return the first occurrence of an href inside the named tag.</p>
1790
1791 <div class="method-signature">
1792 <span class="method-result">void</span>
1793 <span class="method-name">
1794 HrefValueInside
1795 </span>
1796 (<span class="var-type">string</span>&nbsp;<span class="var-name">$tagname</span>)
1797 </div>
1798
1799 <ul class="parameters">
1800 <li>
1801 <span class="var-type">string</span>
1802 <span class="var-name">$tagname</span><span class="var-description">: The tag name to find the href inside of</span> </li>
1803 </ul>
1804
1805
1806 </div>
1807 <a name="methodParseResponse" id="ParseResponse"><!-- --></a>
1808 <div class="oddrow">
1809
1810 <div class="method-header">
1811 <img src="../../media/images/Method.png" />
1812 <span class="method-title">ParseResponse</span> (line <span class="line-number">168</span>)
1813 </div>
1814
1815 <!-- ========== Info from phpDoc block ========= -->
1816 <p class="short-description">Split response into httpResponse and xmlResponse</p>
1817
1818 <div class="method-signature">
1819 <span class="method-result">void</span>
1820 <span class="method-name">
1821 ParseResponse
1822 </span>
1823 (<span class="var-type">string</span>&nbsp;<span class="var-name">$response</span>)
1824 </div>
1825
1826 <ul class="parameters">
1827 <li>
1828 <span class="var-type">string</span>
1829 <span class="var-name">$response</span><span class="var-description">: Response from server</span> </li>
1830 </ul>
1831
1832
1833 </div>
1834 <a name="methodPrincipalURL" id="PrincipalURL"><!-- --></a>
1835 <div class="evenrow">
1836
1837 <div class="method-header">
1838 <img src="../../media/images/Method.png" />
1839 <span class="method-title">PrincipalURL</span> (line <span class="line-number">432</span>)
1840 </div>
1841
1842 <!-- ========== Info from phpDoc block ========= -->
1843 <p class="short-description">Get/Set the Principal URL</p>
1844
1845 <div class="method-signature">
1846 <span class="method-result">void</span>
1847 <span class="method-name">
1848 PrincipalURL
1849 </span>
1850 ([<span class="var-type">$url</span>&nbsp;<span class="var-name">$url</span> = <span class="var-default">null</span>])
1851 </div>
1852
1853 <ul class="parameters">
1854 <li>
1855 <span class="var-type">$url</span>
1856 <span class="var-name">$url</span><span class="var-description">: string The Principal URL to set</span> </li>
1857 </ul>
1858
1859
1860 </div>
1861 <a name="methodSetCalendar" id="SetCalendar"><!-- --></a>
1862 <div class="oddrow">
1863
1864 <div class="method-header">
1865 <img src="../../media/images/Method.png" />
1866 <span class="method-title">SetCalendar</span> (line <span class="line-number">159</span>)
1867 </div>
1868
1869 <!-- ========== Info from phpDoc block ========= -->
1870 <p class="short-description">Set the calendar_url we will be using for a while.</p>
1871
1872 <div class="method-signature">
1873 <span class="method-result">void</span>
1874 <span class="method-name">
1875 SetCalendar
1876 </span>
1877 (<span class="var-type">string</span>&nbsp;<span class="var-name">$url</span>)
1878 </div>
1879
1880 <ul class="parameters">
1881 <li>
1882 <span class="var-type">string</span>
1883 <span class="var-name">$url</span><span class="var-description">: The calendar_url</span> </li>
1884 </ul>
1885
1886
1887 </div>
1888 <a name="methodSetContentType" id="SetContentType"><!-- --></a>
1889 <div class="evenrow">
1890
1891 <div class="method-header">
1892 <img src="../../media/images/Method.png" />
1893 <span class="method-title">SetContentType</span> (line <span class="line-number">150</span>)
1894 </div>
1895
1896 <!-- ========== Info from phpDoc block ========= -->
1897 <p class="short-description">Add a Content-type: header.</p>
1898
1899 <div class="method-signature">
1900 <span class="method-result">void</span>
1901 <span class="method-name">
1902 SetContentType
1903 </span>
1904 (<span class="var-type">string</span>&nbsp;<span class="var-name">$type</span>)
1905 </div>
1906
1907 <ul class="parameters">
1908 <li>
1909 <span class="var-type">string</span>
1910 <span class="var-name">$type</span><span class="var-description">: The content type</span> </li>
1911 </ul>
1912
1913
1914 </div>
1915 <a name="methodSetDepth" id="SetDepth"><!-- --></a>
1916 <div class="oddrow">
1917
1918 <div class="method-header">
1919 <img src="../../media/images/Method.png" />
1920 <span class="method-title">SetDepth</span> (line <span class="line-number">131</span>)
1921 </div>
1922
1923 <!-- ========== Info from phpDoc block ========= -->
1924 <p class="short-description">Add a Depth: header. Valid values are 0, 1 or infinity</p>
1925
1926 <div class="method-signature">
1927 <span class="method-result">void</span>
1928 <span class="method-name">
1929 SetDepth
1930 </span>
1931 ([<span class="var-type">int</span>&nbsp;<span class="var-name">$depth</span> = <span class="var-default">'0'</span>])
1932 </div>
1933
1934 <ul class="parameters">
1935 <li>
1936 <span class="var-type">int</span>
1937 <span class="var-name">$depth</span><span class="var-description">: The depth, default to infinity</span> </li>
1938 </ul>
1939
1940
1941 </div>
1942 <a name="methodSetMatch" id="SetMatch"><!-- --></a>
1943 <div class="evenrow">
1944
1945 <div class="method-header">
1946 <img src="../../media/images/Method.png" />
1947 <span class="method-title">SetMatch</span> (line <span class="line-number">122</span>)
1948 </div>
1949
1950 <!-- ========== Info from phpDoc block ========= -->
1951 <p class="short-description">Adds an If-Match or If-None-Match header</p>
1952
1953 <div class="method-signature">
1954 <span class="method-result">void</span>
1955 <span class="method-name">
1956 SetMatch
1957 </span>
1958 (<span class="var-type">bool</span>&nbsp;<span class="var-name">$match</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$etag</span> = <span class="var-default">'*'</span>])
1959 </div>
1960
1961 <ul class="parameters">
1962 <li>
1963 <span class="var-type">bool</span>
1964 <span class="var-name">$match</span><span class="var-description">: to Match or Not to Match, that is the question!</span> </li>
1965 <li>
1966 <span class="var-type">string</span>
1967 <span class="var-name">$etag</span><span class="var-description">: The etag to match / not match against.</span> </li>
1968 </ul>
1969
1970
1971 </div>
1972 <a name="methodSetUserAgent" id="SetUserAgent"><!-- --></a>
1973 <div class="oddrow">
1974
1975 <div class="method-header">
1976 <img src="../../media/images/Method.png" />
1977 <span class="method-title">SetUserAgent</span> (line <span class="line-number">140</span>)
1978 </div>
1979
1980 <!-- ========== Info from phpDoc block ========= -->
1981 <p class="short-description">Add a Depth: header. Valid values are 1 or infinity</p>
1982
1983 <div class="method-signature">
1984 <span class="method-result">void</span>
1985 <span class="method-name">
1986 SetUserAgent
1987 </span>
1988 ([<span class="var-type"></span>&nbsp;<span class="var-name">$user_agent</span> = <span class="var-default">null</span>], <span class="var-type">int</span>&nbsp;<span class="var-name">$depth</span>)
1989 </div>
1990
1991 <ul class="parameters">
1992 <li>
1993 <span class="var-type">int</span>
1994 <span class="var-name">$depth</span><span class="var-description">: The depth, default to infinity</span> </li>
1995 <li>
1996 <span class="var-type"></span>
1997 <span class="var-name">$user_agent</span> </li>
1998 </ul>
1999
2000
2001 </div>
2002
2003 </div>
2004 </div>
2005
2006
2007 <p class="notes" id="credit">
2008 Documentation generated on Sat, 17 Apr 2010 12:32:24 +1200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
2009 </p>
2010 </div></body>
2011 </html>
DAViCal CalDAV & CardDAV Server