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