?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
Preparing to release 0.45.
[awl.git] / docs / api / awl / vComponent / vComponent.html
blob17a3be8d5d95fee4f0bc1c451a5d3fe1572703f3
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">350</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">array</span>
211 <a href="#GetComponents" title="details" class="method-name">GetComponents</a>
212 ([<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>])
213 </div>
214
215 <div class="method-definition">
216 <img src="../../media/images/Method.png" alt=" "/>
217 <span class="method-result">void</span>
218 <a href="#GetProperties" title="details" class="method-name">GetProperties</a>
219 ([<span class="var-type"></span>&nbsp;<span class="var-name">$type</span> = <span class="var-default">null</span>])
220 </div>
221
222 <div class="method-definition">
223 <img src="../../media/images/Method.png" alt=" "/>
224 <span class="method-result">array</span>
225 <a href="#GetPropertiesByPath" title="details" class="method-name">GetPropertiesByPath</a>
226 (<span class="var-type"></span>&nbsp;<span class="var-name">$path</span>)
227 </div>
228
229 <div class="method-definition">
230 <img src="../../media/images/Method.png" alt=" "/>
231 <span class="method-result">void</span>
232 <a href="#GetProperty" title="details" class="method-name">GetProperty</a>
233 (<span class="var-type"></span>&nbsp;<span class="var-name">$type</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="#GetType" title="details" class="method-name">GetType</a>
240 ()
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="#MaskComponents" title="details" class="method-name">MaskComponents</a>
247 (<span class="var-type">array</span>&nbsp;<span class="var-name">$keep</span>)
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="#MaskProperties" title="details" class="method-name">MaskProperties</a>
254 (<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>])
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="#ParseFrom" title="details" class="method-name">ParseFrom</a>
261 (<span class="var-type">string</span>&nbsp;<span class="var-name">$content</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="#Render" title="details" class="method-name">Render</a>
268 ([<span class="var-type"></span>&nbsp;<span class="var-name">$restricted_properties</span> = <span class="var-default">null</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="#SetComponents" title="details" class="method-name">SetComponents</a>
275 (<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>])
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="#SetProperties" title="details" class="method-name">SetProperties</a>
282 (<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>])
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="#SetType" title="details" class="method-name">SetType</a>
289 (<span class="var-type"></span>&nbsp;<span class="var-name">$type</span>)
290 </div>
291
292 <div class="method-definition">
293 <img src="../../media/images/Method.png" alt=" "/>
294 <span class="method-result">boolean</span>
295 <a href="#TestFilter" title="details" class="method-name">TestFilter</a>
296 (<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>)
297 </div>
298
299 <div class="method-definition">
300 <img src="../../media/images/Method.png" alt=" "/>
301 <span class="method-result">void</span>
302 <a href="#UnwrapComponent" title="details" class="method-name">UnwrapComponent</a>
303 (<span class="var-type"></span>&nbsp;<span class="var-name">$content</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="#WrapComponent" title="details" class="method-name">WrapComponent</a>
310 (<span class="var-type"></span>&nbsp;<span class="var-name">$content</span>)
311 </div>
312 </div>
313 </div>
314 </div>
315
316 <a name="sec-vars"></a>
317 <div class="info-box">
318 <div class="info-box-title">Variables</div>
319 <div class="nav-bar">
320 <a href="#sec-description">Description</a> |
321 <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
322
323
324 |
325 <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
326
327 </div>
328 <div class="info-box-body">
329
330 <a name="var$components" id="$components"><!-- --></A>
331 <div class="evenrow">
332
333 <div class="var-header">
334 <img src="../../media/images/Variable.png" />
335 <span class="var-title">
336 <span class="var-type">array</span>
337 <span class="var-name">$components</span>
338 (line <span class="line-number">374</span>)
339 </span>
340 </div>
341
342 <!-- ========== Info from phpDoc block ========= -->
343 <p class="short-description">An array of (sub-)components, which are vComponent objects</p>
344 <ul class="tags">
345 <li><span class="field">access:</span> protected</li>
346 </ul>
347
348
349
350
351
352 </div>
353 <a name="var$properties" id="$properties"><!-- --></A>
354 <div class="oddrow">
355
356 <div class="var-header">
357 <img src="../../media/images/Variable.png" />
358 <span class="var-title">
359 <span class="var-type">array</span>
360 <span class="var-name">$properties</span>
361 (line <span class="line-number">367</span>)
362 </span>
363 </div>
364
365 <!-- ========== Info from phpDoc block ========= -->
366 <p class="short-description">An array of properties, which are vProperty objects</p>
367 <ul class="tags">
368 <li><span class="field">access:</span> protected</li>
369 </ul>
370
371
372
373
374
375 </div>
376 <a name="var$rendered" id="$rendered"><!-- --></A>
377 <div class="evenrow">
378
379 <div class="var-header">
380 <img src="../../media/images/Variable.png" />
381 <span class="var-title">
382 <span class="var-type">array</span>
383 <span class="var-name">$rendered</span>
384 (line <span class="line-number">381</span>)
385 </span>
386 </div>
387
388 <!-- ========== Info from phpDoc block ========= -->
389 <p class="short-description">The rendered result (or what was originally parsed, if there have been no changes)</p>
390 <ul class="tags">
391 <li><span class="field">access:</span> protected</li>
392 </ul>
393
394
395
396
397
398 </div>
399 <a name="var$type" id="$type"><!-- --></A>
400 <div class="oddrow">
401
402 <div class="var-header">
403 <img src="../../media/images/Variable.png" />
404 <span class="var-title">
405 <span class="var-type">string</span>
406 <span class="var-name">$type</span>
407 (line <span class="line-number">360</span>)
408 </span>
409 </div>
410
411 <!-- ========== Info from phpDoc block ========= -->
412 <p class="short-description">The type of this component, such as 'VEVENT', 'VTODO', 'VTIMEZONE', 'VCARD', etc.</p>
413 <ul class="tags">
414 <li><span class="field">access:</span> protected</li>
415 </ul>
416
417
418
419
420
421 </div>
422
423 </div>
424 </div>
425
426 <a name="sec-methods"></a>
427 <div class="info-box">
428 <div class="info-box-title">Methods</div>
429 <div class="nav-bar">
430 <a href="#sec-description">Description</a> |
431 <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
432 <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
433
434 </div>
435 <div class="info-box-body">
436 <A NAME='method_detail'></A>
437 <a name="method__construct" id="__construct"><!-- --></a>
438 <div class="evenrow">
439
440 <div class="method-header">
441 <img src="../../media/images/Constructor.png" />
442 <span class="method-title">Constructor __construct</span> (line <span class="line-number">388</span>)
443 </div>
444
445 <!-- ========== Info from phpDoc block ========= -->
446 <p class="short-description">A basic constructor</p>
447
448 <div class="method-signature">
449 <span class="method-result">vComponent</span>
450 <span class="method-name">
451 __construct
452 </span>
453 ([<span class="var-type"></span>&nbsp;<span class="var-name">$content</span> = <span class="var-default">null</span>])
454 </div>
455
456 <ul class="parameters">
457 <li>
458 <span class="var-type"></span>
459 <span class="var-name">$content</span> </li>
460 </ul>
461
462
463 </div>
464 <a name="methodAddComponent" id="AddComponent"><!-- --></a>
465 <div class="oddrow">
466
467 <div class="method-header">
468 <img src="../../media/images/Method.png" />
469 <span class="method-title">AddComponent</span> (line <span class="line-number">715</span>)
470 </div>
471
472 <!-- ========== Info from phpDoc block ========= -->
473 <p class="short-description">Adds a new subcomponent</p>
474
475 <div class="method-signature">
476 <span class="method-result">void</span>
477 <span class="method-name">
478 AddComponent
479 </span>
480 (<span class="var-type"><a href="../../awl/vComponent/vComponent.html">vComponent</a></span>&nbsp;<span class="var-name">$new_component</span>)
481 </div>
482
483 <ul class="parameters">
484 <li>
485 <span class="var-type"><a href="../../awl/vComponent/vComponent.html">vComponent</a></span>
486 <span class="var-name">$new_component</span><span class="var-description">: The new component to append to the set</span> </li>
487 </ul>
488
489
490 </div>
491 <a name="methodAddProperty" id="AddProperty"><!-- --></a>
492 <div class="evenrow">
493
494 <div class="method-header">
495 <img src="../../media/images/Method.png" />
496 <span class="method-title">AddProperty</span> (line <span class="line-number">621</span>)
497 </div>
498
499 <!-- ========== Info from phpDoc block ========= -->
500 <p class="short-description">Adds a new property</p>
501
502 <div class="method-signature">
503 <span class="method-result">void</span>
504 <span class="method-name">
505 AddProperty
506 </span>
507 (<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>])
508 </div>
509
510 <ul class="parameters">
511 <li>
512 <span class="var-type"><a href="../../awl/vComponent/vProperty.html">vProperty</a></span>
513 <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>
514 <li>
515 <span class="var-type">string</span>
516 <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>
517 <li>
518 <span class="var-type">array</span>
519 <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>
520 </ul>
521
522
523 </div>
524 <a name="methodClearComponents" id="ClearComponents"><!-- --></a>
525 <div class="oddrow">
526
527 <div class="method-header">
528 <img src="../../media/images/Method.png" />
529 <span class="method-title">ClearComponents</span> (line <span class="line-number">671</span>)
530 </div>
531
532 <!-- ========== Info from phpDoc block ========= -->
533 <p class="short-description">Clear all components, or the components matching a particular type</p>
534
535 <div class="method-signature">
536 <span class="method-result">void</span>
537 <span class="method-name">
538 ClearComponents
539 </span>
540 ([<span class="var-type">string</span>&nbsp;<span class="var-name">$type</span> = <span class="var-default">null</span>])
541 </div>
542
543 <ul class="parameters">
544 <li>
545 <span class="var-type">string</span>
546 <span class="var-name">$type</span><span class="var-description">: The type of component - omit for all components</span> </li>
547 </ul>
548
549
550 </div>
551 <a name="methodClearProperties" id="ClearProperties"><!-- --></a>
552 <div class="evenrow">
553
554 <div class="method-header">
555 <img src="../../media/images/Method.png" />
556 <span class="method-title">ClearProperties</span> (line <span class="line-number">583</span>)
557 </div>
558
559 <!-- ========== Info from phpDoc block ========= -->
560 <p class="short-description">Clear all properties, or the properties matching a particular type</p>
561
562 <div class="method-signature">
563 <span class="method-result">void</span>
564 <span class="method-name">
565 ClearProperties
566 </span>
567 ([<span class="var-type">string|array</span>&nbsp;<span class="var-name">$type</span> = <span class="var-default">null</span>])
568 </div>
569
570 <ul class="parameters">
571 <li>
572 <span class="var-type">string|array</span>
573 <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>
574 </ul>
575
576
577 </div>
578 <a name="methodCollectParameterValues" id="CollectParameterValues"><!-- --></a>
579 <div class="oddrow">
580
581 <div class="method-header">
582 <img src="../../media/images/Method.png" />
583 <span class="method-title">CollectParameterValues</span> (line <span class="line-number">403</span>)
584 </div>
585
586 <!-- ========== Info from phpDoc block ========= -->
587 <p class="short-description">Collect an array of all parameters of our properties which are the specified type</p>
588 <p class="description"><p>Mainly used for collecting the full variety of references TZIDs</p></p>
589
590 <div class="method-signature">
591 <span class="method-result">void</span>
592 <span class="method-name">
593 CollectParameterValues
594 </span>
595 (<span class="var-type"></span>&nbsp;<span class="var-name">$parameter_name</span>)
596 </div>
597
598 <ul class="parameters">
599 <li>
600 <span class="var-type"></span>
601 <span class="var-name">$parameter_name</span> </li>
602 </ul>
603
604
605 </div>
606 <a name="methodGetComponents" id="GetComponents"><!-- --></a>
607 <div class="evenrow">
608
609 <div class="method-header">
610 <img src="../../media/images/Method.png" />
611 <span class="method-title">GetComponents</span> (line <span class="line-number">646</span>)
612 </div>
613
614 <!-- ========== Info from phpDoc block ========= -->
615 <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>
616 <ul class="tags">
617 <li><span class="field">return:</span> an array of the sub-components</li>
618 </ul>
619
620 <div class="method-signature">
621 <span class="method-result">array</span>
622 <span class="method-name">
623 GetComponents
624 </span>
625 ([<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>])
626 </div>
627
628 <ul class="parameters">
629 <li>
630 <span class="var-type">mixed</span>
631 <span class="var-name">$type</span><span class="var-description">: The type(s) to match (default: All)</span> </li>
632 <li>
633 <span class="var-type">boolean</span>
634 <span class="var-name">$normal_match</span><span class="var-description">: Set to false to invert the match (default: true)</span> </li>
635 </ul>
636
637
638 </div>
639 <a name="methodGetProperties" id="GetProperties"><!-- --></a>
640 <div class="oddrow">
641
642 <div class="method-header">
643 <img src="../../media/images/Method.png" />
644 <span class="method-title">GetProperties</span> (line <span class="line-number">566</span>)
645 </div>
646
647 <!-- ========== Info from phpDoc block ========= -->
648 <p class="short-description">Get all properties, or the properties matching a particular type, or matching an</p>
649 <p class="description"><p>array associating property names with true values: array( 'PROPERTY' =&gt; true, 'PROPERTY2' =&gt; true )</p></p>
650
651 <div class="method-signature">
652 <span class="method-result">void</span>
653 <span class="method-name">
654 GetProperties
655 </span>
656 ([<span class="var-type"></span>&nbsp;<span class="var-name">$type</span> = <span class="var-default">null</span>])
657 </div>
658
659 <ul class="parameters">
660 <li>
661 <span class="var-type"></span>
662 <span class="var-name">$type</span> </li>
663 </ul>
664
665
666 </div>
667 <a name="methodGetPropertiesByPath" id="GetPropertiesByPath"><!-- --></a>
668 <div class="evenrow">
669
670 <div class="method-header">
671 <img src="../../media/images/Method.png" />
672 <span class="method-title">GetPropertiesByPath</span> (line <span class="line-number">800</span>)
673 </div>
674
675 <!-- ========== Info from phpDoc block ========= -->
676 <p class="short-description">Return an array of properties matching the specified path</p>
677 <ul class="tags">
678 <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>
679 </ul>
680
681 <div class="method-signature">
682 <span class="method-result">array</span>
683 <span class="method-name">
684 GetPropertiesByPath
685 </span>
686 (<span class="var-type"></span>&nbsp;<span class="var-name">$path</span>)
687 </div>
688
689 <ul class="parameters">
690 <li>
691 <span class="var-type"></span>
692 <span class="var-name">$path</span> </li>
693 </ul>
694
695
696 </div>
697 <a name="methodGetProperty" id="GetProperty"><!-- --></a>
698 <div class="oddrow">
699
700 <div class="method-header">
701 <img src="../../media/images/Method.png" />
702 <span class="method-title">GetProperty</span> (line <span class="line-number">551</span>)
703 </div>
704
705 <!-- ========== Info from phpDoc block ========= -->
706 <p class="short-description">Return the first instance of a property of this name</p>
707
708 <div class="method-signature">
709 <span class="method-result">void</span>
710 <span class="method-name">
711 GetProperty
712 </span>
713 (<span class="var-type"></span>&nbsp;<span class="var-name">$type</span>)
714 </div>
715
716 <ul class="parameters">
717 <li>
718 <span class="var-type"></span>
719 <span class="var-name">$type</span> </li>
720 </ul>
721
722
723 </div>
724 <a name="methodGetType" id="GetType"><!-- --></a>
725 <div class="evenrow">
726
727 <div class="method-header">
728 <img src="../../media/images/Method.png" />
729 <span class="method-title">GetType</span> (line <span class="line-number">533</span>)
730 </div>
731
732 <!-- ========== Info from phpDoc block ========= -->
733 <p class="short-description">Return the type of component which this is</p>
734
735 <div class="method-signature">
736 <span class="method-result">void</span>
737 <span class="method-name">
738 GetType
739 </span>
740 ()
741 </div>
742
743
744
745 </div>
746 <a name="methodMaskComponents" id="MaskComponents"><!-- --></a>
747 <div class="oddrow">
748
749 <div class="method-header">
750 <img src="../../media/images/Method.png" />
751 <span class="method-title">MaskComponents</span> (line <span class="line-number">733</span>)
752 </div>
753
754 <!-- ========== Info from phpDoc block ========= -->
755 <p class="short-description">Mask components, removing any that are not of the types in the list</p>
756
757 <div class="method-signature">
758 <span class="method-result">void</span>
759 <span class="method-name">
760 MaskComponents
761 </span>
762 (<span class="var-type">array</span>&nbsp;<span class="var-name">$keep</span>)
763 </div>
764
765 <ul class="parameters">
766 <li>
767 <span class="var-type">array</span>
768 <span class="var-name">$keep</span><span class="var-description">: An array of component types to be kept</span> </li>
769 </ul>
770
771
772 </div>
773 <a name="methodMaskProperties" id="MaskProperties"><!-- --></a>
774 <div class="evenrow">
775
776 <div class="method-header">
777 <img src="../../media/images/Method.png" />
778 <span class="method-title">MaskProperties</span> (line <span class="line-number">751</span>)
779 </div>
780
781 <!-- ========== Info from phpDoc block ========= -->
782 <p class="short-description">Mask properties, removing any that are not in the list</p>
783
784 <div class="method-signature">
785 <span class="method-result">void</span>
786 <span class="method-name">
787 MaskProperties
788 </span>
789 (<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>])
790 </div>
791
792 <ul class="parameters">
793 <li>
794 <span class="var-type">array</span>
795 <span class="var-name">$keep</span><span class="var-description">: An array of property names to be kept</span> </li>
796 <li>
797 <span class="var-type">array</span>
798 <span class="var-name">$component_list</span><span class="var-description">: An array of component types to check within</span> </li>
799 </ul>
800
801
802 </div>
803 <a name="methodParseFrom" id="ParseFrom"><!-- --></a>
804 <div class="oddrow">
805
806 <div class="method-header">
807 <img src="../../media/images/Method.png" />
808 <span class="method-title">ParseFrom</span> (line <span class="line-number">424</span>)
809 </div>
810
811 <!-- ========== Info from phpDoc block ========= -->
812 <p class="short-description">Parse the text $content into sets of vProperty &amp; vComponent within this vComponent</p>
813
814 <div class="method-signature">
815 <span class="method-result">void</span>
816 <span class="method-name">
817 ParseFrom
818 </span>
819 (<span class="var-type">string</span>&nbsp;<span class="var-name">$content</span>)
820 </div>
821
822 <ul class="parameters">
823 <li>
824 <span class="var-type">string</span>
825 <span class="var-name">$content</span><span class="var-description">: The raw RFC2445-compliant vComponent component, including BEGIN:TYPE &amp; END:TYPE</span> </li>
826 </ul>
827
828
829 </div>
830 <a name="methodRender" id="Render"><!-- --></a>
831 <div class="evenrow">
832
833 <div class="method-header">
834 <img src="../../media/images/Method.png" />
835 <span class="method-title">Render</span> (line <span class="line-number">769</span>)
836 </div>
837
838 <!-- ========== Info from phpDoc block ========= -->
839 <p class="short-description">Renders the component, possibly restricted to only the listed properties</p>
840
841 <div class="method-signature">
842 <span class="method-result">void</span>
843 <span class="method-name">
844 Render
845 </span>
846 ([<span class="var-type"></span>&nbsp;<span class="var-name">$restricted_properties</span> = <span class="var-default">null</span>])
847 </div>
848
849 <ul class="parameters">
850 <li>
851 <span class="var-type"></span>
852 <span class="var-name">$restricted_properties</span> </li>
853 </ul>
854
855
856 </div>
857 <a name="methodSetComponents" id="SetComponents"><!-- --></a>
858 <div class="oddrow">
859
860 <div class="method-header">
861 <img src="../../media/images/Method.png" />
862 <span class="method-title">SetComponents</span> (line <span class="line-number">701</span>)
863 </div>
864
865 <!-- ========== Info from phpDoc block ========= -->
866 <p class="short-description">Sets some or all sub-components of the component to the supplied new components</p>
867
868 <div class="method-signature">
869 <span class="method-result">void</span>
870 <span class="method-name">
871 SetComponents
872 </span>
873 (<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>])
874 </div>
875
876 <ul class="parameters">
877 <li>
878 <span class="var-type">string</span>
879 <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>
880 <li>
881 <span class="var-type">array</span>
882 <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>
883 </ul>
884
885
886 </div>
887 <a name="methodSetProperties" id="SetProperties"><!-- --></a>
888 <div class="evenrow">
889
890 <div class="method-header">
891 <img src="../../media/images/Method.png" />
892 <span class="method-title">SetProperties</span> (line <span class="line-number">605</span>)
893 </div>
894
895 <!-- ========== Info from phpDoc block ========= -->
896 <p class="short-description">Set all properties, or the ones matching a particular type</p>
897
898 <div class="method-signature">
899 <span class="method-result">void</span>
900 <span class="method-name">
901 SetProperties
902 </span>
903 (<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>])
904 </div>
905
906 <ul class="parameters">
907 <li>
908 <span class="var-type"></span>
909 <span class="var-name">$new_properties</span> </li>
910 <li>
911 <span class="var-type"></span>
912 <span class="var-name">$type</span> </li>
913 </ul>
914
915
916 </div>
917 <a name="methodSetType" id="SetType"><!-- --></a>
918 <div class="oddrow">
919
920 <div class="method-header">
921 <img src="../../media/images/Method.png" />
922 <span class="method-title">SetType</span> (line <span class="line-number">541</span>)
923 </div>
924
925 <!-- ========== Info from phpDoc block ========= -->
926 <p class="short-description">Set the type of component which this is</p>
927
928 <div class="method-signature">
929 <span class="method-result">void</span>
930 <span class="method-name">
931 SetType
932 </span>
933 (<span class="var-type"></span>&nbsp;<span class="var-name">$type</span>)
934 </div>
935
936 <ul class="parameters">
937 <li>
938 <span class="var-type"></span>
939 <span class="var-name">$type</span> </li>
940 </ul>
941
942
943 </div>
944 <a name="methodTestFilter" id="TestFilter"><!-- --></a>
945 <div class="evenrow">
946
947 <div class="method-header">
948 <img src="../../media/images/Method.png" />
949 <span class="method-title">TestFilter</span> (line <span class="line-number">853</span>)
950 </div>
951
952 <!-- ========== Info from phpDoc block ========= -->
953 <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>
954 <ul class="tags">
955 <li><span class="field">return:</span> Whether or not this vComponent passes the test</li>
956 </ul>
957
958 <div class="method-signature">
959 <span class="method-result">boolean</span>
960 <span class="method-name">
961 TestFilter
962 </span>
963 (<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>)
964 </div>
965
966 <ul class="parameters">
967 <li>
968 <span class="var-type">array</span>
969 <span class="var-name">$filter</span><span class="var-description">: An array of XMLElement defining the filter</span> </li>
970 <li>
971 <span class="var-type"></span>
972 <span class="var-name">$filters</span> </li>
973 </ul>
974
975
976 </div>
977 <a name="methodUnwrapComponent" id="UnwrapComponent"><!-- --></a>
978 <div class="oddrow">
979
980 <div class="method-header">
981 <img src="../../media/images/Method.png" />
982 <span class="method-title">UnwrapComponent</span> (line <span class="line-number">509</span>)
983 </div>
984
985 <!-- ========== Info from phpDoc block ========= -->
986 <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>
987
988 <div class="method-signature">
989 <span class="method-result">void</span>
990 <span class="method-name">
991 UnwrapComponent
992 </span>
993 (<span class="var-type"></span>&nbsp;<span class="var-name">$content</span>)
994 </div>
995
996 <ul class="parameters">
997 <li>
998 <span class="var-type"></span>
999 <span class="var-name">$content</span> </li>
1000 </ul>
1001
1002
1003 </div>
1004 <a name="methodWrapComponent" id="WrapComponent"><!-- --></a>
1005 <div class="evenrow">
1006
1007 <div class="method-header">
1008 <img src="../../media/images/Method.png" />
1009 <span class="method-title">WrapComponent</span> (line <span class="line-number">521</span>)
1010 </div>
1011
1012 <!-- ========== Info from phpDoc block ========= -->
1013 <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>
1014 <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>
1015
1016 <div class="method-signature">
1017 <span class="method-result">void</span>
1018 <span class="method-name">
1019 WrapComponent
1020 </span>
1021 (<span class="var-type"></span>&nbsp;<span class="var-name">$content</span>)
1022 </div>
1023
1024 <ul class="parameters">
1025 <li>
1026 <span class="var-type"></span>
1027 <span class="var-name">$content</span> </li>
1028 </ul>
1029
1030
1031 </div>
1032
1033 </div>
1034 </div>
1035
1036
1037 <p class="notes" id="credit">
1038 Documentation generated on Mon, 20 Sep 2010 12:52:19 +1200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
1039 </p>
1040 </div></body>
1041 </html>
Andrew's Web Libraries