?  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 / vProperty.html
blob9490c8b218be98c033ec9f7c08358de39369fba3
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 vProperty</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"> vProperty</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 properties within a vComponent (VCALENDAR or VCARD)</p>
105 <p class="notes">
106 Located in <a class="field" href="_vComponent.php.html">/vComponent.php</a> (line <span class="field">23</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">string</span>
132 <a href="#$content" title="details" class="var-name">$content</a>
133 </div>
134 <div class="var-title">
135 <img src="../../media/images/Variable.png" alt=" " />
136 <span class="var-type">string</span>
137 <a href="#$name" title="details" class="var-name">$name</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="#$parameters" title="details" class="var-name">$parameters</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="#$rendered" title="details" class="var-name">$rendered</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">vProperty</span>
169 <a href="#__construct" title="details" class="method-name">__construct</a>
170 ([<span class="var-type">string</span>&nbsp;<span class="var-name">$propstring</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">string</span>
176 <a href="#GetParameterValue" title="details" class="method-name">GetParameterValue</a>
177 (<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>)
178 </div>
179
180 <div class="method-definition">
181 <img src="../../media/images/Method.png" alt=" "/>
182 <span class="method-result">string</span>
183 <a href="#Name" title="details" class="method-name">Name</a>
184 ([<span class="var-type">string</span>&nbsp;<span class="var-name">$newname</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">array</span>
190 <a href="#Parameters" title="details" class="method-name">Parameters</a>
191 ([<span class="var-type">array</span>&nbsp;<span class="var-name">$newparams</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="#ParseFrom" title="details" class="method-name">ParseFrom</a>
198 (<span class="var-type">string</span>&nbsp;<span class="var-name">$propstring</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="#Render" title="details" class="method-name">Render</a>
205 ()
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="#RenderParameters" title="details" class="method-name">RenderParameters</a>
212 ()
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="#SetParameterValue" title="details" class="method-name">SetParameterValue</a>
219 (<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
220 </div>
221
222 <div class="method-definition">
223 <img src="../../media/images/Method.png" alt=" "/>
224 <span class="method-result">boolean</span>
225 <a href="#TestFilter" title="details" class="method-name">TestFilter</a>
226 (<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>)
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="#TestParamFilter" title="details" class="method-name">TestParamFilter</a>
233 (<span class="var-type"></span>&nbsp;<span class="var-name">$filters</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$parameter_value</span>)
234 </div>
235
236 <div class="method-definition">
237 <img src="../../media/images/Method.png" alt=" "/>
238 <span class="method-result">string</span>
239 <a href="#TextMatch" title="details" class="method-name">TextMatch</a>
240 (<span class="var-type">string</span>&nbsp;<span class="var-name">$search</span>)
241 </div>
242
243 <div class="method-definition">
244 <img src="../../media/images/Method.png" alt=" "/>
245 <span class="method-result">string</span>
246 <a href="#Value" title="details" class="method-name">Value</a>
247 ([<span class="var-type">string</span>&nbsp;<span class="var-name">$newvalue</span> = <span class="var-default">null</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="#__toString" title="details" class="method-name">__toString</a>
254 ()
255 </div>
256 </div>
257 </div>
258 </div>
259
260 <a name="sec-vars"></a>
261 <div class="info-box">
262 <div class="info-box-title">Variables</div>
263 <div class="nav-bar">
264 <a href="#sec-description">Description</a> |
265 <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
266
267
268 |
269 <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
270
271 </div>
272 <div class="info-box-body">
273
274 <a name="var$content" id="$content"><!-- --></A>
275 <div class="oddrow">
276
277 <div class="var-header">
278 <img src="../../media/images/Variable.png" />
279 <span class="var-title">
280 <span class="var-type">string</span>
281 <span class="var-name">$content</span>
282 (line <span class="line-number">47</span>)
283 </span>
284 </div>
285
286 <!-- ========== Info from phpDoc block ========= -->
287 <p class="short-description">The value of this property.</p>
288 <ul class="tags">
289 <li><span class="field">access:</span> protected</li>
290 </ul>
291
292
293
294
295
296 </div>
297 <a name="var$name" id="$name"><!-- --></A>
298 <div class="evenrow">
299
300 <div class="var-header">
301 <img src="../../media/images/Variable.png" />
302 <span class="var-title">
303 <span class="var-type">string</span>
304 <span class="var-name">$name</span>
305 (line <span class="line-number">33</span>)
306 </span>
307 </div>
308
309 <!-- ========== Info from phpDoc block ========= -->
310 <p class="short-description">The name of this property</p>
311 <ul class="tags">
312 <li><span class="field">access:</span> protected</li>
313 </ul>
314
315
316
317
318
319 </div>
320 <a name="var$parameters" id="$parameters"><!-- --></A>
321 <div class="oddrow">
322
323 <div class="var-header">
324 <img src="../../media/images/Variable.png" />
325 <span class="var-title">
326 <span class="var-type">array</span>
327 <span class="var-name">$parameters</span>
328 (line <span class="line-number">40</span>)
329 </span>
330 </div>
331
332 <!-- ========== Info from phpDoc block ========= -->
333 <p class="short-description">An array of parameters to this property, represented as key/value pairs.</p>
334 <ul class="tags">
335 <li><span class="field">access:</span> protected</li>
336 </ul>
337
338
339
340
341
342 </div>
343 <a name="var$rendered" id="$rendered"><!-- --></A>
344 <div class="evenrow">
345
346 <div class="var-header">
347 <img src="../../media/images/Variable.png" />
348 <span class="var-title">
349 <span class="var-type">string</span>
350 <span class="var-name">$rendered</span>
351 (line <span class="line-number">54</span>)
352 </span>
353 </div>
354
355 <!-- ========== Info from phpDoc block ========= -->
356 <p class="short-description">The original value that this was parsed from, if that's the way it happened.</p>
357 <ul class="tags">
358 <li><span class="field">access:</span> protected</li>
359 </ul>
360
361
362
363
364
365 </div>
366
367 </div>
368 </div>
369
370 <a name="sec-methods"></a>
371 <div class="info-box">
372 <div class="info-box-title">Methods</div>
373 <div class="nav-bar">
374 <a href="#sec-description">Description</a> |
375 <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
376 <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
377
378 </div>
379 <div class="info-box-body">
380 <A NAME='method_detail'></A>
381 <a name="method__construct" id="__construct"><!-- --></a>
382 <div class="oddrow">
383
384 <div class="method-header">
385 <img src="../../media/images/Constructor.png" />
386 <span class="method-title">Constructor __construct</span> (line <span class="line-number">66</span>)
387 </div>
388
389 <!-- ========== Info from phpDoc block ========= -->
390 <p class="short-description">The constructor parses the incoming string, which is formatted as per RFC2445 as a propname[;param1=pval1[; ... ]]:propvalue however we allow ourselves to assume that the RFC2445 content unescaping has already happened when vComponent::ParseFrom() called vComponent::UnwrapComponent().</p>
391
392 <div class="method-signature">
393 <span class="method-result">vProperty</span>
394 <span class="method-name">
395 __construct
396 </span>
397 ([<span class="var-type">string</span>&nbsp;<span class="var-name">$propstring</span> = <span class="var-default">null</span>])
398 </div>
399
400 <ul class="parameters">
401 <li>
402 <span class="var-type">string</span>
403 <span class="var-name">$propstring</span><span class="var-description">: The string from the vComponent which contains this property.</span> </li>
404 </ul>
405
406
407 </div>
408 <a name="methodGetParameterValue" id="GetParameterValue"><!-- --></a>
409 <div class="evenrow">
410
411 <div class="method-header">
412 <img src="../../media/images/Method.png" />
413 <span class="method-title">GetParameterValue</span> (line <span class="line-number">181</span>)
414 </div>
415
416 <!-- ========== Info from phpDoc block ========= -->
417 <p class="short-description">Get the value of a parameter</p>
418 <ul class="tags">
419 <li><span class="field">return:</span> The value of the parameter</li>
420 </ul>
421
422 <div class="method-signature">
423 <span class="method-result">string</span>
424 <span class="method-name">
425 GetParameterValue
426 </span>
427 (<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>)
428 </div>
429
430 <ul class="parameters">
431 <li>
432 <span class="var-type">string</span>
433 <span class="var-name">$name</span><span class="var-description">: The name of the parameter to retrieve the value for</span> </li>
434 </ul>
435
436
437 </div>
438 <a name="methodName" id="Name"><!-- --></a>
439 <div class="oddrow">
440
441 <div class="method-header">
442 <img src="../../media/images/Method.png" />
443 <span class="method-title">Name</span> (line <span class="line-number">116</span>)
444 </div>
445
446 <!-- ========== Info from phpDoc block ========= -->
447 <p class="short-description">Get/Set name property</p>
448 <ul class="tags">
449 <li><span class="field">return:</span> The name for the property.</li>
450 </ul>
451
452 <div class="method-signature">
453 <span class="method-result">string</span>
454 <span class="method-name">
455 Name
456 </span>
457 ([<span class="var-type">string</span>&nbsp;<span class="var-name">$newname</span> = <span class="var-default">null</span>])
458 </div>
459
460 <ul class="parameters">
461 <li>
462 <span class="var-type">string</span>
463 <span class="var-name">$newname</span><span class="var-description">: [optional] A new name for the property</span> </li>
464 </ul>
465
466
467 </div>
468 <a name="methodParameters" id="Parameters"><!-- --></a>
469 <div class="evenrow">
470
471 <div class="method-header">
472 <img src="../../media/images/Method.png" />
473 <span class="method-title">Parameters</span> (line <span class="line-number">149</span>)
474 </div>
475
476 <!-- ========== Info from phpDoc block ========= -->
477 <p class="short-description">Get/Set parameters in their entirety</p>
478 <ul class="tags">
479 <li><span class="field">return:</span> The current array of parameters for the property.</li>
480 </ul>
481
482 <div class="method-signature">
483 <span class="method-result">array</span>
484 <span class="method-name">
485 Parameters
486 </span>
487 ([<span class="var-type">array</span>&nbsp;<span class="var-name">$newparams</span> = <span class="var-default">null</span>])
488 </div>
489
490 <ul class="parameters">
491 <li>
492 <span class="var-type">array</span>
493 <span class="var-name">$newparams</span><span class="var-description">: An array of new parameter key/value pairs</span> </li>
494 </ul>
495
496
497 </div>
498 <a name="methodParseFrom" id="ParseFrom"><!-- --></a>
499 <div class="oddrow">
500
501 <div class="method-header">
502 <img src="../../media/images/Method.png" />
503 <span class="method-title">ParseFrom</span> (line <span class="line-number">85</span>)
504 </div>
505
506 <!-- ========== Info from phpDoc block ========= -->
507 <p class="short-description">The constructor parses the incoming string, which is formatted as per RFC2445 as a propname[;param1=pval1[; ... ]]:propvalue however we allow ourselves to assume that the RFC2445 content unescaping has already happened when vComponent::ParseFrom() called vComponent::UnwrapComponent().</p>
508
509 <div class="method-signature">
510 <span class="method-result">void</span>
511 <span class="method-name">
512 ParseFrom
513 </span>
514 (<span class="var-type">string</span>&nbsp;<span class="var-name">$propstring</span>)
515 </div>
516
517 <ul class="parameters">
518 <li>
519 <span class="var-type">string</span>
520 <span class="var-name">$propstring</span><span class="var-description">: The string from the vComponent which contains this property.</span> </li>
521 </ul>
522
523
524 </div>
525 <a name="methodRender" id="Render"><!-- --></a>
526 <div class="evenrow">
527
528 <div class="method-header">
529 <img src="../../media/images/Method.png" />
530 <span class="method-title">Render</span> (line <span class="line-number">216</span>)
531 </div>
532
533 <!-- ========== Info from phpDoc block ========= -->
534 <p class="short-description">Render a suitably escaped RFC2445 content string.</p>
535
536 <div class="method-signature">
537 <span class="method-result">void</span>
538 <span class="method-name">
539 Render
540 </span>
541 ()
542 </div>
543
544
545
546 </div>
547 <a name="methodRenderParameters" id="RenderParameters"><!-- --></a>
548 <div class="oddrow">
549
550 <div class="method-header">
551 <img src="../../media/images/Method.png" />
552 <span class="method-title">RenderParameters</span> (line <span class="line-number">203</span>)
553 </div>
554
555 <!-- ========== Info from phpDoc block ========= -->
556 <p class="short-description">Render the set of parameters as key1=value1[;key2=value2[; ...]] with any colons or semicolons escaped.</p>
557
558 <div class="method-signature">
559 <span class="method-result">void</span>
560 <span class="method-name">
561 RenderParameters
562 </span>
563 ()
564 </div>
565
566
567
568 </div>
569 <a name="methodSetParameterValue" id="SetParameterValue"><!-- --></a>
570 <div class="evenrow">
571
572 <div class="method-header">
573 <img src="../../media/images/Method.png" />
574 <span class="method-title">SetParameterValue</span> (line <span class="line-number">194</span>)
575 </div>
576
577 <!-- ========== Info from phpDoc block ========= -->
578 <p class="short-description">Set the value of a parameter</p>
579
580 <div class="method-signature">
581 <span class="method-result">void</span>
582 <span class="method-name">
583 SetParameterValue
584 </span>
585 (<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
586 </div>
587
588 <ul class="parameters">
589 <li>
590 <span class="var-type">string</span>
591 <span class="var-name">$name</span><span class="var-description">: The name of the parameter to set the value for</span> </li>
592 <li>
593 <span class="var-type">string</span>
594 <span class="var-name">$value</span><span class="var-description">: The value of the parameter</span> </li>
595 </ul>
596
597
598 </div>
599 <a name="methodTestFilter" id="TestFilter"><!-- --></a>
600 <div class="oddrow">
601
602 <div class="method-header">
603 <img src="../../media/images/Method.png" />
604 <span class="method-title">TestFilter</span> (line <span class="line-number">269</span>)
605 </div>
606
607 <!-- ========== Info from phpDoc block ========= -->
608 <p class="short-description">Test a PROP-FILTER or PARAM-FILTER and return a true/false PROP-FILTER (is-defined | is-not-defined | ((time-range | text-match)?, param-filter*)) PARAM-FILTER (is-defined | is-not-defined | ((time-range | text-match)?, param-filter*))</p>
609 <ul class="tags">
610 <li><span class="field">return:</span> Whether or not this vProperty passes the test</li>
611 </ul>
612
613 <div class="method-signature">
614 <span class="method-result">boolean</span>
615 <span class="method-name">
616 TestFilter
617 </span>
618 (<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>)
619 </div>
620
621 <ul class="parameters">
622 <li>
623 <span class="var-type">array</span>
624 <span class="var-name">$filter</span><span class="var-description">: An array of XMLElement defining the filter</span> </li>
625 <li>
626 <span class="var-type"></span>
627 <span class="var-name">$filters</span> </li>
628 </ul>
629
630
631 </div>
632 <a name="methodTestParamFilter" id="TestParamFilter"><!-- --></a>
633 <div class="evenrow">
634
635 <div class="method-header">
636 <img src="../../media/images/Method.png" />
637 <span class="method-title">TestParamFilter</span> (line <span class="line-number">313</span>)
638 </div>
639
640 <!-- ========== Info from phpDoc block ========= -->
641
642 <div class="method-signature">
643 <span class="method-result">void</span>
644 <span class="method-name">
645 TestParamFilter
646 </span>
647 (<span class="var-type"></span>&nbsp;<span class="var-name">$filters</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$parameter_value</span>)
648 </div>
649
650 <ul class="parameters">
651 <li>
652 <span class="var-type"></span>
653 <span class="var-name">$filters</span> </li>
654 <li>
655 <span class="var-type"></span>
656 <span class="var-name">$parameter_value</span> </li>
657 </ul>
658
659
660 </div>
661 <a name="methodTextMatch" id="TextMatch"><!-- --></a>
662 <div class="oddrow">
663
664 <div class="method-header">
665 <img src="../../media/images/Method.png" />
666 <span class="method-title">TextMatch</span> (line <span class="line-number">168</span>)
667 </div>
668
669 <!-- ========== Info from phpDoc block ========= -->
670 <p class="short-description">Test if our value contains a string</p>
671 <ul class="tags">
672 <li><span class="field">return:</span> The name for the property.</li>
673 </ul>
674
675 <div class="method-signature">
676 <span class="method-result">string</span>
677 <span class="method-name">
678 TextMatch
679 </span>
680 (<span class="var-type">string</span>&nbsp;<span class="var-name">$search</span>)
681 </div>
682
683 <ul class="parameters">
684 <li>
685 <span class="var-type">string</span>
686 <span class="var-name">$search</span><span class="var-description">: The needle which we shall search the haystack for.</span> </li>
687 </ul>
688
689
690 </div>
691 <a name="methodValue" id="Value"><!-- --></a>
692 <div class="evenrow">
693
694 <div class="method-header">
695 <img src="../../media/images/Method.png" />
696 <span class="method-title">Value</span> (line <span class="line-number">133</span>)
697 </div>
698
699 <!-- ========== Info from phpDoc block ========= -->
700 <p class="short-description">Get/Set the content of the property</p>
701 <ul class="tags">
702 <li><span class="field">return:</span> The value of the property.</li>
703 </ul>
704
705 <div class="method-signature">
706 <span class="method-result">string</span>
707 <span class="method-name">
708 Value
709 </span>
710 ([<span class="var-type">string</span>&nbsp;<span class="var-name">$newvalue</span> = <span class="var-default">null</span>])
711 </div>
712
713 <ul class="parameters">
714 <li>
715 <span class="var-type">string</span>
716 <span class="var-name">$newvalue</span><span class="var-description">: [optional] A new value for the property</span> </li>
717 </ul>
718
719
720 </div>
721 <a name="method__toString" id="__toString"><!-- --></a>
722 <div class="oddrow">
723
724 <div class="method-header">
725 <img src="../../media/images/Method.png" />
726 <span class="method-title">__toString</span> (line <span class="line-number">255</span>)
727 </div>
728
729 <!-- ========== Info from phpDoc block ========= -->
730 <ul class="tags">
731 <li><span class="field">access:</span> public</li>
732 </ul>
733
734 <div class="method-signature">
735 <span class="method-result">void</span>
736 <span class="method-name">
737 __toString
738 </span>
739 ()
740 </div>
741
742
743
744 </div>
745
746 </div>
747 </div>
748
749
750 <p class="notes" id="credit">
751 Documentation generated on Tue, 28 Dec 2010 02:01:38 +1300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
752 </p>
753 </div></body>
754 </html>
Andrew's Web Libraries