?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
The real release 0.46 :-)
[awl.git] / docs / api / awl / iCalendar / iCalComponent.html
blobb0cb42f9c32f05d19e7a3934e6413d3fce0c717b
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 iCalComponent</title>
7 <link rel="stylesheet" href="../../media/stylesheet.css" />
8 <script src="../../media/lib/classTree.js"></script>
9 <script language="javascript" type="text/javascript">
10 var imgPlus = new Image();
11 var imgMinus = new Image();
12 imgPlus.src = "../../media/images/plus.png";
13 imgMinus.src = "../../media/images/minus.png";
14
15 function showNode(Node){
16 switch(navigator.family){
17 case 'nn4':
18 // Nav 4.x code fork...
19 var oTable = document.layers["span" + Node];
20 var oImg = document.layers["img" + Node];
21 break;
22 case 'ie4':
23 // IE 4/5 code fork...
24 var oTable = document.all["span" + Node];
25 var oImg = document.all["img" + Node];
26 break;
27 case 'gecko':
28 // Standards Compliant code fork...
29 var oTable = document.getElementById("span" + Node);
30 var oImg = document.getElementById("img" + Node);
31 break;
32 }
33 oImg.src = imgMinus.src;
34 oTable.style.display = "block";
35 }
36
37 function hideNode(Node){
38 switch(navigator.family){
39 case 'nn4':
40 // Nav 4.x code fork...
41 var oTable = document.layers["span" + Node];
42 var oImg = document.layers["img" + Node];
43 break;
44 case 'ie4':
45 // IE 4/5 code fork...
46 var oTable = document.all["span" + Node];
47 var oImg = document.all["img" + Node];
48 break;
49 case 'gecko':
50 // Standards Compliant code fork...
51 var oTable = document.getElementById("span" + Node);
52 var oImg = document.getElementById("img" + Node);
53 break;
54 }
55 oImg.src = imgPlus.src;
56 oTable.style.display = "none";
57 }
58
59 function nodeIsVisible(Node){
60 switch(navigator.family){
61 case 'nn4':
62 // Nav 4.x code fork...
63 var oTable = document.layers["span" + Node];
64 break;
65 case 'ie4':
66 // IE 4/5 code fork...
67 var oTable = document.all["span" + Node];
68 break;
69 case 'gecko':
70 // Standards Compliant code fork...
71 var oTable = document.getElementById("span" + Node);
72 break;
73 }
74 return (oTable && oTable.style.display == "block");
75 }
76
77 function toggleNodeVisibility(Node){
78 if (nodeIsVisible(Node)){
79 hideNode(Node);
80 }else{
81 showNode(Node);
82 }
83 }
84 </script>
85 </head>
86 <body>
87 <div class="page-body">
88 <h2 class="class-name"><img src="../../media/images/Class_logo.png"
89 alt=" Class"
90 title=" Class"
91 style="vertical-align: middle"> iCalComponent</h2>
92
93 <a name="sec-description"></a>
94 <div class="info-box">
95 <div class="info-box-title">Description</div>
96 <div class="nav-bar">
97 <span class="disabled">Description</span> |
98 <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
99
100 </div>
101 <div class="info-box-body">
102 <!-- ========== Info from phpDoc block ========= -->
103 <p class="short-description">A Class for representing components within an iCalendar</p>
104 <p class="notes">
105 Located in <a class="field" href="_iCalendar.php.html">/iCalendar.php</a> (line <span class="field">299</span>)
106 </p>
107
108
109 <pre></pre>
110
111 </div>
112 </div>
113
114
115
116
117 <a name="sec-method-summary"></a>
118 <div class="info-box">
119 <div class="info-box-title">Method Summary</span></div>
120 <div class="nav-bar">
121 <a href="#sec-description">Description</a> |
122 <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
123 </div>
124 <div class="info-box-body">
125 <div class="method-summary">
126
127 <div class="method-definition">
128 <img src="../../media/images/Constructor.png" alt=" "/>
129 <span class="method-result">iCalComponent</span>
130 <a href="#iCalComponent" title="details" class="method-name">iCalComponent</a>
131 ([<span class="var-type"></span>&nbsp;<span class="var-name">$content</span> = <span class="var-default">null</span>])
132 </div>
133
134 <div class="method-definition">
135 <img src="../../media/images/Method.png" alt=" "/>
136 <span class="method-result">void</span>
137 <a href="#AddComponent" title="details" class="method-name">AddComponent</a>
138 (<span class="var-type"><a href="../../awl/iCalendar/iCalComponent.html">iCalComponent</a></span>&nbsp;<span class="var-name">$new_component</span>)
139 </div>
140
141 <div class="method-definition">
142 <img src="../../media/images/Method.png" alt=" "/>
143 <span class="method-result">void</span>
144 <a href="#AddProperty" title="details" class="method-name">AddProperty</a>
145 (<span class="var-type"><a href="../../awl/iCalendar/iCalProp.html">iCalProp</a></span>&nbsp;<span class="var-name">$new_property</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span> = <span class="var-default">null</span>], [<span class="var-type">array</span>&nbsp;<span class="var-name">$parameters</span> = <span class="var-default">null</span>])
146 </div>
147
148 <div class="method-definition">
149 <img src="../../media/images/Method.png" alt=" "/>
150 <span class="method-result">void</span>
151 <a href="#ClearComponents" title="details" class="method-name">ClearComponents</a>
152 ([<span class="var-type">string</span>&nbsp;<span class="var-name">$type</span> = <span class="var-default">null</span>])
153 </div>
154
155 <div class="method-definition">
156 <img src="../../media/images/Method.png" alt=" "/>
157 <span class="method-result">void</span>
158 <a href="#ClearProperties" title="details" class="method-name">ClearProperties</a>
159 ([<span class="var-type">string</span>&nbsp;<span class="var-name">$type</span> = <span class="var-default">null</span>])
160 </div>
161
162 <div class="method-definition">
163 <img src="../../media/images/Method.png" alt=" "/>
164 <span class="method-result">void</span>
165 <a href="#CloneConfidential" title="details" class="method-name">CloneConfidential</a>
166 ()
167 </div>
168
169 <div class="method-definition">
170 <img src="../../media/images/Method.png" alt=" "/>
171 <span class="method-result">void</span>
172 <a href="#CollectParameterValues" title="details" class="method-name">CollectParameterValues</a>
173 (<span class="var-type"></span>&nbsp;<span class="var-name">$parameter_name</span>)
174 </div>
175
176 <div class="method-definition">
177 <img src="../../media/images/Method.png" alt=" "/>
178 <span class="method-result">array</span>
179 <a href="#FirstNonTimezone" title="details" class="method-name">&amp;FirstNonTimezone</a>
180 ([<span class="var-type"></span>&nbsp;<span class="var-name">$type</span> = <span class="var-default">null</span>])
181 </div>
182
183 <div class="method-definition">
184 <img src="../../media/images/Method.png" alt=" "/>
185 <span class="method-result">array</span>
186 <a href="#GetComponents" title="details" class="method-name">GetComponents</a>
187 ([<span class="var-type">string</span>&nbsp;<span class="var-name">$type</span> = <span class="var-default">null</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$normal_match</span> = <span class="var-default">true</span>])
188 </div>
189
190 <div class="method-definition">
191 <img src="../../media/images/Method.png" alt=" "/>
192 <span class="method-result">string</span>
193 <a href="#GetPParamValue" title="details" class="method-name">GetPParamValue</a>
194 (<span class="var-type">string</span>&nbsp;<span class="var-name">$type</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$parameter_name</span>)
195 </div>
196
197 <div class="method-definition">
198 <img src="../../media/images/Method.png" alt=" "/>
199 <span class="method-result">void</span>
200 <a href="#GetProperties" title="details" class="method-name">GetProperties</a>
201 ([<span class="var-type"></span>&nbsp;<span class="var-name">$type</span> = <span class="var-default">null</span>])
202 </div>
203
204 <div class="method-definition">
205 <img src="../../media/images/Method.png" alt=" "/>
206 <span class="method-result">array</span>
207 <a href="#GetPropertiesByPath" title="details" class="method-name">GetPropertiesByPath</a>
208 (<span class="var-type"></span>&nbsp;<span class="var-name">$path</span>)
209 </div>
210
211 <div class="method-definition">
212 <img src="../../media/images/Method.png" alt=" "/>
213 <span class="method-result">string</span>
214 <a href="#GetPValue" title="details" class="method-name">GetPValue</a>
215 (<span class="var-type">string</span>&nbsp;<span class="var-name">$type</span>)
216 </div>
217
218 <div class="method-definition">
219 <img src="../../media/images/Method.png" alt=" "/>
220 <span class="method-result">void</span>
221 <a href="#GetType" title="details" class="method-name">GetType</a>
222 ()
223 </div>
224
225 <div class="method-definition">
226 <img src="../../media/images/Method.png" alt=" "/>
227 <span class="method-result">boolean</span>
228 <a href="#IsAttendee" title="details" class="method-name">IsAttendee</a>
229 (<span class="var-type">string</span>&nbsp;<span class="var-name">$email</span>)
230 </div>
231
232 <div class="method-definition">
233 <img src="../../media/images/Method.png" alt=" "/>
234 <span class="method-result">boolean</span>
235 <a href="#IsOrganizer" title="details" class="method-name">IsOrganizer</a>
236 (<span class="var-type">string</span>&nbsp;<span class="var-name">$email</span>)
237 </div>
238
239 <div class="method-definition">
240 <img src="../../media/images/Method.png" alt=" "/>
241 <span class="method-result">void</span>
242 <a href="#MaskComponents" title="details" class="method-name">MaskComponents</a>
243 (<span class="var-type">array</span>&nbsp;<span class="var-name">$keep</span>)
244 </div>
245
246 <div class="method-definition">
247 <img src="../../media/images/Method.png" alt=" "/>
248 <span class="method-result">void</span>
249 <a href="#MaskProperties" title="details" class="method-name">MaskProperties</a>
250 (<span class="var-type">array</span>&nbsp;<span class="var-name">$keep</span>, [<span class="var-type">array</span>&nbsp;<span class="var-name">$component_list</span> = <span class="var-default">null</span>])
251 </div>
252
253 <div class="method-definition">
254 <img src="../../media/images/Method.png" alt=" "/>
255 <span class="method-result">void</span>
256 <a href="#ParseFrom" title="details" class="method-name">ParseFrom</a>
257 (<span class="var-type">string</span>&nbsp;<span class="var-name">$content</span>)
258 </div>
259
260 <div class="method-definition">
261 <img src="../../media/images/Method.png" alt=" "/>
262 <span class="method-result">void</span>
263 <a href="#Render" title="details" class="method-name">Render</a>
264 ([<span class="var-type"></span>&nbsp;<span class="var-name">$restricted_properties</span> = <span class="var-default">null</span>])
265 </div>
266
267 <div class="method-definition">
268 <img src="../../media/images/Method.png" alt=" "/>
269 <span class="method-result">void</span>
270 <a href="#SetComponents" title="details" class="method-name">SetComponents</a>
271 (<span class="var-type">array</span>&nbsp;<span class="var-name">$new_component</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$type</span> = <span class="var-default">null</span>])
272 </div>
273
274 <div class="method-definition">
275 <img src="../../media/images/Method.png" alt=" "/>
276 <span class="method-result">void</span>
277 <a href="#SetProperties" title="details" class="method-name">SetProperties</a>
278 (<span class="var-type"></span>&nbsp;<span class="var-name">$new_properties</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$type</span> = <span class="var-default">null</span>])
279 </div>
280
281 <div class="method-definition">
282 <img src="../../media/images/Method.png" alt=" "/>
283 <span class="method-result">void</span>
284 <a href="#SetType" title="details" class="method-name">SetType</a>
285 (<span class="var-type"></span>&nbsp;<span class="var-name">$type</span>)
286 </div>
287
288 <div class="method-definition">
289 <img src="../../media/images/Method.png" alt=" "/>
290 <span class="method-result">void</span>
291 <a href="#UnwrapComponent" title="details" class="method-name">UnwrapComponent</a>
292 (<span class="var-type"></span>&nbsp;<span class="var-name">$content</span>)
293 </div>
294
295 <div class="method-definition">
296 <img src="../../media/images/Method.png" alt=" "/>
297 <span class="method-result">void</span>
298 <a href="#VCalendar" title="details" class="method-name">VCalendar</a>
299 ([<span class="var-type">array</span>&nbsp;<span class="var-name">$extra_properties</span> = <span class="var-default">null</span>])
300 </div>
301
302 <div class="method-definition">
303 <img src="../../media/images/Method.png" alt=" "/>
304 <span class="method-result">void</span>
305 <a href="#WrapComponent" title="details" class="method-name">WrapComponent</a>
306 (<span class="var-type"></span>&nbsp;<span class="var-name">$content</span>)
307 </div>
308 </div>
309 </div>
310 </div>
311
312
313 <a name="sec-methods"></a>
314 <div class="info-box">
315 <div class="info-box-title">Methods</div>
316 <div class="nav-bar">
317 <a href="#sec-description">Description</a> |
318 <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
319
320 </div>
321 <div class="info-box-body">
322 <A NAME='method_detail'></A>
323 <a name="methodiCalComponent" id="iCalComponent"><!-- --></a>
324 <div class="evenrow">
325
326 <div class="method-header">
327 <img src="../../media/images/Constructor.png" />
328 <span class="method-title">Constructor iCalComponent</span> (line <span class="line-number">337</span>)
329 </div>
330
331 <!-- ========== Info from phpDoc block ========= -->
332 <p class="short-description">A basic constructor</p>
333
334 <div class="method-signature">
335 <span class="method-result">iCalComponent</span>
336 <span class="method-name">
337 iCalComponent
338 </span>
339 ([<span class="var-type"></span>&nbsp;<span class="var-name">$content</span> = <span class="var-default">null</span>])
340 </div>
341
342 <ul class="parameters">
343 <li>
344 <span class="var-type"></span>
345 <span class="var-name">$content</span> </li>
346 </ul>
347
348
349 </div>
350 <a name="methodAddComponent" id="AddComponent"><!-- --></a>
351 <div class="oddrow">
352
353 <div class="method-header">
354 <img src="../../media/images/Method.png" />
355 <span class="method-title">AddComponent</span> (line <span class="line-number">730</span>)
356 </div>
357
358 <!-- ========== Info from phpDoc block ========= -->
359 <p class="short-description">Adds a new subcomponent</p>
360
361 <div class="method-signature">
362 <span class="method-result">void</span>
363 <span class="method-name">
364 AddComponent
365 </span>
366 (<span class="var-type"><a href="../../awl/iCalendar/iCalComponent.html">iCalComponent</a></span>&nbsp;<span class="var-name">$new_component</span>)
367 </div>
368
369 <ul class="parameters">
370 <li>
371 <span class="var-type"><a href="../../awl/iCalendar/iCalComponent.html">iCalComponent</a></span>
372 <span class="var-name">$new_component</span><span class="var-description">: The new component to append to the set</span> </li>
373 </ul>
374
375
376 </div>
377 <a name="methodAddProperty" id="AddProperty"><!-- --></a>
378 <div class="evenrow">
379
380 <div class="method-header">
381 <img src="../../media/images/Method.png" />
382 <span class="method-title">AddProperty</span> (line <span class="line-number">599</span>)
383 </div>
384
385 <!-- ========== Info from phpDoc block ========= -->
386 <p class="short-description">Adds a new property</p>
387
388 <div class="method-signature">
389 <span class="method-result">void</span>
390 <span class="method-name">
391 AddProperty
392 </span>
393 (<span class="var-type"><a href="../../awl/iCalendar/iCalProp.html">iCalProp</a></span>&nbsp;<span class="var-name">$new_property</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span> = <span class="var-default">null</span>], [<span class="var-type">array</span>&nbsp;<span class="var-name">$parameters</span> = <span class="var-default">null</span>])
394 </div>
395
396 <ul class="parameters">
397 <li>
398 <span class="var-type"><a href="../../awl/iCalendar/iCalProp.html">iCalProp</a></span>
399 <span class="var-name">$new_property</span><span class="var-description">: The new property to append to the set, or a string with the name</span> </li>
400 <li>
401 <span class="var-type">string</span>
402 <span class="var-name">$value</span><span class="var-description">: The value of the new property (default: param 1 is an iCalProp with everything</span> </li>
403 <li>
404 <span class="var-type">array</span>
405 <span class="var-name">$parameters</span><span class="var-description">: The key/value parameter pairs (default: none, or param 1 is an iCalProp with everything)</span> </li>
406 </ul>
407
408
409 </div>
410 <a name="methodClearComponents" id="ClearComponents"><!-- --></a>
411 <div class="oddrow">
412
413 <div class="method-header">
414 <img src="../../media/images/Method.png" />
415 <span class="method-title">ClearComponents</span> (line <span class="line-number">687</span>)
416 </div>
417
418 <!-- ========== Info from phpDoc block ========= -->
419 <p class="short-description">Clear all components, or the components matching a particular type</p>
420
421 <div class="method-signature">
422 <span class="method-result">void</span>
423 <span class="method-name">
424 ClearComponents
425 </span>
426 ([<span class="var-type">string</span>&nbsp;<span class="var-name">$type</span> = <span class="var-default">null</span>])
427 </div>
428
429 <ul class="parameters">
430 <li>
431 <span class="var-type">string</span>
432 <span class="var-name">$type</span><span class="var-description">: The type of component - omit for all components</span> </li>
433 </ul>
434
435
436 </div>
437 <a name="methodClearProperties" id="ClearProperties"><!-- --></a>
438 <div class="evenrow">
439
440 <div class="method-header">
441 <img src="../../media/images/Method.png" />
442 <span class="method-title">ClearProperties</span> (line <span class="line-number">562</span>)
443 </div>
444
445 <!-- ========== Info from phpDoc block ========= -->
446 <p class="short-description">Clear all properties, or the properties matching a particular type</p>
447
448 <div class="method-signature">
449 <span class="method-result">void</span>
450 <span class="method-name">
451 ClearProperties
452 </span>
453 ([<span class="var-type">string</span>&nbsp;<span class="var-name">$type</span> = <span class="var-default">null</span>])
454 </div>
455
456 <ul class="parameters">
457 <li>
458 <span class="var-type">string</span>
459 <span class="var-name">$type</span><span class="var-description">: The type of property - omit for all properties</span> </li>
460 </ul>
461
462
463 </div>
464 <a name="methodCloneConfidential" id="CloneConfidential"><!-- --></a>
465 <div class="oddrow">
466
467 <div class="method-header">
468 <img src="../../media/images/Method.png" />
469 <span class="method-title">CloneConfidential</span> (line <span class="line-number">787</span>)
470 </div>
471
472 <!-- ========== Info from phpDoc block ========= -->
473 <p class="short-description">Clone this component (and subcomponents) into a confidential version of it. A confidential event will be scrubbed of any identifying characteristics other than time/date, repeat, uid and a summary which is just a translated 'Busy'.</p>
474
475 <div class="method-signature">
476 <span class="method-result">void</span>
477 <span class="method-name">
478 CloneConfidential
479 </span>
480 ()
481 </div>
482
483
484
485 </div>
486 <a name="methodCollectParameterValues" id="CollectParameterValues"><!-- --></a>
487 <div class="evenrow">
488
489 <div class="method-header">
490 <img src="../../media/images/Method.png" />
491 <span class="method-title">CollectParameterValues</span> (line <span class="line-number">368</span>)
492 </div>
493
494 <!-- ========== Info from phpDoc block ========= -->
495 <p class="short-description">Collect an array of all parameters of our properties which are the specified type</p>
496 <p class="description"><p>Mainly used for collecting the full variety of references TZIDs</p></p>
497
498 <div class="method-signature">
499 <span class="method-result">void</span>
500 <span class="method-name">
501 CollectParameterValues
502 </span>
503 (<span class="var-type"></span>&nbsp;<span class="var-name">$parameter_name</span>)
504 </div>
505
506 <ul class="parameters">
507 <li>
508 <span class="var-type"></span>
509 <span class="var-name">$parameter_name</span> </li>
510 </ul>
511
512
513 </div>
514 <a name="methodFirstNonTimezone" id="FirstNonTimezone"><!-- --></a>
515 <div class="oddrow">
516
517 <div class="method-header">
518 <img src="../../media/images/Method.png" />
519 <span class="method-title">FirstNonTimezone</span> (line <span class="line-number">619</span>)
520 </div>
521
522 <!-- ========== Info from phpDoc block ========= -->
523 <p class="short-description">Get all sub-components, or at least get those matching a type</p>
524 <ul class="tags">
525 <li><span class="field">return:</span> an array of the sub-components</li>
526 </ul>
527
528 <div class="method-signature">
529 <span class="method-result">array</span>
530 <span class="method-name">
531 &amp;FirstNonTimezone
532 </span>
533 ([<span class="var-type"></span>&nbsp;<span class="var-name">$type</span> = <span class="var-default">null</span>])
534 </div>
535
536 <ul class="parameters">
537 <li>
538 <span class="var-type"></span>
539 <span class="var-name">$type</span> </li>
540 </ul>
541
542
543 </div>
544 <a name="methodGetComponents" id="GetComponents"><!-- --></a>
545 <div class="evenrow">
546
547 <div class="method-header">
548 <img src="../../media/images/Method.png" />
549 <span class="method-title">GetComponents</span> (line <span class="line-number">669</span>)
550 </div>
551
552 <!-- ========== Info from phpDoc block ========= -->
553 <p class="short-description">Get all sub-components, or at least get those matching a type, or failling to match, should the second parameter be set to false.</p>
554 <ul class="tags">
555 <li><span class="field">return:</span> an array of the sub-components</li>
556 </ul>
557
558 <div class="method-signature">
559 <span class="method-result">array</span>
560 <span class="method-name">
561 GetComponents
562 </span>
563 ([<span class="var-type">string</span>&nbsp;<span class="var-name">$type</span> = <span class="var-default">null</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$normal_match</span> = <span class="var-default">true</span>])
564 </div>
565
566 <ul class="parameters">
567 <li>
568 <span class="var-type">string</span>
569 <span class="var-name">$type</span><span class="var-description">: The type to match (default: All)</span> </li>
570 <li>
571 <span class="var-type">boolean</span>
572 <span class="var-name">$normal_match</span><span class="var-description">: Set to false to invert the match (default: true)</span> </li>
573 </ul>
574
575
576 </div>
577 <a name="methodGetPParamValue" id="GetPParamValue"><!-- --></a>
578 <div class="oddrow">
579
580 <div class="method-header">
581 <img src="../../media/images/Method.png" />
582 <span class="method-title">GetPParamValue</span> (line <span class="line-number">550</span>)
583 </div>
584
585 <!-- ========== Info from phpDoc block ========= -->
586 <p class="short-description">Get the value of the specified parameter for the first property matching the name. Obviously this isn't so useful for properties which may occur multiply, but most don't.</p>
587 <ul class="tags">
588 <li><span class="field">return:</span> The value of the parameter for the property, or null in the case that there was no such property, or no such parameter.</li>
589 </ul>
590
591 <div class="method-signature">
592 <span class="method-result">string</span>
593 <span class="method-name">
594 GetPParamValue
595 </span>
596 (<span class="var-type">string</span>&nbsp;<span class="var-name">$type</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$parameter_name</span>)
597 </div>
598
599 <ul class="parameters">
600 <li>
601 <span class="var-type">string</span>
602 <span class="var-name">$type</span><span class="var-description">: The name of the parameter we are after.</span> </li>
603 <li>
604 <span class="var-type"></span>
605 <span class="var-name">$parameter_name</span> </li>
606 </ul>
607
608
609 </div>
610 <a name="methodGetProperties" id="GetProperties"><!-- --></a>
611 <div class="evenrow">
612
613 <div class="method-header">
614 <img src="../../media/images/Method.png" />
615 <span class="method-title">GetProperties</span> (line <span class="line-number">516</span>)
616 </div>
617
618 <!-- ========== Info from phpDoc block ========= -->
619 <p class="short-description">Get all properties, or the properties matching a particular type</p>
620
621 <div class="method-signature">
622 <span class="method-result">void</span>
623 <span class="method-name">
624 GetProperties
625 </span>
626 ([<span class="var-type"></span>&nbsp;<span class="var-name">$type</span> = <span class="var-default">null</span>])
627 </div>
628
629 <ul class="parameters">
630 <li>
631 <span class="var-type"></span>
632 <span class="var-name">$type</span> </li>
633 </ul>
634
635
636 </div>
637 <a name="methodGetPropertiesByPath" id="GetPropertiesByPath"><!-- --></a>
638 <div class="oddrow">
639
640 <div class="method-header">
641 <img src="../../media/images/Method.png" />
642 <span class="method-title">GetPropertiesByPath</span> (line <span class="line-number">840</span>)
643 </div>
644
645 <!-- ========== Info from phpDoc block ========= -->
646 <p class="short-description">Return an array of properties matching the specified path</p>
647 <ul class="tags">
648 <li><span class="field">return:</span> An array of iCalProp within the tree which match the path given, in the form [/]COMPONENT[/...]/PROPERTY in a syntax kind of similar to our poor man's XML queries. We also allow COMPONENT and PROPERTY to be !COMPONENT and !PROPERTY for ++fun.</li>
649 </ul>
650
651 <div class="method-signature">
652 <span class="method-result">array</span>
653 <span class="method-name">
654 GetPropertiesByPath
655 </span>
656 (<span class="var-type"></span>&nbsp;<span class="var-name">$path</span>)
657 </div>
658
659 <ul class="parameters">
660 <li>
661 <span class="var-type"></span>
662 <span class="var-name">$path</span> </li>
663 </ul>
664
665
666 </div>
667 <a name="methodGetPValue" id="GetPValue"><!-- --></a>
668 <div class="evenrow">
669
670 <div class="method-header">
671 <img src="../../media/images/Method.png" />
672 <span class="method-title">GetPValue</span> (line <span class="line-number">534</span>)
673 </div>
674
675 <!-- ========== Info from phpDoc block ========= -->
676 <p class="short-description">Get the value of the first property matching the name. Obviously this isn't so useful for properties which may occur multiply, but most don't.</p>
677 <ul class="tags">
678 <li><span class="field">return:</span> The value of the property, or null if there was no such property.</li>
679 </ul>
680
681 <div class="method-signature">
682 <span class="method-result">string</span>
683 <span class="method-name">
684 GetPValue
685 </span>
686 (<span class="var-type">string</span>&nbsp;<span class="var-name">$type</span>)
687 </div>
688
689 <ul class="parameters">
690 <li>
691 <span class="var-type">string</span>
692 <span class="var-name">$type</span><span class="var-description">: The type of property we are after.</span> </li>
693 </ul>
694
695
696 </div>
697 <a name="methodGetType" id="GetType"><!-- --></a>
698 <div class="oddrow">
699
700 <div class="method-header">
701 <img src="../../media/images/Method.png" />
702 <span class="method-title">GetType</span> (line <span class="line-number">498</span>)
703 </div>
704
705 <!-- ========== Info from phpDoc block ========= -->
706 <p class="short-description">Return the type of component which this is</p>
707
708 <div class="method-signature">
709 <span class="method-result">void</span>
710 <span class="method-name">
711 GetType
712 </span>
713 ()
714 </div>
715
716
717
718 </div>
719 <a name="methodIsAttendee" id="IsAttendee"><!-- --></a>
720 <div class="evenrow">
721
722 <div class="method-header">
723 <img src="../../media/images/Method.png" />
724 <span class="method-title">IsAttendee</span> (line <span class="line-number">650</span>)
725 </div>
726
727 <!-- ========== Info from phpDoc block ========= -->
728 <p class="short-description">Return true if the person identified by the email address is down as an attendee or organizer for this meeting.</p>
729 <ul class="tags">
730 <li><span class="field">return:</span> true if we found 'em, false if we didn't.</li>
731 </ul>
732
733 <div class="method-signature">
734 <span class="method-result">boolean</span>
735 <span class="method-name">
736 IsAttendee
737 </span>
738 (<span class="var-type">string</span>&nbsp;<span class="var-name">$email</span>)
739 </div>
740
741 <ul class="parameters">
742 <li>
743 <span class="var-type">string</span>
744 <span class="var-name">$email</span><span class="var-description">: The e-mail address of the person we're seeking.</span> </li>
745 </ul>
746
747
748 </div>
749 <a name="methodIsOrganizer" id="IsOrganizer"><!-- --></a>
750 <div class="oddrow">
751
752 <div class="method-header">
753 <img src="../../media/images/Method.png" />
754 <span class="method-title">IsOrganizer</span> (line <span class="line-number">634</span>)
755 </div>
756
757 <!-- ========== Info from phpDoc block ========= -->
758 <p class="short-description">Return true if the person identified by the email address is down as an organizer for this meeting.</p>
759 <ul class="tags">
760 <li><span class="field">return:</span> true if we found 'em, false if we didn't.</li>
761 </ul>
762
763 <div class="method-signature">
764 <span class="method-result">boolean</span>
765 <span class="method-name">
766 IsOrganizer
767 </span>
768 (<span class="var-type">string</span>&nbsp;<span class="var-name">$email</span>)
769 </div>
770
771 <ul class="parameters">
772 <li>
773 <span class="var-type">string</span>
774 <span class="var-name">$email</span><span class="var-description">: The e-mail address of the person we're seeking.</span> </li>
775 </ul>
776
777
778 </div>
779 <a name="methodMaskComponents" id="MaskComponents"><!-- --></a>
780 <div class="evenrow">
781
782 <div class="method-header">
783 <img src="../../media/images/Method.png" />
784 <span class="method-title">MaskComponents</span> (line <span class="line-number">748</span>)
785 </div>
786
787 <!-- ========== Info from phpDoc block ========= -->
788 <p class="short-description">Mask components, removing any that are not of the types in the list</p>
789
790 <div class="method-signature">
791 <span class="method-result">void</span>
792 <span class="method-name">
793 MaskComponents
794 </span>
795 (<span class="var-type">array</span>&nbsp;<span class="var-name">$keep</span>)
796 </div>
797
798 <ul class="parameters">
799 <li>
800 <span class="var-type">array</span>
801 <span class="var-name">$keep</span><span class="var-description">: An array of component types to be kept</span> </li>
802 </ul>
803
804
805 </div>
806 <a name="methodMaskProperties" id="MaskProperties"><!-- --></a>
807 <div class="oddrow">
808
809 <div class="method-header">
810 <img src="../../media/images/Method.png" />
811 <span class="method-title">MaskProperties</span> (line <span class="line-number">766</span>)
812 </div>
813
814 <!-- ========== Info from phpDoc block ========= -->
815 <p class="short-description">Mask properties, removing any that are not in the list</p>
816
817 <div class="method-signature">
818 <span class="method-result">void</span>
819 <span class="method-name">
820 MaskProperties
821 </span>
822 (<span class="var-type">array</span>&nbsp;<span class="var-name">$keep</span>, [<span class="var-type">array</span>&nbsp;<span class="var-name">$component_list</span> = <span class="var-default">null</span>])
823 </div>
824
825 <ul class="parameters">
826 <li>
827 <span class="var-type">array</span>
828 <span class="var-name">$keep</span><span class="var-description">: An array of property names to be kept</span> </li>
829 <li>
830 <span class="var-type">array</span>
831 <span class="var-name">$component_list</span><span class="var-description">: An array of component types to check within</span> </li>
832 </ul>
833
834
835 </div>
836 <a name="methodParseFrom" id="ParseFrom"><!-- --></a>
837 <div class="evenrow">
838
839 <div class="method-header">
840 <img src="../../media/images/Method.png" />
841 <span class="method-title">ParseFrom</span> (line <span class="line-number">389</span>)
842 </div>
843
844 <!-- ========== Info from phpDoc block ========= -->
845 <p class="short-description">Parse the text $content into sets of iCalProp &amp; iCalComponent within this iCalComponent</p>
846
847 <div class="method-signature">
848 <span class="method-result">void</span>
849 <span class="method-name">
850 ParseFrom
851 </span>
852 (<span class="var-type">string</span>&nbsp;<span class="var-name">$content</span>)
853 </div>
854
855 <ul class="parameters">
856 <li>
857 <span class="var-type">string</span>
858 <span class="var-name">$content</span><span class="var-description">: The raw RFC2445-compliant iCalendar component, including BEGIN:TYPE &amp; END:TYPE</span> </li>
859 </ul>
860
861
862 </div>
863 <a name="methodRender" id="Render"><!-- --></a>
864 <div class="oddrow">
865
866 <div class="method-header">
867 <img src="../../media/images/Method.png" />
868 <span class="method-title">Render</span> (line <span class="line-number">809</span>)
869 </div>
870
871 <!-- ========== Info from phpDoc block ========= -->
872 <p class="short-description">Renders the component, possibly restricted to only the listed properties</p>
873
874 <div class="method-signature">
875 <span class="method-result">void</span>
876 <span class="method-name">
877 Render
878 </span>
879 ([<span class="var-type"></span>&nbsp;<span class="var-name">$restricted_properties</span> = <span class="var-default">null</span>])
880 </div>
881
882 <ul class="parameters">
883 <li>
884 <span class="var-type"></span>
885 <span class="var-name">$restricted_properties</span> </li>
886 </ul>
887
888
889 </div>
890 <a name="methodSetComponents" id="SetComponents"><!-- --></a>
891 <div class="evenrow">
892
893 <div class="method-header">
894 <img src="../../media/images/Method.png" />
895 <span class="method-title">SetComponents</span> (line <span class="line-number">716</span>)
896 </div>
897
898 <!-- ========== Info from phpDoc block ========= -->
899 <p class="short-description">Sets some or all sub-components of the component to the supplied new components</p>
900
901 <div class="method-signature">
902 <span class="method-result">void</span>
903 <span class="method-name">
904 SetComponents
905 </span>
906 (<span class="var-type">array</span>&nbsp;<span class="var-name">$new_component</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$type</span> = <span class="var-default">null</span>])
907 </div>
908
909 <ul class="parameters">
910 <li>
911 <span class="var-type">string</span>
912 <span class="var-name">$type</span><span class="var-description">: The type of components to be replaced. Defaults to null, which means all components will be replaced.</span> </li>
913 <li>
914 <span class="var-type">array</span>
915 <span class="var-name">$new_component</span><span class="var-description">: of iCalComponent $new_components The new components to replace the existing ones</span> </li>
916 </ul>
917
918
919 </div>
920 <a name="methodSetProperties" id="SetProperties"><!-- --></a>
921 <div class="oddrow">
922
923 <div class="method-header">
924 <img src="../../media/images/Method.png" />
925 <span class="method-title">SetProperties</span> (line <span class="line-number">583</span>)
926 </div>
927
928 <!-- ========== Info from phpDoc block ========= -->
929 <p class="short-description">Set all properties, or the ones matching a particular type</p>
930
931 <div class="method-signature">
932 <span class="method-result">void</span>
933 <span class="method-name">
934 SetProperties
935 </span>
936 (<span class="var-type"></span>&nbsp;<span class="var-name">$new_properties</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$type</span> = <span class="var-default">null</span>])
937 </div>
938
939 <ul class="parameters">
940 <li>
941 <span class="var-type"></span>
942 <span class="var-name">$new_properties</span> </li>
943 <li>
944 <span class="var-type"></span>
945 <span class="var-name">$type</span> </li>
946 </ul>
947
948
949 </div>
950 <a name="methodSetType" id="SetType"><!-- --></a>
951 <div class="evenrow">
952
953 <div class="method-header">
954 <img src="../../media/images/Method.png" />
955 <span class="method-title">SetType</span> (line <span class="line-number">506</span>)
956 </div>
957
958 <!-- ========== Info from phpDoc block ========= -->
959 <p class="short-description">Set the type of component which this is</p>
960
961 <div class="method-signature">
962 <span class="method-result">void</span>
963 <span class="method-name">
964 SetType
965 </span>
966 (<span class="var-type"></span>&nbsp;<span class="var-name">$type</span>)
967 </div>
968
969 <ul class="parameters">
970 <li>
971 <span class="var-type"></span>
972 <span class="var-name">$type</span> </li>
973 </ul>
974
975
976 </div>
977 <a name="methodUnwrapComponent" id="UnwrapComponent"><!-- --></a>
978 <div class="oddrow">
979
980 <div class="method-header">
981 <img src="../../media/images/Method.png" />
982 <span class="method-title">UnwrapComponent</span> (line <span class="line-number">474</span>)
983 </div>
984
985 <!-- ========== Info from phpDoc block ========= -->
986 <p class="short-description">This unescapes the (CRLF + linear space) wrapping specified in RFC2445. According to RFC2445 we should always end with CRLF but the CalDAV spec says that normalising XML parsers often muck with it and may remove the CR. We accept either case.</p>
987
988 <div class="method-signature">
989 <span class="method-result">void</span>
990 <span class="method-name">
991 UnwrapComponent
992 </span>
993 (<span class="var-type"></span>&nbsp;<span class="var-name">$content</span>)
994 </div>
995
996 <ul class="parameters">
997 <li>
998 <span class="var-type"></span>
999 <span class="var-name">$content</span> </li>
1000 </ul>
1001
1002
1003 </div>
1004 <a name="methodVCalendar" id="VCalendar"><!-- --></a>
1005 <div class="evenrow">
1006
1007 <div class="method-header">
1008 <img src="../../media/images/Method.png" />
1009 <span class="method-title">VCalendar</span> (line <span class="line-number">352</span>)
1010 </div>
1011
1012 <!-- ========== Info from phpDoc block ========= -->
1013 <p class="short-description">Apply standard properties for a VCalendar</p>
1014
1015 <div class="method-signature">
1016 <span class="method-result">void</span>
1017 <span class="method-name">
1018 VCalendar
1019 </span>
1020 ([<span class="var-type">array</span>&nbsp;<span class="var-name">$extra_properties</span> = <span class="var-default">null</span>])
1021 </div>
1022
1023 <ul class="parameters">
1024 <li>
1025 <span class="var-type">array</span>
1026 <span class="var-name">$extra_properties</span><span class="var-description">: Key/value pairs of additional properties</span> </li>
1027 </ul>
1028
1029
1030 </div>
1031 <a name="methodWrapComponent" id="WrapComponent"><!-- --></a>
1032 <div class="oddrow">
1033
1034 <div class="method-header">
1035 <img src="../../media/images/Method.png" />
1036 <span class="method-title">WrapComponent</span> (line <span class="line-number">486</span>)
1037 </div>
1038
1039 <!-- ========== Info from phpDoc block ========= -->
1040 <p class="short-description">This imposes the (CRLF + linear space) wrapping specified in RFC2445. According to RFC2445 we should always end with CRLF but the CalDAV spec says that normalising XML parsers often muck with it and may remove the CR. We output RFC2445 compliance.</p>
1041 <p class="description"><p>In order to preserve pre-existing wrapping in the component, we split the incoming string on line breaks before running wordwrap over each component of that.</p></p>
1042
1043 <div class="method-signature">
1044 <span class="method-result">void</span>
1045 <span class="method-name">
1046 WrapComponent
1047 </span>
1048 (<span class="var-type"></span>&nbsp;<span class="var-name">$content</span>)
1049 </div>
1050
1051 <ul class="parameters">
1052 <li>
1053 <span class="var-type"></span>
1054 <span class="var-name">$content</span> </li>
1055 </ul>
1056
1057
1058 </div>
1059
1060 </div>
1061 </div>
1062
1063
1064 <p class="notes" id="credit">
1065 Documentation generated on Tue, 28 Dec 2010 02:01:36 +1300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
1066 </p>
1067 </div></body>
1068 </html>
Andrew's Web Libraries