?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
Release 0.33
[awl.git] / docs / api / awl / iCalendar / iCalendar.html
blob697629dddac4c60c5f372b4773fa226dc210ecb1
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</p>
104 <p class="notes">
105 Located in <a class="field" href="_iCalendar.php.html">/iCalendar.php</a> (line <span class="field">625</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">iCalendar</span>
130 <a href="#iCalendar" title="details" class="method-name">iCalendar</a>
131 (<span class="var-type"></span>&nbsp;<span class="var-name">$args</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="#Add" title="details" class="method-name">Add</a>
138 (<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>])
139 </div>
140
141 <div class="method-definition">
142 <img src="../../media/images/Method.png" alt=" "/>
143 <span class="method-result">boolean</span>
144 <a href="#ApplyFilter" title="details" class="method-name">ApplyFilter</a>
145 (<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>)
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="#BuildFromText" title="details" class="method-name">BuildFromText</a>
152 (<span class="var-type"></span>&nbsp;<span class="var-name">$icalendar</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="#DealWithTimeZones" title="details" class="method-name">DealWithTimeZones</a>
159 ()
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="#DefaultPropertyList" title="details" class="method-name">DefaultPropertyList</a>
166 ()
167 </div>
168
169 <div class="method-definition">
170 <img src="../../media/images/Method.png" alt=" "/>
171 <span class="method-result">array</span>
172 <a href="#ExtractProperty" title="details" class="method-name">ExtractProperty</a>
173 (<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>])
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="#ExtractSubComponent" title="details" class="method-name">ExtractSubComponent</a>
180 (<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>])
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="#Get" title="details" class="method-name">Get</a>
187 (<span class="var-type"></span>&nbsp;<span class="var-name">$key</span>)
188 </div>
189
190 <div class="method-definition">
191 <img src="../../media/images/Method.png" alt=" "/>
192 <span class="method-result">void</span>
193 <a href="#HttpDateFormat" title="details" class="method-name">HttpDateFormat</a>
194 ()
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="#iCalFooter" title="details" class="method-name">iCalFooter</a>
201 ()
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="#iCalHeader" title="details" class="method-name">iCalHeader</a>
208 ()
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="#JustThisBitPlease" title="details" class="method-name">JustThisBitPlease</a>
215 (<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>])
216 </div>
217
218 <div class="method-definition">
219 <img src="../../media/images/Method.png" alt=" "/>
220 <span class="method-result">arrayref</span>
221 <a href="#ParseSomeLines" title="details" class="method-name">&amp;ParseSomeLines</a>
222 (<span class="var-type"></span>&nbsp;<span class="var-name">$type</span>)
223 </div>
224
225 <div class="method-definition">
226 <img src="../../media/images/Method.png" alt=" "/>
227 <span class="method-result">void</span>
228 <a href="#Put" title="details" class="method-name">Put</a>
229 (<span class="var-type"></span>&nbsp;<span class="var-name">$key</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$value</span>)
230 </div>
231
232 <div class="method-definition">
233 <img src="../../media/images/Method.png" alt=" "/>
234 <span class="method-result">void</span>
235 <a href="#Render" title="details" class="method-name">Render</a>
236 ([<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>])
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="#RFC2445ContentEscape" title="details" class="method-name">RFC2445ContentEscape</a>
243 (<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>)
244 </div>
245
246 <div class="method-definition">
247 <img src="../../media/images/Method.png" alt=" "/>
248 <span class="method-result">string</span>
249 <a href="#RFC2445ContentUnescape" title="details" class="method-name">RFC2445ContentUnescape</a>
250 (<span class="var-type">string</span>&nbsp;<span class="var-name">$escaped</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="#SaveTimeZones" title="details" class="method-name">SaveTimeZones</a>
257 ()
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="#Set" title="details" class="method-name">Set</a>
264 (<span class="var-type"></span>&nbsp;<span class="var-name">$key</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$value</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="#SqlDateFormat" title="details" class="method-name">SqlDateFormat</a>
271 ()
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="#SqlDurationFormat" title="details" class="method-name">SqlDurationFormat</a>
278 ()
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="#SqlUTCFormat" title="details" class="method-name">SqlUTCFormat</a>
285 ()
286 </div>
287
288 <div class="method-definition">
289 <img src="../../media/images/Method.png" alt=" "/>
290 <span class="method-result">boolean</span>
291 <a href="#TestFilter" title="details" class="method-name">TestFilter</a>
292 (<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>)
293 </div>
294 </div>
295 </div>
296 </div>
297
298
299 <a name="sec-methods"></a>
300 <div class="info-box">
301 <div class="info-box-title">Methods</div>
302 <div class="nav-bar">
303 <a href="#sec-description">Description</a> |
304 <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
305
306 </div>
307 <div class="info-box-body">
308 <A NAME='method_detail'></A>
309 <a name="methodiCalendar" id="iCalendar"><!-- --></a>
310 <div class="oddrow">
311
312 <div class="method-header">
313 <img src="../../media/images/Constructor.png" />
314 <span class="method-title">Constructor iCalendar</span> (line <span class="line-number">667</span>)
315 </div>
316
317 <!-- ========== Info from phpDoc block ========= -->
318 <p class="short-description">The constructor takes an array of args. If there is an element called 'icalendar' then that will be parsed into the iCalendar object. Otherwise the array elements are converted into properties of the iCalendar object directly.</p>
319
320 <div class="method-signature">
321 <span class="method-result">iCalendar</span>
322 <span class="method-name">
323 iCalendar
324 </span>
325 (<span class="var-type"></span>&nbsp;<span class="var-name">$args</span>)
326 </div>
327
328 <ul class="parameters">
329 <li>
330 <span class="var-type"></span>
331 <span class="var-name">$args</span> </li>
332 </ul>
333
334
335 </div>
336 <a name="methodAdd" id="Add"><!-- --></a>
337 <div class="evenrow">
338
339 <div class="method-header">
340 <img src="../../media/images/Method.png" />
341 <span class="method-title">Add</span> (line <span class="line-number">1082</span>)
342 </div>
343
344 <!-- ========== Info from phpDoc block ========= -->
345 <p class="short-description">Add a new property/value, regardless of whether it exists already</p>
346
347 <div class="method-signature">
348 <span class="method-result">void</span>
349 <span class="method-name">
350 Add
351 </span>
352 (<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>])
353 </div>
354
355 <ul class="parameters">
356 <li>
357 <span class="var-type">string</span>
358 <span class="var-name">$key</span><span class="var-description">: The property key</span> </li>
359 <li>
360 <span class="var-type">string</span>
361 <span class="var-name">$value</span><span class="var-description">: The property value</span> </li>
362 <li>
363 <span class="var-type">string</span>
364 <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>
365 </ul>
366
367
368 </div>
369 <a name="methodApplyFilter" id="ApplyFilter"><!-- --></a>
370 <div class="oddrow">
371
372 <div class="method-header">
373 <img src="../../media/images/Method.png" />
374 <span class="method-title">ApplyFilter</span> (line <span class="line-number">1248</span>)
375 </div>
376
377 <!-- ========== Info from phpDoc block ========= -->
378 <p class="short-description">Applies the filter conditions, possibly recursively, to the value which will be either a single property, or an array of lines of the component under test.</p>
379 <ul class="tags">
380 <li><span class="field">return:</span> Whether the filter passed / failed.</li>
381 <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>
382 </ul>
383
384 <div class="method-signature">
385 <span class="method-result">boolean</span>
386 <span class="method-name">
387 ApplyFilter
388 </span>
389 (<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>)
390 </div>
391
392 <ul class="parameters">
393 <li>
394 <span class="var-type">array</span>
395 <span class="var-name">$filter</span><span class="var-description">: An array of XMLElement defining the filter(s)</span> </li>
396 <li>
397 <span class="var-type">mixed</span>
398 <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>
399 </ul>
400
401
402 </div>
403 <a name="methodBuildFromText" id="BuildFromText"><!-- --></a>
404 <div class="evenrow">
405
406 <div class="method-header">
407 <img src="../../media/images/Method.png" />
408 <span class="method-title">BuildFromText</span> (line <span class="line-number">930</span>)
409 </div>
410
411 <!-- ========== Info from phpDoc block ========= -->
412 <p class="short-description">Build the iCalendar object from a text string which is a single iCalendar resource</p>
413 <ul class="tags">
414 <li><span class="field">var:</span> The RFC2445 iCalendar resource to be parsed</li>
415 <li><span class="field">deprecated:</span> This function is deprecated and will be removed eventually.</li>
416 <li><span class="field">TODO:</span> Remove this function.</li>
417 </ul>
418
419 <div class="method-signature">
420 <span class="method-result">void</span>
421 <span class="method-name">
422 BuildFromText
423 </span>
424 (<span class="var-type"></span>&nbsp;<span class="var-name">$icalendar</span>)
425 </div>
426
427 <ul class="parameters">
428 <li>
429 <span class="var-type"></span>
430 <span class="var-name">$icalendar</span> </li>
431 </ul>
432
433
434 </div>
435 <a name="methodDealWithTimeZones" id="DealWithTimeZones"><!-- --></a>
436 <div class="oddrow">
437
438 <div class="method-header">
439 <img src="../../media/images/Method.png" />
440 <span class="method-title">DealWithTimeZones</span> (line <span class="line-number">984</span>)
441 </div>
442
443 <!-- ========== Info from phpDoc block ========= -->
444 <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>
445 <ul class="tags">
446 <li><span class="field">deprecated:</span> This function is deprecated and will be removed eventually.</li>
447 <li><span class="field">TODO:</span> Remove this function.</li>
448 </ul>
449
450 <div class="method-signature">
451 <span class="method-result">void</span>
452 <span class="method-name">
453 DealWithTimeZones
454 </span>
455 ()
456 </div>
457
458
459
460 </div>
461 <a name="methodDefaultPropertyList" id="DefaultPropertyList"><!-- --></a>
462 <div class="evenrow">
463
464 <div class="method-header">
465 <img src="../../media/images/Method.png" />
466 <span class="method-title">DefaultPropertyList</span> (line <span class="line-number">806</span>)
467 </div>
468
469 <!-- ========== Info from phpDoc block ========= -->
470 <p class="short-description">An array of property names that we should always want when rendering an iCalendar</p>
471 <ul class="tags">
472 <li><span class="field">deprecated:</span> This function is deprecated and will be removed eventually.</li>
473 <li><span class="field">TODO:</span> Remove this function.</li>
474 </ul>
475
476 <div class="method-signature">
477 <span class="method-result">void</span>
478 <span class="method-name">
479 DefaultPropertyList
480 </span>
481 ()
482 </div>
483
484
485
486 </div>
487 <a name="methodExtractProperty" id="ExtractProperty"><!-- --></a>
488 <div class="oddrow">
489
490 <div class="method-header">
491 <img src="../../media/images/Method.png" />
492 <span class="method-title">ExtractProperty</span> (line <span class="line-number">1218</span>)
493 </div>
494
495 <!-- ========== Info from phpDoc block ========= -->
496 <p class="short-description">Extract a particular property from the provided component. In doing so we assume that the content was unescaped when iCalComponent::ParseFrom() called iCalComponent::UnwrapComponent().</p>
497 <ul class="tags">
498 <li><span class="field">return:</span> An array of iCalProperty objects</li>
499 </ul>
500
501 <div class="method-signature">
502 <span class="method-result">array</span>
503 <span class="method-name">
504 ExtractProperty
505 </span>
506 (<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>])
507 </div>
508
509 <ul class="parameters">
510 <li>
511 <span class="var-type">array</span>
512 <span class="var-name">$component</span><span class="var-description">: An array of lines of this component</span> </li>
513 <li>
514 <span class="var-type">string</span>
515 <span class="var-name">$type</span><span class="var-description">: The type of parameter</span> </li>
516 <li>
517 <span class="var-type"></span>
518 <span class="var-name">$count</span> </li>
519 </ul>
520
521
522 </div>
523 <a name="methodExtractSubComponent" id="ExtractSubComponent"><!-- --></a>
524 <div class="evenrow">
525
526 <div class="method-header">
527 <img src="../../media/images/Method.png" />
528 <span class="method-title">ExtractSubComponent</span> (line <span class="line-number">1184</span>)
529 </div>
530
531 <!-- ========== Info from phpDoc block ========= -->
532 <p class="short-description">Return all sub-components of the given type, which are part of the component we pass in as an array of lines.</p>
533 <ul class="tags">
534 <li><span class="field">return:</span> The sub-component lines</li>
535 </ul>
536
537 <div class="method-signature">
538 <span class="method-result">array</span>
539 <span class="method-name">
540 ExtractSubComponent
541 </span>
542 (<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>])
543 </div>
544
545 <ul class="parameters">
546 <li>
547 <span class="var-type">array</span>
548 <span class="var-name">$component</span><span class="var-description">: The component to be parsed</span> </li>
549 <li>
550 <span class="var-type">string</span>
551 <span class="var-name">$type</span><span class="var-description">: The type of sub-components to be extracted</span> </li>
552 <li>
553 <span class="var-type">int</span>
554 <span class="var-name">$count</span><span class="var-description">: The number of sub-components to extract (default: 9999)</span> </li>
555 </ul>
556
557
558 </div>
559 <a name="methodGet" id="Get"><!-- --></a>
560 <div class="oddrow">
561
562 <div class="method-header">
563 <img src="../../media/images/Method.png" />
564 <span class="method-title">Get</span> (line <span class="line-number">1037</span>)
565 </div>
566
567 <!-- ========== Info from phpDoc block ========= -->
568 <p class="short-description">Get the value of a property in the first non-VTIMEZONE</p>
569
570 <div class="method-signature">
571 <span class="method-result">void</span>
572 <span class="method-name">
573 Get
574 </span>
575 (<span class="var-type"></span>&nbsp;<span class="var-name">$key</span>)
576 </div>
577
578 <ul class="parameters">
579 <li>
580 <span class="var-type"></span>
581 <span class="var-name">$key</span> </li>
582 </ul>
583
584
585 </div>
586 <a name="methodHttpDateFormat" id="HttpDateFormat"><!-- --></a>
587 <div class="evenrow">
588
589 <div class="method-header">
590 <img src="../../media/images/Method.png" />
591 <span class="method-title">HttpDateFormat</span> (line <span class="line-number">1111</span>)
592 </div>
593
594 <!-- ========== Info from phpDoc block ========= -->
595 <p class="short-description">Returns a PostgreSQL Date Format string suitable for returning HTTP (RFC2068) dates Preferred is &quot;Sun, 06 Nov 1994 08:49:37 GMT&quot; so we do that.</p>
596
597 <div class="method-signature">
598 <span class="method-result">void</span>
599 <span class="method-name">
600 HttpDateFormat
601 </span>
602 ()
603 </div>
604
605
606
607 </div>
608 <a name="methodiCalFooter" id="iCalFooter"><!-- --></a>
609 <div class="oddrow">
610
611 <div class="method-header">
612 <img src="../../media/images/Method.png" />
613 <span class="method-title">iCalFooter</span> (line <span class="line-number">1363</span>)
614 </div>
615
616 <!-- ========== Info from phpDoc block ========= -->
617 <p class="short-description">Returns the footer we always use at the finish of our iCalendar resources</p>
618 <ul class="tags">
619 <li><span class="field">deprecated:</span> This function is deprecated and will be removed eventually.</li>
620 <li><span class="field">TODO:</span> Remove this function.</li>
621 </ul>
622
623 <div class="method-signature">
624 <span class="method-result">void</span>
625 <span class="method-name">
626 iCalFooter
627 </span>
628 ()
629 </div>
630
631
632
633 </div>
634 <a name="methodiCalHeader" id="iCalHeader"><!-- --></a>
635 <div class="evenrow">
636
637 <div class="method-header">
638 <img src="../../media/images/Method.png" />
639 <span class="method-title">iCalHeader</span> (line <span class="line-number">1346</span>)
640 </div>
641
642 <!-- ========== Info from phpDoc block ========= -->
643 <p class="short-description">Returns the header we always use at the start of our iCalendar resources</p>
644 <ul class="tags">
645 <li><span class="field">deprecated:</span> This function is deprecated and will be removed eventually.</li>
646 <li><span class="field">TODO:</span> Remove this function.</li>
647 </ul>
648
649 <div class="method-signature">
650 <span class="method-result">void</span>
651 <span class="method-name">
652 iCalHeader
653 </span>
654 ()
655 </div>
656
657
658
659 </div>
660 <a name="methodJustThisBitPlease" id="JustThisBitPlease"><!-- --></a>
661 <div class="oddrow">
662
663 <div class="method-header">
664 <img src="../../media/images/Method.png" />
665 <span class="method-title">JustThisBitPlease</span> (line <span class="line-number">825</span>)
666 </div>
667
668 <!-- ========== Info from phpDoc block ========= -->
669 <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>
670 <ul class="tags">
671 <li><span class="field">var:</span> The type of thing(s) we want returned.</li>
672 <li><span class="field">return:</span> A string from BEGIN:SOMETHING to END:SOMETHING, possibly multiple of these</li>
673 <li><span class="field">deprecated:</span> This function is deprecated and will be removed eventually.</li>
674 <li><span class="field">TODO:</span> Remove this function.</li>
675 </ul>
676
677 <div class="method-signature">
678 <span class="method-result">string</span>
679 <span class="method-name">
680 JustThisBitPlease
681 </span>
682 (<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>])
683 </div>
684
685 <ul class="parameters">
686 <li>
687 <span class="var-type"></span>
688 <span class="var-name">$type</span> </li>
689 <li>
690 <span class="var-type"></span>
691 <span class="var-name">$count</span> </li>
692 </ul>
693
694
695 </div>
696 <a name="methodParseSomeLines" id="ParseSomeLines"><!-- --></a>
697 <div class="evenrow">
698
699 <div class="method-header">
700 <img src="../../media/images/Method.png" />
701 <span class="method-title">ParseSomeLines</span> (line <span class="line-number">859</span>)
702 </div>
703
704 <!-- ========== Info from phpDoc block ========= -->
705 <p class="short-description">Function to parse lines from BEGIN:SOMETHING to END:SOMETHING into a nested array structure</p>
706 <ul class="tags">
707 <li><span class="field">var:</span> The &quot;SOMETHING&quot; from the BEGIN:SOMETHING line we just met</li>
708 <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>
709 <li><span class="field">deprecated:</span> This function is deprecated and will be removed eventually.</li>
710 <li><span class="field">TODO:</span> Remove this function.</li>
711 </ul>
712
713 <div class="method-signature">
714 <span class="method-result">arrayref</span>
715 <span class="method-name">
716 &amp;ParseSomeLines
717 </span>
718 (<span class="var-type"></span>&nbsp;<span class="var-name">$type</span>)
719 </div>
720
721 <ul class="parameters">
722 <li>
723 <span class="var-type"></span>
724 <span class="var-name">$type</span> </li>
725 </ul>
726
727
728 </div>
729 <a name="methodPut" id="Put"><!-- --></a>
730 <div class="oddrow">
731
732 <div class="method-header">
733 <img src="../../media/images/Method.png" />
734 <span class="method-title">Put</span> (line <span class="line-number">1102</span>)
735 </div>
736
737 <!-- ========== Info from phpDoc block ========= -->
738 <p class="short-description">Because I screwed up with the name originally...</p>
739
740 <div class="method-signature">
741 <span class="method-result">void</span>
742 <span class="method-name">
743 Put
744 </span>
745 (<span class="var-type"></span>&nbsp;<span class="var-name">$key</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$value</span>)
746 </div>
747
748 <ul class="parameters">
749 <li>
750 <span class="var-type"></span>
751 <span class="var-name">$key</span> </li>
752 <li>
753 <span class="var-type"></span>
754 <span class="var-name">$value</span> </li>
755 </ul>
756
757
758 </div>
759 <a name="methodRender" id="Render"><!-- --></a>
760 <div class="evenrow">
761
762 <div class="method-header">
763 <img src="../../media/images/Method.png" />
764 <span class="method-title">Render</span> (line <span class="line-number">1376</span>)
765 </div>
766
767 <!-- ========== Info from phpDoc block ========= -->
768 <p class="short-description">Render the iCalendar object as a text string which is a single VEVENT (or other)</p>
769
770 <div class="method-signature">
771 <span class="method-result">void</span>
772 <span class="method-name">
773 Render
774 </span>
775 ([<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>])
776 </div>
777
778 <ul class="parameters">
779 <li>
780 <span class="var-type">boolean</span>
781 <span class="var-name">$as_calendar</span><span class="var-description">: Whether or not to wrap the event in a VCALENDAR</span> </li>
782 <li>
783 <span class="var-type">string</span>
784 <span class="var-name">$type</span><span class="var-description">: The type of iCalendar object (VEVENT, VTODO, VFREEBUSY etc.)</span> </li>
785 <li>
786 <span class="var-type">array</span>
787 <span class="var-name">$restrict_properties</span><span class="var-description">: The names of the properties we want in our rendered result.</span> </li>
788 </ul>
789
790
791 </div>
792 <a name="methodRFC2445ContentEscape" id="RFC2445ContentEscape"><!-- --></a>
793 <div class="oddrow">
794
795 <div class="method-header">
796 <img src="../../media/images/Method.png" />
797 <span class="method-title">RFC2445ContentEscape</span> (line <span class="line-number">1150</span>)
798 </div>
799
800 <!-- ========== Info from phpDoc block ========= -->
801 <p class="short-description">Returns a suitably escaped RFC2445 content string.</p>
802 <ul class="tags">
803 <li><span class="field">deprecated:</span> This function is deprecated and will be removed eventually.</li>
804 <li><span class="field">TODO:</span> Remove this function.</li>
805 </ul>
806
807 <div class="method-signature">
808 <span class="method-result">void</span>
809 <span class="method-name">
810 RFC2445ContentEscape
811 </span>
812 (<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>)
813 </div>
814
815 <ul class="parameters">
816 <li>
817 <span class="var-type">string</span>
818 <span class="var-name">$name</span><span class="var-description">: The incoming name[;param] prefixing the string.</span> </li>
819 <li>
820 <span class="var-type">string</span>
821 <span class="var-name">$value</span><span class="var-description">: The incoming string to be escaped.</span> </li>
822 </ul>
823
824
825 </div>
826 <a name="methodRFC2445ContentUnescape" id="RFC2445ContentUnescape"><!-- --></a>
827 <div class="evenrow">
828
829 <div class="method-header">
830 <img src="../../media/images/Method.png" />
831 <span class="method-title">RFC2445ContentUnescape</span> (line <span class="line-number">967</span>)
832 </div>
833
834 <!-- ========== Info from phpDoc block ========= -->
835 <p class="short-description">Returns a content string with the RFC2445 escaping removed</p>
836 <ul class="tags">
837 <li><span class="field">return:</span> The string with RFC2445 content escaping removed.</li>
838 <li><span class="field">deprecated:</span> This function is deprecated and will be removed eventually.</li>
839 <li><span class="field">TODO:</span> Remove this function.</li>
840 </ul>
841
842 <div class="method-signature">
843 <span class="method-result">string</span>
844 <span class="method-name">
845 RFC2445ContentUnescape
846 </span>
847 (<span class="var-type">string</span>&nbsp;<span class="var-name">$escaped</span>)
848 </div>
849
850 <ul class="parameters">
851 <li>
852 <span class="var-type">string</span>
853 <span class="var-name">$escaped</span><span class="var-description">: The incoming string to be escaped.</span> </li>
854 </ul>
855
856
857 </div>
858 <a name="methodSaveTimeZones" id="SaveTimeZones"><!-- --></a>
859 <div class="oddrow">
860
861 <div class="method-header">
862 <img src="../../media/images/Method.png" />
863 <span class="method-title">SaveTimeZones</span> (line <span class="line-number">734</span>)
864 </div>
865
866 <!-- ========== Info from phpDoc block ========= -->
867 <p class="short-description">Save any timezones by TZID in the PostgreSQL database for future re-use.</p>
868
869 <div class="method-signature">
870 <span class="method-result">void</span>
871 <span class="method-name">
872 SaveTimeZones
873 </span>
874 ()
875 </div>
876
877
878
879 </div>
880 <a name="methodSet" id="Set"><!-- --></a>
881 <div class="evenrow">
882
883 <div class="method-header">
884 <img src="../../media/images/Method.png" />
885 <span class="method-title">Set</span> (line <span class="line-number">1062</span>)
886 </div>
887
888 <!-- ========== Info from phpDoc block ========= -->
889 <p class="short-description">Set the value of a property</p>
890
891 <div class="method-signature">
892 <span class="method-result">void</span>
893 <span class="method-name">
894 Set
895 </span>
896 (<span class="var-type"></span>&nbsp;<span class="var-name">$key</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$value</span>)
897 </div>
898
899 <ul class="parameters">
900 <li>
901 <span class="var-type"></span>
902 <span class="var-name">$key</span> </li>
903 <li>
904 <span class="var-type"></span>
905 <span class="var-name">$value</span> </li>
906 </ul>
907
908
909 </div>
910 <a name="methodSqlDateFormat" id="SqlDateFormat"><!-- --></a>
911 <div class="oddrow">
912
913 <div class="method-header">
914 <img src="../../media/images/Method.png" />
915 <span class="method-title">SqlDateFormat</span> (line <span class="line-number">1119</span>)
916 </div>
917
918 <!-- ========== Info from phpDoc block ========= -->
919 <p class="short-description">Returns a PostgreSQL Date Format string suitable for returning iCal dates</p>
920
921 <div class="method-signature">
922 <span class="method-result">void</span>
923 <span class="method-name">
924 SqlDateFormat
925 </span>
926 ()
927 </div>
928
929
930
931 </div>
932 <a name="methodSqlDurationFormat" id="SqlDurationFormat"><!-- --></a>
933 <div class="evenrow">
934
935 <div class="method-header">
936 <img src="../../media/images/Method.png" />
937 <span class="method-title">SqlDurationFormat</span> (line <span class="line-number">1137</span>)
938 </div>
939
940 <!-- ========== Info from phpDoc block ========= -->
941 <p class="short-description">Returns a PostgreSQL Date Format string suitable for returning iCal durations</p>
942 <p class="description"><p><ul><li>this doesn't work for negative intervals, but events should not have such!</li></ul></p></p>
943
944 <div class="method-signature">
945 <span class="method-result">void</span>
946 <span class="method-name">
947 SqlDurationFormat
948 </span>
949 ()
950 </div>
951
952
953
954 </div>
955 <a name="methodSqlUTCFormat" id="SqlUTCFormat"><!-- --></a>
956 <div class="oddrow">
957
958 <div class="method-header">
959 <img src="../../media/images/Method.png" />
960 <span class="method-title">SqlUTCFormat</span> (line <span class="line-number">1128</span>)
961 </div>
962
963 <!-- ========== Info from phpDoc block ========= -->
964 <p class="short-description">Returns a PostgreSQL Date Format string suitable for returning dates which</p>
965 <p class="description"><p>have been cast to UTC</p></p>
966
967 <div class="method-signature">
968 <span class="method-result">void</span>
969 <span class="method-name">
970 SqlUTCFormat
971 </span>
972 ()
973 </div>
974
975
976
977 </div>
978 <a name="methodTestFilter" id="TestFilter"><!-- --></a>
979 <div class="evenrow">
980
981 <div class="method-header">
982 <img src="../../media/images/Method.png" />
983 <span class="method-title">TestFilter</span> (line <span class="line-number">1322</span>)
984 </div>
985
986 <!-- ========== Info from phpDoc block ========= -->
987 <p class="short-description">Test a PROP-FILTER or COMP-FILTER and return a true/false COMP-FILTER (is-defined | is-not-defined | (time-range?, prop-filter*, comp-filter*)) PROP-FILTER (is-defined | is-not-defined | ((time-range | text-match)?, param-filter*))</p>
988 <ul class="tags">
989 <li><span class="field">return:</span> Whether or not this iCalendar passes the test</li>
990 </ul>
991
992 <div class="method-signature">
993 <span class="method-result">boolean</span>
994 <span class="method-name">
995 TestFilter
996 </span>
997 (<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>)
998 </div>
999
1000 <ul class="parameters">
1001 <li>
1002 <span class="var-type">array</span>
1003 <span class="var-name">$filter</span><span class="var-description">: An array of XMLElement defining the filter</span> </li>
1004 <li>
1005 <span class="var-type"></span>
1006 <span class="var-name">$filters</span> </li>
1007 </ul>
1008
1009
1010 </div>
1011
1012 </div>
1013 </div>
1014
1015
1016 <p class="notes" id="credit">
1017 Documentation generated on Tue, 28 Oct 2008 20:25:16 +1300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
1018 </p>
1019 </div></body>
1020 </html>
Andrew's Web Libraries