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