?  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 / iCalProp.html
blobd6ef11eb8faf73b4c4049466eae0fdc51aa49673
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 iCalProp</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"> iCalProp</h2>
92
93 <a name="sec-description"></a>
94 <div class="info-box">
95 <div class="info-box-title">Description</div>
96 <div class="nav-bar">
97 <span class="disabled">Description</span> |
98 <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
99
100 </div>
101 <div class="info-box-body">
102 <!-- ========== Info from phpDoc block ========= -->
103 <p class="short-description">A Class for representing properties within an iCalendar</p>
104 <p class="notes">
105 Located in <a class="field" href="_iCalendar.php.html">/iCalendar.php</a> (line <span class="field">57</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">iCalProp</span>
130 <a href="#iCalProp" title="details" class="method-name">iCalProp</a>
131 ([<span class="var-type">string</span>&nbsp;<span class="var-name">$propstring</span> = <span class="var-default">null</span>])
132 </div>
133
134 <div class="method-definition">
135 <img src="../../media/images/Method.png" alt=" "/>
136 <span class="method-result">string</span>
137 <a href="#GetParameterValue" title="details" class="method-name">GetParameterValue</a>
138 (<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>)
139 </div>
140
141 <div class="method-definition">
142 <img src="../../media/images/Method.png" alt=" "/>
143 <span class="method-result">string</span>
144 <a href="#Name" title="details" class="method-name">Name</a>
145 ([<span class="var-type">string</span>&nbsp;<span class="var-name">$newname</span> = <span class="var-default">null</span>])
146 </div>
147
148 <div class="method-definition">
149 <img src="../../media/images/Method.png" alt=" "/>
150 <span class="method-result">array</span>
151 <a href="#Parameters" title="details" class="method-name">Parameters</a>
152 ([<span class="var-type">array</span>&nbsp;<span class="var-name">$newparams</span> = <span class="var-default">null</span>])
153 </div>
154
155 <div class="method-definition">
156 <img src="../../media/images/Method.png" alt=" "/>
157 <span class="method-result">void</span>
158 <a href="#ParseFrom" title="details" class="method-name">ParseFrom</a>
159 (<span class="var-type">string</span>&nbsp;<span class="var-name">$propstring</span>)
160 </div>
161
162 <div class="method-definition">
163 <img src="../../media/images/Method.png" alt=" "/>
164 <span class="method-result">void</span>
165 <a href="#Render" title="details" class="method-name">Render</a>
166 ()
167 </div>
168
169 <div class="method-definition">
170 <img src="../../media/images/Method.png" alt=" "/>
171 <span class="method-result">void</span>
172 <a href="#RenderParameters" title="details" class="method-name">RenderParameters</a>
173 ()
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="#SetParameterValue" title="details" class="method-name">SetParameterValue</a>
180 (<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>)
181 </div>
182
183 <div class="method-definition">
184 <img src="../../media/images/Method.png" alt=" "/>
185 <span class="method-result">string</span>
186 <a href="#TextMatch" title="details" class="method-name">TextMatch</a>
187 (<span class="var-type">string</span>&nbsp;<span class="var-name">$search</span>)
188 </div>
189
190 <div class="method-definition">
191 <img src="../../media/images/Method.png" alt=" "/>
192 <span class="method-result">string</span>
193 <a href="#Value" title="details" class="method-name">Value</a>
194 ([<span class="var-type">string</span>&nbsp;<span class="var-name">$newvalue</span> = <span class="var-default">null</span>])
195 </div>
196 </div>
197 </div>
198 </div>
199
200
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>)
207
208 </div>
209 <div class="info-box-body">
210 <A NAME='method_detail'></A>
211 <a name="methodiCalProp" id="iCalProp"><!-- --></a>
212 <div class="evenrow">
213
214 <div class="method-header">
215 <img src="../../media/images/Constructor.png" />
216 <span class="method-title">Constructor iCalProp</span> (line <span class="line-number">100</span>)
217 </div>
218
219 <!-- ========== Info from phpDoc block ========= -->
220 <p class="short-description">The constructor parses the incoming string, which is formatted as per RFC2445 as a propname[;param1=pval1[; ... ]]:propvalue however we allow ourselves to assume that the RFC2445 content unescaping has already happened when iCalComponent::ParseFrom() called iCalComponent::UnwrapComponent().</p>
221
222 <div class="method-signature">
223 <span class="method-result">iCalProp</span>
224 <span class="method-name">
225 iCalProp
226 </span>
227 ([<span class="var-type">string</span>&nbsp;<span class="var-name">$propstring</span> = <span class="var-default">null</span>])
228 </div>
229
230 <ul class="parameters">
231 <li>
232 <span class="var-type">string</span>
233 <span class="var-name">$propstring</span><span class="var-description">: The string from the iCalendar which contains this property.</span> </li>
234 </ul>
235
236
237 </div>
238 <a name="methodGetParameterValue" id="GetParameterValue"><!-- --></a>
239 <div class="oddrow">
240
241 <div class="method-header">
242 <img src="../../media/images/Method.png" />
243 <span class="method-title">GetParameterValue</span> (line <span class="line-number">213</span>)
244 </div>
245
246 <!-- ========== Info from phpDoc block ========= -->
247 <p class="short-description">Get the value of a parameter</p>
248 <ul class="tags">
249 <li><span class="field">return:</span> The value of the parameter</li>
250 </ul>
251
252 <div class="method-signature">
253 <span class="method-result">string</span>
254 <span class="method-name">
255 GetParameterValue
256 </span>
257 (<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>)
258 </div>
259
260 <ul class="parameters">
261 <li>
262 <span class="var-type">string</span>
263 <span class="var-name">$name</span><span class="var-description">: The name of the parameter to retrieve the value for</span> </li>
264 </ul>
265
266
267 </div>
268 <a name="methodName" id="Name"><!-- --></a>
269 <div class="evenrow">
270
271 <div class="method-header">
272 <img src="../../media/images/Method.png" />
273 <span class="method-title">Name</span> (line <span class="line-number">151</span>)
274 </div>
275
276 <!-- ========== Info from phpDoc block ========= -->
277 <p class="short-description">Get/Set name property</p>
278 <ul class="tags">
279 <li><span class="field">return:</span> The name for the property.</li>
280 </ul>
281
282 <div class="method-signature">
283 <span class="method-result">string</span>
284 <span class="method-name">
285 Name
286 </span>
287 ([<span class="var-type">string</span>&nbsp;<span class="var-name">$newname</span> = <span class="var-default">null</span>])
288 </div>
289
290 <ul class="parameters">
291 <li>
292 <span class="var-type">string</span>
293 <span class="var-name">$newname</span><span class="var-description">: [optional] A new name for the property</span> </li>
294 </ul>
295
296
297 </div>
298 <a name="methodParameters" id="Parameters"><!-- --></a>
299 <div class="oddrow">
300
301 <div class="method-header">
302 <img src="../../media/images/Method.png" />
303 <span class="method-title">Parameters</span> (line <span class="line-number">184</span>)
304 </div>
305
306 <!-- ========== Info from phpDoc block ========= -->
307 <p class="short-description">Get/Set parameters in their entirety</p>
308 <ul class="tags">
309 <li><span class="field">return:</span> The current array of parameters for the property.</li>
310 </ul>
311
312 <div class="method-signature">
313 <span class="method-result">array</span>
314 <span class="method-name">
315 Parameters
316 </span>
317 ([<span class="var-type">array</span>&nbsp;<span class="var-name">$newparams</span> = <span class="var-default">null</span>])
318 </div>
319
320 <ul class="parameters">
321 <li>
322 <span class="var-type">array</span>
323 <span class="var-name">$newparams</span><span class="var-description">: An array of new parameter key/value pairs</span> </li>
324 </ul>
325
326
327 </div>
328 <a name="methodParseFrom" id="ParseFrom"><!-- --></a>
329 <div class="evenrow">
330
331 <div class="method-header">
332 <img src="../../media/images/Method.png" />
333 <span class="method-title">ParseFrom</span> (line <span class="line-number">119</span>)
334 </div>
335
336 <!-- ========== Info from phpDoc block ========= -->
337 <p class="short-description">The constructor parses the incoming string, which is formatted as per RFC2445 as a propname[;param1=pval1[; ... ]]:propvalue however we allow ourselves to assume that the RFC2445 content unescaping has already happened when iCalComponent::ParseFrom() called iCalComponent::UnwrapComponent().</p>
338
339 <div class="method-signature">
340 <span class="method-result">void</span>
341 <span class="method-name">
342 ParseFrom
343 </span>
344 (<span class="var-type">string</span>&nbsp;<span class="var-name">$propstring</span>)
345 </div>
346
347 <ul class="parameters">
348 <li>
349 <span class="var-type">string</span>
350 <span class="var-name">$propstring</span><span class="var-description">: The string from the iCalendar which contains this property.</span> </li>
351 </ul>
352
353
354 </div>
355 <a name="methodRender" id="Render"><!-- --></a>
356 <div class="oddrow">
357
358 <div class="method-header">
359 <img src="../../media/images/Method.png" />
360 <span class="method-title">Render</span> (line <span class="line-number">246</span>)
361 </div>
362
363 <!-- ========== Info from phpDoc block ========= -->
364 <p class="short-description">Render a suitably escaped RFC2445 content string.</p>
365
366 <div class="method-signature">
367 <span class="method-result">void</span>
368 <span class="method-name">
369 Render
370 </span>
371 ()
372 </div>
373
374
375
376 </div>
377 <a name="methodRenderParameters" id="RenderParameters"><!-- --></a>
378 <div class="evenrow">
379
380 <div class="method-header">
381 <img src="../../media/images/Method.png" />
382 <span class="method-title">RenderParameters</span> (line <span class="line-number">233</span>)
383 </div>
384
385 <!-- ========== Info from phpDoc block ========= -->
386 <p class="short-description">Render the set of parameters as key1=value1[;key2=value2[; ...]] with any colons or semicolons escaped.</p>
387
388 <div class="method-signature">
389 <span class="method-result">void</span>
390 <span class="method-name">
391 RenderParameters
392 </span>
393 ()
394 </div>
395
396
397
398 </div>
399 <a name="methodSetParameterValue" id="SetParameterValue"><!-- --></a>
400 <div class="oddrow">
401
402 <div class="method-header">
403 <img src="../../media/images/Method.png" />
404 <span class="method-title">SetParameterValue</span> (line <span class="line-number">224</span>)
405 </div>
406
407 <!-- ========== Info from phpDoc block ========= -->
408 <p class="short-description">Set the value of a parameter</p>
409
410 <div class="method-signature">
411 <span class="method-result">void</span>
412 <span class="method-name">
413 SetParameterValue
414 </span>
415 (<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>)
416 </div>
417
418 <ul class="parameters">
419 <li>
420 <span class="var-type">string</span>
421 <span class="var-name">$name</span><span class="var-description">: The name of the parameter to set the value for</span> </li>
422 <li>
423 <span class="var-type">string</span>
424 <span class="var-name">$value</span><span class="var-description">: The value of the parameter</span> </li>
425 </ul>
426
427
428 </div>
429 <a name="methodTextMatch" id="TextMatch"><!-- --></a>
430 <div class="evenrow">
431
432 <div class="method-header">
433 <img src="../../media/images/Method.png" />
434 <span class="method-title">TextMatch</span> (line <span class="line-number">200</span>)
435 </div>
436
437 <!-- ========== Info from phpDoc block ========= -->
438 <p class="short-description">Test if our value contains a string</p>
439 <ul class="tags">
440 <li><span class="field">return:</span> The name for the property.</li>
441 </ul>
442
443 <div class="method-signature">
444 <span class="method-result">string</span>
445 <span class="method-name">
446 TextMatch
447 </span>
448 (<span class="var-type">string</span>&nbsp;<span class="var-name">$search</span>)
449 </div>
450
451 <ul class="parameters">
452 <li>
453 <span class="var-type">string</span>
454 <span class="var-name">$search</span><span class="var-description">: The needle which we shall search the haystack for.</span> </li>
455 </ul>
456
457
458 </div>
459 <a name="methodValue" id="Value"><!-- --></a>
460 <div class="oddrow">
461
462 <div class="method-header">
463 <img src="../../media/images/Method.png" />
464 <span class="method-title">Value</span> (line <span class="line-number">168</span>)
465 </div>
466
467 <!-- ========== Info from phpDoc block ========= -->
468 <p class="short-description">Get/Set the content of the property</p>
469 <ul class="tags">
470 <li><span class="field">return:</span> The value of the property.</li>
471 </ul>
472
473 <div class="method-signature">
474 <span class="method-result">string</span>
475 <span class="method-name">
476 Value
477 </span>
478 ([<span class="var-type">string</span>&nbsp;<span class="var-name">$newvalue</span> = <span class="var-default">null</span>])
479 </div>
480
481 <ul class="parameters">
482 <li>
483 <span class="var-type">string</span>
484 <span class="var-name">$newvalue</span><span class="var-description">: [optional] A new value for the property</span> </li>
485 </ul>
486
487
488 </div>
489
490 </div>
491 </div>
492
493
494 <p class="notes" id="credit">
495 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>
496 </p>
497 </div></body>
498 </html>
Andrew's Web Libraries