The real release 0.46 :-)
[awl.git] / docs / api / awl / iCalendar / vEvent.html
blobc9ce21f69fc3ed58178be7e5a7e08b7357dee965
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 vEvent</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";
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;
33 oImg.src = imgMinus.src;
34 oTable.style.display = "block";
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;
55 oImg.src = imgPlus.src;
56 oTable.style.display = "none";
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;
74 return (oTable && oTable.style.display == "block");
77 function toggleNodeVisibility(Node){
78 if (nodeIsVisible(Node)){
79 hideNode(Node);
80 }else{
81 showNode(Node);
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"> vEvent</h2>
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>)
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="_vEvent.php.html">/vEvent.php</a> (line <span class="field">19</span>)
106 </p>
109 <pre></pre>
111 </div>
112 </div>
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">
127 <div class="method-definition">
128 <img src="../../media/images/Constructor.png" alt=" "/>
129 <span class="method-result">vEvent</span>
130 <a href="#vEvent" title="details" class="method-name">vEvent</a>
131 (<span class="var-type"></span>&nbsp;<span class="var-name">$args</span>)
132 </div>
134 <div class="method-definition">
135 <img src="../../media/images/Method.png" alt=" "/>
136 <span class="method-result">void</span>
137 <a href="#BuildFromText" title="details" class="method-name">BuildFromText</a>
138 (<span class="var-type"></span>&nbsp;<span class="var-name">$vevent</span>)
139 </div>
141 <div class="method-definition">
142 <img src="../../media/images/Method.png" alt=" "/>
143 <span class="method-result">void</span>
144 <a href="#DealWithTimeZones" title="details" class="method-name">DealWithTimeZones</a>
146 </div>
148 <div class="method-definition">
149 <img src="../../media/images/Method.png" alt=" "/>
150 <span class="method-result">void</span>
151 <a href="#Get" title="details" class="method-name">Get</a>
152 (<span class="var-type"></span>&nbsp;<span class="var-name">$key</span>)
153 </div>
155 <div class="method-definition">
156 <img src="../../media/images/Method.png" alt=" "/>
157 <span class="method-result">void</span>
158 <a href="#Put" title="details" class="method-name">Put</a>
159 (<span class="var-type"></span>&nbsp;<span class="var-name">$key</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$value</span>)
160 </div>
162 <div class="method-definition">
163 <img src="../../media/images/Method.png" alt=" "/>
164 <span class="method-result">void</span>
165 <a href="#Render" title="details" class="method-name">Render</a>
167 </div>
169 <div class="method-definition">
170 <img src="../../media/images/Method.png" alt=" "/>
171 <span class="method-result">void</span>
172 <a href="#RFC2445ContentEscape" title="details" class="method-name">RFC2445ContentEscape</a>
173 (<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>)
174 </div>
176 <div class="method-definition">
177 <img src="../../media/images/Method.png" alt=" "/>
178 <span class="method-result">void</span>
179 <a href="#SqlDateFormat" title="details" class="method-name">SqlDateFormat</a>
181 </div>
183 <div class="method-definition">
184 <img src="../../media/images/Method.png" alt=" "/>
185 <span class="method-result">void</span>
186 <a href="#SqlDurationFormat" title="details" class="method-name">SqlDurationFormat</a>
188 </div>
190 <div class="method-definition">
191 <img src="../../media/images/Method.png" alt=" "/>
192 <span class="method-result">void</span>
193 <a href="#SqlUTCFormat" title="details" class="method-name">SqlUTCFormat</a>
195 </div>
196 </div>
197 </div>
198 </div>
201 <a name="sec-methods"></a>
202 <div class="info-box">
203 <div class="info-box-title">Methods</div>
204 <div class="nav-bar">
205 <a href="#sec-description">Description</a> |
206 <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
208 </div>
209 <div class="info-box-body">
210 <A NAME='method_detail'></A>
211 <a name="methodvEvent" id="vEvent"><!-- --></a>
212 <div class="oddrow">
214 <div class="method-header">
215 <img src="../../media/images/Constructor.png" />
216 <span class="method-title">Constructor vEvent</span> (line <span class="line-number">55</span>)
217 </div>
219 <!-- ========== Info from phpDoc block ========= -->
220 <p class="short-description">The constructor takes an array of args. If there is an element called 'vevent' then that will be parsed into the vEvent object. Otherwise the array elements are converted into properties of the vEvent object directly.</p>
222 <div class="method-signature">
223 <span class="method-result">vEvent</span>
224 <span class="method-name">
225 vEvent
226 </span>
227 (<span class="var-type"></span>&nbsp;<span class="var-name">$args</span>)
228 </div>
230 <ul class="parameters">
231 <li>
232 <span class="var-type"></span>
233 <span class="var-name">$args</span> </li>
234 </ul>
237 </div>
238 <a name="methodBuildFromText" id="BuildFromText"><!-- --></a>
239 <div class="evenrow">
241 <div class="method-header">
242 <img src="../../media/images/Method.png" />
243 <span class="method-title">BuildFromText</span> (line <span class="line-number">83</span>)
244 </div>
246 <!-- ========== Info from phpDoc block ========= -->
247 <p class="short-description">Build the vEvent object from a text string which is a single VEVENT</p>
248 <ul class="tags">
249 <li><span class="field">var:</span> string</li>
250 </ul>
252 <div class="method-signature">
253 <span class="method-result">void</span>
254 <span class="method-name">
255 BuildFromText
256 </span>
257 (<span class="var-type"></span>&nbsp;<span class="var-name">$vevent</span>)
258 </div>
260 <ul class="parameters">
261 <li>
262 <span class="var-type"></span>
263 <span class="var-name">$vevent</span> </li>
264 </ul>
267 </div>
268 <a name="methodDealWithTimeZones" id="DealWithTimeZones"><!-- --></a>
269 <div class="oddrow">
271 <div class="method-header">
272 <img src="../../media/images/Method.png" />
273 <span class="method-title">DealWithTimeZones</span> (line <span class="line-number">163</span>)
274 </div>
276 <!-- ========== Info from phpDoc block ========= -->
277 <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>
279 <div class="method-signature">
280 <span class="method-result">void</span>
281 <span class="method-name">
282 DealWithTimeZones
283 </span>
285 </div>
289 </div>
290 <a name="methodGet" id="Get"><!-- --></a>
291 <div class="evenrow">
293 <div class="method-header">
294 <img src="../../media/images/Method.png" />
295 <span class="method-title">Get</span> (line <span class="line-number">188</span>)
296 </div>
298 <!-- ========== Info from phpDoc block ========= -->
299 <p class="short-description">Get the value of a property</p>
301 <div class="method-signature">
302 <span class="method-result">void</span>
303 <span class="method-name">
305 </span>
306 (<span class="var-type"></span>&nbsp;<span class="var-name">$key</span>)
307 </div>
309 <ul class="parameters">
310 <li>
311 <span class="var-type"></span>
312 <span class="var-name">$key</span> </li>
313 </ul>
316 </div>
317 <a name="methodPut" id="Put"><!-- --></a>
318 <div class="oddrow">
320 <div class="method-header">
321 <img src="../../media/images/Method.png" />
322 <span class="method-title">Put</span> (line <span class="line-number">196</span>)
323 </div>
325 <!-- ========== Info from phpDoc block ========= -->
326 <p class="short-description">Put the value of a property</p>
328 <div class="method-signature">
329 <span class="method-result">void</span>
330 <span class="method-name">
332 </span>
333 (<span class="var-type"></span>&nbsp;<span class="var-name">$key</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$value</span>)
334 </div>
336 <ul class="parameters">
337 <li>
338 <span class="var-type"></span>
339 <span class="var-name">$key</span> </li>
340 <li>
341 <span class="var-type"></span>
342 <span class="var-name">$value</span> </li>
343 </ul>
346 </div>
347 <a name="methodRender" id="Render"><!-- --></a>
348 <div class="evenrow">
350 <div class="method-header">
351 <img src="../../media/images/Method.png" />
352 <span class="method-title">Render</span> (line <span class="line-number">287</span>)
353 </div>
355 <!-- ========== Info from phpDoc block ========= -->
356 <p class="short-description">Render the vEvent object as a text string which is a single VEVENT</p>
358 <div class="method-signature">
359 <span class="method-result">void</span>
360 <span class="method-name">
361 Render
362 </span>
364 </div>
368 </div>
369 <a name="methodRFC2445ContentEscape" id="RFC2445ContentEscape"><!-- --></a>
370 <div class="oddrow">
372 <div class="method-header">
373 <img src="../../media/images/Method.png" />
374 <span class="method-title">RFC2445ContentEscape</span> (line <span class="line-number">232</span>)
375 </div>
377 <!-- ========== Info from phpDoc block ========= -->
378 <p class="short-description">Returns a suitably escaped RFC2445 content string.</p>
380 <div class="method-signature">
381 <span class="method-result">void</span>
382 <span class="method-name">
383 RFC2445ContentEscape
384 </span>
385 (<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>)
386 </div>
388 <ul class="parameters">
389 <li>
390 <span class="var-type">string</span>
391 <span class="var-name">$name</span><span class="var-description">: The incoming name[;param] prefixing the string.</span> </li>
392 <li>
393 <span class="var-type">string</span>
394 <span class="var-name">$value</span><span class="var-description">: The incoming string to be escaped.</span> </li>
395 </ul>
398 </div>
399 <a name="methodSqlDateFormat" id="SqlDateFormat"><!-- --></a>
400 <div class="evenrow">
402 <div class="method-header">
403 <img src="../../media/images/Method.png" />
404 <span class="method-title">SqlDateFormat</span> (line <span class="line-number">204</span>)
405 </div>
407 <!-- ========== Info from phpDoc block ========= -->
408 <p class="short-description">Returns a PostgreSQL Date Format string suitable for returning iCal dates</p>
410 <div class="method-signature">
411 <span class="method-result">void</span>
412 <span class="method-name">
413 SqlDateFormat
414 </span>
416 </div>
420 </div>
421 <a name="methodSqlDurationFormat" id="SqlDurationFormat"><!-- --></a>
422 <div class="oddrow">
424 <div class="method-header">
425 <img src="../../media/images/Method.png" />
426 <span class="method-title">SqlDurationFormat</span> (line <span class="line-number">222</span>)
427 </div>
429 <!-- ========== Info from phpDoc block ========= -->
430 <p class="short-description">Returns a PostgreSQL Date Format string suitable for returning iCal durations</p>
431 <p class="description"><p><ul><li>this doesn't work for negative intervals, but events should not have such!</li></ul></p></p>
433 <div class="method-signature">
434 <span class="method-result">void</span>
435 <span class="method-name">
436 SqlDurationFormat
437 </span>
439 </div>
443 </div>
444 <a name="methodSqlUTCFormat" id="SqlUTCFormat"><!-- --></a>
445 <div class="evenrow">
447 <div class="method-header">
448 <img src="../../media/images/Method.png" />
449 <span class="method-title">SqlUTCFormat</span> (line <span class="line-number">213</span>)
450 </div>
452 <!-- ========== Info from phpDoc block ========= -->
453 <p class="short-description">Returns a PostgreSQL Date Format string suitable for returning dates which</p>
454 <p class="description"><p>have been cast to UTC</p></p>
456 <div class="method-signature">
457 <span class="method-result">void</span>
458 <span class="method-name">
459 SqlUTCFormat
460 </span>
462 </div>
466 </div>
468 </div>
469 </div>
472 <p class="notes" id="credit">
473 Documentation generated on Tue, 28 Dec 2010 02:01:38 +1300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
474 </p>
475 </div></body>
476 </html>