?  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 / iCalendar.html
blobb09d53772ed906e889a949c10fff04511dc91b77
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 iCalendar</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"> iCalendar</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 handling Events on a calendar (DEPRECATED)</p>
104 <p class="notes">
105 Located in <a class="field" href="_iCalendar.php.html">/iCalendar.php</a> (line <span class="field">909</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/StaticMethod.png" alt=" "/>
129 static <span class="method-result">void</span>
130 <a href="#HttpDateFormat" title="details" class="method-name">HttpDateFormat</a>
131 ()
132 </div>
133
134 <div class="method-definition">
135 <img src="../../media/images/StaticMethod.png" alt=" "/>
136 static <span class="method-result">void</span>
137 <a href="#iCalFooter" title="details" class="method-name">iCalFooter</a>
138 ()
139 </div>
140
141 <div class="method-definition">
142 <img src="../../media/images/StaticMethod.png" alt=" "/>
143 static <span class="method-result">void</span>
144 <a href="#iCalHeader" title="details" class="method-name">iCalHeader</a>
145 ()
146 </div>
147
148 <div class="method-definition">
149 <img src="../../media/images/StaticMethod.png" alt=" "/>
150 static <span class="method-result">void</span>
151 <a href="#SqlDateFormat" title="details" class="method-name">SqlDateFormat</a>
152 ()
153 </div>
154
155 <div class="method-definition">
156 <img src="../../media/images/StaticMethod.png" alt=" "/>
157 static <span class="method-result">void</span>
158 <a href="#SqlDurationFormat" title="details" class="method-name">SqlDurationFormat</a>
159 ()
160 </div>
161
162 <div class="method-definition">
163 <img src="../../media/images/StaticMethod.png" alt=" "/>
164 static <span class="method-result">void</span>
165 <a href="#SqlUTCFormat" title="details" class="method-name">SqlUTCFormat</a>
166 ()
167 </div>
168
169 <div class="method-definition">
170 <img src="../../media/images/Constructor.png" alt=" "/>
171 <span class="method-result">iCalendar</span>
172 <a href="#iCalendar" title="details" class="method-name">iCalendar</a>
173 (<span class="var-type"></span>&nbsp;<span class="var-name">$args</span>)
174 </div>
175
176 <div class="method-definition">
177 <img src="../../media/images/Method.png" alt=" "/>
178 <span class="method-result">void</span>
179 <a href="#Add" title="details" class="method-name">Add</a>
180 (<span class="var-type">string</span>&nbsp;<span class="var-name">$key</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$parameters</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">void</span>
186 <a href="#AddComponent" title="details" class="method-name">AddComponent</a>
187 (<span class="var-type"><a href="../../awl/iCalendar/iCalComponent.html">iCalComponent</a></span>&nbsp;<span class="var-name">$new_component</span>)
188 </div>
189
190 <div class="method-definition">
191 <img src="../../media/images/Method.png" alt=" "/>
192 <span class="method-result">boolean</span>
193 <a href="#ApplyFilter" title="details" class="method-name">ApplyFilter</a>
194 (<span class="var-type">array</span>&nbsp;<span class="var-name">$filter</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$value</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="#BuildFromText" title="details" class="method-name">BuildFromText</a>
201 (<span class="var-type"></span>&nbsp;<span class="var-name">$icalendar</span>)
202 </div>
203
204 <div class="method-definition">
205 <img src="../../media/images/Method.png" alt=" "/>
206 <span class="method-result">void</span>
207 <a href="#ClearComponents" title="details" class="method-name">ClearComponents</a>
208 ([<span class="var-type">string</span>&nbsp;<span class="var-name">$type</span> = <span class="var-default">null</span>])
209 </div>
210
211 <div class="method-definition">
212 <img src="../../media/images/Method.png" alt=" "/>
213 <span class="method-result">void</span>
214 <a href="#DealWithTimeZones" title="details" class="method-name">DealWithTimeZones</a>
215 ()
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="#DefaultPropertyList" title="details" class="method-name">DefaultPropertyList</a>
222 ()
223 </div>
224
225 <div class="method-definition">
226 <img src="../../media/images/Method.png" alt=" "/>
227 <span class="method-result">array</span>
228 <a href="#ExtractProperty" title="details" class="method-name">ExtractProperty</a>
229 (<span class="var-type">array</span>&nbsp;<span class="var-name">$component</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$type</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$count</span> = <span class="var-default">9999</span>])
230 </div>
231
232 <div class="method-definition">
233 <img src="../../media/images/Method.png" alt=" "/>
234 <span class="method-result">array</span>
235 <a href="#ExtractSubComponent" title="details" class="method-name">ExtractSubComponent</a>
236 (<span class="var-type">array</span>&nbsp;<span class="var-name">$component</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$type</span>, [<span class="var-type">int</span>&nbsp;<span class="var-name">$count</span> = <span class="var-default">9999</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="#Get" title="details" class="method-name">Get</a>
243 (<span class="var-type"></span>&nbsp;<span class="var-name">$key</span>)
244 </div>
245
246 <div class="method-definition">
247 <img src="../../media/images/Method.png" alt=" "/>
248 <span class="method-result">array</span>
249 <a href="#GetComponents" title="details" class="method-name">GetComponents</a>
250 ([<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>])
251 </div>
252
253 <div class="method-definition">
254 <img src="../../media/images/Method.png" alt=" "/>
255 <span class="method-result">string</span>
256 <a href="#JustThisBitPlease" title="details" class="method-name">JustThisBitPlease</a>
257 (<span class="var-type"></span>&nbsp;<span class="var-name">$type</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$count</span> = <span class="var-default">1</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="#MaskComponents" title="details" class="method-name">MaskComponents</a>
264 (<span class="var-type">array</span>&nbsp;<span class="var-name">$keep</span>)
265 </div>
266
267 <div class="method-definition">
268 <img src="../../media/images/Method.png" alt=" "/>
269 <span class="method-result">arrayref</span>
270 <a href="#ParseSomeLines" title="details" class="method-name">&amp;ParseSomeLines</a>
271 (<span class="var-type"></span>&nbsp;<span class="var-name">$type</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="#Render" title="details" class="method-name">Render</a>
278 ([<span class="var-type">boolean</span>&nbsp;<span class="var-name">$as_calendar</span> = <span class="var-default">true</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$type</span> = <span class="var-default">null</span>], [<span class="var-type">array</span>&nbsp;<span class="var-name">$restrict_properties</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="#RFC2445ContentEscape" title="details" class="method-name">RFC2445ContentEscape</a>
285 (<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
286 </div>
287
288 <div class="method-definition">
289 <img src="../../media/images/Method.png" alt=" "/>
290 <span class="method-result">string</span>
291 <a href="#RFC2445ContentUnescape" title="details" class="method-name">RFC2445ContentUnescape</a>
292 (<span class="var-type">string</span>&nbsp;<span class="var-name">$escaped</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="#SaveTimeZones" title="details" class="method-name">SaveTimeZones</a>
299 ()
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="#Set" title="details" class="method-name">Set</a>
306 (<span class="var-type"></span>&nbsp;<span class="var-name">$key</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$value</span>)
307 </div>
308
309 <div class="method-definition">
310 <img src="../../media/images/Method.png" alt=" "/>
311 <span class="method-result">void</span>
312 <a href="#SetComponents" title="details" class="method-name">SetComponents</a>
313 (<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>])
314 </div>
315
316 <div class="method-definition">
317 <img src="../../media/images/Method.png" alt=" "/>
318 <span class="method-result">boolean</span>
319 <a href="#TestFilter" title="details" class="method-name">TestFilter</a>
320 (<span class="var-type"></span>&nbsp;<span class="var-name">$filters</span>, <span class="var-type">array</span>&nbsp;<span class="var-name">$filter</span>)
321 </div>
322 </div>
323 </div>
324 </div>
325
326
327 <a name="sec-methods"></a>
328 <div class="info-box">
329 <div class="info-box-title">Methods</div>
330 <div class="nav-bar">
331 <a href="#sec-description">Description</a> |
332 <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
333
334 </div>
335 <div class="info-box-body">
336 <A NAME='method_detail'></A>
337 <a name="methodHttpDateFormat" id="HttpDateFormat"><!-- --></a>
338 <div class="evenrow">
339
340 <div class="method-header">
341 <img src="../../media/images/StaticMethod.png" />
342 <span class="method-title">static HttpDateFormat</span> (line <span class="line-number">1444</span>)
343 </div>
344
345 <!-- ========== Info from phpDoc block ========= -->
346
347 <div class="method-signature">
348 static <span class="method-result">void</span>
349 <span class="method-name">
350 HttpDateFormat
351 </span>
352 ()
353 </div>
354
355
356
357 </div>
358 <a name="methodiCalFooter" id="iCalFooter"><!-- --></a>
359 <div class="oddrow">
360
361 <div class="method-header">
362 <img src="../../media/images/StaticMethod.png" />
363 <span class="method-title">static iCalFooter</span> (line <span class="line-number">1709</span>)
364 </div>
365
366 <!-- ========== Info from phpDoc block ========= -->
367 <ul class="tags">
368 <li><span class="field">todo:</span> Remove this function.</li>
369 </ul>
370
371 <div class="method-signature">
372 static <span class="method-result">void</span>
373 <span class="method-name">
374 iCalFooter
375 </span>
376 ()
377 </div>
378
379
380
381 </div>
382 <a name="methodiCalHeader" id="iCalHeader"><!-- --></a>
383 <div class="evenrow">
384
385 <div class="method-header">
386 <img src="../../media/images/StaticMethod.png" />
387 <span class="method-title">static iCalHeader</span> (line <span class="line-number">1691</span>)
388 </div>
389
390 <!-- ========== Info from phpDoc block ========= -->
391 <ul class="tags">
392 <li><span class="field">todo:</span> Remove this function.</li>
393 </ul>
394
395 <div class="method-signature">
396 static <span class="method-result">void</span>
397 <span class="method-name">
398 iCalHeader
399 </span>
400 ()
401 </div>
402
403
404
405 </div>
406 <a name="methodSqlDateFormat" id="SqlDateFormat"><!-- --></a>
407 <div class="oddrow">
408
409 <div class="method-header">
410 <img src="../../media/images/StaticMethod.png" />
411 <span class="method-title">static SqlDateFormat</span> (line <span class="line-number">1453</span>)
412 </div>
413
414 <!-- ========== Info from phpDoc block ========= -->
415
416 <div class="method-signature">
417 static <span class="method-result">void</span>
418 <span class="method-name">
419 SqlDateFormat
420 </span>
421 ()
422 </div>
423
424
425
426 </div>
427 <a name="methodSqlDurationFormat" id="SqlDurationFormat"><!-- --></a>
428 <div class="evenrow">
429
430 <div class="method-header">
431 <img src="../../media/images/StaticMethod.png" />
432 <span class="method-title">static SqlDurationFormat</span> (line <span class="line-number">1473</span>)
433 </div>
434
435 <!-- ========== Info from phpDoc block ========= -->
436
437 <div class="method-signature">
438 static <span class="method-result">void</span>
439 <span class="method-name">
440 SqlDurationFormat
441 </span>
442 ()
443 </div>
444
445
446
447 </div>
448 <a name="methodSqlUTCFormat" id="SqlUTCFormat"><!-- --></a>
449 <div class="oddrow">
450
451 <div class="method-header">
452 <img src="../../media/images/StaticMethod.png" />
453 <span class="method-title">static SqlUTCFormat</span> (line <span class="line-number">1463</span>)
454 </div>
455
456 <!-- ========== Info from phpDoc block ========= -->
457
458 <div class="method-signature">
459 static <span class="method-result">void</span>
460 <span class="method-name">
461 SqlUTCFormat
462 </span>
463 ()
464 </div>
465
466
467
468 </div>
469 <a name="methodiCalendar" id="iCalendar"><!-- --></a>
470 <div class="evenrow">
471
472 <div class="method-header">
473 <img src="../../media/images/Constructor.png" />
474 <span class="method-title">Constructor iCalendar</span> (line <span class="line-number">952</span>)
475 </div>
476
477 <!-- ========== Info from phpDoc block ========= -->
478
479 <div class="method-signature">
480 <span class="method-result">iCalendar</span>
481 <span class="method-name">
482 iCalendar
483 </span>
484 (<span class="var-type"></span>&nbsp;<span class="var-name">$args</span>)
485 </div>
486
487 <ul class="parameters">
488 <li>
489 <span class="var-type"></span>
490 <span class="var-name">$args</span> </li>
491 </ul>
492
493
494 </div>
495 <a name="methodAdd" id="Add"><!-- --></a>
496 <div class="oddrow">
497
498 <div class="method-header">
499 <img src="../../media/images/Method.png" />
500 <span class="method-title">Add</span> (line <span class="line-number">1361</span>)
501 </div>
502
503 <!-- ========== Info from phpDoc block ========= -->
504
505 <div class="method-signature">
506 <span class="method-result">void</span>
507 <span class="method-name">
508 Add
509 </span>
510 (<span class="var-type">string</span>&nbsp;<span class="var-name">$key</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$parameters</span> = <span class="var-default">null</span>])
511 </div>
512
513 <ul class="parameters">
514 <li>
515 <span class="var-type">string</span>
516 <span class="var-name">$key</span><span class="var-description">: The property key</span> </li>
517 <li>
518 <span class="var-type">string</span>
519 <span class="var-name">$value</span><span class="var-description">: The property value</span> </li>
520 <li>
521 <span class="var-type">string</span>
522 <span class="var-name">$parameters</span><span class="var-description">: Any parameters to set for the property, as an array of key/value pairs</span> </li>
523 </ul>
524
525
526 </div>
527 <a name="methodAddComponent" id="AddComponent"><!-- --></a>
528 <div class="evenrow">
529
530 <div class="method-header">
531 <img src="../../media/images/Method.png" />
532 <span class="method-title">AddComponent</span> (line <span class="line-number">1422</span>)
533 </div>
534
535 <!-- ========== Info from phpDoc block ========= -->
536
537 <div class="method-signature">
538 <span class="method-result">void</span>
539 <span class="method-name">
540 AddComponent
541 </span>
542 (<span class="var-type"><a href="../../awl/iCalendar/iCalComponent.html">iCalComponent</a></span>&nbsp;<span class="var-name">$new_component</span>)
543 </div>
544
545 <ul class="parameters">
546 <li>
547 <span class="var-type"><a href="../../awl/iCalendar/iCalComponent.html">iCalComponent</a></span>
548 <span class="var-name">$new_component</span><span class="var-description">: The new component to append to the set</span> </li>
549 </ul>
550
551
552 </div>
553 <a name="methodApplyFilter" id="ApplyFilter"><!-- --></a>
554 <div class="oddrow">
555
556 <div class="method-header">
557 <img src="../../media/images/Method.png" />
558 <span class="method-title">ApplyFilter</span> (line <span class="line-number">1590</span>)
559 </div>
560
561 <!-- ========== Info from phpDoc block ========= -->
562 <ul class="tags">
563 <li><span class="field">return:</span> Whether the filter passed / failed.</li>
564 <li><span class="field">todo:</span> Eventually we need to handle all of these possibilities, which will mean writing several routines: <ul><li>Get Property from Component</li><li>Get Parameter from Property</li><li>Test TimeRange</li></ul> For the moment we will leave these, until there is a perceived need.</li>
565 </ul>
566
567 <div class="method-signature">
568 <span class="method-result">boolean</span>
569 <span class="method-name">
570 ApplyFilter
571 </span>
572 (<span class="var-type">array</span>&nbsp;<span class="var-name">$filter</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$value</span>)
573 </div>
574
575 <ul class="parameters">
576 <li>
577 <span class="var-type">array</span>
578 <span class="var-name">$filter</span><span class="var-description">: An array of XMLElement defining the filter(s)</span> </li>
579 <li>
580 <span class="var-type">mixed</span>
581 <span class="var-name">$value</span><span class="var-description">: Either a string which is the single property, or an array of lines, for the component.</span> </li>
582 </ul>
583
584
585 </div>
586 <a name="methodBuildFromText" id="BuildFromText"><!-- --></a>
587 <div class="evenrow">
588
589 <div class="method-header">
590 <img src="../../media/images/Method.png" />
591 <span class="method-title">BuildFromText</span> (line <span class="line-number">1210</span>)
592 </div>
593
594 <!-- ========== Info from phpDoc block ========= -->
595 <p class="short-description">Build the iCalendar object from a text string which is a single iCalendar resource</p>
596 <ul class="tags">
597 <li><span class="field">var:</span> The RFC2445 iCalendar resource to be parsed</li>
598 <li><span class="field">todo:</span> Remove this function.</li>
599 </ul>
600
601 <div class="method-signature">
602 <span class="method-result">void</span>
603 <span class="method-name">
604 BuildFromText
605 </span>
606 (<span class="var-type"></span>&nbsp;<span class="var-name">$icalendar</span>)
607 </div>
608
609 <ul class="parameters">
610 <li>
611 <span class="var-type"></span>
612 <span class="var-name">$icalendar</span> </li>
613 </ul>
614
615
616 </div>
617 <a name="methodClearComponents" id="ClearComponents"><!-- --></a>
618 <div class="oddrow">
619
620 <div class="method-header">
621 <img src="../../media/images/Method.png" />
622 <span class="method-title">ClearComponents</span> (line <span class="line-number">1397</span>)
623 </div>
624
625 <!-- ========== Info from phpDoc block ========= -->
626
627 <div class="method-signature">
628 <span class="method-result">void</span>
629 <span class="method-name">
630 ClearComponents
631 </span>
632 ([<span class="var-type">string</span>&nbsp;<span class="var-name">$type</span> = <span class="var-default">null</span>])
633 </div>
634
635 <ul class="parameters">
636 <li>
637 <span class="var-type">string</span>
638 <span class="var-name">$type</span><span class="var-description">: The type of component - omit for all components</span> </li>
639 </ul>
640
641
642 </div>
643 <a name="methodDealWithTimeZones" id="DealWithTimeZones"><!-- --></a>
644 <div class="evenrow">
645
646 <div class="method-header">
647 <img src="../../media/images/Method.png" />
648 <span class="method-title">DealWithTimeZones</span> (line <span class="line-number">1264</span>)
649 </div>
650
651 <!-- ========== Info from phpDoc block ========= -->
652 <p class="short-description">Do what must be done with time zones from on file. Attempt to turn them into something that PostgreSQL can understand...</p>
653 <ul class="tags">
654 <li><span class="field">todo:</span> Remove this function.</li>
655 </ul>
656
657 <div class="method-signature">
658 <span class="method-result">void</span>
659 <span class="method-name">
660 DealWithTimeZones
661 </span>
662 ()
663 </div>
664
665
666
667 </div>
668 <a name="methodDefaultPropertyList" id="DefaultPropertyList"><!-- --></a>
669 <div class="oddrow">
670
671 <div class="method-header">
672 <img src="../../media/images/Method.png" />
673 <span class="method-title">DefaultPropertyList</span> (line <span class="line-number">1086</span>)
674 </div>
675
676 <!-- ========== Info from phpDoc block ========= -->
677 <p class="short-description">An array of property names that we should always want when rendering an iCalendar</p>
678 <ul class="tags">
679 <li><span class="field">todo:</span> Remove this function.</li>
680 </ul>
681
682 <div class="method-signature">
683 <span class="method-result">void</span>
684 <span class="method-name">
685 DefaultPropertyList
686 </span>
687 ()
688 </div>
689
690
691
692 </div>
693 <a name="methodExtractProperty" id="ExtractProperty"><!-- --></a>
694 <div class="evenrow">
695
696 <div class="method-header">
697 <img src="../../media/images/Method.png" />
698 <span class="method-title">ExtractProperty</span> (line <span class="line-number">1558</span>)
699 </div>
700
701 <!-- ========== Info from phpDoc block ========= -->
702 <ul class="tags">
703 <li><span class="field">return:</span> An array of iCalProperty objects</li>
704 </ul>
705
706 <div class="method-signature">
707 <span class="method-result">array</span>
708 <span class="method-name">
709 ExtractProperty
710 </span>
711 (<span class="var-type">array</span>&nbsp;<span class="var-name">$component</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$type</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$count</span> = <span class="var-default">9999</span>])
712 </div>
713
714 <ul class="parameters">
715 <li>
716 <span class="var-type">array</span>
717 <span class="var-name">$component</span><span class="var-description">: An array of lines of this component</span> </li>
718 <li>
719 <span class="var-type">string</span>
720 <span class="var-name">$type</span><span class="var-description">: The type of parameter</span> </li>
721 <li>
722 <span class="var-type"></span>
723 <span class="var-name">$count</span> </li>
724 </ul>
725
726
727 </div>
728 <a name="methodExtractSubComponent" id="ExtractSubComponent"><!-- --></a>
729 <div class="oddrow">
730
731 <div class="method-header">
732 <img src="../../media/images/Method.png" />
733 <span class="method-title">ExtractSubComponent</span> (line <span class="line-number">1522</span>)
734 </div>
735
736 <!-- ========== Info from phpDoc block ========= -->
737 <ul class="tags">
738 <li><span class="field">return:</span> The sub-component lines</li>
739 </ul>
740
741 <div class="method-signature">
742 <span class="method-result">array</span>
743 <span class="method-name">
744 ExtractSubComponent
745 </span>
746 (<span class="var-type">array</span>&nbsp;<span class="var-name">$component</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$type</span>, [<span class="var-type">int</span>&nbsp;<span class="var-name">$count</span> = <span class="var-default">9999</span>])
747 </div>
748
749 <ul class="parameters">
750 <li>
751 <span class="var-type">array</span>
752 <span class="var-name">$component</span><span class="var-description">: The component to be parsed</span> </li>
753 <li>
754 <span class="var-type">string</span>
755 <span class="var-name">$type</span><span class="var-description">: The type of sub-components to be extracted</span> </li>
756 <li>
757 <span class="var-type">int</span>
758 <span class="var-name">$count</span><span class="var-description">: The number of sub-components to extract (default: 9999)</span> </li>
759 </ul>
760
761
762 </div>
763 <a name="methodGet" id="Get"><!-- --></a>
764 <div class="evenrow">
765
766 <div class="method-header">
767 <img src="../../media/images/Method.png" />
768 <span class="method-title">Get</span> (line <span class="line-number">1318</span>)
769 </div>
770
771 <!-- ========== Info from phpDoc block ========= -->
772 <p class="short-description">Get the value of a property in the first non-VTIMEZONE</p>
773
774 <div class="method-signature">
775 <span class="method-result">void</span>
776 <span class="method-name">
777 Get
778 </span>
779 (<span class="var-type"></span>&nbsp;<span class="var-name">$key</span>)
780 </div>
781
782 <ul class="parameters">
783 <li>
784 <span class="var-type"></span>
785 <span class="var-name">$key</span> </li>
786 </ul>
787
788
789 </div>
790 <a name="methodGetComponents" id="GetComponents"><!-- --></a>
791 <div class="oddrow">
792
793 <div class="method-header">
794 <img src="../../media/images/Method.png" />
795 <span class="method-title">GetComponents</span> (line <span class="line-number">1386</span>)
796 </div>
797
798 <!-- ========== Info from phpDoc block ========= -->
799 <ul class="tags">
800 <li><span class="field">return:</span> an array of the sub-components</li>
801 </ul>
802
803 <div class="method-signature">
804 <span class="method-result">array</span>
805 <span class="method-name">
806 GetComponents
807 </span>
808 ([<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>])
809 </div>
810
811 <ul class="parameters">
812 <li>
813 <span class="var-type">string</span>
814 <span class="var-name">$type</span><span class="var-description">: The type to match (default: All)</span> </li>
815 <li>
816 <span class="var-type">boolean</span>
817 <span class="var-name">$normal_match</span><span class="var-description">: Set to false to invert the match (default: true)</span> </li>
818 </ul>
819
820
821 </div>
822 <a name="methodJustThisBitPlease" id="JustThisBitPlease"><!-- --></a>
823 <div class="evenrow">
824
825 <div class="method-header">
826 <img src="../../media/images/Method.png" />
827 <span class="method-title">JustThisBitPlease</span> (line <span class="line-number">1105</span>)
828 </div>
829
830 <!-- ========== Info from phpDoc block ========= -->
831 <p class="short-description">A function to extract the contents of a BEGIN:SOMETHING to END:SOMETHING (perhaps multiply) and return just that bit (or, of course, those bits :-)</p>
832 <ul class="tags">
833 <li><span class="field">var:</span> The type of thing(s) we want returned.</li>
834 <li><span class="field">return:</span> A string from BEGIN:SOMETHING to END:SOMETHING, possibly multiple of these</li>
835 <li><span class="field">todo:</span> Remove this function.</li>
836 </ul>
837
838 <div class="method-signature">
839 <span class="method-result">string</span>
840 <span class="method-name">
841 JustThisBitPlease
842 </span>
843 (<span class="var-type"></span>&nbsp;<span class="var-name">$type</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$count</span> = <span class="var-default">1</span>])
844 </div>
845
846 <ul class="parameters">
847 <li>
848 <span class="var-type"></span>
849 <span class="var-name">$type</span> </li>
850 <li>
851 <span class="var-type"></span>
852 <span class="var-name">$count</span> </li>
853 </ul>
854
855
856 </div>
857 <a name="methodMaskComponents" id="MaskComponents"><!-- --></a>
858 <div class="oddrow">
859
860 <div class="method-header">
861 <img src="../../media/images/Method.png" />
862 <span class="method-title">MaskComponents</span> (line <span class="line-number">1433</span>)
863 </div>
864
865 <!-- ========== Info from phpDoc block ========= -->
866
867 <div class="method-signature">
868 <span class="method-result">void</span>
869 <span class="method-name">
870 MaskComponents
871 </span>
872 (<span class="var-type">array</span>&nbsp;<span class="var-name">$keep</span>)
873 </div>
874
875 <ul class="parameters">
876 <li>
877 <span class="var-type">array</span>
878 <span class="var-name">$keep</span><span class="var-description">: An array of component types to be kept</span> </li>
879 </ul>
880
881
882 </div>
883 <a name="methodParseSomeLines" id="ParseSomeLines"><!-- --></a>
884 <div class="evenrow">
885
886 <div class="method-header">
887 <img src="../../media/images/Method.png" />
888 <span class="method-title">ParseSomeLines</span> (line <span class="line-number">1139</span>)
889 </div>
890
891 <!-- ========== Info from phpDoc block ========= -->
892 <p class="short-description">Function to parse lines from BEGIN:SOMETHING to END:SOMETHING into a nested array structure</p>
893 <ul class="tags">
894 <li><span class="field">var:</span> The &quot;SOMETHING&quot; from the BEGIN:SOMETHING line we just met</li>
895 <li><span class="field">return:</span> An array of the things we found between (excluding) the BEGIN &amp; END, some of which might be sub-arrays</li>
896 <li><span class="field">todo:</span> Remove this function.</li>
897 </ul>
898
899 <div class="method-signature">
900 <span class="method-result">arrayref</span>
901 <span class="method-name">
902 &amp;ParseSomeLines
903 </span>
904 (<span class="var-type"></span>&nbsp;<span class="var-name">$type</span>)
905 </div>
906
907 <ul class="parameters">
908 <li>
909 <span class="var-type"></span>
910 <span class="var-name">$type</span> </li>
911 </ul>
912
913
914 </div>
915 <a name="methodRender" id="Render"><!-- --></a>
916 <div class="oddrow">
917
918 <div class="method-header">
919 <img src="../../media/images/Method.png" />
920 <span class="method-title">Render</span> (line <span class="line-number">1723</span>)
921 </div>
922
923 <!-- ========== Info from phpDoc block ========= -->
924
925 <div class="method-signature">
926 <span class="method-result">void</span>
927 <span class="method-name">
928 Render
929 </span>
930 ([<span class="var-type">boolean</span>&nbsp;<span class="var-name">$as_calendar</span> = <span class="var-default">true</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$type</span> = <span class="var-default">null</span>], [<span class="var-type">array</span>&nbsp;<span class="var-name">$restrict_properties</span> = <span class="var-default">null</span>])
931 </div>
932
933 <ul class="parameters">
934 <li>
935 <span class="var-type">boolean</span>
936 <span class="var-name">$as_calendar</span><span class="var-description">: Whether or not to wrap the event in a VCALENDAR</span> </li>
937 <li>
938 <span class="var-type">string</span>
939 <span class="var-name">$type</span><span class="var-description">: The type of iCalendar object (VEVENT, VTODO, VFREEBUSY etc.)</span> </li>
940 <li>
941 <span class="var-type">array</span>
942 <span class="var-name">$restrict_properties</span><span class="var-description">: The names of the properties we want in our rendered result.</span> </li>
943 </ul>
944
945
946 </div>
947 <a name="methodRFC2445ContentEscape" id="RFC2445ContentEscape"><!-- --></a>
948 <div class="evenrow">
949
950 <div class="method-header">
951 <img src="../../media/images/Method.png" />
952 <span class="method-title">RFC2445ContentEscape</span> (line <span class="line-number">1487</span>)
953 </div>
954
955 <!-- ========== Info from phpDoc block ========= -->
956 <ul class="tags">
957 <li><span class="field">deprecated:</span> This function is deprecated and will be removed eventually.</li>
958 <li><span class="field">todo:</span> Remove this function.</li>
959 </ul>
960
961 <div class="method-signature">
962 <span class="method-result">void</span>
963 <span class="method-name">
964 RFC2445ContentEscape
965 </span>
966 (<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
967 </div>
968
969 <ul class="parameters">
970 <li>
971 <span class="var-type">string</span>
972 <span class="var-name">$name</span><span class="var-description">: The incoming name[;param] prefixing the string.</span> </li>
973 <li>
974 <span class="var-type">string</span>
975 <span class="var-name">$value</span><span class="var-description">: The incoming string to be escaped.</span> </li>
976 </ul>
977
978
979 </div>
980 <a name="methodRFC2445ContentUnescape" id="RFC2445ContentUnescape"><!-- --></a>
981 <div class="oddrow">
982
983 <div class="method-header">
984 <img src="../../media/images/Method.png" />
985 <span class="method-title">RFC2445ContentUnescape</span> (line <span class="line-number">1247</span>)
986 </div>
987
988 <!-- ========== Info from phpDoc block ========= -->
989 <p class="short-description">Returns a content string with the RFC2445 escaping removed</p>
990 <ul class="tags">
991 <li><span class="field">return:</span> The string with RFC2445 content escaping removed.</li>
992 <li><span class="field">todo:</span> Remove this function.</li>
993 </ul>
994
995 <div class="method-signature">
996 <span class="method-result">string</span>
997 <span class="method-name">
998 RFC2445ContentUnescape
999 </span>
1000 (<span class="var-type">string</span>&nbsp;<span class="var-name">$escaped</span>)
1001 </div>
1002
1003 <ul class="parameters">
1004 <li>
1005 <span class="var-type">string</span>
1006 <span class="var-name">$escaped</span><span class="var-description">: The incoming string to be escaped.</span> </li>
1007 </ul>
1008
1009
1010 </div>
1011 <a name="methodSaveTimeZones" id="SaveTimeZones"><!-- --></a>
1012 <div class="evenrow">
1013
1014 <div class="method-header">
1015 <img src="../../media/images/Method.png" />
1016 <span class="method-title">SaveTimeZones</span> (line <span class="line-number">1026</span>)
1017 </div>
1018
1019 <!-- ========== Info from phpDoc block ========= -->
1020
1021 <div class="method-signature">
1022 <span class="method-result">void</span>
1023 <span class="method-name">
1024 SaveTimeZones
1025 </span>
1026 ()
1027 </div>
1028
1029
1030
1031 </div>
1032 <a name="methodSet" id="Set"><!-- --></a>
1033 <div class="oddrow">
1034
1035 <div class="method-header">
1036 <img src="../../media/images/Method.png" />
1037 <span class="method-title">Set</span> (line <span class="line-number">1339</span>)
1038 </div>
1039
1040 <!-- ========== Info from phpDoc block ========= -->
1041 <p class="short-description">Set the value of a property</p>
1042
1043 <div class="method-signature">
1044 <span class="method-result">void</span>
1045 <span class="method-name">
1046 Set
1047 </span>
1048 (<span class="var-type"></span>&nbsp;<span class="var-name">$key</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$value</span>)
1049 </div>
1050
1051 <ul class="parameters">
1052 <li>
1053 <span class="var-type"></span>
1054 <span class="var-name">$key</span> </li>
1055 <li>
1056 <span class="var-type"></span>
1057 <span class="var-name">$value</span> </li>
1058 </ul>
1059
1060
1061 </div>
1062 <a name="methodSetComponents" id="SetComponents"><!-- --></a>
1063 <div class="evenrow">
1064
1065 <div class="method-header">
1066 <img src="../../media/images/Method.png" />
1067 <span class="method-title">SetComponents</span> (line <span class="line-number">1410</span>)
1068 </div>
1069
1070 <!-- ========== Info from phpDoc block ========= -->
1071
1072 <div class="method-signature">
1073 <span class="method-result">void</span>
1074 <span class="method-name">
1075 SetComponents
1076 </span>
1077 (<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>])
1078 </div>
1079
1080 <ul class="parameters">
1081 <li>
1082 <span class="var-type">string</span>
1083 <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>
1084 <li>
1085 <span class="var-type">array</span>
1086 <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>
1087 </ul>
1088
1089
1090 </div>
1091 <a name="methodTestFilter" id="TestFilter"><!-- --></a>
1092 <div class="oddrow">
1093
1094 <div class="method-header">
1095 <img src="../../media/images/Method.png" />
1096 <span class="method-title">TestFilter</span> (line <span class="line-number">1666</span>)
1097 </div>
1098
1099 <!-- ========== Info from phpDoc block ========= -->
1100 <ul class="tags">
1101 <li><span class="field">return:</span> Whether or not this iCalendar passes the test</li>
1102 </ul>
1103
1104 <div class="method-signature">
1105 <span class="method-result">boolean</span>
1106 <span class="method-name">
1107 TestFilter
1108 </span>
1109 (<span class="var-type"></span>&nbsp;<span class="var-name">$filters</span>, <span class="var-type">array</span>&nbsp;<span class="var-name">$filter</span>)
1110 </div>
1111
1112 <ul class="parameters">
1113 <li>
1114 <span class="var-type">array</span>
1115 <span class="var-name">$filter</span><span class="var-description">: An array of XMLElement defining the filter</span> </li>
1116 <li>
1117 <span class="var-type"></span>
1118 <span class="var-name">$filters</span> </li>
1119 </ul>
1120
1121
1122 </div>
1123
1124 </div>
1125 </div>
1126
1127
1128 <p class="notes" id="credit">
1129 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>
1130 </p>
1131 </div></body>
1132 </html>
Andrew's Web Libraries