?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
Release 1.0.2
[davical.git] / docs / api / davical / Request / CalDAVRequest.html
blobd14fd8cc5de54201a36597a95c570e1de8e216b9
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 CalDAVRequest</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"> CalDAVRequest</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 collecting things to do with this request.</p>
29 <p class="notes">
30 Located in <a class="field" href="_inc---CalDAVRequest.php.html">/inc/CalDAVRequest.php</a> (line <span class="field">29</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">mixed</span>
56 <a href="#$collection_id" title="details" class="var-name">$collection_id</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="#$collection_path" title="details" class="var-name">$collection_path</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="#$collection_type" title="details" class="var-name">$collection_type</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="#$current_user_principal_xml" title="details" class="var-name">$current_user_principal_xml</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="#$depth" title="details" class="var-name">$depth</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="#$destination" title="details" class="var-name">$destination</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="#$exists" title="details" class="var-name">$exists</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="#$method" title="details" class="var-name">$method</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="#$options" title="details" class="var-name">$options</a>
97 </div>
98 <div class="var-title">
99 <img src="../../media/images/Variable.png" alt=" " />
100 <span class="var-type"><a href="../../davical/Principal/DAVPrincipal.html">DAVPrincipal</a></span>
101 <a href="#$principal" title="details" class="var-name">$principal</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="#$privileges" title="details" class="var-name">$privileges</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="#$raw_post" title="details" class="var-name">$raw_post</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="#$supported_privileges" title="details" class="var-name">$supported_privileges</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="#$ticket" title="details" class="var-name">$ticket</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="#$user_agent" title="details" class="var-name">$user_agent</a>
127 </div>
128 </div>
129 </div>
130 </div>
131
132 <a name="sec-method-summary"></a>
133 <div class="info-box">
134 <div class="info-box-title">Method Summary</span></div>
135 <div class="nav-bar">
136 <a href="#sec-description">Description</a> |
137 <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
138
139 |
140 <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
141 </div>
142 <div class="info-box-body">
143 <div class="method-summary">
144 <div class="method-definition">
145 <img src="../../media/images/Constructor.png" alt=" "/>
146 <span class="method-result">CalDAVRequest</span>
147 <a href="#__construct" title="details" class="method-name">__construct</a>
148 ([<span class="var-type"></span>&nbsp;<span class="var-name">$options</span> = <span class="var-default">array()</span>])
149 </div>
150 <div class="method-definition">
151 <img src="../../media/images/Method.png" alt=" "/>
152 <span class="method-result">void</span>
153 <a href="#AllowedTo" title="details" class="method-name">AllowedTo</a>
154 (<span class="var-type">string</span>&nbsp;<span class="var-name">$activity</span>)
155 </div>
156 <div class="method-definition">
157 <img src="../../media/images/Method.png" alt=" "/>
158 <span class="method-result">void</span>
159 <a href="#BuildSupportedPrivileges" title="details" class="method-name">BuildSupportedPrivileges</a>
160 (<span class="var-type"></span>&nbsp;<span class="var-name">&$reply</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$privs</span> = <span class="var-default">null</span>])
161 </div>
162 <div class="method-definition">
163 <img src="../../media/images/Method.png" alt=" "/>
164 <span class="method-result">void</span>
165 <a href="#CoerceContentType" title="details" class="method-name">CoerceContentType</a>
166 ()
167 </div>
168 <div class="method-definition">
169 <img src="../../media/images/Method.png" alt=" "/>
170 <span class="method-result">void</span>
171 <a href="#CollectionId" title="details" class="method-name">CollectionId</a>
172 ()
173 </div>
174 <div class="method-definition">
175 <img src="../../media/images/Method.png" alt=" "/>
176 <span class="method-result">void</span>
177 <a href="#dav_name" title="details" class="method-name">dav_name</a>
178 ()
179 </div>
180 <div class="method-definition">
181 <img src="../../media/images/Method.png" alt=" "/>
182 <span class="method-result">void</span>
183 <a href="#DepthRegexTail" title="details" class="method-name">DepthRegexTail</a>
184 ()
185 </div>
186 <div class="method-definition">
187 <img src="../../media/images/Method.png" alt=" "/>
188 <span class="method-result">void</span>
189 <a href="#DoResponse" title="details" class="method-name">DoResponse</a>
190 (<span class="var-type">int</span>&nbsp;<span class="var-name">$status</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$message</span> = <span class="var-default">&quot;&quot;</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$content_type</span> = <span class="var-default">&quot;text/plain; charset=\&quot;utf-8\&quot;&quot;</span>])
191 </div>
192 <div class="method-definition">
193 <img src="../../media/images/Method.png" alt=" "/>
194 <span class="method-result">mixed</span>
195 <a href="#FailIfLocked" title="details" class="method-name">FailIfLocked</a>
196 ()
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="#GetDepthName" title="details" class="method-name">GetDepthName</a>
202 ()
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="#GetLockDetails" title="details" class="method-name">GetLockDetails</a>
208 (<span class="var-type">string</span>&nbsp;<span class="var-name">$lock_token</span>)
209 </div>
210 <div class="method-definition">
211 <img src="../../media/images/Method.png" alt=" "/>
212 <span class="method-result">void</span>
213 <a href="#GetLockRow" title="details" class="method-name">GetLockRow</a>
214 (<span class="var-type"></span>&nbsp;<span class="var-name">$lock_token</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$dav_name</span>)
215 </div>
216 <div class="method-definition">
217 <img src="../../media/images/Method.png" alt=" "/>
218 <span class="method-result">void</span>
219 <a href="#HavePrivilegeTo" title="details" class="method-name">HavePrivilegeTo</a>
220 (<span class="var-type"></span>&nbsp;<span class="var-name">$do_what</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="#IsAddressBook" title="details" class="method-name">IsAddressBook</a>
226 ()
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="#IsCalendar" title="details" class="method-name">IsCalendar</a>
232 ()
233 </div>
234 <div class="method-definition">
235 <img src="../../media/images/Method.png" alt=" "/>
236 <span class="method-result">void</span>
237 <a href="#IsCollection" title="details" class="method-name">IsCollection</a>
238 ()
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="#IsInfiniteDepth" title="details" class="method-name">IsInfiniteDepth</a>
244 ()
245 </div>
246 <div class="method-definition">
247 <img src="../../media/images/Method.png" alt=" "/>
248 <span class="method-result">void</span>
249 <a href="#IsLocked" title="details" class="method-name">IsLocked</a>
250 ()
251 </div>
252 <div class="method-definition">
253 <img src="../../media/images/Method.png" alt=" "/>
254 <span class="method-result">void</span>
255 <a href="#IsPrincipal" title="details" class="method-name">IsPrincipal</a>
256 ()
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="#IsProxyRequest" title="details" class="method-name">IsProxyRequest</a>
262 ()
263 </div>
264 <div class="method-definition">
265 <img src="../../media/images/Method.png" alt=" "/>
266 <span class="method-result">void</span>
267 <a href="#IsPublic" title="details" class="method-name">IsPublic</a>
268 ()
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="#MalformedRequest" title="details" class="method-name">MalformedRequest</a>
274 ([<span class="var-type">string</span>&nbsp;<span class="var-name">$text</span> = <span class="var-default">'Bad request'</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="#NeedPrivilege" title="details" class="method-name">NeedPrivilege</a>
280 (<span class="var-type"></span>&nbsp;<span class="var-name">$privileges</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$href</span> = <span class="var-default">null</span>], <span class="var-type">string</span>&nbsp;<span class="var-name">$privilege</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="#PreconditionFailed" title="details" class="method-name">PreconditionFailed</a>
286 (<span class="var-type">int</span>&nbsp;<span class="var-name">$status</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$precondition</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$explanation</span> = <span class="var-default">''</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$xmlns</span> = <span class="var-default">'DAV:'</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="#Privileges" title="details" class="method-name">Privileges</a>
292 ()
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="#setPermissions" title="details" class="method-name">setPermissions</a>
298 (<span class="var-type">int</span>&nbsp;<span class="var-name">$user_no</span>)
299 </div>
300 <div class="method-definition">
301 <img src="../../media/images/Method.png" alt=" "/>
302 <span class="method-result">void</span>
303 <a href="#UnsupportedRequest" title="details" class="method-name">UnsupportedRequest</a>
304 (<span class="var-type">array</span>&nbsp;<span class="var-name">$unsupported</span>)
305 </div>
306 <div class="method-definition">
307 <img src="../../media/images/Method.png" alt=" "/>
308 <span class="method-result">void</span>
309 <a href="#ValidateLockToken" title="details" class="method-name">ValidateLockToken</a>
310 (<span class="var-type">string</span>&nbsp;<span class="var-name">$lock_token</span>)
311 </div>
312 <div class="method-definition">
313 <img src="../../media/images/Method.png" alt=" "/>
314 <span class="method-result">void</span>
315 <a href="#XMLResponse" title="details" class="method-name">XMLResponse</a>
316 (<span class="var-type">int</span>&nbsp;<span class="var-name">$status</span>, <span class="var-type">XMLElement</span>&nbsp;<span class="var-name">$xmltree</span>)
317 </div>
318 </div>
319 </div>
320 </div>
321
322 <a name="sec-vars"></a>
323 <div class="info-box">
324 <div class="info-box-title">Variables</div>
325 <div class="nav-bar">
326 <a href="#sec-description">Description</a> |
327 <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
328
329
330 |
331 <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
332
333 </div>
334 <div class="info-box-body">
335
336 <a name="var$collection_id" id="$collection_id"><!-- --></A>
337 <div class="evenrow">
338
339 <div class="var-header">
340 <img src="../../media/images/Variable.png" />
341 <span class="var-title">
342 <span class="var-type">mixed</span>
343 <span class="var-name">$collection_id</span>
344 (line <span class="line-number">69</span>)
345 </span>
346 </div>
347
348 <!-- ========== Info from phpDoc block ========= -->
349 <p class="short-description">The ID of the collection containing this path, or of this path if it is a collection</p>
350
351
352
353
354
355 </div>
356 <a name="var$collection_path" id="$collection_path"><!-- --></A>
357 <div class="oddrow">
358
359 <div class="var-header">
360 <img src="../../media/images/Variable.png" />
361 <span class="var-title">
362 <span class="var-type">mixed</span>
363 <span class="var-name">$collection_path</span>
364 (line <span class="line-number">74</span>)
365 </span>
366 </div>
367
368 <!-- ========== Info from phpDoc block ========= -->
369 <p class="short-description">The path corresponding to the collection_id</p>
370
371
372
373
374
375 </div>
376 <a name="var$collection_type" id="$collection_type"><!-- --></A>
377 <div class="evenrow">
378
379 <div class="var-header">
380 <img src="../../media/images/Variable.png" />
381 <span class="var-title">
382 <span class="var-type">mixed</span>
383 <span class="var-name">$collection_type</span>
384 (line <span class="line-number">80</span>)
385 </span>
386 </div>
387
388 <!-- ========== Info from phpDoc block ========= -->
389 <p class="short-description">The type of collection being requested:</p>
390 <p class="description"><p>calendar, schedule-inbox, schedule-outbox</p></p>
391
392
393
394
395
396 </div>
397 <a name="var$current_user_principal_xml" id="$current_user_principal_xml"><!-- --></A>
398 <div class="oddrow">
399
400 <div class="var-header">
401 <img src="../../media/images/Variable.png" />
402 <span class="var-title">
403 <span class="var-type">mixed</span>
404 <span class="var-name">$current_user_principal_xml</span>
405 (line <span class="line-number">59</span>)
406 </span>
407 </div>
408
409 <!-- ========== Info from phpDoc block ========= -->
410 <p class="short-description">The 'current_user_principal_xml' the DAV:current-user-principal answer. An XMLElement object with an &lt;href&gt; or &lt;unauthenticated&gt; fragment.</p>
411
412
413
414
415
416 </div>
417 <a name="var$depth" id="$depth"><!-- --></A>
418 <div class="evenrow">
419
420 <div class="var-header">
421 <img src="../../media/images/Variable.png" />
422 <span class="var-title">
423 <span class="var-type">mixed</span>
424 <span class="var-name">$depth</span>
425 (line <span class="line-number">47</span>)
426 </span>
427 </div>
428
429 <!-- ========== Info from phpDoc block ========= -->
430 <p class="short-description">The depth parameter from the request headers, coerced into a valid integer: 0, 1 or DEPTH_INFINITY which is defined above. The default is set per various RFCs.</p>
431
432
433
434
435
436 </div>
437 <a name="var$destination" id="$destination"><!-- --></A>
438 <div class="oddrow">
439
440 <div class="var-header">
441 <img src="../../media/images/Variable.png" />
442 <span class="var-title">
443 <span class="var-type">mixed</span>
444 <span class="var-name">$destination</span>
445 (line <span class="line-number">91</span>)
446 </span>
447 </div>
448
449 <!-- ========== Info from phpDoc block ========= -->
450 <p class="short-description">The value of any 'Destionation:' header, if present.</p>
451
452
453
454
455
456 </div>
457 <a name="var$exists" id="$exists"><!-- --></A>
458 <div class="evenrow">
459
460 <div class="var-header">
461 <img src="../../media/images/Variable.png" />
462 <span class="var-title">
463 <span class="var-type">mixed</span>
464 <span class="var-name">$exists</span>
465 (line <span class="line-number">86</span>)
466 </span>
467 </div>
468
469 <!-- ========== Info from phpDoc block ========= -->
470 <p class="short-description">The type of collection being requested:</p>
471 <p class="description"><p>calendar, schedule-inbox, schedule-outbox</p></p>
472 <ul class="tags">
473 <li><span class="field">access:</span> protected</li>
474 </ul>
475
476
477
478
479
480 </div>
481 <a name="var$method" id="$method"><!-- --></A>
482 <div class="oddrow">
483
484 <div class="var-header">
485 <img src="../../media/images/Variable.png" />
486 <span class="var-title">
487 <span class="var-type">mixed</span>
488 <span class="var-name">$method</span>
489 (line <span class="line-number">41</span>)
490 </span>
491 </div>
492
493 <!-- ========== Info from phpDoc block ========= -->
494 <p class="short-description">The HTTP request method: PROPFIND, LOCK, REPORT, OPTIONS, etc...</p>
495
496
497
498
499
500 </div>
501 <a name="var$options" id="$options"><!-- --></A>
502 <div class="evenrow">
503
504 <div class="var-header">
505 <img src="../../media/images/Variable.png" />
506 <span class="var-title">
507 <span class="var-type">mixed</span>
508 <span class="var-name">$options</span>
509 (line <span class="line-number">31</span>)
510 </span>
511 </div>
512
513 <!-- ========== Info from phpDoc block ========= -->
514
515
516
517
518
519 </div>
520 <a name="var$principal" id="$principal"><!-- --></A>
521 <div class="oddrow">
522
523 <div class="var-header">
524 <img src="../../media/images/Variable.png" />
525 <span class="var-title">
526 <span class="var-type"><a href="../../davical/Principal/DAVPrincipal.html">DAVPrincipal</a></span>
527 <span class="var-name">$principal</span>
528 (line <span class="line-number">53</span>)
529 </span>
530 </div>
531
532 <!-- ========== Info from phpDoc block ========= -->
533 <p class="short-description">The 'principal' (user/resource/...) which this request seeks to access</p>
534
535
536
537
538
539 </div>
540 <a name="var$privileges" id="$privileges"><!-- --></A>
541 <div class="evenrow">
542
543 <div class="var-header">
544 <img src="../../media/images/Variable.png" />
545 <span class="var-title">
546 <span class="var-type">mixed</span>
547 <span class="var-name">$privileges</span>
548 (line <span class="line-number">96</span>)
549 </span>
550 </div>
551
552 <!-- ========== Info from phpDoc block ========= -->
553 <p class="short-description">The decimal privileges allowed by this user to the identified resource.</p>
554 <ul class="tags">
555 <li><span class="field">access:</span> protected</li>
556 </ul>
557
558
559
560
561
562 </div>
563 <a name="var$raw_post" id="$raw_post"><!-- --></A>
564 <div class="oddrow">
565
566 <div class="var-header">
567 <img src="../../media/images/Variable.png" />
568 <span class="var-title">
569 <span class="var-type">mixed</span>
570 <span class="var-name">$raw_post</span>
571 (line <span class="line-number">36</span>)
572 </span>
573 </div>
574
575 <!-- ========== Info from phpDoc block ========= -->
576 <p class="short-description">The raw data sent along with the request</p>
577
578
579
580
581
582 </div>
583 <a name="var$supported_privileges" id="$supported_privileges"><!-- --></A>
584 <div class="evenrow">
585
586 <div class="var-header">
587 <img src="../../media/images/Variable.png" />
588 <span class="var-title">
589 <span class="var-type">mixed</span>
590 <span class="var-name">$supported_privileges</span>
591 (line <span class="line-number">101</span>)
592 </span>
593 </div>
594
595 <!-- ========== Info from phpDoc block ========= -->
596 <p class="short-description">A static structure of supported privileges.</p>
597
598
599
600
601
602 </div>
603 <a name="var$ticket" id="$ticket"><!-- --></A>
604 <div class="oddrow">
605
606 <div class="var-header">
607 <img src="../../media/images/Variable.png" />
608 <span class="var-title">
609 <span class="var-type">mixed</span>
610 <span class="var-name">$ticket</span>
611 (line <span class="line-number">106</span>)
612 </span>
613 </div>
614
615 <!-- ========== Info from phpDoc block ========= -->
616 <p class="short-description">A DAVTicket object, if there is a ?ticket=id or Ticket: id with this request</p>
617 <ul class="tags">
618 <li><span class="field">access:</span> public</li>
619 </ul>
620
621
622
623
624
625 </div>
626 <a name="var$user_agent" id="$user_agent"><!-- --></A>
627 <div class="evenrow">
628
629 <div class="var-header">
630 <img src="../../media/images/Variable.png" />
631 <span class="var-title">
632 <span class="var-type">mixed</span>
633 <span class="var-name">$user_agent</span>
634 (line <span class="line-number">64</span>)
635 </span>
636 </div>
637
638 <!-- ========== Info from phpDoc block ========= -->
639 <p class="short-description">The user agent making the request.</p>
640
641
642
643
644
645 </div>
646
647 </div>
648 </div>
649
650 <a name="sec-methods"></a>
651 <div class="info-box">
652 <div class="info-box-title">Methods</div>
653 <div class="nav-bar">
654 <a href="#sec-description">Description</a> |
655 <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
656 <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
657
658 </div>
659 <div class="info-box-body">
660 <A NAME='method_detail'></A>
661 <a name="method__construct" id="__construct"><!-- --></a>
662 <div class="oddrow">
663
664 <div class="method-header">
665 <img src="../../media/images/Constructor.png" />
666 <span class="method-title">Constructor __construct</span> (line <span class="line-number">111</span>)
667 </div>
668
669 <!-- ========== Info from phpDoc block ========= -->
670 <p class="short-description">Create a new CalDAVRequest object.</p>
671
672 <div class="method-signature">
673 <span class="method-result">CalDAVRequest</span>
674 <span class="method-name">
675 __construct
676 </span>
677 ([<span class="var-type"></span>&nbsp;<span class="var-name">$options</span> = <span class="var-default">array()</span>])
678 </div>
679
680 <ul class="parameters">
681 <li>
682 <span class="var-type"></span>
683 <span class="var-name">$options</span> </li>
684 </ul>
685
686
687 </div>
688 <a name="methodAllowedTo" id="AllowedTo"><!-- --></a>
689 <div class="evenrow">
690
691 <div class="method-header">
692 <img src="../../media/images/Method.png" />
693 <span class="method-title">AllowedTo</span> (line <span class="line-number">1002</span>)
694 </div>
695
696 <!-- ========== Info from phpDoc block ========= -->
697 <p class="short-description">Are we allowed to do the requested activity</p>
698 <p class="description"><p>+------------+------------------------------------------------------+ | METHOD | PRIVILEGES | +------------+------------------------------------------------------+ | MKCALENDAR | DAV:bind | | REPORT | DAV:read or CALDAV:read-free-busy (on all referenced | | | resources) | +------------+------------------------------------------------------+</p></p>
699
700 <div class="method-signature">
701 <span class="method-result">void</span>
702 <span class="method-name">
703 AllowedTo
704 </span>
705 (<span class="var-type">string</span>&nbsp;<span class="var-name">$activity</span>)
706 </div>
707
708 <ul class="parameters">
709 <li>
710 <span class="var-type">string</span>
711 <span class="var-name">$activity</span><span class="var-description">: The activity we want to do.</span> </li>
712 </ul>
713
714
715 </div>
716 <a name="methodBuildSupportedPrivileges" id="BuildSupportedPrivileges"><!-- --></a>
717 <div class="oddrow">
718
719 <div class="method-header">
720 <img src="../../media/images/Method.png" />
721 <span class="method-title">BuildSupportedPrivileges</span> (line <span class="line-number">964</span>)
722 </div>
723
724 <!-- ========== Info from phpDoc block ========= -->
725 <p class="short-description">Returns the array of supported privileges converted into XMLElements</p>
726
727 <div class="method-signature">
728 <span class="method-result">void</span>
729 <span class="method-name">
730 BuildSupportedPrivileges
731 </span>
732 (<span class="var-type"></span>&nbsp;<span class="var-name">&$reply</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$privs</span> = <span class="var-default">null</span>])
733 </div>
734
735 <ul class="parameters">
736 <li>
737 <span class="var-type"></span>
738 <span class="var-name">&$reply</span> </li>
739 <li>
740 <span class="var-type"></span>
741 <span class="var-name">$privs</span> </li>
742 </ul>
743
744
745 </div>
746 <a name="methodCoerceContentType" id="CoerceContentType"><!-- --></a>
747 <div class="evenrow">
748
749 <div class="method-header">
750 <img src="../../media/images/Method.png" />
751 <span class="method-title">CoerceContentType</span> (line <span class="line-number">856</span>)
752 </div>
753
754 <!-- ========== Info from phpDoc block ========= -->
755 <p class="short-description">Coerces the Content-type of the request into something valid/appropriate</p>
756
757 <div class="method-signature">
758 <span class="method-result">void</span>
759 <span class="method-name">
760 CoerceContentType
761 </span>
762 ()
763 </div>
764
765
766
767 </div>
768 <a name="methodCollectionId" id="CollectionId"><!-- --></a>
769 <div class="oddrow">
770
771 <div class="method-header">
772 <img src="../../media/images/Method.png" />
773 <span class="method-title">CollectionId</span> (line <span class="line-number">956</span>)
774 </div>
775
776 <!-- ========== Info from phpDoc block ========= -->
777 <p class="short-description">Returns the ID of the collection of, or containing this request</p>
778
779 <div class="method-signature">
780 <span class="method-result">void</span>
781 <span class="method-name">
782 CollectionId
783 </span>
784 ()
785 </div>
786
787
788
789 </div>
790 <a name="methoddav_name" id="dav_name"><!-- --></a>
791 <div class="evenrow">
792
793 <div class="method-header">
794 <img src="../../media/images/Method.png" />
795 <span class="method-title">dav_name</span> (line <span class="line-number">722</span>)
796 </div>
797
798 <!-- ========== Info from phpDoc block ========= -->
799 <p class="short-description">Returns the dav_name of the resource in our internal namespace</p>
800
801 <div class="method-signature">
802 <span class="method-result">void</span>
803 <span class="method-name">
804 dav_name
805 </span>
806 ()
807 </div>
808
809
810
811 </div>
812 <a name="methodDepthRegexTail" id="DepthRegexTail"><!-- --></a>
813 <div class="oddrow">
814
815 <div class="method-header">
816 <img src="../../media/images/Method.png" />
817 <span class="method-title">DepthRegexTail</span> (line <span class="line-number">740</span>)
818 </div>
819
820 <!-- ========== Info from phpDoc block ========= -->
821 <p class="short-description">Returns the tail of a Regex appropriate for this Depth, when appended to</p>
822
823 <div class="method-signature">
824 <span class="method-result">void</span>
825 <span class="method-name">
826 DepthRegexTail
827 </span>
828 ()
829 </div>
830
831
832
833 </div>
834 <a name="methodDoResponse" id="DoResponse"><!-- --></a>
835 <div class="evenrow">
836
837 <div class="method-header">
838 <img src="../../media/images/Method.png" />
839 <span class="method-title">DoResponse</span> (line <span class="line-number">1179</span>)
840 </div>
841
842 <!-- ========== Info from phpDoc block ========= -->
843 <p class="short-description">Utility function we call when we have a simple status-based response to return to the client. Possibly</p>
844
845 <div class="method-signature">
846 <span class="method-result">void</span>
847 <span class="method-name">
848 DoResponse
849 </span>
850 (<span class="var-type">int</span>&nbsp;<span class="var-name">$status</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$message</span> = <span class="var-default">&quot;&quot;</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$content_type</span> = <span class="var-default">&quot;text/plain; charset=\&quot;utf-8\&quot;&quot;</span>])
851 </div>
852
853 <ul class="parameters">
854 <li>
855 <span class="var-type">int</span>
856 <span class="var-name">$status</span><span class="var-description">: The HTTP status code to send.</span> </li>
857 <li>
858 <span class="var-type">string</span>
859 <span class="var-name">$message</span><span class="var-description">: The friendly text message to send with the response.</span> </li>
860 <li>
861 <span class="var-type"></span>
862 <span class="var-name">$content_type</span> </li>
863 </ul>
864
865
866 </div>
867 <a name="methodFailIfLocked" id="FailIfLocked"><!-- --></a>
868 <div class="oddrow">
869
870 <div class="method-header">
871 <img src="../../media/images/Method.png" />
872 <span class="method-title">FailIfLocked</span> (line <span class="line-number">821</span>)
873 </div>
874
875 <!-- ========== Info from phpDoc block ========= -->
876 <p class="short-description">This will either (a) return false if no locks apply, or (b) return the lock_token which the request successfully included to open the lock, or: (c) respond directly to the client with the failure.</p>
877 <ul class="tags">
878 <li><span class="field">return:</span> false (no lock) or opaquelocktoken (opened lock)</li>
879 </ul>
880
881 <div class="method-signature">
882 <span class="method-result">mixed</span>
883 <span class="method-name">
884 FailIfLocked
885 </span>
886 ()
887 </div>
888
889
890
891 </div>
892 <a name="methodGetDepthName" id="GetDepthName"><!-- --></a>
893 <div class="evenrow">
894
895 <div class="method-header">
896 <img src="../../media/images/Method.png" />
897 <span class="method-title">GetDepthName</span> (line <span class="line-number">731</span>)
898 </div>
899
900 <!-- ========== Info from phpDoc block ========= -->
901 <p class="short-description">Returns the name for this depth: 0, 1, infinity</p>
902
903 <div class="method-signature">
904 <span class="method-result">void</span>
905 <span class="method-name">
906 GetDepthName
907 </span>
908 ()
909 </div>
910
911
912
913 </div>
914 <a name="methodGetLockDetails" id="GetLockDetails"><!-- --></a>
915 <div class="oddrow">
916
917 <div class="method-header">
918 <img src="../../media/images/Method.png" />
919 <span class="method-title">GetLockDetails</span> (line <span class="line-number">807</span>)
920 </div>
921
922 <!-- ========== Info from phpDoc block ========= -->
923 <p class="short-description">Returns the DB object associated with a lock token, or false.</p>
924
925 <div class="method-signature">
926 <span class="method-result">void</span>
927 <span class="method-name">
928 GetLockDetails
929 </span>
930 (<span class="var-type">string</span>&nbsp;<span class="var-name">$lock_token</span>)
931 </div>
932
933 <ul class="parameters">
934 <li>
935 <span class="var-type">string</span>
936 <span class="var-name">$lock_token</span><span class="var-description">: The opaquelocktoken which we are looking for</span> </li>
937 </ul>
938
939
940 </div>
941 <a name="methodGetLockRow" id="GetLockRow"><!-- --></a>
942 <div class="evenrow">
943
944 <div class="method-header">
945 <img src="../../media/images/Method.png" />
946 <span class="method-title">GetLockRow</span> (line <span class="line-number">751</span>)
947 </div>
948
949 <!-- ========== Info from phpDoc block ========= -->
950 <p class="short-description">Returns the locked row, either from the cache or from the database</p>
951
952 <div class="method-signature">
953 <span class="method-result">void</span>
954 <span class="method-name">
955 GetLockRow
956 </span>
957 (<span class="var-type"></span>&nbsp;<span class="var-name">$lock_token</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$dav_name</span>)
958 </div>
959
960 <ul class="parameters">
961 <li>
962 <span class="var-type">string</span>
963 <span class="var-name">$dav_name</span><span class="var-description">: The resource which we want to know the lock status for</span> </li>
964 <li>
965 <span class="var-type"></span>
966 <span class="var-name">$lock_token</span> </li>
967 </ul>
968
969
970 </div>
971 <a name="methodHavePrivilegeTo" id="HavePrivilegeTo"><!-- --></a>
972 <div class="oddrow">
973
974 <div class="method-header">
975 <img src="../../media/images/Method.png" />
976 <span class="method-title">HavePrivilegeTo</span> (line <span class="line-number">1075</span>)
977 </div>
978
979 <!-- ========== Info from phpDoc block ========= -->
980 <p class="short-description">Is the user has the privileges to do what is requested.</p>
981
982 <div class="method-signature">
983 <span class="method-result">void</span>
984 <span class="method-name">
985 HavePrivilegeTo
986 </span>
987 (<span class="var-type"></span>&nbsp;<span class="var-name">$do_what</span>)
988 </div>
989
990 <ul class="parameters">
991 <li>
992 <span class="var-type"></span>
993 <span class="var-name">$do_what</span> </li>
994 </ul>
995
996
997 </div>
998 <a name="methodIsAddressBook" id="IsAddressBook"><!-- --></a>
999 <div class="evenrow">
1000
1001 <div class="method-header">
1002 <img src="../../media/images/Method.png" />
1003 <span class="method-title">IsAddressBook</span> (line <span class="line-number">917</span>)
1004 </div>
1005
1006 <!-- ========== Info from phpDoc block ========= -->
1007 <p class="short-description">Returns true if the URL referenced by this request points at an addressbook collection.</p>
1008
1009 <div class="method-signature">
1010 <span class="method-result">void</span>
1011 <span class="method-name">
1012 IsAddressBook
1013 </span>
1014 ()
1015 </div>
1016
1017
1018
1019 </div>
1020 <a name="methodIsCalendar" id="IsCalendar"><!-- --></a>
1021 <div class="oddrow">
1022
1023 <div class="method-header">
1024 <img src="../../media/images/Method.png" />
1025 <span class="method-title">IsCalendar</span> (line <span class="line-number">908</span>)
1026 </div>
1027
1028 <!-- ========== Info from phpDoc block ========= -->
1029 <p class="short-description">Returns true if the URL referenced by this request points at a calendar collection.</p>
1030
1031 <div class="method-signature">
1032 <span class="method-result">void</span>
1033 <span class="method-name">
1034 IsCalendar
1035 </span>
1036 ()
1037 </div>
1038
1039
1040
1041 </div>
1042 <a name="methodIsCollection" id="IsCollection"><!-- --></a>
1043 <div class="evenrow">
1044
1045 <div class="method-header">
1046 <img src="../../media/images/Method.png" />
1047 <span class="method-title">IsCollection</span> (line <span class="line-number">897</span>)
1048 </div>
1049
1050 <!-- ========== Info from phpDoc block ========= -->
1051 <p class="short-description">Returns true if the URL referenced by this request points at a collection.</p>
1052
1053 <div class="method-signature">
1054 <span class="method-result">void</span>
1055 <span class="method-name">
1056 IsCollection
1057 </span>
1058 ()
1059 </div>
1060
1061
1062
1063 </div>
1064 <a name="methodIsInfiniteDepth" id="IsInfiniteDepth"><!-- --></a>
1065 <div class="oddrow">
1066
1067 <div class="method-header">
1068 <img src="../../media/images/Method.png" />
1069 <span class="method-title">IsInfiniteDepth</span> (line <span class="line-number">948</span>)
1070 </div>
1071
1072 <!-- ========== Info from phpDoc block ========= -->
1073 <p class="short-description">Returns true if the request asked for infinite depth</p>
1074
1075 <div class="method-signature">
1076 <span class="method-result">void</span>
1077 <span class="method-name">
1078 IsInfiniteDepth
1079 </span>
1080 ()
1081 </div>
1082
1083
1084
1085 </div>
1086 <a name="methodIsLocked" id="IsLocked"><!-- --></a>
1087 <div class="evenrow">
1088
1089 <div class="method-header">
1090 <img src="../../media/images/Method.png" />
1091 <span class="method-title">IsLocked</span> (line <span class="line-number">643</span>)
1092 </div>
1093
1094 <!-- ========== Info from phpDoc block ========= -->
1095 <p class="short-description">Checks whether the resource is locked, returning any lock token, or false</p>
1096 <ul class="tags">
1097 <li><span class="field">todo:</span> This logic does not catch all locking scenarios. For example an infinite depth request should check the permissions for all collections and resources within that. At present we only maintain permissions on a per-collection basis though.</li>
1098 </ul>
1099
1100 <div class="method-signature">
1101 <span class="method-result">void</span>
1102 <span class="method-name">
1103 IsLocked
1104 </span>
1105 ()
1106 </div>
1107
1108
1109
1110 </div>
1111 <a name="methodIsPrincipal" id="IsPrincipal"><!-- --></a>
1112 <div class="oddrow">
1113
1114 <div class="method-header">
1115 <img src="../../media/images/Method.png" />
1116 <span class="method-title">IsPrincipal</span> (line <span class="line-number">926</span>)
1117 </div>
1118
1119 <!-- ========== Info from phpDoc block ========= -->
1120 <p class="short-description">Returns true if the URL referenced by this request points at a principal.</p>
1121
1122 <div class="method-signature">
1123 <span class="method-result">void</span>
1124 <span class="method-name">
1125 IsPrincipal
1126 </span>
1127 ()
1128 </div>
1129
1130
1131
1132 </div>
1133 <a name="methodIsProxyRequest" id="IsProxyRequest"><!-- --></a>
1134 <div class="evenrow">
1135
1136 <div class="method-header">
1137 <img src="../../media/images/Method.png" />
1138 <span class="method-title">IsProxyRequest</span> (line <span class="line-number">937</span>)
1139 </div>
1140
1141 <!-- ========== Info from phpDoc block ========= -->
1142 <p class="short-description">Returns true if the URL referenced by this request is within a proxy URL</p>
1143
1144 <div class="method-signature">
1145 <span class="method-result">void</span>
1146 <span class="method-name">
1147 IsProxyRequest
1148 </span>
1149 ()
1150 </div>
1151
1152
1153
1154 </div>
1155 <a name="methodIsPublic" id="IsPublic"><!-- --></a>
1156 <div class="oddrow">
1157
1158 <div class="method-header">
1159 <img src="../../media/images/Method.png" />
1160 <span class="method-title">IsPublic</span> (line <span class="line-number">680</span>)
1161 </div>
1162
1163 <!-- ========== Info from phpDoc block ========= -->
1164 <p class="short-description">Checks whether the collection is public</p>
1165
1166 <div class="method-signature">
1167 <span class="method-result">void</span>
1168 <span class="method-name">
1169 IsPublic
1170 </span>
1171 ()
1172 </div>
1173
1174
1175
1176 </div>
1177 <a name="methodMalformedRequest" id="MalformedRequest"><!-- --></a>
1178 <div class="evenrow">
1179
1180 <div class="method-header">
1181 <img src="../../media/images/Method.png" />
1182 <span class="method-title">MalformedRequest</span> (line <span class="line-number">1152</span>)
1183 </div>
1184
1185 <!-- ========== Info from phpDoc block ========= -->
1186 <p class="short-description">Send a simple error informing the client that was a malformed request</p>
1187
1188 <div class="method-signature">
1189 <span class="method-result">void</span>
1190 <span class="method-name">
1191 MalformedRequest
1192 </span>
1193 ([<span class="var-type">string</span>&nbsp;<span class="var-name">$text</span> = <span class="var-default">'Bad request'</span>])
1194 </div>
1195
1196 <ul class="parameters">
1197 <li>
1198 <span class="var-type">string</span>
1199 <span class="var-name">$text</span><span class="var-description">: An optional text description of the failure.</span> </li>
1200 </ul>
1201
1202
1203 </div>
1204 <a name="methodNeedPrivilege" id="NeedPrivilege"><!-- --></a>
1205 <div class="oddrow">
1206
1207 <div class="method-header">
1208 <img src="../../media/images/Method.png" />
1209 <span class="method-title">NeedPrivilege</span> (line <span class="line-number">1111</span>)
1210 </div>
1211
1212 <!-- ========== Info from phpDoc block ========= -->
1213 <p class="short-description">Send a need-privileges error response. This function will only return if the $href is not supplied and the current user has the specified permission for the request path.</p>
1214
1215 <div class="method-signature">
1216 <span class="method-result">void</span>
1217 <span class="method-name">
1218 NeedPrivilege
1219 </span>
1220 (<span class="var-type"></span>&nbsp;<span class="var-name">$privileges</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$href</span> = <span class="var-default">null</span>], <span class="var-type">string</span>&nbsp;<span class="var-name">$privilege</span>)
1221 </div>
1222
1223 <ul class="parameters">
1224 <li>
1225 <span class="var-type">string</span>
1226 <span class="var-name">$privilege</span><span class="var-description">: The name of the needed privilege.</span> </li>
1227 <li>
1228 <span class="var-type">string</span>
1229 <span class="var-name">$href</span><span class="var-description">: The unconstructed URI where we needed the privilege.</span> </li>
1230 <li>
1231 <span class="var-type"></span>
1232 <span class="var-name">$privileges</span> </li>
1233 </ul>
1234
1235
1236 </div>
1237 <a name="methodPreconditionFailed" id="PreconditionFailed"><!-- --></a>
1238 <div class="evenrow">
1239
1240 <div class="method-header">
1241 <img src="../../media/images/Method.png" />
1242 <span class="method-title">PreconditionFailed</span> (line <span class="line-number">1136</span>)
1243 </div>
1244
1245 <!-- ========== Info from phpDoc block ========= -->
1246 <p class="short-description">Send an error response for a failed precondition.</p>
1247
1248 <div class="method-signature">
1249 <span class="method-result">void</span>
1250 <span class="method-name">
1251 PreconditionFailed
1252 </span>
1253 (<span class="var-type">int</span>&nbsp;<span class="var-name">$status</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$precondition</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$explanation</span> = <span class="var-default">''</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$xmlns</span> = <span class="var-default">'DAV:'</span>])
1254 </div>
1255
1256 <ul class="parameters">
1257 <li>
1258 <span class="var-type">int</span>
1259 <span class="var-name">$status</span><span class="var-description">: The status code for the failed precondition. Normally 403</span> </li>
1260 <li>
1261 <span class="var-type">string</span>
1262 <span class="var-name">$precondition</span><span class="var-description">: The namespaced precondition tag.</span> </li>
1263 <li>
1264 <span class="var-type">string</span>
1265 <span class="var-name">$explanation</span><span class="var-description">: An optional text explanation for the failure.</span> </li>
1266 <li>
1267 <span class="var-type"></span>
1268 <span class="var-name">$xmlns</span> </li>
1269 </ul>
1270
1271
1272 </div>
1273 <a name="methodPrivileges" id="Privileges"><!-- --></a>
1274 <div class="oddrow">
1275
1276 <div class="method-header">
1277 <img src="../../media/images/Method.png" />
1278 <span class="method-title">Privileges</span> (line <span class="line-number">1067</span>)
1279 </div>
1280
1281 <!-- ========== Info from phpDoc block ========= -->
1282 <p class="short-description">Return the privileges bits for the current session user to this resource</p>
1283
1284 <div class="method-signature">
1285 <span class="method-result">void</span>
1286 <span class="method-name">
1287 Privileges
1288 </span>
1289 ()
1290 </div>
1291
1292
1293
1294 </div>
1295 <a name="methodsetPermissions" id="setPermissions"><!-- --></a>
1296 <div class="evenrow">
1297
1298 <div class="method-header">
1299 <img src="../../media/images/Method.png" />
1300 <span class="method-title">setPermissions</span> (line <span class="line-number">575</span>)
1301 </div>
1302
1303 <!-- ========== Info from phpDoc block ========= -->
1304 <p class="short-description">Permissions are controlled as follows:</p>
1305 <p class="description"><p><ol><li>if the path is '/', the request has read privileges</li><li>if the requester is an admin, the request has read/write priviliges</li><li>if there is a &lt;user name&gt; component which matches the logged on user
1306 then the request has read/write privileges</li><li>otherwise we query the defined relationships between users and use
1307 the minimum privileges returned from that analysis.</li></ol></p></p>
1308
1309 <div class="method-signature">
1310 <span class="method-result">void</span>
1311 <span class="method-name">
1312 setPermissions
1313 </span>
1314 (<span class="var-type">int</span>&nbsp;<span class="var-name">$user_no</span>)
1315 </div>
1316
1317 <ul class="parameters">
1318 <li>
1319 <span class="var-type">int</span>
1320 <span class="var-name">$user_no</span><span class="var-description">: The current user number</span> </li>
1321 </ul>
1322
1323
1324 </div>
1325 <a name="methodUnsupportedRequest" id="UnsupportedRequest"><!-- --></a>
1326 <div class="oddrow">
1327
1328 <div class="method-header">
1329 <img src="../../media/images/Method.png" />
1330 <span class="method-title">UnsupportedRequest</span> (line <span class="line-number">1088</span>)
1331 </div>
1332
1333 <!-- ========== Info from phpDoc block ========= -->
1334 <p class="short-description">Sometimes it's a perfectly formed request, but we just don't do that :-(</p>
1335
1336 <div class="method-signature">
1337 <span class="method-result">void</span>
1338 <span class="method-name">
1339 UnsupportedRequest
1340 </span>
1341 (<span class="var-type">array</span>&nbsp;<span class="var-name">$unsupported</span>)
1342 </div>
1343
1344 <ul class="parameters">
1345 <li>
1346 <span class="var-type">array</span>
1347 <span class="var-name">$unsupported</span><span class="var-description">: An array of the properties we don't support.</span> </li>
1348 </ul>
1349
1350
1351 </div>
1352 <a name="methodValidateLockToken" id="ValidateLockToken"><!-- --></a>
1353 <div class="evenrow">
1354
1355 <div class="method-header">
1356 <img src="../../media/images/Method.png" />
1357 <span class="method-title">ValidateLockToken</span> (line <span class="line-number">776</span>)
1358 </div>
1359
1360 <!-- ========== Info from phpDoc block ========= -->
1361 <p class="short-description">Checks to see whether the lock token given matches one of the ones handed in with the request.</p>
1362
1363 <div class="method-signature">
1364 <span class="method-result">void</span>
1365 <span class="method-name">
1366 ValidateLockToken
1367 </span>
1368 (<span class="var-type">string</span>&nbsp;<span class="var-name">$lock_token</span>)
1369 </div>
1370
1371 <ul class="parameters">
1372 <li>
1373 <span class="var-type">string</span>
1374 <span class="var-name">$lock_token</span><span class="var-description">: The opaquelocktoken which we are looking for</span> </li>
1375 </ul>
1376
1377
1378 </div>
1379 <a name="methodXMLResponse" id="XMLResponse"><!-- --></a>
1380 <div class="oddrow">
1381
1382 <div class="method-header">
1383 <img src="../../media/images/Method.png" />
1384 <span class="method-title">XMLResponse</span> (line <span class="line-number">1164</span>)
1385 </div>
1386
1387 <!-- ========== Info from phpDoc block ========= -->
1388 <p class="short-description">Send an XML Response. This function will never return.</p>
1389
1390 <div class="method-signature">
1391 <span class="method-result">void</span>
1392 <span class="method-name">
1393 XMLResponse
1394 </span>
1395 (<span class="var-type">int</span>&nbsp;<span class="var-name">$status</span>, <span class="var-type">XMLElement</span>&nbsp;<span class="var-name">$xmltree</span>)
1396 </div>
1397
1398 <ul class="parameters">
1399 <li>
1400 <span class="var-type">int</span>
1401 <span class="var-name">$status</span><span class="var-description">: The HTTP status to respond</span> </li>
1402 <li>
1403 <span class="var-type">XMLElement</span>
1404 <span class="var-name">$xmltree</span><span class="var-description">: An XMLElement tree to be rendered</span> </li>
1405 </ul>
1406
1407
1408 </div>
1409
1410 </div>
1411 </div>
1412
1413
1414 <p class="notes" id="credit">
1415 Documentation generated on Fri, 13 Jan 2012 23:44:53 +1300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
1416 </p>
1417 </div></body>
1418 </html>
DAViCal CalDAV & CardDAV Server