?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
Release 0.9.9.6
[davical.git] / docs / api / davical / Resource / DAVResource.html
bloba5eab486a0097b6394731e35c8a6de462f1a6a03
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 DAVResource</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"> DAVResource</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-descendents">Descendents</a>
23 | <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
24 | <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
25
26 </div>
27 <div class="info-box-body">
28 <!-- ========== Info from phpDoc block ========= -->
29 <p class="short-description">A class for things to do with a DAV Resource</p>
30 <p class="notes">
31 Located in <a class="field" href="_inc---DAVResource.php.html">/inc/DAVResource.php</a> (line <span class="field">23</span>)
32 </p>
33
34
35 <pre></pre>
36
37 </div>
38 </div>
39
40 <a name="sec-descendents"></a>
41 <div class="info-box">
42 <div class="info-box-title">Direct descendents</div>
43 <div class="nav-bar">
44 <a href="#sec-description">Description</a> |
45 <span class="disabled">Descendents</span>
46 | <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
47 | <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
48
49 </div>
50 <div class="info-box-body">
51 <table cellpadding="2" cellspacing="0" class="class-table">
52 <tr>
53 <th class="class-table-header">Class</th>
54 <th class="class-table-header">Description</th>
55 </tr>
56 <tr>
57 <td style="padding-right: 2em; white-space: nowrap">
58 <img src="../../media/images/Class.png"
59 alt=" class"
60 title=" class"
61 style="vertical-align: center"/>
62 <a href="../../davical/Resource/WritableCollection.html">WritableCollection</a>
63 </td>
64 <td>
65 A class for things to do with a DAV Resource
66 </td>
67 </tr>
68 </table>
69 </div>
70 </div>
71
72
73 <a name="sec-var-summary"></a>
74 <div class="info-box">
75 <div class="info-box-title">Variable Summary</span></div>
76 <div class="nav-bar">
77 <a href="#sec-description">Description</a> |
78 <a href="#sec-descendents">Descendants</a> |
79 <span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
80 |
81 <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
82
83 </div>
84 <div class="info-box-body">
85 <div class="var-summary">
86 <div class="var-title">
87 <img src="../../media/images/Variable.png" alt=" " />
88 <span class="var-type">The</span>
89 <a href="#$bound_from" title="details" class="var-name">$bound_from</a>
90 </div>
91 <div class="var-title">
92 <img src="../../media/images/Variable.png" alt=" " />
93 <span class="var-type">The</span>
94 <a href="#$contenttype" title="details" class="var-name">$contenttype</a>
95 </div>
96 <div class="var-title">
97 <img src="../../media/images/Variable.png" alt=" " />
98 <span class="var-type">The</span>
99 <a href="#$dav_name" title="details" class="var-name">$dav_name</a>
100 </div>
101 <div class="var-title">
102 <img src="../../media/images/Variable.png" alt=" " />
103 <span class="var-type">Boolean:</span>
104 <a href="#$exists" title="details" class="var-name">$exists</a>
105 </div>
106 <div class="var-title">
107 <img src="../../media/images/Variable.png" alt=" " />
108 <span class="var-type">The</span>
109 <a href="#$parent" title="details" class="var-name">$parent</a>
110 </div>
111 <div class="var-title">
112 <img src="../../media/images/Variable.png" alt=" " />
113 <span class="var-type">The</span>
114 <a href="#$resource" title="details" class="var-name">$resource</a>
115 </div>
116 <div class="var-title">
117 <img src="../../media/images/Variable.png" alt=" " />
118 <span class="var-type">The</span>
119 <a href="#$resourcetypes" title="details" class="var-name">$resourcetypes</a>
120 </div>
121 <div class="var-title">
122 <img src="../../media/images/Variable.png" alt=" " />
123 <span class="var-type">The</span>
124 <a href="#$unique_tag" title="details" class="var-name">$unique_tag</a>
125 </div>
126 </div>
127 </div>
128 </div>
129
130 <a name="sec-method-summary"></a>
131 <div class="info-box">
132 <div class="info-box-title">Method Summary</span></div>
133 <div class="nav-bar">
134 <a href="#sec-description">Description</a> |
135 <a href="#sec-descendents">Descendants</a> |
136 <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
137
138 |
139 <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
140 </div>
141 <div class="info-box-body">
142 <div class="method-summary">
143 <div class="method-definition">
144 <img src="../../media/images/Constructor.png" alt=" "/>
145 <span class="method-result">DAVResource</span>
146 <a href="#__construct" title="details" class="method-name">__construct</a>
147 ([<span class="var-type">mixed</span>&nbsp;<span class="var-name">$parameters</span> = <span class="var-default">null</span>])
148 </div>
149 <div class="method-definition">
150 <img src="../../media/images/Method.png" alt=" "/>
151 <span class="method-result">void</span>
152 <a href="#bound_from" title="details" class="method-name">bound_from</a>
153 ()
154 </div>
155 <div class="method-definition">
156 <img src="../../media/images/Method.png" alt=" "/>
157 <span class="method-result">void</span>
158 <a href="#BuildACE" title="details" class="method-name">BuildACE</a>
159 (<span class="var-type"></span>&nbsp;<span class="var-name">&$xmldoc</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$privs</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$principal</span>)
160 </div>
161 <div class="method-definition">
162 <img src="../../media/images/Method.png" alt=" "/>
163 <span class="method-result">void</span>
164 <a href="#BuildPrivileges" title="details" class="method-name">BuildPrivileges</a>
165 ([<span class="var-type"></span>&nbsp;<span class="var-name">$privilege_names</span> = <span class="var-default">null</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">&$xmldoc</span> = <span class="var-default">null</span>])
166 </div>
167 <div class="method-definition">
168 <img src="../../media/images/Method.png" alt=" "/>
169 <span class="method-result">void</span>
170 <a href="#BuildSupportedMethods" title="details" class="method-name">BuildSupportedMethods</a>
171 ()
172 </div>
173 <div class="method-definition">
174 <img src="../../media/images/Method.png" alt=" "/>
175 <span class="method-result">void</span>
176 <a href="#BuildSupportedReports" title="details" class="method-name">BuildSupportedReports</a>
177 (<span class="var-type"></span>&nbsp;<span class="var-name">&$reply</span>)
178 </div>
179 <div class="method-definition">
180 <img src="../../media/images/Method.png" alt=" "/>
181 <span class="method-result">XMLTreeFragment</span>
182 <a href="#BuildTicketinfo" title="details" class="method-name">BuildTicketinfo</a>
183 (<span class="var-type"></span>&nbsp;<span class="var-name">&$reply</span>, <span class="var-type">&XMLDocument</span>&nbsp;<span class="var-name">$reply</span>)
184 </div>
185 <div class="method-definition">
186 <img src="../../media/images/Method.png" alt=" "/>
187 <span class="method-result">void</span>
188 <a href="#collection_id" title="details" class="method-name">collection_id</a>
189 ()
190 </div>
191 <div class="method-definition">
192 <img src="../../media/images/Method.png" alt=" "/>
193 <span class="method-result">void</span>
194 <a href="#ContainerExists" title="details" class="method-name">ContainerExists</a>
195 ()
196 </div>
197 <div class="method-definition">
198 <img src="../../media/images/Method.png" alt=" "/>
199 <span class="method-result">void</span>
200 <a href="#ContainerType" title="details" class="method-name">ContainerType</a>
201 ()
202 </div>
203 <div class="method-definition">
204 <img src="../../media/images/Method.png" alt=" "/>
205 <span class="method-result">void</span>
206 <a href="#DAV_AllProperties" title="details" class="method-name">DAV_AllProperties</a>
207 ()
208 </div>
209 <div class="method-definition">
210 <img src="../../media/images/Method.png" alt=" "/>
211 <span class="method-result">void</span>
212 <a href="#dav_name" title="details" class="method-name">dav_name</a>
213 ()
214 </div>
215 <div class="method-definition">
216 <img src="../../media/images/Method.png" alt=" "/>
217 <span class="method-result">void</span>
218 <a href="#Exists" title="details" class="method-name">Exists</a>
219 ()
220 </div>
221 <div class="method-definition">
222 <img src="../../media/images/Method.png" alt=" "/>
223 <span class="method-result">void</span>
224 <a href="#FetchCollection" title="details" class="method-name">FetchCollection</a>
225 ()
226 </div>
227 <div class="method-definition">
228 <img src="../../media/images/Method.png" alt=" "/>
229 <span class="method-result">void</span>
230 <a href="#FetchDeadProperties" title="details" class="method-name">FetchDeadProperties</a>
231 ()
232 </div>
233 <div class="method-definition">
234 <img src="../../media/images/Method.png" alt=" "/>
235 <span class="method-result">void</span>
236 <a href="#FetchParentContainer" title="details" class="method-name">FetchParentContainer</a>
237 ()
238 </div>
239 <div class="method-definition">
240 <img src="../../media/images/Method.png" alt=" "/>
241 <span class="method-result">void</span>
242 <a href="#FetchPrincipal" title="details" class="method-name">FetchPrincipal</a>
243 ()
244 </div>
245 <div class="method-definition">
246 <img src="../../media/images/Method.png" alt=" "/>
247 <span class="method-result">void</span>
248 <a href="#FetchPrivileges" title="details" class="method-name">FetchPrivileges</a>
249 ()
250 </div>
251 <div class="method-definition">
252 <img src="../../media/images/Method.png" alt=" "/>
253 <span class="method-result">void</span>
254 <a href="#FetchResource" title="details" class="method-name">FetchResource</a>
255 ()
256 </div>
257 <div class="method-definition">
258 <img src="../../media/images/Method.png" alt=" "/>
259 <span class="method-result">void</span>
260 <a href="#FetchSupportedMethods" title="details" class="method-name">FetchSupportedMethods</a>
261 ()
262 </div>
263 <div class="method-definition">
264 <img src="../../media/images/Method.png" alt=" "/>
265 <span class="method-result">void</span>
266 <a href="#FetchSupportedReports" title="details" class="method-name">FetchSupportedReports</a>
267 ()
268 </div>
269 <div class="method-definition">
270 <img src="../../media/images/Method.png" alt=" "/>
271 <span class="method-result">void</span>
272 <a href="#FetchTickets" title="details" class="method-name">FetchTickets</a>
273 ()
274 </div>
275 <div class="method-definition">
276 <img src="../../media/images/Method.png" alt=" "/>
277 <span class="method-result">void</span>
278 <a href="#FromPath" title="details" class="method-name">FromPath</a>
279 (<span class="var-type">object</span>&nbsp;<span class="var-name">$inpath</span>)
280 </div>
281 <div class="method-definition">
282 <img src="../../media/images/Method.png" alt=" "/>
283 <span class="method-result">void</span>
284 <a href="#FromRow" title="details" class="method-name">FromRow</a>
285 (<span class="var-type">object</span>&nbsp;<span class="var-name">$row</span>)
286 </div>
287 <div class="method-definition">
288 <img src="../../media/images/Method.png" alt=" "/>
289 <span class="method-result">void</span>
290 <a href="#GetACL" title="details" class="method-name">GetACL</a>
291 (<span class="var-type"></span>&nbsp;<span class="var-name">&$xmldoc</span>)
292 </div>
293 <div class="method-definition">
294 <img src="../../media/images/Method.png" alt=" "/>
295 <span class="method-result">void</span>
296 <a href="#GetParentContainer" title="details" class="method-name">GetParentContainer</a>
297 ()
298 </div>
299 <div class="method-definition">
300 <img src="../../media/images/Method.png" alt=" "/>
301 <span class="method-result">void</span>
302 <a href="#GetProperty" title="details" class="method-name">GetProperty</a>
303 (<span class="var-type"></span>&nbsp;<span class="var-name">$name</span>)
304 </div>
305 <div class="method-definition">
306 <img src="../../media/images/Method.png" alt=" "/>
307 <span class="method-result">string</span>
308 <a href="#GetPropStat" title="details" class="method-name">GetPropStat</a>
309 (<span class="var-type">array</span>&nbsp;<span class="var-name">$properties</span>, <span class="var-type"></span>&nbsp;<span class="var-name">&$reply</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$props_only</span> = <span class="var-default">false</span>])
310 </div>
311 <div class="method-definition">
312 <img src="../../media/images/Method.png" alt=" "/>
313 <span class="method-result">boolean</span>
314 <a href="#HavePrivilegeTo" title="details" class="method-name">HavePrivilegeTo</a>
315 (<span class="var-type">$do_what</span>&nbsp;<span class="var-name">$do_what</span>, [<span class="var-type">$any</span>&nbsp;<span class="var-name">$any</span> = <span class="var-default">null</span>])
316 </div>
317 <div class="method-definition">
318 <img src="../../media/images/Method.png" alt=" "/>
319 <span class="method-result">void</span>
320 <a href="#IsAddressbook" title="details" class="method-name">IsAddressbook</a>
321 ()
322 </div>
323 <div class="method-definition">
324 <img src="../../media/images/Method.png" alt=" "/>
325 <span class="method-result">void</span>
326 <a href="#IsBinding" title="details" class="method-name">IsBinding</a>
327 ()
328 </div>
329 <div class="method-definition">
330 <img src="../../media/images/Method.png" alt=" "/>
331 <span class="method-result">void</span>
332 <a href="#IsCalendar" title="details" class="method-name">IsCalendar</a>
333 ()
334 </div>
335 <div class="method-definition">
336 <img src="../../media/images/Method.png" alt=" "/>
337 <span class="method-result">void</span>
338 <a href="#IsCollection" title="details" class="method-name">IsCollection</a>
339 ()
340 </div>
341 <div class="method-definition">
342 <img src="../../media/images/Method.png" alt=" "/>
343 <span class="method-result">void</span>
344 <a href="#IsExternal" title="details" class="method-name">IsExternal</a>
345 ()
346 </div>
347 <div class="method-definition">
348 <img src="../../media/images/Method.png" alt=" "/>
349 <span class="method-result">void</span>
350 <a href="#IsLocked" title="details" class="method-name">IsLocked</a>
351 ([<span class="var-type"></span>&nbsp;<span class="var-name">$depth</span> = <span class="var-default">0</span>])
352 </div>
353 <div class="method-definition">
354 <img src="../../media/images/Method.png" alt=" "/>
355 <span class="method-result">void</span>
356 <a href="#IsPrincipal" title="details" class="method-name">IsPrincipal</a>
357 ()
358 </div>
359 <div class="method-definition">
360 <img src="../../media/images/Method.png" alt=" "/>
361 <span class="method-result">void</span>
362 <a href="#IsPublic" title="details" class="method-name">IsPublic</a>
363 ()
364 </div>
365 <div class="method-definition">
366 <img src="../../media/images/Method.png" alt=" "/>
367 <span class="method-result">void</span>
368 <a href="#IsSchedulingCollection" title="details" class="method-name">IsSchedulingCollection</a>
369 ([<span class="var-type">string</span>&nbsp;<span class="var-name">$type</span> = <span class="var-default">'any'</span>])
370 </div>
371 <div class="method-definition">
372 <img src="../../media/images/Method.png" alt=" "/>
373 <span class="method-result">void</span>
374 <a href="#NeedPrivilege" title="details" class="method-name">NeedPrivilege</a>
375 (<span class="var-type">string</span>&nbsp;<span class="var-name">$privilege</span>, [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$any</span> = <span class="var-default">null</span>])
376 </div>
377 <div class="method-definition">
378 <img src="../../media/images/Method.png" alt=" "/>
379 <span class="method-result">void</span>
380 <a href="#parent_path" title="details" class="method-name">parent_path</a>
381 ()
382 </div>
383 <div class="method-definition">
384 <img src="../../media/images/Method.png" alt=" "/>
385 <span class="method-result">void</span>
386 <a href="#principal_url" title="details" class="method-name">principal_url</a>
387 ()
388 </div>
389 <div class="method-definition">
390 <img src="../../media/images/Method.png" alt=" "/>
391 <span class="method-result">void</span>
392 <a href="#Privileges" title="details" class="method-name">Privileges</a>
393 ()
394 </div>
395 <div class="method-definition">
396 <img src="../../media/images/Method.png" alt=" "/>
397 <span class="method-result">string</span>
398 <a href="#RenderAsXML" title="details" class="method-name">RenderAsXML</a>
399 (<span class="var-type">array</span>&nbsp;<span class="var-name">$properties</span>, <span class="var-type"></span>&nbsp;<span class="var-name">&$reply</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$bound_parent_path</span> = <span class="var-default">null</span>], <span class="var-type">reference</span>&nbsp;<span class="var-name">$reply</span>)
400 </div>
401 <div class="method-definition">
402 <img src="../../media/images/Method.png" alt=" "/>
403 <span class="method-result">void</span>
404 <a href="#resource" title="details" class="method-name">resource</a>
405 ()
406 </div>
407 <div class="method-definition">
408 <img src="../../media/images/Method.png" alt=" "/>
409 <span class="method-result">void</span>
410 <a href="#ResourceProperty" title="details" class="method-name">ResourceProperty</a>
411 (<span class="var-type"></span>&nbsp;<span class="var-name">$tag</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$prop</span>, <span class="var-type"></span>&nbsp;<span class="var-name">&$reply</span>, <span class="var-type"></span>&nbsp;<span class="var-name">&$denied</span>)
412 </div>
413 <div class="method-definition">
414 <img src="../../media/images/Method.png" alt=" "/>
415 <span class="method-result">void</span>
416 <a href="#resource_id" title="details" class="method-name">resource_id</a>
417 ()
418 </div>
419 <div class="method-definition">
420 <img src="../../media/images/Method.png" alt=" "/>
421 <span class="method-result">void</span>
422 <a href="#set_bind_location" title="details" class="method-name">set_bind_location</a>
423 (<span class="var-type"></span>&nbsp;<span class="var-name">$new_dav_name</span>)
424 </div>
425 <div class="method-definition">
426 <img src="../../media/images/Method.png" alt=" "/>
427 <span class="method-result">void</span>
428 <a href="#unique_tag" title="details" class="method-name">unique_tag</a>
429 ()
430 </div>
431 <div class="method-definition">
432 <img src="../../media/images/Method.png" alt=" "/>
433 <span class="method-result">void</span>
434 <a href="#url" title="details" class="method-name">url</a>
435 ()
436 </div>
437 <div class="method-definition">
438 <img src="../../media/images/Method.png" alt=" "/>
439 <span class="method-result">void</span>
440 <a href="#user_no" title="details" class="method-name">user_no</a>
441 ()
442 </div>
443 </div>
444 </div>
445 </div>
446
447 <a name="sec-vars"></a>
448 <div class="info-box">
449 <div class="info-box-title">Variables</div>
450 <div class="nav-bar">
451 <a href="#sec-description">Description</a> |
452 <a href="#sec-descendents">Descendents</a> |
453 <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
454
455
456 |
457 <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
458
459 </div>
460 <div class="info-box-body">
461
462 <a name="var$bound_from" id="$bound_from"><!-- --></A>
463 <div class="evenrow">
464
465 <div class="var-header">
466 <img src="../../media/images/Variable.png" />
467 <span class="var-title">
468 <span class="var-type">The</span>
469 <span class="var-name">$bound_from</span>
470 (line <span class="line-number">63</span>)
471 </span>
472 </div>
473
474 <!-- ========== Info from phpDoc block ========= -->
475 <ul class="tags">
476 <li><span class="field">var:</span> canonical name which this resource exists at</li>
477 <li><span class="field">access:</span> protected</li>
478 </ul>
479
480
481
482
483
484 </div>
485 <a name="var$contenttype" id="$contenttype"><!-- --></A>
486 <div class="oddrow">
487
488 <div class="var-header">
489 <img src="../../media/images/Variable.png" />
490 <span class="var-title">
491 <span class="var-type">The</span>
492 <span class="var-name">$contenttype</span>
493 (line <span class="line-number">58</span>)
494 </span>
495 </div>
496
497 <!-- ========== Info from phpDoc block ========= -->
498 <ul class="tags">
499 <li><span class="field">var:</span> type of the content</li>
500 <li><span class="field">access:</span> protected</li>
501 </ul>
502
503
504
505
506
507 </div>
508 <a name="var$dav_name" id="$dav_name"><!-- --></A>
509 <div class="evenrow">
510
511 <div class="var-header">
512 <img src="../../media/images/Variable.png" />
513 <span class="var-title">
514 <span class="var-type">The</span>
515 <span class="var-name">$dav_name</span>
516 (line <span class="line-number">28</span>)
517 </span>
518 </div>
519
520 <!-- ========== Info from phpDoc block ========= -->
521 <ul class="tags">
522 <li><span class="field">var:</span> partial URL of the resource within our namespace, which this resource is being retrieved as</li>
523 <li><span class="field">access:</span> protected</li>
524 </ul>
525
526
527
528
529
530 </div>
531 <a name="var$exists" id="$exists"><!-- --></A>
532 <div class="oddrow">
533
534 <div class="var-header">
535 <img src="../../media/images/Variable.png" />
536 <span class="var-title">
537 <span class="var-type">Boolean:</span>
538 <span class="var-name">$exists</span>
539 (line <span class="line-number">33</span>)
540 </span>
541 </div>
542
543 <!-- ========== Info from phpDoc block ========= -->
544 <ul class="tags">
545 <li><span class="field">var:</span> does the resource actually exist yet?</li>
546 <li><span class="field">access:</span> protected</li>
547 </ul>
548
549
550
551
552
553 </div>
554 <a name="var$parent" id="$parent"><!-- --></A>
555 <div class="evenrow">
556
557 <div class="var-header">
558 <img src="../../media/images/Variable.png" />
559 <span class="var-title">
560 <span class="var-type">The</span>
561 <span class="var-name">$parent</span>
562 (line <span class="line-number">48</span>)
563 </span>
564 </div>
565
566 <!-- ========== Info from phpDoc block ========= -->
567 <ul class="tags">
568 <li><span class="field">var:</span> parent of the resource, which will always be a collection</li>
569 <li><span class="field">access:</span> protected</li>
570 </ul>
571
572
573
574
575
576 </div>
577 <a name="var$resource" id="$resource"><!-- --></A>
578 <div class="oddrow">
579
580 <div class="var-header">
581 <img src="../../media/images/Variable.png" />
582 <span class="var-title">
583 <span class="var-type">The</span>
584 <span class="var-name">$resource</span>
585 (line <span class="line-number">43</span>)
586 </span>
587 </div>
588
589 <!-- ========== Info from phpDoc block ========= -->
590 <ul class="tags">
591 <li><span class="field">var:</span> actual resource content, if it exists and is not a collection</li>
592 <li><span class="field">access:</span> protected</li>
593 </ul>
594
595
596
597
598
599 </div>
600 <a name="var$resourcetypes" id="$resourcetypes"><!-- --></A>
601 <div class="evenrow">
602
603 <div class="var-header">
604 <img src="../../media/images/Variable.png" />
605 <span class="var-title">
606 <span class="var-type">The</span>
607 <span class="var-name">$resourcetypes</span>
608 (line <span class="line-number">53</span>)
609 </span>
610 </div>
611
612 <!-- ========== Info from phpDoc block ========= -->
613 <ul class="tags">
614 <li><span class="field">var:</span> types of the resource, possibly multiple</li>
615 <li><span class="field">access:</span> protected</li>
616 </ul>
617
618
619
620
621
622 </div>
623 <a name="var$unique_tag" id="$unique_tag"><!-- --></A>
624 <div class="oddrow">
625
626 <div class="var-header">
627 <img src="../../media/images/Variable.png" />
628 <span class="var-title">
629 <span class="var-type">The</span>
630 <span class="var-name">$unique_tag</span>
631 (line <span class="line-number">38</span>)
632 </span>
633 </div>
634
635 <!-- ========== Info from phpDoc block ========= -->
636 <ul class="tags">
637 <li><span class="field">var:</span> unique etag associated with the current version of the resource</li>
638 <li><span class="field">access:</span> protected</li>
639 </ul>
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-descendents">Descendents</a> |
656 <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
657 <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
658
659 </div>
660 <div class="info-box-body">
661 <A NAME='method_detail'></A>
662 <a name="method__construct" id="__construct"><!-- --></a>
663 <div class="evenrow">
664
665 <div class="method-header">
666 <img src="../../media/images/Constructor.png" />
667 <span class="method-title">Constructor __construct</span> (line <span class="line-number">146</span>)
668 </div>
669
670 <!-- ========== Info from phpDoc block ========= -->
671 <p class="short-description">Constructor</p>
672
673 <div class="method-signature">
674 <span class="method-result">DAVResource</span>
675 <span class="method-name">
676 __construct
677 </span>
678 ([<span class="var-type">mixed</span>&nbsp;<span class="var-name">$parameters</span> = <span class="var-default">null</span>])
679 </div>
680
681 <ul class="parameters">
682 <li>
683 <span class="var-type">mixed</span>
684 <span class="var-name">$parameters</span><span class="var-description">: If null, an empty Resourced is created. If it is an object then it is expected to be a record that was read elsewhere.</span> </li>
685 </ul>
686
687
688 </div>
689 <a name="methodbound_from" id="bound_from"><!-- --></a>
690 <div class="oddrow">
691
692 <div class="method-header">
693 <img src="../../media/images/Method.png" />
694 <span class="method-title">bound_from</span> (line <span class="line-number">1138</span>)
695 </div>
696
697 <!-- ========== Info from phpDoc block ========= -->
698 <p class="short-description">Returns the dav_name of the resource we are bound to, within our internal namespace</p>
699
700 <div class="method-signature">
701 <span class="method-result">void</span>
702 <span class="method-name">
703 bound_from
704 </span>
705 ()
706 </div>
707
708
709
710 </div>
711 <a name="methodBuildACE" id="BuildACE"><!-- --></a>
712 <div class="evenrow">
713
714 <div class="method-header">
715 <img src="../../media/images/Method.png" />
716 <span class="method-title">BuildACE</span> (line <span class="line-number">1284</span>)
717 </div>
718
719 <!-- ========== Info from phpDoc block ========= -->
720 <p class="short-description">BuildACE - construct an XMLElement subtree for a DAV::ace</p>
721
722 <div class="method-signature">
723 <span class="method-result">void</span>
724 <span class="method-name">
725 BuildACE
726 </span>
727 (<span class="var-type"></span>&nbsp;<span class="var-name">&$xmldoc</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$privs</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$principal</span>)
728 </div>
729
730 <ul class="parameters">
731 <li>
732 <span class="var-type"></span>
733 <span class="var-name">&$xmldoc</span> </li>
734 <li>
735 <span class="var-type"></span>
736 <span class="var-name">$privs</span> </li>
737 <li>
738 <span class="var-type"></span>
739 <span class="var-name">$principal</span> </li>
740 </ul>
741
742
743 </div>
744 <a name="methodBuildPrivileges" id="BuildPrivileges"><!-- --></a>
745 <div class="oddrow">
746
747 <div class="method-header">
748 <img src="../../media/images/Method.png" />
749 <span class="method-title">BuildPrivileges</span> (line <span class="line-number">762</span>)
750 </div>
751
752 <!-- ========== Info from phpDoc block ========= -->
753 <p class="short-description">Returns the array of privilege names converted into XMLElements</p>
754
755 <div class="method-signature">
756 <span class="method-result">void</span>
757 <span class="method-name">
758 BuildPrivileges
759 </span>
760 ([<span class="var-type"></span>&nbsp;<span class="var-name">$privilege_names</span> = <span class="var-default">null</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">&$xmldoc</span> = <span class="var-default">null</span>])
761 </div>
762
763 <ul class="parameters">
764 <li>
765 <span class="var-type"></span>
766 <span class="var-name">$privilege_names</span> </li>
767 <li>
768 <span class="var-type"></span>
769 <span class="var-name">&$xmldoc</span> </li>
770 </ul>
771
772
773 </div>
774 <a name="methodBuildSupportedMethods" id="BuildSupportedMethods"><!-- --></a>
775 <div class="evenrow">
776
777 <div class="method-header">
778 <img src="../../media/images/Method.png" />
779 <span class="method-title">BuildSupportedMethods</span> (line <span class="line-number">851</span>)
780 </div>
781
782 <!-- ========== Info from phpDoc block ========= -->
783 <p class="short-description">Returns the array of supported methods converted into XMLElements</p>
784
785 <div class="method-signature">
786 <span class="method-result">void</span>
787 <span class="method-name">
788 BuildSupportedMethods
789 </span>
790 ()
791 </div>
792
793
794
795 </div>
796 <a name="methodBuildSupportedReports" id="BuildSupportedReports"><!-- --></a>
797 <div class="oddrow">
798
799 <div class="method-header">
800 <img src="../../media/images/Method.png" />
801 <span class="method-title">BuildSupportedReports</span> (line <span class="line-number">903</span>)
802 </div>
803
804 <!-- ========== Info from phpDoc block ========= -->
805 <p class="short-description">Returns the array of supported reports converted into XMLElements</p>
806
807 <div class="method-signature">
808 <span class="method-result">void</span>
809 <span class="method-name">
810 BuildSupportedReports
811 </span>
812 (<span class="var-type"></span>&nbsp;<span class="var-name">&$reply</span>)
813 </div>
814
815 <ul class="parameters">
816 <li>
817 <span class="var-type"></span>
818 <span class="var-name">&$reply</span> </li>
819 </ul>
820
821
822 </div>
823 <a name="methodBuildTicketinfo" id="BuildTicketinfo"><!-- --></a>
824 <div class="evenrow">
825
826 <div class="method-header">
827 <img src="../../media/images/Method.png" />
828 <span class="method-title">BuildTicketinfo</span> (line <span class="line-number">964</span>)
829 </div>
830
831 <!-- ========== Info from phpDoc block ========= -->
832 <p class="short-description">Returns the array of tickets converted into XMLElements</p>
833 <p class="description"><p>If the current user does not have DAV::read-acl privilege on this resource they will only get to see the tickets where they are the owner, or which they supplied along with the request.</p></p>
834 <ul class="tags">
835 <li><span class="field">return:</span> A fragment of an XMLDocument to go in the reply</li>
836 </ul>
837
838 <div class="method-signature">
839 <span class="method-result">XMLTreeFragment</span>
840 <span class="method-name">
841 BuildTicketinfo
842 </span>
843 (<span class="var-type"></span>&nbsp;<span class="var-name">&$reply</span>, <span class="var-type">&XMLDocument</span>&nbsp;<span class="var-name">$reply</span>)
844 </div>
845
846 <ul class="parameters">
847 <li>
848 <span class="var-type">&XMLDocument</span>
849 <span class="var-name">$reply</span><span class="var-description">: A reference to the XMLDocument used to construct the reply</span> </li>
850 <li>
851 <span class="var-type"></span>
852 <span class="var-name">&$reply</span> </li>
853 </ul>
854
855
856 </div>
857 <a name="methodcollection_id" id="collection_id"><!-- --></a>
858 <div class="oddrow">
859
860 <div class="method-header">
861 <img src="../../media/images/Method.png" />
862 <span class="method-title">collection_id</span> (line <span class="line-number">1193</span>)
863 </div>
864
865 <!-- ========== Info from phpDoc block ========= -->
866 <p class="short-description">Returns the internal collection_id for this collection, or the collection containing this resource</p>
867
868 <div class="method-signature">
869 <span class="method-result">void</span>
870 <span class="method-name">
871 collection_id
872 </span>
873 ()
874 </div>
875
876
877
878 </div>
879 <a name="methodContainerExists" id="ContainerExists"><!-- --></a>
880 <div class="evenrow">
881
882 <div class="method-header">
883 <img src="../../media/images/Method.png" />
884 <span class="method-title">ContainerExists</span> (line <span class="line-number">1106</span>)
885 </div>
886
887 <!-- ========== Info from phpDoc block ========= -->
888 <p class="short-description">Checks whether the container for this resource actually exists, in the virtual sense, within the hierarchy</p>
889
890 <div class="method-signature">
891 <span class="method-result">void</span>
892 <span class="method-name">
893 ContainerExists
894 </span>
895 ()
896 </div>
897
898
899
900 </div>
901 <a name="methodContainerType" id="ContainerType"><!-- --></a>
902 <div class="oddrow">
903
904 <div class="method-header">
905 <img src="../../media/images/Method.png" />
906 <span class="method-title">ContainerType</span> (line <span class="line-number">1250</span>)
907 </div>
908
909 <!-- ========== Info from phpDoc block ========= -->
910 <p class="short-description">Return the type of whatever contains this resource, or would if it existed.</p>
911
912 <div class="method-signature">
913 <span class="method-result">void</span>
914 <span class="method-name">
915 ContainerType
916 </span>
917 ()
918 </div>
919
920
921
922 </div>
923 <a name="methodDAV_AllProperties" id="DAV_AllProperties"><!-- --></a>
924 <div class="evenrow">
925
926 <div class="method-header">
927 <img src="../../media/images/Method.png" />
928 <span class="method-title">DAV_AllProperties</span> (line <span class="line-number">1413</span>)
929 </div>
930
931 <!-- ========== Info from phpDoc block ========= -->
932 <p class="short-description">Return an array which is an expansion of the DAV::allprop</p>
933
934 <div class="method-signature">
935 <span class="method-result">void</span>
936 <span class="method-name">
937 DAV_AllProperties
938 </span>
939 ()
940 </div>
941
942
943
944 </div>
945 <a name="methoddav_name" id="dav_name"><!-- --></a>
946 <div class="oddrow">
947
948 <div class="method-header">
949 <img src="../../media/images/Method.png" />
950 <span class="method-title">dav_name</span> (line <span class="line-number">1129</span>)
951 </div>
952
953 <!-- ========== Info from phpDoc block ========= -->
954 <p class="short-description">Returns the dav_name of the resource in our internal namespace</p>
955
956 <div class="method-signature">
957 <span class="method-result">void</span>
958 <span class="method-name">
959 dav_name
960 </span>
961 ()
962 </div>
963
964
965
966 </div>
967 <a name="methodExists" id="Exists"><!-- --></a>
968 <div class="evenrow">
969
970 <div class="method-header">
971 <img src="../../media/images/Method.png" />
972 <span class="method-title">Exists</span> (line <span class="line-number">1088</span>)
973 </div>
974
975 <!-- ========== Info from phpDoc block ========= -->
976 <p class="short-description">Checks whether this resource actually exists, in the virtual sense, within the hierarchy</p>
977
978 <div class="method-signature">
979 <span class="method-result">void</span>
980 <span class="method-name">
981 Exists
982 </span>
983 ()
984 </div>
985
986
987
988 </div>
989 <a name="methodFetchCollection" id="FetchCollection"><!-- --></a>
990 <div class="oddrow">
991
992 <div class="method-header">
993 <img src="../../media/images/Method.png" />
994 <span class="method-title">FetchCollection</span> (line <span class="line-number">470</span>)
995 </div>
996
997 <!-- ========== Info from phpDoc block ========= -->
998 <p class="short-description">Find the collection associated with this resource.</p>
999 <ul class="tags">
1000 <li><span class="field">access:</span> protected</li>
1001 </ul>
1002
1003 <div class="method-signature">
1004 <span class="method-result">void</span>
1005 <span class="method-name">
1006 FetchCollection
1007 </span>
1008 ()
1009 </div>
1010
1011
1012
1013 </div>
1014 <a name="methodFetchDeadProperties" id="FetchDeadProperties"><!-- --></a>
1015 <div class="evenrow">
1016
1017 <div class="method-header">
1018 <img src="../../media/images/Method.png" />
1019 <span class="method-title">FetchDeadProperties</span> (line <span class="line-number">609</span>)
1020 </div>
1021
1022 <!-- ========== Info from phpDoc block ========= -->
1023 <p class="short-description">Fetch any dead properties for this URL</p>
1024 <ul class="tags">
1025 <li><span class="field">access:</span> protected</li>
1026 </ul>
1027
1028 <div class="method-signature">
1029 <span class="method-result">void</span>
1030 <span class="method-name">
1031 FetchDeadProperties
1032 </span>
1033 ()
1034 </div>
1035
1036
1037
1038 </div>
1039 <a name="methodFetchParentContainer" id="FetchParentContainer"><!-- --></a>
1040 <div class="oddrow">
1041
1042 <div class="method-header">
1043 <img src="../../media/images/Method.png" />
1044 <span class="method-title">FetchParentContainer</span> (line <span class="line-number">704</span>)
1045 </div>
1046
1047 <!-- ========== Info from phpDoc block ========= -->
1048 <p class="short-description">Fetch the parent to this resource.</p>
1049
1050 <div class="method-signature">
1051 <span class="method-result">void</span>
1052 <span class="method-name">
1053 FetchParentContainer
1054 </span>
1055 ()
1056 </div>
1057
1058
1059
1060 </div>
1061 <a name="methodFetchPrincipal" id="FetchPrincipal"><!-- --></a>
1062 <div class="evenrow">
1063
1064 <div class="method-header">
1065 <img src="../../media/images/Method.png" />
1066 <span class="method-title">FetchPrincipal</span> (line <span class="line-number">557</span>)
1067 </div>
1068
1069 <!-- ========== Info from phpDoc block ========= -->
1070 <p class="short-description">Find the principal associated with this resource.</p>
1071 <ul class="tags">
1072 <li><span class="field">access:</span> protected</li>
1073 </ul>
1074
1075 <div class="method-signature">
1076 <span class="method-result">void</span>
1077 <span class="method-name">
1078 FetchPrincipal
1079 </span>
1080 ()
1081 </div>
1082
1083
1084
1085 </div>
1086 <a name="methodFetchPrivileges" id="FetchPrivileges"><!-- --></a>
1087 <div class="oddrow">
1088
1089 <div class="method-header">
1090 <img src="../../media/images/Method.png" />
1091 <span class="method-title">FetchPrivileges</span> (line <span class="line-number">627</span>)
1092 </div>
1093
1094 <!-- ========== Info from phpDoc block ========= -->
1095 <p class="short-description">Build permissions for this URL</p>
1096 <ul class="tags">
1097 <li><span class="field">access:</span> protected</li>
1098 </ul>
1099
1100 <div class="method-signature">
1101 <span class="method-result">void</span>
1102 <span class="method-name">
1103 FetchPrivileges
1104 </span>
1105 ()
1106 </div>
1107
1108
1109
1110 </div>
1111 <a name="methodFetchResource" id="FetchResource"><!-- --></a>
1112 <div class="evenrow">
1113
1114 <div class="method-header">
1115 <img src="../../media/images/Method.png" />
1116 <span class="method-title">FetchResource</span> (line <span class="line-number">580</span>)
1117 </div>
1118
1119 <!-- ========== Info from phpDoc block ========= -->
1120 <p class="short-description">Retrieve the actual resource.</p>
1121 <ul class="tags">
1122 <li><span class="field">access:</span> protected</li>
1123 </ul>
1124
1125 <div class="method-signature">
1126 <span class="method-result">void</span>
1127 <span class="method-name">
1128 FetchResource
1129 </span>
1130 ()
1131 </div>
1132
1133
1134
1135 </div>
1136 <a name="methodFetchSupportedMethods" id="FetchSupportedMethods"><!-- --></a>
1137 <div class="oddrow">
1138
1139 <div class="method-header">
1140 <img src="../../media/images/Method.png" />
1141 <span class="method-title">FetchSupportedMethods</span> (line <span class="line-number">774</span>)
1142 </div>
1143
1144 <!-- ========== Info from phpDoc block ========= -->
1145 <p class="short-description">Returns the array of supported methods</p>
1146
1147 <div class="method-signature">
1148 <span class="method-result">void</span>
1149 <span class="method-name">
1150 FetchSupportedMethods
1151 </span>
1152 ()
1153 </div>
1154
1155
1156
1157 </div>
1158 <a name="methodFetchSupportedReports" id="FetchSupportedReports"><!-- --></a>
1159 <div class="evenrow">
1160
1161 <div class="method-header">
1162 <img src="../../media/images/Method.png" />
1163 <span class="method-title">FetchSupportedReports</span> (line <span class="line-number">865</span>)
1164 </div>
1165
1166 <!-- ========== Info from phpDoc block ========= -->
1167 <p class="short-description">Returns the array of supported reports</p>
1168
1169 <div class="method-signature">
1170 <span class="method-result">void</span>
1171 <span class="method-name">
1172 FetchSupportedReports
1173 </span>
1174 ()
1175 </div>
1176
1177
1178
1179 </div>
1180 <a name="methodFetchTickets" id="FetchTickets"><!-- --></a>
1181 <div class="oddrow">
1182
1183 <div class="method-header">
1184 <img src="../../media/images/Method.png" />
1185 <span class="method-title">FetchTickets</span> (line <span class="line-number">919</span>)
1186 </div>
1187
1188 <!-- ========== Info from phpDoc block ========= -->
1189 <p class="short-description">Fetches an array of the access_ticket records applying to this path</p>
1190
1191 <div class="method-signature">
1192 <span class="method-result">void</span>
1193 <span class="method-name">
1194 FetchTickets
1195 </span>
1196 ()
1197 </div>
1198
1199
1200
1201 </div>
1202 <a name="methodFromPath" id="FromPath"><!-- --></a>
1203 <div class="evenrow">
1204
1205 <div class="method-header">
1206 <img src="../../media/images/Method.png" />
1207 <span class="method-title">FromPath</span> (line <span class="line-number">301</span>)
1208 </div>
1209
1210 <!-- ========== Info from phpDoc block ========= -->
1211 <p class="short-description">Initialise from a path</p>
1212
1213 <div class="method-signature">
1214 <span class="method-result">void</span>
1215 <span class="method-name">
1216 FromPath
1217 </span>
1218 (<span class="var-type">object</span>&nbsp;<span class="var-name">$inpath</span>)
1219 </div>
1220
1221 <ul class="parameters">
1222 <li>
1223 <span class="var-type">object</span>
1224 <span class="var-name">$inpath</span><span class="var-description">: The path to populate the resource data from</span> </li>
1225 </ul>
1226
1227
1228 </div>
1229 <a name="methodFromRow" id="FromRow"><!-- --></a>
1230 <div class="oddrow">
1231
1232 <div class="method-header">
1233 <img src="../../media/images/Method.png" />
1234 <span class="method-title">FromRow</span> (line <span class="line-number">187</span>)
1235 </div>
1236
1237 <!-- ========== Info from phpDoc block ========= -->
1238 <p class="short-description">Initialise from a database row</p>
1239
1240 <div class="method-signature">
1241 <span class="method-result">void</span>
1242 <span class="method-name">
1243 FromRow
1244 </span>
1245 (<span class="var-type">object</span>&nbsp;<span class="var-name">$row</span>)
1246 </div>
1247
1248 <ul class="parameters">
1249 <li>
1250 <span class="var-type">object</span>
1251 <span class="var-name">$row</span><span class="var-description">: The row from the DB.</span> </li>
1252 </ul>
1253
1254
1255 </div>
1256 <a name="methodGetACL" id="GetACL"><!-- --></a>
1257 <div class="evenrow">
1258
1259 <div class="method-header">
1260 <img src="../../media/images/Method.png" />
1261 <span class="method-title">GetACL</span> (line <span class="line-number">1305</span>)
1262 </div>
1263
1264 <!-- ========== Info from phpDoc block ========= -->
1265 <p class="short-description">Return ACL settings</p>
1266
1267 <div class="method-signature">
1268 <span class="method-result">void</span>
1269 <span class="method-name">
1270 GetACL
1271 </span>
1272 (<span class="var-type"></span>&nbsp;<span class="var-name">&$xmldoc</span>)
1273 </div>
1274
1275 <ul class="parameters">
1276 <li>
1277 <span class="var-type"></span>
1278 <span class="var-name">&$xmldoc</span> </li>
1279 </ul>
1280
1281
1282 </div>
1283 <a name="methodGetParentContainer" id="GetParentContainer"><!-- --></a>
1284 <div class="oddrow">
1285
1286 <div class="method-header">
1287 <img src="../../media/images/Method.png" />
1288 <span class="method-title">GetParentContainer</span> (line <span class="line-number">685</span>)
1289 </div>
1290
1291 <!-- ========== Info from phpDoc block ========= -->
1292 <p class="short-description">Get a DAVResource which is the parent to this resource.</p>
1293
1294 <div class="method-signature">
1295 <span class="method-result">void</span>
1296 <span class="method-name">
1297 GetParentContainer
1298 </span>
1299 ()
1300 </div>
1301
1302
1303
1304 </div>
1305 <a name="methodGetProperty" id="GetProperty"><!-- --></a>
1306 <div class="evenrow">
1307
1308 <div class="method-header">
1309 <img src="../../media/images/Method.png" />
1310 <span class="method-title">GetProperty</span> (line <span class="line-number">1337</span>)
1311 </div>
1312
1313 <!-- ========== Info from phpDoc block ========= -->
1314 <p class="short-description">Return general server-related properties, in plain form</p>
1315
1316 <div class="method-signature">
1317 <span class="method-result">void</span>
1318 <span class="method-name">
1319 GetProperty
1320 </span>
1321 (<span class="var-type"></span>&nbsp;<span class="var-name">$name</span>)
1322 </div>
1323
1324 <ul class="parameters">
1325 <li>
1326 <span class="var-type"></span>
1327 <span class="var-name">$name</span> </li>
1328 </ul>
1329
1330
1331 </div>
1332 <a name="methodGetPropStat" id="GetPropStat"><!-- --></a>
1333 <div class="oddrow">
1334
1335 <div class="method-header">
1336 <img src="../../media/images/Method.png" />
1337 <span class="method-title">GetPropStat</span> (line <span class="line-number">1712</span>)
1338 </div>
1339
1340 <!-- ========== Info from phpDoc block ========= -->
1341 <p class="short-description">Construct XML propstat fragment for this resource</p>
1342 <ul class="tags">
1343 <li><span class="field">return:</span> An XML fragment with the requested properties for this resource</li>
1344 </ul>
1345
1346 <div class="method-signature">
1347 <span class="method-result">string</span>
1348 <span class="method-name">
1349 GetPropStat
1350 </span>
1351 (<span class="var-type">array</span>&nbsp;<span class="var-name">$properties</span>, <span class="var-type"></span>&nbsp;<span class="var-name">&$reply</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$props_only</span> = <span class="var-default">false</span>])
1352 </div>
1353
1354 <ul class="parameters">
1355 <li>
1356 <span class="var-type">array</span>
1357 <span class="var-name">$properties</span><span class="var-description">: of string $properties The requested properties for this resource</span> </li>
1358 <li>
1359 <span class="var-type"></span>
1360 <span class="var-name">&$reply</span> </li>
1361 <li>
1362 <span class="var-type"></span>
1363 <span class="var-name">$props_only</span> </li>
1364 </ul>
1365
1366
1367 </div>
1368 <a name="methodHavePrivilegeTo" id="HavePrivilegeTo"><!-- --></a>
1369 <div class="evenrow">
1370
1371 <div class="method-header">
1372 <img src="../../media/images/Method.png" />
1373 <span class="method-title">HavePrivilegeTo</span> (line <span class="line-number">725</span>)
1374 </div>
1375
1376 <!-- ========== Info from phpDoc block ========= -->
1377 <p class="short-description">Is the user has the privileges to do what is requested.</p>
1378 <ul class="tags">
1379 <li><span class="field">return:</span> Whether they do have one of those privileges against this resource.</li>
1380 </ul>
1381
1382 <div class="method-signature">
1383 <span class="method-result">boolean</span>
1384 <span class="method-name">
1385 HavePrivilegeTo
1386 </span>
1387 (<span class="var-type">$do_what</span>&nbsp;<span class="var-name">$do_what</span>, [<span class="var-type">$any</span>&nbsp;<span class="var-name">$any</span> = <span class="var-default">null</span>])
1388 </div>
1389
1390 <ul class="parameters">
1391 <li>
1392 <span class="var-type">$do_what</span>
1393 <span class="var-name">$do_what</span><span class="var-description">: mixed The request privilege name, or array of privilege names, to be checked.</span> </li>
1394 <li>
1395 <span class="var-type">$any</span>
1396 <span class="var-name">$any</span><span class="var-description">: boolean Whether we accept any of the privileges. The default is true, unless the requested privilege is 'all', when it is false.</span> </li>
1397 </ul>
1398
1399
1400 </div>
1401 <a name="methodIsAddressbook" id="IsAddressbook"><!-- --></a>
1402 <div class="oddrow">
1403
1404 <div class="method-header">
1405 <img src="../../media/images/Method.png" />
1406 <span class="method-title">IsAddressbook</span> (line <span class="line-number">1064</span>)
1407 </div>
1408
1409 <!-- ========== Info from phpDoc block ========= -->
1410 <p class="short-description">Checks whether this resource is an addressbook</p>
1411
1412 <div class="method-signature">
1413 <span class="method-result">void</span>
1414 <span class="method-name">
1415 IsAddressbook
1416 </span>
1417 ()
1418 </div>
1419
1420
1421
1422 </div>
1423 <a name="methodIsBinding" id="IsBinding"><!-- --></a>
1424 <div class="evenrow">
1425
1426 <div class="method-header">
1427 <img src="../../media/images/Method.png" />
1428 <span class="method-title">IsBinding</span> (line <span class="line-number">1072</span>)
1429 </div>
1430
1431 <!-- ========== Info from phpDoc block ========= -->
1432 <p class="short-description">Checks whether this resource is a bind to another resource</p>
1433
1434 <div class="method-signature">
1435 <span class="method-result">void</span>
1436 <span class="method-name">
1437 IsBinding
1438 </span>
1439 ()
1440 </div>
1441
1442
1443
1444 </div>
1445 <a name="methodIsCalendar" id="IsCalendar"><!-- --></a>
1446 <div class="oddrow">
1447
1448 <div class="method-header">
1449 <img src="../../media/images/Method.png" />
1450 <span class="method-title">IsCalendar</span> (line <span class="line-number">1044</span>)
1451 </div>
1452
1453 <!-- ========== Info from phpDoc block ========= -->
1454 <p class="short-description">Checks whether this resource is a calendar</p>
1455
1456 <div class="method-signature">
1457 <span class="method-result">void</span>
1458 <span class="method-name">
1459 IsCalendar
1460 </span>
1461 ()
1462 </div>
1463
1464
1465
1466 </div>
1467 <a name="methodIsCollection" id="IsCollection"><!-- --></a>
1468 <div class="evenrow">
1469
1470 <div class="method-header">
1471 <img src="../../media/images/Method.png" />
1472 <span class="method-title">IsCollection</span> (line <span class="line-number">1028</span>)
1473 </div>
1474
1475 <!-- ========== Info from phpDoc block ========= -->
1476 <p class="short-description">Checks whether this resource is a collection</p>
1477
1478 <div class="method-signature">
1479 <span class="method-result">void</span>
1480 <span class="method-name">
1481 IsCollection
1482 </span>
1483 ()
1484 </div>
1485
1486
1487
1488 </div>
1489 <a name="methodIsExternal" id="IsExternal"><!-- --></a>
1490 <div class="oddrow">
1491
1492 <div class="method-header">
1493 <img src="../../media/images/Method.png" />
1494 <span class="method-title">IsExternal</span> (line <span class="line-number">1080</span>)
1495 </div>
1496
1497 <!-- ========== Info from phpDoc block ========= -->
1498 <p class="short-description">Checks whether this resource is a bind to an external resource</p>
1499
1500 <div class="method-signature">
1501 <span class="method-result">void</span>
1502 <span class="method-name">
1503 IsExternal
1504 </span>
1505 ()
1506 </div>
1507
1508
1509
1510 </div>
1511 <a name="methodIsLocked" id="IsLocked"><!-- --></a>
1512 <div class="evenrow">
1513
1514 <div class="method-header">
1515 <img src="../../media/images/Method.png" />
1516 <span class="method-title">IsLocked</span> (line <span class="line-number">996</span>)
1517 </div>
1518
1519 <!-- ========== Info from phpDoc block ========= -->
1520 <p class="short-description">Checks whether the resource is locked, returning any lock token, or false</p>
1521 <ul class="tags">
1522 <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>
1523 </ul>
1524
1525 <div class="method-signature">
1526 <span class="method-result">void</span>
1527 <span class="method-name">
1528 IsLocked
1529 </span>
1530 ([<span class="var-type"></span>&nbsp;<span class="var-name">$depth</span> = <span class="var-default">0</span>])
1531 </div>
1532
1533 <ul class="parameters">
1534 <li>
1535 <span class="var-type"></span>
1536 <span class="var-name">$depth</span> </li>
1537 </ul>
1538
1539
1540 </div>
1541 <a name="methodIsPrincipal" id="IsPrincipal"><!-- --></a>
1542 <div class="oddrow">
1543
1544 <div class="method-header">
1545 <img src="../../media/images/Method.png" />
1546 <span class="method-title">IsPrincipal</span> (line <span class="line-number">1036</span>)
1547 </div>
1548
1549 <!-- ========== Info from phpDoc block ========= -->
1550 <p class="short-description">Checks whether this resource is a principal</p>
1551
1552 <div class="method-signature">
1553 <span class="method-result">void</span>
1554 <span class="method-name">
1555 IsPrincipal
1556 </span>
1557 ()
1558 </div>
1559
1560
1561
1562 </div>
1563 <a name="methodIsPublic" id="IsPublic"><!-- --></a>
1564 <div class="evenrow">
1565
1566 <div class="method-header">
1567 <img src="../../media/images/Method.png" />
1568 <span class="method-title">IsPublic</span> (line <span class="line-number">1242</span>)
1569 </div>
1570
1571 <!-- ========== Info from phpDoc block ========= -->
1572 <p class="short-description">Checks whether the target collection is publicly_readable</p>
1573
1574 <div class="method-signature">
1575 <span class="method-result">void</span>
1576 <span class="method-name">
1577 IsPublic
1578 </span>
1579 ()
1580 </div>
1581
1582
1583
1584 </div>
1585 <a name="methodIsSchedulingCollection" id="IsSchedulingCollection"><!-- --></a>
1586 <div class="oddrow">
1587
1588 <div class="method-header">
1589 <img src="../../media/images/Method.png" />
1590 <span class="method-title">IsSchedulingCollection</span> (line <span class="line-number">1053</span>)
1591 </div>
1592
1593 <!-- ========== Info from phpDoc block ========= -->
1594 <p class="short-description">Checks whether this resource is a calendar</p>
1595
1596 <div class="method-signature">
1597 <span class="method-result">void</span>
1598 <span class="method-name">
1599 IsSchedulingCollection
1600 </span>
1601 ([<span class="var-type">string</span>&nbsp;<span class="var-name">$type</span> = <span class="var-default">'any'</span>])
1602 </div>
1603
1604 <ul class="parameters">
1605 <li>
1606 <span class="var-type">string</span>
1607 <span class="var-name">$type</span><span class="var-description">: The type of scheduling collection, 'read', 'write' or 'any'</span> </li>
1608 </ul>
1609
1610
1611 </div>
1612 <a name="methodNeedPrivilege" id="NeedPrivilege"><!-- --></a>
1613 <div class="evenrow">
1614
1615 <div class="method-header">
1616 <img src="../../media/images/Method.png" />
1617 <span class="method-title">NeedPrivilege</span> (line <span class="line-number">747</span>)
1618 </div>
1619
1620 <!-- ========== Info from phpDoc block ========= -->
1621 <p class="short-description">Check if we have the needed privilege or send an error response. If the user does not have the privileges then the call will not return, and an XML error document will be output.</p>
1622
1623 <div class="method-signature">
1624 <span class="method-result">void</span>
1625 <span class="method-name">
1626 NeedPrivilege
1627 </span>
1628 (<span class="var-type">string</span>&nbsp;<span class="var-name">$privilege</span>, [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$any</span> = <span class="var-default">null</span>])
1629 </div>
1630
1631 <ul class="parameters">
1632 <li>
1633 <span class="var-type">string</span>
1634 <span class="var-name">$privilege</span><span class="var-description">: The name of the needed privilege.</span> </li>
1635 <li>
1636 <span class="var-type">boolean</span>
1637 <span class="var-name">$any</span><span class="var-description">: Whether we accept any of the privileges. The default is true, unless the requested privilege is 'all', when it is false.</span> </li>
1638 </ul>
1639
1640
1641 </div>
1642 <a name="methodparent_path" id="parent_path"><!-- --></a>
1643 <div class="oddrow">
1644
1645 <div class="method-header">
1646 <img src="../../media/images/Method.png" />
1647 <span class="method-title">parent_path</span> (line <span class="line-number">1159</span>)
1648 </div>
1649
1650 <!-- ========== Info from phpDoc block ========= -->
1651 <p class="short-description">Returns the dav_name of the resource in our internal namespace</p>
1652
1653 <div class="method-signature">
1654 <span class="method-result">void</span>
1655 <span class="method-name">
1656 parent_path
1657 </span>
1658 ()
1659 </div>
1660
1661
1662
1663 </div>
1664 <a name="methodprincipal_url" id="principal_url"><!-- --></a>
1665 <div class="evenrow">
1666
1667 <div class="method-header">
1668 <img src="../../media/images/Method.png" />
1669 <span class="method-title">principal_url</span> (line <span class="line-number">1175</span>)
1670 </div>
1671
1672 <!-- ========== Info from phpDoc block ========= -->
1673 <p class="short-description">Returns the principal-URL for this resource</p>
1674
1675 <div class="method-signature">
1676 <span class="method-result">void</span>
1677 <span class="method-name">
1678 principal_url
1679 </span>
1680 ()
1681 </div>
1682
1683
1684
1685 </div>
1686 <a name="methodPrivileges" id="Privileges"><!-- --></a>
1687 <div class="oddrow">
1688
1689 <div class="method-header">
1690 <img src="../../media/images/Method.png" />
1691 <span class="method-title">Privileges</span> (line <span class="line-number">713</span>)
1692 </div>
1693
1694 <!-- ========== Info from phpDoc block ========= -->
1695 <p class="short-description">Return the privileges bits for the current session user to this resource</p>
1696
1697 <div class="method-signature">
1698 <span class="method-result">void</span>
1699 <span class="method-name">
1700 Privileges
1701 </span>
1702 ()
1703 </div>
1704
1705
1706
1707 </div>
1708 <a name="methodRenderAsXML" id="RenderAsXML"><!-- --></a>
1709 <div class="evenrow">
1710
1711 <div class="method-header">
1712 <img src="../../media/images/Method.png" />
1713 <span class="method-title">RenderAsXML</span> (line <span class="line-number">1770</span>)
1714 </div>
1715
1716 <!-- ========== Info from phpDoc block ========= -->
1717 <p class="short-description">Render XML for this resource</p>
1718 <ul class="tags">
1719 <li><span class="field">return:</span> An XML fragment with the requested properties for this principal</li>
1720 </ul>
1721
1722 <div class="method-signature">
1723 <span class="method-result">string</span>
1724 <span class="method-name">
1725 RenderAsXML
1726 </span>
1727 (<span class="var-type">array</span>&nbsp;<span class="var-name">$properties</span>, <span class="var-type"></span>&nbsp;<span class="var-name">&$reply</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$bound_parent_path</span> = <span class="var-default">null</span>], <span class="var-type">reference</span>&nbsp;<span class="var-name">$reply</span>)
1728 </div>
1729
1730 <ul class="parameters">
1731 <li>
1732 <span class="var-type">array</span>
1733 <span class="var-name">$properties</span><span class="var-description">: The requested properties for this principal</span> </li>
1734 <li>
1735 <span class="var-type">reference</span>
1736 <span class="var-name">$reply</span><span class="var-description">: A reference to the XMLDocument being used for the reply</span> </li>
1737 <li>
1738 <span class="var-type"></span>
1739 <span class="var-name">&$reply</span> </li>
1740 <li>
1741 <span class="var-type"></span>
1742 <span class="var-name">$bound_parent_path</span> </li>
1743 </ul>
1744
1745
1746 </div>
1747 <a name="methodresource" id="resource"><!-- --></a>
1748 <div class="oddrow">
1749
1750 <div class="method-header">
1751 <img src="../../media/images/Method.png" />
1752 <span class="method-title">resource</span> (line <span class="line-number">1202</span>)
1753 </div>
1754
1755 <!-- ========== Info from phpDoc block ========= -->
1756 <p class="short-description">Returns the database row for this resource</p>
1757
1758 <div class="method-signature">
1759 <span class="method-result">void</span>
1760 <span class="method-name">
1761 resource
1762 </span>
1763 ()
1764 </div>
1765
1766
1767
1768 </div>
1769 <a name="methodResourceProperty" id="ResourceProperty"><!-- --></a>
1770 <div class="evenrow">
1771
1772 <div class="method-header">
1773 <img src="../../media/images/Method.png" />
1774 <span class="method-title">ResourceProperty</span> (line <span class="line-number">1432</span>)
1775 </div>
1776
1777 <!-- ========== Info from phpDoc block ========= -->
1778 <p class="short-description">Return general server-related properties for this URL</p>
1779
1780 <div class="method-signature">
1781 <span class="method-result">void</span>
1782 <span class="method-name">
1783 ResourceProperty
1784 </span>
1785 (<span class="var-type"></span>&nbsp;<span class="var-name">$tag</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$prop</span>, <span class="var-type"></span>&nbsp;<span class="var-name">&$reply</span>, <span class="var-type"></span>&nbsp;<span class="var-name">&$denied</span>)
1786 </div>
1787
1788 <ul class="parameters">
1789 <li>
1790 <span class="var-type"></span>
1791 <span class="var-name">$tag</span> </li>
1792 <li>
1793 <span class="var-type"></span>
1794 <span class="var-name">$prop</span> </li>
1795 <li>
1796 <span class="var-type"></span>
1797 <span class="var-name">&$reply</span> </li>
1798 <li>
1799 <span class="var-type"></span>
1800 <span class="var-name">&$denied</span> </li>
1801 </ul>
1802
1803
1804 </div>
1805 <a name="methodresource_id" id="resource_id"><!-- --></a>
1806 <div class="oddrow">
1807
1808 <div class="method-header">
1809 <img src="../../media/images/Method.png" />
1810 <span class="method-title">resource_id</span> (line <span class="line-number">1228</span>)
1811 </div>
1812
1813 <!-- ========== Info from phpDoc block ========= -->
1814 <p class="short-description">Returns the definitive resource_id for this resource - usually a dav_id</p>
1815
1816 <div class="method-signature">
1817 <span class="method-result">void</span>
1818 <span class="method-name">
1819 resource_id
1820 </span>
1821 ()
1822 </div>
1823
1824
1825
1826 </div>
1827 <a name="methodset_bind_location" id="set_bind_location"><!-- --></a>
1828 <div class="evenrow">
1829
1830 <div class="method-header">
1831 <img src="../../media/images/Method.png" />
1832 <span class="method-title">set_bind_location</span> (line <span class="line-number">1147</span>)
1833 </div>
1834
1835 <!-- ========== Info from phpDoc block ========= -->
1836 <p class="short-description">Sets the dav_name of the resource we are bound as</p>
1837
1838 <div class="method-signature">
1839 <span class="method-result">void</span>
1840 <span class="method-name">
1841 set_bind_location
1842 </span>
1843 (<span class="var-type"></span>&nbsp;<span class="var-name">$new_dav_name</span>)
1844 </div>
1845
1846 <ul class="parameters">
1847 <li>
1848 <span class="var-type"></span>
1849 <span class="var-name">$new_dav_name</span> </li>
1850 </ul>
1851
1852
1853 </div>
1854 <a name="methodunique_tag" id="unique_tag"><!-- --></a>
1855 <div class="oddrow">
1856
1857 <div class="method-header">
1858 <img src="../../media/images/Method.png" />
1859 <span class="method-title">unique_tag</span> (line <span class="line-number">1211</span>)
1860 </div>
1861
1862 <!-- ========== Info from phpDoc block ========= -->
1863 <p class="short-description">Returns the unique_tag (ETag or getctag) for this resource</p>
1864
1865 <div class="method-signature">
1866 <span class="method-result">void</span>
1867 <span class="method-name">
1868 unique_tag
1869 </span>
1870 ()
1871 </div>
1872
1873
1874
1875 </div>
1876 <a name="methodurl" id="url"><!-- --></a>
1877 <div class="evenrow">
1878
1879 <div class="method-header">
1880 <img src="../../media/images/Method.png" />
1881 <span class="method-title">url</span> (line <span class="line-number">1118</span>)
1882 </div>
1883
1884 <!-- ========== Info from phpDoc block ========= -->
1885 <p class="short-description">Returns the URL of our resource</p>
1886
1887 <div class="method-signature">
1888 <span class="method-result">void</span>
1889 <span class="method-name">
1890 url
1891 </span>
1892 ()
1893 </div>
1894
1895
1896
1897 </div>
1898 <a name="methoduser_no" id="user_no"><!-- --></a>
1899 <div class="oddrow">
1900
1901 <div class="method-header">
1902 <img src="../../media/images/Method.png" />
1903 <span class="method-title">user_no</span> (line <span class="line-number">1184</span>)
1904 </div>
1905
1906 <!-- ========== Info from phpDoc block ========= -->
1907 <p class="short-description">Returns the internal user_no for the principal for this resource</p>
1908
1909 <div class="method-signature">
1910 <span class="method-result">void</span>
1911 <span class="method-name">
1912 user_no
1913 </span>
1914 ()
1915 </div>
1916
1917
1918
1919 </div>
1920
1921 </div>
1922 </div>
1923
1924
1925 <p class="notes" id="credit">
1926 Documentation generated on Tue, 27 Sep 2011 11:30:46 +1300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
1927 </p>
1928 </div></body>
1929 </html>
DAViCal CalDAV & CardDAV Server