?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
Release 0.51
[awl.git] / docs / api / awl / vComponent / vComponent.html
blobcdc34b06b97192f48b3aad8208570bbd3743cdc5
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 vComponent</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"> vComponent</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-descendents">Descendents</a>
99 | <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
100 | <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
101
102 </div>
103 <div class="info-box-body">
104 <!-- ========== Info from phpDoc block ========= -->
105 <p class="short-description">A Class for representing components within an vComponent</p>
106 <p class="notes">
107 Located in <a class="field" href="_vComponent.php.html">/vComponent.php</a> (line <span class="field">409</span>)
108 </p>
109
110
111 <pre></pre>
112
113 </div>
114 </div>
115
116 <a name="sec-descendents"></a>
117 <div class="info-box">
118 <div class="info-box-title">Direct descendents</div>
119 <div class="nav-bar">
120 <a href="#sec-description">Description</a> |
121 <span class="disabled">Descendents</span>
122 | <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
123 | <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
124
125 </div>
126 <div class="info-box-body">
127 <table cellpadding="2" cellspacing="0" class="class-table">
128 <tr>
129 <th class="class-table-header">Class</th>
130 <th class="class-table-header">Description</th>
131 </tr>
132 <tr>
133 <td style="padding-right: 2em; white-space: nowrap">
134 <img src="../../media/images/Class.png"
135 alt=" class"
136 title=" class"
137 style="vertical-align: center"/>
138 <a href="../../awl/vCalendar/vCalendar.html">vCalendar</a>
139 </td>
140 <td>
141 A Class for representing components within an vComponent
142 </td>
143 </tr>
144 </table>
145 </div>
146 </div>
147
148
149 <a name="sec-var-summary"></a>
150 <div class="info-box">
151 <div class="info-box-title">Variable Summary</span></div>
152 <div class="nav-bar">
153 <a href="#sec-description">Description</a> |
154 <a href="#sec-descendents">Descendants</a> |
155 <span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
156 |
157 <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
158
159 </div>
160 <div class="info-box-body">
161 <div class="var-summary">
162 <div class="var-title">
163 <img src="../../media/images/Variable.png" alt=" " />
164 <span class="var-type">array</span>
165 <a href="#$components" title="details" class="var-name">$components</a>
166 </div>
167 <div class="var-title">
168 <img src="../../media/images/Variable.png" alt=" " />
169 <span class="var-type">array</span>
170 <a href="#$properties" title="details" class="var-name">$properties</a>
171 </div>
172 <div class="var-title">
173 <img src="../../media/images/Variable.png" alt=" " />
174 <span class="var-type">array</span>
175 <a href="#$rendered" title="details" class="var-name">$rendered</a>
176 </div>
177 <div class="var-title">
178 <img src="../../media/images/Variable.png" alt=" " />
179 <span class="var-type">string</span>
180 <a href="#$type" title="details" class="var-name">$type</a>
181 </div>
182 </div>
183 </div>
184 </div>
185
186 <a name="sec-method-summary"></a>
187 <div class="info-box">
188 <div class="info-box-title">Method Summary</span></div>
189 <div class="nav-bar">
190 <a href="#sec-description">Description</a> |
191 <a href="#sec-descendents">Descendants</a> |
192 <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
193
194 |
195 <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
196 </div>
197 <div class="info-box-body">
198 <div class="method-summary">
199
200 <div class="method-definition">
201 <img src="../../media/images/Constructor.png" alt=" "/>
202 <span class="method-result">vComponent</span>
203 <a href="#__construct" title="details" class="method-name">__construct</a>
204 ([<span class="var-type"></span>&nbsp;<span class="var-name">$content</span> = <span class="var-default">null</span>])
205 </div>
206
207 <div class="method-definition">
208 <img src="../../media/images/Method.png" alt=" "/>
209 <span class="method-result">void</span>
210 <a href="#AddComponent" title="details" class="method-name">AddComponent</a>
211 (<span class="var-type"><a href="../../awl/vComponent/vComponent.html">vComponent</a></span>&nbsp;<span class="var-name">$new_component</span>)
212 </div>
213
214 <div class="method-definition">
215 <img src="../../media/images/Method.png" alt=" "/>
216 <span class="method-result">void</span>
217 <a href="#AddProperty" title="details" class="method-name">AddProperty</a>
218 (<span class="var-type"><a href="../../awl/vComponent/vProperty.html">vProperty</a></span>&nbsp;<span class="var-name">$new_property</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span> = <span class="var-default">null</span>], [<span class="var-type">array</span>&nbsp;<span class="var-name">$parameters</span> = <span class="var-default">null</span>])
219 </div>
220
221 <div class="method-definition">
222 <img src="../../media/images/Method.png" alt=" "/>
223 <span class="method-result">void</span>
224 <a href="#ClearComponents" title="details" class="method-name">ClearComponents</a>
225 ([<span class="var-type">string</span>&nbsp;<span class="var-name">$type</span> = <span class="var-default">null</span>])
226 </div>
227
228 <div class="method-definition">
229 <img src="../../media/images/Method.png" alt=" "/>
230 <span class="method-result">void</span>
231 <a href="#ClearProperties" title="details" class="method-name">ClearProperties</a>
232 ([<span class="var-type">string|array</span>&nbsp;<span class="var-name">$type</span> = <span class="var-default">null</span>])
233 </div>
234
235 <div class="method-definition">
236 <img src="../../media/images/Method.png" alt=" "/>
237 <span class="method-result">void</span>
238 <a href="#CollectParameterValues" title="details" class="method-name">CollectParameterValues</a>
239 (<span class="var-type"></span>&nbsp;<span class="var-name">$parameter_name</span>)
240 </div>
241
242 <div class="method-definition">
243 <img src="../../media/images/Method.png" alt=" "/>
244 <span class="method-result">void</span>
245 <a href="#ComponentCount" title="details" class="method-name">ComponentCount</a>
246 ()
247 </div>
248
249 <div class="method-definition">
250 <img src="../../media/images/Method.png" alt=" "/>
251 <span class="method-result">array</span>
252 <a href="#GetComponents" title="details" class="method-name">GetComponents</a>
253 ([<span class="var-type">mixed</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>])
254 </div>
255
256 <div class="method-definition">
257 <img src="../../media/images/Method.png" alt=" "/>
258 <span class="method-result">void</span>
259 <a href="#GetProperties" title="details" class="method-name">GetProperties</a>
260 ([<span class="var-type"></span>&nbsp;<span class="var-name">$type</span> = <span class="var-default">null</span>])
261 </div>
262
263 <div class="method-definition">
264 <img src="../../media/images/Method.png" alt=" "/>
265 <span class="method-result">array</span>
266 <a href="#GetPropertiesByPath" title="details" class="method-name">GetPropertiesByPath</a>
267 (<span class="var-type"></span>&nbsp;<span class="var-name">$path</span>)
268 </div>
269
270 <div class="method-definition">
271 <img src="../../media/images/Method.png" alt=" "/>
272 <span class="method-result">void</span>
273 <a href="#GetProperty" title="details" class="method-name">GetProperty</a>
274 (<span class="var-type"></span>&nbsp;<span class="var-name">$type</span>)
275 </div>
276
277 <div class="method-definition">
278 <img src="../../media/images/Method.png" alt=" "/>
279 <span class="method-result">void</span>
280 <a href="#GetPValue" title="details" class="method-name">GetPValue</a>
281 (<span class="var-type"></span>&nbsp;<span class="var-name">$type</span>)
282 </div>
283
284 <div class="method-definition">
285 <img src="../../media/images/Method.png" alt=" "/>
286 <span class="method-result">void</span>
287 <a href="#GetType" title="details" class="method-name">GetType</a>
288 ()
289 </div>
290
291 <div class="method-definition">
292 <img src="../../media/images/Method.png" alt=" "/>
293 <span class="method-result">void</span>
294 <a href="#MaskComponents" title="details" class="method-name">MaskComponents</a>
295 (<span class="var-type">array</span>&nbsp;<span class="var-name">$keep</span>, [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$recursive</span> = <span class="var-default">true</span>])
296 </div>
297
298 <div class="method-definition">
299 <img src="../../media/images/Method.png" alt=" "/>
300 <span class="method-result">void</span>
301 <a href="#MaskProperties" title="details" class="method-name">MaskProperties</a>
302 (<span class="var-type">array</span>&nbsp;<span class="var-name">$keep</span>, [<span class="var-type">array</span>&nbsp;<span class="var-name">$component_list</span> = <span class="var-default">null</span>])
303 </div>
304
305 <div class="method-definition">
306 <img src="../../media/images/Method.png" alt=" "/>
307 <span class="method-result">void</span>
308 <a href="#ParseFrom" title="details" class="method-name">ParseFrom</a>
309 (<span class="var-type">string</span>&nbsp;<span class="var-name">$content</span>)
310 </div>
311
312 <div class="method-definition">
313 <img src="../../media/images/Method.png" alt=" "/>
314 <span class="method-result">void</span>
315 <a href="#Render" title="details" class="method-name">Render</a>
316 ([<span class="var-type"></span>&nbsp;<span class="var-name">$restricted_properties</span> = <span class="var-default">null</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$force_rendering</span> = <span class="var-default">false</span>])
317 </div>
318
319 <div class="method-definition">
320 <img src="../../media/images/Method.png" alt=" "/>
321 <span class="method-result">void</span>
322 <a href="#SetComponents" title="details" class="method-name">SetComponents</a>
323 (<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>])
324 </div>
325
326 <div class="method-definition">
327 <img src="../../media/images/Method.png" alt=" "/>
328 <span class="method-result">void</span>
329 <a href="#SetProperties" title="details" class="method-name">SetProperties</a>
330 (<span class="var-type"></span>&nbsp;<span class="var-name">$new_properties</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$type</span> = <span class="var-default">null</span>])
331 </div>
332
333 <div class="method-definition">
334 <img src="../../media/images/Method.png" alt=" "/>
335 <span class="method-result">void</span>
336 <a href="#SetType" title="details" class="method-name">SetType</a>
337 (<span class="var-type"></span>&nbsp;<span class="var-name">$type</span>)
338 </div>
339
340 <div class="method-definition">
341 <img src="../../media/images/Method.png" alt=" "/>
342 <span class="method-result">boolean</span>
343 <a href="#TestFilter" title="details" class="method-name">TestFilter</a>
344 (<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>)
345 </div>
346
347 <div class="method-definition">
348 <img src="../../media/images/Method.png" alt=" "/>
349 <span class="method-result">void</span>
350 <a href="#UnwrapComponent" title="details" class="method-name">UnwrapComponent</a>
351 (<span class="var-type"></span>&nbsp;<span class="var-name">$content</span>)
352 </div>
353
354 <div class="method-definition">
355 <img src="../../media/images/Method.png" alt=" "/>
356 <span class="method-result">void</span>
357 <a href="#WrapComponent" title="details" class="method-name">WrapComponent</a>
358 (<span class="var-type"></span>&nbsp;<span class="var-name">$content</span>)
359 </div>
360
361 <div class="method-definition">
362 <img src="../../media/images/Method.png" alt=" "/>
363 <span class="method-result">void</span>
364 <a href="#__toString" title="details" class="method-name">__toString</a>
365 ()
366 </div>
367 </div>
368 </div>
369 </div>
370
371 <a name="sec-vars"></a>
372 <div class="info-box">
373 <div class="info-box-title">Variables</div>
374 <div class="nav-bar">
375 <a href="#sec-description">Description</a> |
376 <a href="#sec-descendents">Descendents</a> |
377 <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
378
379
380 |
381 <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
382
383 </div>
384 <div class="info-box-body">
385
386 <a name="var$components" id="$components"><!-- --></A>
387 <div class="oddrow">
388
389 <div class="var-header">
390 <img src="../../media/images/Variable.png" />
391 <span class="var-title">
392 <span class="var-type">array</span>
393 <span class="var-name">$components</span>
394 (line <span class="line-number">433</span>)
395 </span>
396 </div>
397
398 <!-- ========== Info from phpDoc block ========= -->
399 <p class="short-description">An array of (sub-)components, which are vComponent objects</p>
400 <ul class="tags">
401 <li><span class="field">access:</span> protected</li>
402 </ul>
403
404
405
406
407
408 </div>
409 <a name="var$properties" id="$properties"><!-- --></A>
410 <div class="evenrow">
411
412 <div class="var-header">
413 <img src="../../media/images/Variable.png" />
414 <span class="var-title">
415 <span class="var-type">array</span>
416 <span class="var-name">$properties</span>
417 (line <span class="line-number">426</span>)
418 </span>
419 </div>
420
421 <!-- ========== Info from phpDoc block ========= -->
422 <p class="short-description">An array of properties, which are vProperty objects</p>
423 <ul class="tags">
424 <li><span class="field">access:</span> protected</li>
425 </ul>
426
427
428
429
430
431 </div>
432 <a name="var$rendered" id="$rendered"><!-- --></A>
433 <div class="oddrow">
434
435 <div class="var-header">
436 <img src="../../media/images/Variable.png" />
437 <span class="var-title">
438 <span class="var-type">array</span>
439 <span class="var-name">$rendered</span>
440 (line <span class="line-number">440</span>)
441 </span>
442 </div>
443
444 <!-- ========== Info from phpDoc block ========= -->
445 <p class="short-description">The rendered result (or what was originally parsed, if there have been no changes)</p>
446 <ul class="tags">
447 <li><span class="field">access:</span> protected</li>
448 </ul>
449
450
451
452
453
454 </div>
455 <a name="var$type" id="$type"><!-- --></A>
456 <div class="evenrow">
457
458 <div class="var-header">
459 <img src="../../media/images/Variable.png" />
460 <span class="var-title">
461 <span class="var-type">string</span>
462 <span class="var-name">$type</span>
463 (line <span class="line-number">419</span>)
464 </span>
465 </div>
466
467 <!-- ========== Info from phpDoc block ========= -->
468 <p class="short-description">The type of this component, such as 'VEVENT', 'VTODO', 'VTIMEZONE', 'VCARD', etc.</p>
469 <ul class="tags">
470 <li><span class="field">access:</span> protected</li>
471 </ul>
472
473
474
475
476
477 </div>
478
479 </div>
480 </div>
481
482 <a name="sec-methods"></a>
483 <div class="info-box">
484 <div class="info-box-title">Methods</div>
485 <div class="nav-bar">
486 <a href="#sec-description">Description</a> |
487 <a href="#sec-descendents">Descendents</a> |
488 <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
489 <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
490
491 </div>
492 <div class="info-box-body">
493 <A NAME='method_detail'></A>
494 <a name="method__construct" id="__construct"><!-- --></a>
495 <div class="oddrow">
496
497 <div class="method-header">
498 <img src="../../media/images/Constructor.png" />
499 <span class="method-title">Constructor __construct</span> (line <span class="line-number">447</span>)
500 </div>
501
502 <!-- ========== Info from phpDoc block ========= -->
503 <p class="short-description">A basic constructor</p>
504
505 <div class="method-signature">
506 <span class="method-result">vComponent</span>
507 <span class="method-name">
508 __construct
509 </span>
510 ([<span class="var-type"></span>&nbsp;<span class="var-name">$content</span> = <span class="var-default">null</span>])
511 </div>
512
513 <ul class="parameters">
514 <li>
515 <span class="var-type"></span>
516 <span class="var-name">$content</span> </li>
517 </ul>
518
519
520 <hr class="separator" />
521 <div class="notes">Redefined in descendants as:</div>
522 <ul class="redefinitions">
523 <li>
524 <a href="../../awl/vCalendar/vCalendar.html#method__construct">vCalendar::__construct()</a>
525 : Constructor. If a string is passed it will be parsed as if it was an iCalendar object, otherwise a new vCalendar will be initialised with basic content. If an array of key value pairs is provided they will also be used as top-level properties.
526 </li>
527 </ul>
528 </div>
529 <a name="methodAddComponent" id="AddComponent"><!-- --></a>
530 <div class="evenrow">
531
532 <div class="method-header">
533 <img src="../../media/images/Method.png" />
534 <span class="method-title">AddComponent</span> (line <span class="line-number">796</span>)
535 </div>
536
537 <!-- ========== Info from phpDoc block ========= -->
538 <p class="short-description">Adds a new subcomponent</p>
539
540 <div class="method-signature">
541 <span class="method-result">void</span>
542 <span class="method-name">
543 AddComponent
544 </span>
545 (<span class="var-type"><a href="../../awl/vComponent/vComponent.html">vComponent</a></span>&nbsp;<span class="var-name">$new_component</span>)
546 </div>
547
548 <ul class="parameters">
549 <li>
550 <span class="var-type"><a href="../../awl/vComponent/vComponent.html">vComponent</a></span>
551 <span class="var-name">$new_component</span><span class="var-description">: The new component to append to the set</span> </li>
552 </ul>
553
554
555 </div>
556 <a name="methodAddProperty" id="AddProperty"><!-- --></a>
557 <div class="oddrow">
558
559 <div class="method-header">
560 <img src="../../media/images/Method.png" />
561 <span class="method-title">AddProperty</span> (line <span class="line-number">693</span>)
562 </div>
563
564 <!-- ========== Info from phpDoc block ========= -->
565 <p class="short-description">Adds a new property</p>
566
567 <div class="method-signature">
568 <span class="method-result">void</span>
569 <span class="method-name">
570 AddProperty
571 </span>
572 (<span class="var-type"><a href="../../awl/vComponent/vProperty.html">vProperty</a></span>&nbsp;<span class="var-name">$new_property</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span> = <span class="var-default">null</span>], [<span class="var-type">array</span>&nbsp;<span class="var-name">$parameters</span> = <span class="var-default">null</span>])
573 </div>
574
575 <ul class="parameters">
576 <li>
577 <span class="var-type"><a href="../../awl/vComponent/vProperty.html">vProperty</a></span>
578 <span class="var-name">$new_property</span><span class="var-description">: The new property to append to the set, or a string with the name</span> </li>
579 <li>
580 <span class="var-type">string</span>
581 <span class="var-name">$value</span><span class="var-description">: The value of the new property (default: param 1 is an vProperty with everything</span> </li>
582 <li>
583 <span class="var-type">array</span>
584 <span class="var-name">$parameters</span><span class="var-description">: The key/value parameter pairs (default: none, or param 1 is an vProperty with everything)</span> </li>
585 </ul>
586
587
588 </div>
589 <a name="methodClearComponents" id="ClearComponents"><!-- --></a>
590 <div class="evenrow">
591
592 <div class="method-header">
593 <img src="../../media/images/Method.png" />
594 <span class="method-title">ClearComponents</span> (line <span class="line-number">751</span>)
595 </div>
596
597 <!-- ========== Info from phpDoc block ========= -->
598 <p class="short-description">Clear all components, or the components matching a particular type</p>
599
600 <div class="method-signature">
601 <span class="method-result">void</span>
602 <span class="method-name">
603 ClearComponents
604 </span>
605 ([<span class="var-type">string</span>&nbsp;<span class="var-name">$type</span> = <span class="var-default">null</span>])
606 </div>
607
608 <ul class="parameters">
609 <li>
610 <span class="var-type">string</span>
611 <span class="var-name">$type</span><span class="var-description">: The type of component - omit for all components</span> </li>
612 </ul>
613
614
615 </div>
616 <a name="methodClearProperties" id="ClearProperties"><!-- --></a>
617 <div class="oddrow">
618
619 <div class="method-header">
620 <img src="../../media/images/Method.png" />
621 <span class="method-title">ClearProperties</span> (line <span class="line-number">655</span>)
622 </div>
623
624 <!-- ========== Info from phpDoc block ========= -->
625 <p class="short-description">Clear all properties, or the properties matching a particular type</p>
626
627 <div class="method-signature">
628 <span class="method-result">void</span>
629 <span class="method-name">
630 ClearProperties
631 </span>
632 ([<span class="var-type">string|array</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|array</span>
638 <span class="var-name">$type</span><span class="var-description">: The type of property - omit for all properties - or an array associating property names with true values: array( 'PROPERTY' =&gt; true, 'PROPERTY2' =&gt; true )</span> </li>
639 </ul>
640
641
642 </div>
643 <a name="methodCollectParameterValues" id="CollectParameterValues"><!-- --></a>
644 <div class="evenrow">
645
646 <div class="method-header">
647 <img src="../../media/images/Method.png" />
648 <span class="method-title">CollectParameterValues</span> (line <span class="line-number">462</span>)
649 </div>
650
651 <!-- ========== Info from phpDoc block ========= -->
652 <p class="short-description">Collect an array of all parameters of our properties which are the specified type</p>
653 <p class="description"><p>Mainly used for collecting the full variety of references TZIDs</p></p>
654
655 <div class="method-signature">
656 <span class="method-result">void</span>
657 <span class="method-name">
658 CollectParameterValues
659 </span>
660 (<span class="var-type"></span>&nbsp;<span class="var-name">$parameter_name</span>)
661 </div>
662
663 <ul class="parameters">
664 <li>
665 <span class="var-type"></span>
666 <span class="var-name">$parameter_name</span> </li>
667 </ul>
668
669
670 </div>
671 <a name="methodComponentCount" id="ComponentCount"><!-- --></a>
672 <div class="oddrow">
673
674 <div class="method-header">
675 <img src="../../media/images/Method.png" />
676 <span class="method-title">ComponentCount</span> (line <span class="line-number">712</span>)
677 </div>
678
679 <!-- ========== Info from phpDoc block ========= -->
680 <p class="short-description">Return number of components</p>
681
682 <div class="method-signature">
683 <span class="method-result">void</span>
684 <span class="method-name">
685 ComponentCount
686 </span>
687 ()
688 </div>
689
690
691
692 </div>
693 <a name="methodGetComponents" id="GetComponents"><!-- --></a>
694 <div class="evenrow">
695
696 <div class="method-header">
697 <img src="../../media/images/Method.png" />
698 <span class="method-title">GetComponents</span> (line <span class="line-number">726</span>)
699 </div>
700
701 <!-- ========== Info from phpDoc block ========= -->
702 <p class="short-description">Get all sub-components, or at least get those matching a type, or failling to match, should the second parameter be set to false. Component types may be a string or an array associating property names with true values: array( 'TYPE' =&gt; true, 'TYPE2' =&gt; true )</p>
703 <ul class="tags">
704 <li><span class="field">return:</span> an array of the sub-components</li>
705 </ul>
706
707 <div class="method-signature">
708 <span class="method-result">array</span>
709 <span class="method-name">
710 GetComponents
711 </span>
712 ([<span class="var-type">mixed</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>])
713 </div>
714
715 <ul class="parameters">
716 <li>
717 <span class="var-type">mixed</span>
718 <span class="var-name">$type</span><span class="var-description">: The type(s) to match (default: All)</span> </li>
719 <li>
720 <span class="var-type">boolean</span>
721 <span class="var-name">$normal_match</span><span class="var-description">: Set to false to invert the match (default: true)</span> </li>
722 </ul>
723
724
725 </div>
726 <a name="methodGetProperties" id="GetProperties"><!-- --></a>
727 <div class="oddrow">
728
729 <div class="method-header">
730 <img src="../../media/images/Method.png" />
731 <span class="method-title">GetProperties</span> (line <span class="line-number">638</span>)
732 </div>
733
734 <!-- ========== Info from phpDoc block ========= -->
735 <p class="short-description">Get all properties, or the properties matching a particular type, or matching an</p>
736 <p class="description"><p>array associating property names with true values: array( 'PROPERTY' =&gt; true, 'PROPERTY2' =&gt; true )</p></p>
737
738 <div class="method-signature">
739 <span class="method-result">void</span>
740 <span class="method-name">
741 GetProperties
742 </span>
743 ([<span class="var-type"></span>&nbsp;<span class="var-name">$type</span> = <span class="var-default">null</span>])
744 </div>
745
746 <ul class="parameters">
747 <li>
748 <span class="var-type"></span>
749 <span class="var-name">$type</span> </li>
750 </ul>
751
752
753 </div>
754 <a name="methodGetPropertiesByPath" id="GetPropertiesByPath"><!-- --></a>
755 <div class="evenrow">
756
757 <div class="method-header">
758 <img src="../../media/images/Method.png" />
759 <span class="method-title">GetPropertiesByPath</span> (line <span class="line-number">889</span>)
760 </div>
761
762 <!-- ========== Info from phpDoc block ========= -->
763 <p class="short-description">Return an array of properties matching the specified path</p>
764 <ul class="tags">
765 <li><span class="field">return:</span> An array of vProperty within the tree which match the path given, in the form [/]COMPONENT[/...]/PROPERTY in a syntax kind of similar to our poor man's XML queries. We also allow COMPONENT and PROPERTY to be !COMPONENT and !PROPERTY for ++fun.</li>
766 </ul>
767
768 <div class="method-signature">
769 <span class="method-result">array</span>
770 <span class="method-name">
771 GetPropertiesByPath
772 </span>
773 (<span class="var-type"></span>&nbsp;<span class="var-name">$path</span>)
774 </div>
775
776 <ul class="parameters">
777 <li>
778 <span class="var-type"></span>
779 <span class="var-name">$path</span> </li>
780 </ul>
781
782
783 </div>
784 <a name="methodGetProperty" id="GetProperty"><!-- --></a>
785 <div class="oddrow">
786
787 <div class="method-header">
788 <img src="../../media/images/Method.png" />
789 <span class="method-title">GetProperty</span> (line <span class="line-number">610</span>)
790 </div>
791
792 <!-- ========== Info from phpDoc block ========= -->
793 <p class="short-description">Return the first instance of a property of this name</p>
794
795 <div class="method-signature">
796 <span class="method-result">void</span>
797 <span class="method-name">
798 GetProperty
799 </span>
800 (<span class="var-type"></span>&nbsp;<span class="var-name">$type</span>)
801 </div>
802
803 <ul class="parameters">
804 <li>
805 <span class="var-type"></span>
806 <span class="var-name">$type</span> </li>
807 </ul>
808
809
810 </div>
811 <a name="methodGetPValue" id="GetPValue"><!-- --></a>
812 <div class="evenrow">
813
814 <div class="method-header">
815 <img src="../../media/images/Method.png" />
816 <span class="method-title">GetPValue</span> (line <span class="line-number">627</span>)
817 </div>
818
819 <!-- ========== Info from phpDoc block ========= -->
820 <p class="short-description">Return the value of the first instance of a property of this name, or null</p>
821
822 <div class="method-signature">
823 <span class="method-result">void</span>
824 <span class="method-name">
825 GetPValue
826 </span>
827 (<span class="var-type"></span>&nbsp;<span class="var-name">$type</span>)
828 </div>
829
830 <ul class="parameters">
831 <li>
832 <span class="var-type"></span>
833 <span class="var-name">$type</span> </li>
834 </ul>
835
836
837 </div>
838 <a name="methodGetType" id="GetType"><!-- --></a>
839 <div class="oddrow">
840
841 <div class="method-header">
842 <img src="../../media/images/Method.png" />
843 <span class="method-title">GetType</span> (line <span class="line-number">592</span>)
844 </div>
845
846 <!-- ========== Info from phpDoc block ========= -->
847 <p class="short-description">Return the type of component which this is</p>
848
849 <div class="method-signature">
850 <span class="method-result">void</span>
851 <span class="method-name">
852 GetType
853 </span>
854 ()
855 </div>
856
857
858
859 </div>
860 <a name="methodMaskComponents" id="MaskComponents"><!-- --></a>
861 <div class="evenrow">
862
863 <div class="method-header">
864 <img src="../../media/images/Method.png" />
865 <span class="method-title">MaskComponents</span> (line <span class="line-number">815</span>)
866 </div>
867
868 <!-- ========== Info from phpDoc block ========= -->
869 <p class="short-description">Mask components, removing any that are not of the types in the list</p>
870
871 <div class="method-signature">
872 <span class="method-result">void</span>
873 <span class="method-name">
874 MaskComponents
875 </span>
876 (<span class="var-type">array</span>&nbsp;<span class="var-name">$keep</span>, [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$recursive</span> = <span class="var-default">true</span>])
877 </div>
878
879 <ul class="parameters">
880 <li>
881 <span class="var-type">array</span>
882 <span class="var-name">$keep</span><span class="var-description">: An array of component types to be kept</span> </li>
883 <li>
884 <span class="var-type">boolean</span>
885 <span class="var-name">$recursive</span><span class="var-description">: (default true) Whether to recursively MaskComponents on the ones we find</span> </li>
886 </ul>
887
888
889 </div>
890 <a name="methodMaskProperties" id="MaskProperties"><!-- --></a>
891 <div class="oddrow">
892
893 <div class="method-header">
894 <img src="../../media/images/Method.png" />
895 <span class="method-title">MaskProperties</span> (line <span class="line-number">833</span>)
896 </div>
897
898 <!-- ========== Info from phpDoc block ========= -->
899 <p class="short-description">Mask properties, removing any that are not in the list</p>
900
901 <div class="method-signature">
902 <span class="method-result">void</span>
903 <span class="method-name">
904 MaskProperties
905 </span>
906 (<span class="var-type">array</span>&nbsp;<span class="var-name">$keep</span>, [<span class="var-type">array</span>&nbsp;<span class="var-name">$component_list</span> = <span class="var-default">null</span>])
907 </div>
908
909 <ul class="parameters">
910 <li>
911 <span class="var-type">array</span>
912 <span class="var-name">$keep</span><span class="var-description">: An array of property names to be kept</span> </li>
913 <li>
914 <span class="var-type">array</span>
915 <span class="var-name">$component_list</span><span class="var-description">: An array of component types to check within</span> </li>
916 </ul>
917
918
919 </div>
920 <a name="methodParseFrom" id="ParseFrom"><!-- --></a>
921 <div class="evenrow">
922
923 <div class="method-header">
924 <img src="../../media/images/Method.png" />
925 <span class="method-title">ParseFrom</span> (line <span class="line-number">483</span>)
926 </div>
927
928 <!-- ========== Info from phpDoc block ========= -->
929 <p class="short-description">Parse the text $content into sets of vProperty &amp; vComponent within this vComponent</p>
930
931 <div class="method-signature">
932 <span class="method-result">void</span>
933 <span class="method-name">
934 ParseFrom
935 </span>
936 (<span class="var-type">string</span>&nbsp;<span class="var-name">$content</span>)
937 </div>
938
939 <ul class="parameters">
940 <li>
941 <span class="var-type">string</span>
942 <span class="var-name">$content</span><span class="var-description">: The raw RFC2445-compliant vComponent component, including BEGIN:TYPE &amp; END:TYPE</span> </li>
943 </ul>
944
945
946 </div>
947 <a name="methodRender" id="Render"><!-- --></a>
948 <div class="oddrow">
949
950 <div class="method-header">
951 <img src="../../media/images/Method.png" />
952 <span class="method-title">Render</span> (line <span class="line-number">851</span>)
953 </div>
954
955 <!-- ========== Info from phpDoc block ========= -->
956 <p class="short-description">Renders the component, possibly restricted to only the listed properties</p>
957
958 <div class="method-signature">
959 <span class="method-result">void</span>
960 <span class="method-name">
961 Render
962 </span>
963 ([<span class="var-type"></span>&nbsp;<span class="var-name">$restricted_properties</span> = <span class="var-default">null</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$force_rendering</span> = <span class="var-default">false</span>])
964 </div>
965
966 <ul class="parameters">
967 <li>
968 <span class="var-type"></span>
969 <span class="var-name">$restricted_properties</span> </li>
970 <li>
971 <span class="var-type"></span>
972 <span class="var-name">$force_rendering</span> </li>
973 </ul>
974
975
976 </div>
977 <a name="methodSetComponents" id="SetComponents"><!-- --></a>
978 <div class="evenrow">
979
980 <div class="method-header">
981 <img src="../../media/images/Method.png" />
982 <span class="method-title">SetComponents</span> (line <span class="line-number">782</span>)
983 </div>
984
985 <!-- ========== Info from phpDoc block ========= -->
986 <p class="short-description">Sets some or all sub-components of the component to the supplied new components</p>
987
988 <div class="method-signature">
989 <span class="method-result">void</span>
990 <span class="method-name">
991 SetComponents
992 </span>
993 (<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>])
994 </div>
995
996 <ul class="parameters">
997 <li>
998 <span class="var-type">string</span>
999 <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>
1000 <li>
1001 <span class="var-type">array</span>
1002 <span class="var-name">$new_component</span><span class="var-description">: of vComponent $new_components The new components to replace the existing ones</span> </li>
1003 </ul>
1004
1005
1006 </div>
1007 <a name="methodSetProperties" id="SetProperties"><!-- --></a>
1008 <div class="oddrow">
1009
1010 <div class="method-header">
1011 <img src="../../media/images/Method.png" />
1012 <span class="method-title">SetProperties</span> (line <span class="line-number">677</span>)
1013 </div>
1014
1015 <!-- ========== Info from phpDoc block ========= -->
1016 <p class="short-description">Set all properties, or the ones matching a particular type</p>
1017
1018 <div class="method-signature">
1019 <span class="method-result">void</span>
1020 <span class="method-name">
1021 SetProperties
1022 </span>
1023 (<span class="var-type"></span>&nbsp;<span class="var-name">$new_properties</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$type</span> = <span class="var-default">null</span>])
1024 </div>
1025
1026 <ul class="parameters">
1027 <li>
1028 <span class="var-type"></span>
1029 <span class="var-name">$new_properties</span> </li>
1030 <li>
1031 <span class="var-type"></span>
1032 <span class="var-name">$type</span> </li>
1033 </ul>
1034
1035
1036 </div>
1037 <a name="methodSetType" id="SetType"><!-- --></a>
1038 <div class="evenrow">
1039
1040 <div class="method-header">
1041 <img src="../../media/images/Method.png" />
1042 <span class="method-title">SetType</span> (line <span class="line-number">600</span>)
1043 </div>
1044
1045 <!-- ========== Info from phpDoc block ========= -->
1046 <p class="short-description">Set the type of component which this is</p>
1047
1048 <div class="method-signature">
1049 <span class="method-result">void</span>
1050 <span class="method-name">
1051 SetType
1052 </span>
1053 (<span class="var-type"></span>&nbsp;<span class="var-name">$type</span>)
1054 </div>
1055
1056 <ul class="parameters">
1057 <li>
1058 <span class="var-type"></span>
1059 <span class="var-name">$type</span> </li>
1060 </ul>
1061
1062
1063 </div>
1064 <a name="methodTestFilter" id="TestFilter"><!-- --></a>
1065 <div class="oddrow">
1066
1067 <div class="method-header">
1068 <img src="../../media/images/Method.png" />
1069 <span class="method-title">TestFilter</span> (line <span class="line-number">942</span>)
1070 </div>
1071
1072 <!-- ========== Info from phpDoc block ========= -->
1073 <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>
1074 <ul class="tags">
1075 <li><span class="field">return:</span> Whether or not this vComponent passes the test</li>
1076 </ul>
1077
1078 <div class="method-signature">
1079 <span class="method-result">boolean</span>
1080 <span class="method-name">
1081 TestFilter
1082 </span>
1083 (<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>)
1084 </div>
1085
1086 <ul class="parameters">
1087 <li>
1088 <span class="var-type">array</span>
1089 <span class="var-name">$filter</span><span class="var-description">: An array of XMLElement defining the filter</span> </li>
1090 <li>
1091 <span class="var-type"></span>
1092 <span class="var-name">$filters</span> </li>
1093 </ul>
1094
1095
1096 </div>
1097 <a name="methodUnwrapComponent" id="UnwrapComponent"><!-- --></a>
1098 <div class="evenrow">
1099
1100 <div class="method-header">
1101 <img src="../../media/images/Method.png" />
1102 <span class="method-title">UnwrapComponent</span> (line <span class="line-number">568</span>)
1103 </div>
1104
1105 <!-- ========== Info from phpDoc block ========= -->
1106 <p class="short-description">This unescapes the (CRLF + linear space) wrapping specified in RFC2445. According to RFC2445 we should always end with CRLF but the CalDAV spec says that normalising XML parsers often muck with it and may remove the CR. We accept either case.</p>
1107
1108 <div class="method-signature">
1109 <span class="method-result">void</span>
1110 <span class="method-name">
1111 UnwrapComponent
1112 </span>
1113 (<span class="var-type"></span>&nbsp;<span class="var-name">$content</span>)
1114 </div>
1115
1116 <ul class="parameters">
1117 <li>
1118 <span class="var-type"></span>
1119 <span class="var-name">$content</span> </li>
1120 </ul>
1121
1122
1123 </div>
1124 <a name="methodWrapComponent" id="WrapComponent"><!-- --></a>
1125 <div class="oddrow">
1126
1127 <div class="method-header">
1128 <img src="../../media/images/Method.png" />
1129 <span class="method-title">WrapComponent</span> (line <span class="line-number">580</span>)
1130 </div>
1131
1132 <!-- ========== Info from phpDoc block ========= -->
1133 <p class="short-description">This imposes the (CRLF + linear space) wrapping specified in RFC2445. According to RFC2445 we should always end with CRLF but the CalDAV spec says that normalising XML parsers often muck with it and may remove the CR. We output RFC2445 compliance.</p>
1134 <p class="description"><p>In order to preserve pre-existing wrapping in the component, we split the incoming string on line breaks before running wordwrap over each component of that.</p></p>
1135
1136 <div class="method-signature">
1137 <span class="method-result">void</span>
1138 <span class="method-name">
1139 WrapComponent
1140 </span>
1141 (<span class="var-type"></span>&nbsp;<span class="var-name">$content</span>)
1142 </div>
1143
1144 <ul class="parameters">
1145 <li>
1146 <span class="var-type"></span>
1147 <span class="var-name">$content</span> </li>
1148 </ul>
1149
1150
1151 </div>
1152 <a name="method__toString" id="__toString"><!-- --></a>
1153 <div class="evenrow">
1154
1155 <div class="method-header">
1156 <img src="../../media/images/Method.png" />
1157 <span class="method-title">__toString</span> (line <span class="line-number">875</span>)
1158 </div>
1159
1160 <!-- ========== Info from phpDoc block ========= -->
1161 <ul class="tags">
1162 <li><span class="field">access:</span> public</li>
1163 </ul>
1164
1165 <div class="method-signature">
1166 <span class="method-result">void</span>
1167 <span class="method-name">
1168 __toString
1169 </span>
1170 ()
1171 </div>
1172
1173
1174
1175 </div>
1176
1177 </div>
1178 </div>
1179
1180
1181 <p class="notes" id="credit">
1182 Documentation generated on Fri, 13 Jan 2012 23:40:18 +1300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
1183 </p>
1184 </div></body>
1185 </html>
Andrew's Web Libraries