?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
Release 0.52
[awl.git] / docs / api / awl / XMLElement / XMLElement.html
blobe11928dfe0cb2b1a6e995591ff01f6e2f5ab0b65
1
2 Warning: strftime(): It is not safe to rely on the system's timezone settings. You are *required* to use the date.timezone setting or the date_default_timezone_set() function. In case you used any of those methods and you are still getting this warning, you most likely misspelled the timezone identifier. We selected the timezone 'UTC' for now, but please set date.timezone to select your timezone. in /usr/share/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty_Compiler.class.php on line 370
3 <?xml version="1.0" encoding="iso-8859-1"?>
4 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5 <html xmlns="http://www.w3.org/1999/xhtml">
6 <head>
7 <!-- template designed by Marco Von Ballmoos -->
8 <title>Docs For Class XMLElement</title>
9 <link rel="stylesheet" href="../../media/stylesheet.css" />
10 <script src="../../media/lib/classTree.js"></script>
11 <script language="javascript" type="text/javascript">
12 var imgPlus = new Image();
13 var imgMinus = new Image();
14 imgPlus.src = "../../media/images/plus.png";
15 imgMinus.src = "../../media/images/minus.png";
16
17 function showNode(Node){
18 switch(navigator.family){
19 case 'nn4':
20 // Nav 4.x code fork...
21 var oTable = document.layers["span" + Node];
22 var oImg = document.layers["img" + Node];
23 break;
24 case 'ie4':
25 // IE 4/5 code fork...
26 var oTable = document.all["span" + Node];
27 var oImg = document.all["img" + Node];
28 break;
29 case 'gecko':
30 // Standards Compliant code fork...
31 var oTable = document.getElementById("span" + Node);
32 var oImg = document.getElementById("img" + Node);
33 break;
34 }
35 oImg.src = imgMinus.src;
36 oTable.style.display = "block";
37 }
38
39 function hideNode(Node){
40 switch(navigator.family){
41 case 'nn4':
42 // Nav 4.x code fork...
43 var oTable = document.layers["span" + Node];
44 var oImg = document.layers["img" + Node];
45 break;
46 case 'ie4':
47 // IE 4/5 code fork...
48 var oTable = document.all["span" + Node];
49 var oImg = document.all["img" + Node];
50 break;
51 case 'gecko':
52 // Standards Compliant code fork...
53 var oTable = document.getElementById("span" + Node);
54 var oImg = document.getElementById("img" + Node);
55 break;
56 }
57 oImg.src = imgPlus.src;
58 oTable.style.display = "none";
59 }
60
61 function nodeIsVisible(Node){
62 switch(navigator.family){
63 case 'nn4':
64 // Nav 4.x code fork...
65 var oTable = document.layers["span" + Node];
66 break;
67 case 'ie4':
68 // IE 4/5 code fork...
69 var oTable = document.all["span" + Node];
70 break;
71 case 'gecko':
72 // Standards Compliant code fork...
73 var oTable = document.getElementById("span" + Node);
74 break;
75 }
76 return (oTable && oTable.style.display == "block");
77 }
78
79 function toggleNodeVisibility(Node){
80 if (nodeIsVisible(Node)){
81 hideNode(Node);
82 }else{
83 showNode(Node);
84 }
85 }
86 </script>
87 </head>
88 <body>
89 <div class="page-body">
90 <h2 class="class-name"><img src="../../media/images/Class_logo.png"
91 alt=" Class"
92 title=" Class"
93 style="vertical-align: middle"> XMLElement</h2>
94
95 <a name="sec-description"></a>
96 <div class="info-box">
97 <div class="info-box-title">Description</div>
98 <div class="nav-bar">
99 <span class="disabled">Description</span> |
100 <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
101 | <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
102
103 </div>
104 <div class="info-box-body">
105
106 Warning: strftime(): It is not safe to rely on the system's timezone settings. You are *required* to use the date.timezone setting or the date_default_timezone_set() function. In case you used any of those methods and you are still getting this warning, you most likely misspelled the timezone identifier. We selected the timezone 'UTC' for now, but please set date.timezone to select your timezone. in /usr/share/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty_Compiler.class.php on line 370
107 <!-- ========== Info from phpDoc block ========= -->
108 <p class="short-description">A class for XML elements which may have attributes, or contain other XML sub-elements</p>
109 <p class="notes">
110 Located in <a class="field" href="_XMLElement.php.html">/XMLElement.php</a> (line <span class="field">20</span>)
111 </p>
112
113
114 <pre></pre>
115
116 </div>
117 </div>
118
119
120
121 <a name="sec-var-summary"></a>
122 <div class="info-box">
123 <div class="info-box-title">Variable Summary</span></div>
124 <div class="nav-bar">
125 <a href="#sec-description">Description</a> |
126 <span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
127 |
128 <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
129
130 </div>
131 <div class="info-box-body">
132 <div class="var-summary">
133 <div class="var-title">
134 <img src="../../media/images/Variable.png" alt=" " />
135 <span class="var-type">mixed</span>
136 <a href="#$attributes" title="details" class="var-name">$attributes</a>
137 </div>
138 <div class="var-title">
139 <img src="../../media/images/Variable.png" alt=" " />
140 <span class="var-type">mixed</span>
141 <a href="#$content" title="details" class="var-name">$content</a>
142 </div>
143 <div class="var-title">
144 <img src="../../media/images/Variable.png" alt=" " />
145 <span class="var-type">mixed</span>
146 <a href="#$tagname" title="details" class="var-name">$tagname</a>
147 </div>
148 <div class="var-title">
149 <img src="../../media/images/Variable.png" alt=" " />
150 <span class="var-type">mixed</span>
151 <a href="#$xmlns" title="details" class="var-name">$xmlns</a>
152 </div>
153 <div class="var-title">
154 <img src="../../media/images/Variable.png" alt=" " />
155 <span class="var-type">mixed</span>
156 <a href="#$_parent" title="details" class="var-name">$_parent</a>
157 </div>
158 </div>
159 </div>
160 </div>
161
162 <a name="sec-method-summary"></a>
163 <div class="info-box">
164 <div class="info-box-title">Method Summary</span></div>
165 <div class="nav-bar">
166 <a href="#sec-description">Description</a> |
167 <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
168
169 |
170 <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
171 </div>
172 <div class="info-box-body">
173 <div class="method-summary">
174
175 <div class="method-definition">
176 <img src="../../media/images/Constructor.png" alt=" "/>
177 <span class="method-result">XMLElement</span>
178 <a href="#__construct" title="details" class="method-name">__construct</a>
179 (<span class="var-type">string</span>&nbsp;<span class="var-name">$tagname</span>, [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$content</span> = <span class="var-default">false</span>], [<span class="var-type">array</span>&nbsp;<span class="var-name">$attributes</span> = <span class="var-default">false</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$xmlns</span> = <span class="var-default">null</span>])
180 </div>
181
182 <div class="method-definition">
183 <img src="../../media/images/Method.png" alt=" "/>
184 <span class="method-result">void</span>
185 <a href="#AddSubTag" title="details" class="method-name">AddSubTag</a>
186 (<span class="var-type">object An</span>&nbsp;<span class="var-name">&$v</span>)
187 </div>
188
189 <div class="method-definition">
190 <img src="../../media/images/Method.png" alt=" "/>
191 <span class="method-result">int</span>
192 <a href="#CountElements" title="details" class="method-name">CountElements</a>
193 ()
194 </div>
195
196 <div class="method-definition">
197 <img src="../../media/images/Method.png" alt=" "/>
198 <span class="method-result">string</span>
199 <a href="#GetAttribute" title="details" class="method-name">GetAttribute</a>
200 (<span class="var-type">string</span>&nbsp;<span class="var-name">$attr</span>)
201 </div>
202
203 <div class="method-definition">
204 <img src="../../media/images/Method.png" alt=" "/>
205 <span class="method-result">array</span>
206 <a href="#GetAttributes" title="details" class="method-name">GetAttributes</a>
207 ()
208 </div>
209
210 <div class="method-definition">
211 <img src="../../media/images/Method.png" alt=" "/>
212 <span class="method-result">array</span>
213 <a href="#GetContent" title="details" class="method-name">GetContent</a>
214 ()
215 </div>
216
217 <div class="method-definition">
218 <img src="../../media/images/Method.png" alt=" "/>
219 <span class="method-result">array</span>
220 <a href="#GetElements" title="details" class="method-name">GetElements</a>
221 ([<span class="var-type"></span>&nbsp;<span class="var-name">$tag</span> = <span class="var-default">null</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$recursive</span> = <span class="var-default">false</span>])
222 </div>
223
224 <div class="method-definition">
225 <img src="../../media/images/Method.png" alt=" "/>
226 <span class="method-result">string</span>
227 <a href="#GetNSTag" title="details" class="method-name">GetNSTag</a>
228 ()
229 </div>
230
231 <div class="method-definition">
232 <img src="../../media/images/Method.png" alt=" "/>
233 <span class="method-result">array</span>
234 <a href="#GetPath" title="details" class="method-name">GetPath</a>
235 (<span class="var-type"></span>&nbsp;<span class="var-name">$path</span>)
236 </div>
237
238 <div class="method-definition">
239 <img src="../../media/images/Method.png" alt=" "/>
240 <span class="method-result">string</span>
241 <a href="#GetTag" title="details" class="method-name">GetTag</a>
242 ()
243 </div>
244
245 <div class="method-definition">
246 <img src="../../media/images/Method.png" alt=" "/>
247 <span class="method-result">objectref</span>
248 <a href="#NewElement" title="details" class="method-name">&amp;NewElement</a>
249 (<span class="var-type">string</span>&nbsp;<span class="var-name">$tagname</span>, [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$content</span> = <span class="var-default">false</span>], [<span class="var-type">array</span>&nbsp;<span class="var-name">$attributes</span> = <span class="var-default">false</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$xmlns</span> = <span class="var-default">null</span>])
250 </div>
251
252 <div class="method-definition">
253 <img src="../../media/images/Method.png" alt=" "/>
254 <span class="method-result">void</span>
255 <a href="#Render" title="details" class="method-name">Render</a>
256 ([<span class="var-type">int</span>&nbsp;<span class="var-name">$indent</span> = <span class="var-default">0</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$xmldef</span> = <span class="var-default">&quot;&quot;</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$nslist</span> = <span class="var-default">null</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$force_xmlns</span> = <span class="var-default">false</span>])
257 </div>
258
259 <div class="method-definition">
260 <img src="../../media/images/Method.png" alt=" "/>
261 <span class="method-result">string</span>
262 <a href="#RenderContent" title="details" class="method-name">RenderContent</a>
263 ([<span class="var-type"></span>&nbsp;<span class="var-name">$indent</span> = <span class="var-default">0</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$nslist</span> = <span class="var-default">null</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$force_xmlns</span> = <span class="var-default">false</span>])
264 </div>
265
266 <div class="method-definition">
267 <img src="../../media/images/Method.png" alt=" "/>
268 <span class="method-result">void</span>
269 <a href="#SetAttribute" title="details" class="method-name">SetAttribute</a>
270 (<span class="var-type">string</span>&nbsp;<span class="var-name">$k</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$v</span>)
271 </div>
272
273 <div class="method-definition">
274 <img src="../../media/images/Method.png" alt=" "/>
275 <span class="method-result">void</span>
276 <a href="#SetContent" title="details" class="method-name">SetContent</a>
277 (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$v</span>)
278 </div>
279
280 <div class="method-definition">
281 <img src="../../media/images/Method.png" alt=" "/>
282 <span class="method-result">void</span>
283 <a href="#__tostring" title="details" class="method-name">__tostring</a>
284 ()
285 </div>
286 </div>
287 </div>
288 </div>
289
290 <a name="sec-vars"></a>
291 <div class="info-box">
292 <div class="info-box-title">Variables</div>
293 <div class="nav-bar">
294 <a href="#sec-description">Description</a> |
295 <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
296
297
298 |
299 <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
300
301 </div>
302 <div class="info-box-body">
303
304 Strict Standards: Only variables should be passed by reference in /usr/share/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty_Compiler.class.php on line 712
305
306 Warning: strftime(): It is not safe to rely on the system's timezone settings. You are *required* to use the date.timezone setting or the date_default_timezone_set() function. In case you used any of those methods and you are still getting this warning, you most likely misspelled the timezone identifier. We selected the timezone 'UTC' for now, but please set date.timezone to select your timezone. in /usr/share/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty_Compiler.class.php on line 370
307
308 <a name="var$attributes" id="$attributes"><!-- --></A>
309 <div class="oddrow">
310
311 <div class="var-header">
312 <img src="../../media/images/Variable.png" />
313 <span class="var-title">
314 <span class="var-type">mixed</span>
315 <span class="var-name">$attributes</span>
316 (line <span class="line-number">23</span>)
317 </span>
318 </div>
319
320 <!-- ========== Info from phpDoc block ========= -->
321 <ul class="tags">
322 <li><span class="field">access:</span> protected</li>
323 </ul>
324
325
326
327
328
329 </div>
330 <a name="var$content" id="$content"><!-- --></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">mixed</span>
337 <span class="var-name">$content</span>
338 (line <span class="line-number">24</span>)
339 </span>
340 </div>
341
342 <!-- ========== Info from phpDoc block ========= -->
343 <ul class="tags">
344 <li><span class="field">access:</span> protected</li>
345 </ul>
346
347
348
349
350
351 </div>
352 <a name="var$tagname" id="$tagname"><!-- --></A>
353 <div class="oddrow">
354
355 <div class="var-header">
356 <img src="../../media/images/Variable.png" />
357 <span class="var-title">
358 <span class="var-type">mixed</span>
359 <span class="var-name">$tagname</span>
360 (line <span class="line-number">21</span>)
361 </span>
362 </div>
363
364 <!-- ========== Info from phpDoc block ========= -->
365 <ul class="tags">
366 <li><span class="field">access:</span> protected</li>
367 </ul>
368
369
370
371
372
373 </div>
374 <a name="var$xmlns" id="$xmlns"><!-- --></A>
375 <div class="evenrow">
376
377 <div class="var-header">
378 <img src="../../media/images/Variable.png" />
379 <span class="var-title">
380 <span class="var-type">mixed</span>
381 <span class="var-name">$xmlns</span>
382 (line <span class="line-number">22</span>)
383 </span>
384 </div>
385
386 <!-- ========== Info from phpDoc block ========= -->
387 <ul class="tags">
388 <li><span class="field">access:</span> protected</li>
389 </ul>
390
391
392
393
394
395 </div>
396 <a name="var$_parent" id="$_parent"><!-- --></A>
397 <div class="oddrow">
398
399 <div class="var-header">
400 <img src="../../media/images/Variable.png" />
401 <span class="var-title">
402 <span class="var-type">mixed</span>
403 <span class="var-name">$_parent</span>
404 (line <span class="line-number">25</span>)
405 </span>
406 </div>
407
408 <!-- ========== Info from phpDoc block ========= -->
409 <ul class="tags">
410 <li><span class="field">access:</span> protected</li>
411 </ul>
412
413
414
415
416
417 </div>
418
419 </div>
420 </div>
421
422 <a name="sec-methods"></a>
423 <div class="info-box">
424 <div class="info-box-title">Methods</div>
425 <div class="nav-bar">
426 <a href="#sec-description">Description</a> |
427 <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
428 <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
429
430 </div>
431 <div class="info-box-body">
432
433 Strict Standards: Only variables should be passed by reference in /usr/share/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty_Compiler.class.php on line 712
434
435 Warning: strftime(): It is not safe to rely on the system's timezone settings. You are *required* to use the date.timezone setting or the date_default_timezone_set() function. In case you used any of those methods and you are still getting this warning, you most likely misspelled the timezone identifier. We selected the timezone 'UTC' for now, but please set date.timezone to select your timezone. in /usr/share/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty_Compiler.class.php on line 370
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">35</span>)
443 </div>
444
445 <!-- ========== Info from phpDoc block ========= -->
446 <p class="short-description">Constructor - nothing fancy as yet.</p>
447
448 <div class="method-signature">
449 <span class="method-result">XMLElement</span>
450 <span class="method-name">
451 __construct
452 </span>
453 (<span class="var-type">string</span>&nbsp;<span class="var-name">$tagname</span>, [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$content</span> = <span class="var-default">false</span>], [<span class="var-type">array</span>&nbsp;<span class="var-name">$attributes</span> = <span class="var-default">false</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$xmlns</span> = <span class="var-default">null</span>])
454 </div>
455
456 <ul class="parameters">
457 <li>
458 <span class="var-type">string</span>
459 <span class="var-name">$tagname</span><span class="var-description">: The tag name of the new element</span> </li>
460 <li>
461 <span class="var-type">mixed</span>
462 <span class="var-name">$content</span><span class="var-description">: Either a string of content, or an array of sub-elements</span> </li>
463 <li>
464 <span class="var-type">array</span>
465 <span class="var-name">$attributes</span><span class="var-description">: An array of attribute name/value pairs</span> </li>
466 <li>
467 <span class="var-type">string</span>
468 <span class="var-name">$xmlns</span><span class="var-description">: An XML namespace specifier</span> </li>
469 </ul>
470
471
472 </div>
473 <a name="methodAddSubTag" id="AddSubTag"><!-- --></a>
474 <div class="oddrow">
475
476 <div class="method-header">
477 <img src="../../media/images/Method.png" />
478 <span class="method-title">AddSubTag</span> (line <span class="line-number">215</span>)
479 </div>
480
481 <!-- ========== Info from phpDoc block ========= -->
482 <p class="short-description">Add a sub-element</p>
483
484 <div class="method-signature">
485 <span class="method-result">void</span>
486 <span class="method-name">
487 AddSubTag
488 </span>
489 (<span class="var-type">object An</span>&nbsp;<span class="var-name">&$v</span>)
490 </div>
491
492 <ul class="parameters">
493 <li>
494 <span class="var-type">object An</span>
495 <span class="var-name">&$v</span><span class="var-description">: XMLElement to be appended to the array of sub-elements</span> </li>
496 </ul>
497
498
499 </div>
500 <a name="methodCountElements" id="CountElements"><!-- --></a>
501 <div class="evenrow">
502
503 <div class="method-header">
504 <img src="../../media/images/Method.png" />
505 <span class="method-title">CountElements</span> (line <span class="line-number">68</span>)
506 </div>
507
508 <!-- ========== Info from phpDoc block ========= -->
509 <p class="short-description">Count the number of elements</p>
510 <ul class="tags">
511 <li><span class="field">return:</span> The number of elements</li>
512 </ul>
513
514 <div class="method-signature">
515 <span class="method-result">int</span>
516 <span class="method-name">
517 CountElements
518 </span>
519 ()
520 </div>
521
522
523
524 </div>
525 <a name="methodGetAttribute" id="GetAttribute"><!-- --></a>
526 <div class="oddrow">
527
528 <div class="method-header">
529 <img src="../../media/images/Method.png" />
530 <span class="method-title">GetAttribute</span> (line <span class="line-number">121</span>)
531 </div>
532
533 <!-- ========== Info from phpDoc block ========= -->
534 <p class="short-description">Accessor for a single attribute</p>
535 <ul class="tags">
536 <li><span class="field">return:</span> The value of that attribute of the element</li>
537 </ul>
538
539 <div class="method-signature">
540 <span class="method-result">string</span>
541 <span class="method-name">
542 GetAttribute
543 </span>
544 (<span class="var-type">string</span>&nbsp;<span class="var-name">$attr</span>)
545 </div>
546
547 <ul class="parameters">
548 <li>
549 <span class="var-type">string</span>
550 <span class="var-name">$attr</span><span class="var-description">: The name of the attribute.</span> </li>
551 </ul>
552
553
554 </div>
555 <a name="methodGetAttributes" id="GetAttributes"><!-- --></a>
556 <div class="evenrow">
557
558 <div class="method-header">
559 <img src="../../media/images/Method.png" />
560 <span class="method-title">GetAttributes</span> (line <span class="line-number">132</span>)
561 </div>
562
563 <!-- ========== Info from phpDoc block ========= -->
564 <p class="short-description">Accessor for the attributes</p>
565 <ul class="tags">
566 <li><span class="field">return:</span> The attributes of this element</li>
567 </ul>
568
569 <div class="method-signature">
570 <span class="method-result">array</span>
571 <span class="method-name">
572 GetAttributes
573 </span>
574 ()
575 </div>
576
577
578
579 </div>
580 <a name="methodGetContent" id="GetContent"><!-- --></a>
581 <div class="oddrow">
582
583 <div class="method-header">
584 <img src="../../media/images/Method.png" />
585 <span class="method-title">GetContent</span> (line <span class="line-number">141</span>)
586 </div>
587
588 <!-- ========== Info from phpDoc block ========= -->
589 <p class="short-description">Accessor for the content</p>
590 <ul class="tags">
591 <li><span class="field">return:</span> The content of this element</li>
592 </ul>
593
594 <div class="method-signature">
595 <span class="method-result">array</span>
596 <span class="method-name">
597 GetContent
598 </span>
599 ()
600 </div>
601
602
603
604 </div>
605 <a name="methodGetElements" id="GetElements"><!-- --></a>
606 <div class="evenrow">
607
608 <div class="method-header">
609 <img src="../../media/images/Method.png" />
610 <span class="method-title">GetElements</span> (line <span class="line-number">151</span>)
611 </div>
612
613 <!-- ========== Info from phpDoc block ========= -->
614 <p class="short-description">Return an array of elements matching the specified tag, or all elements if no tag is supplied.</p>
615 <p class="description"><p>Unlike GetContent() this will always return an array.</p></p>
616 <ul class="tags">
617 <li><span class="field">return:</span> The XMLElements within the tree which match this tag</li>
618 </ul>
619
620 <div class="method-signature">
621 <span class="method-result">array</span>
622 <span class="method-name">
623 GetElements
624 </span>
625 ([<span class="var-type"></span>&nbsp;<span class="var-name">$tag</span> = <span class="var-default">null</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$recursive</span> = <span class="var-default">false</span>])
626 </div>
627
628 <ul class="parameters">
629 <li>
630 <span class="var-type"></span>
631 <span class="var-name">$tag</span> </li>
632 <li>
633 <span class="var-type"></span>
634 <span class="var-name">$recursive</span> </li>
635 </ul>
636
637
638 </div>
639 <a name="methodGetNSTag" id="GetNSTag"><!-- --></a>
640 <div class="oddrow">
641
642 <div class="method-header">
643 <img src="../../media/images/Method.png" />
644 <span class="method-title">GetNSTag</span> (line <span class="line-number">112</span>)
645 </div>
646
647 <!-- ========== Info from phpDoc block ========= -->
648 <p class="short-description">Accessor for the full-namespaced tag name</p>
649 <ul class="tags">
650 <li><span class="field">return:</span> The tag name of the element, prefixed by the namespace</li>
651 </ul>
652
653 <div class="method-signature">
654 <span class="method-result">string</span>
655 <span class="method-name">
656 GetNSTag
657 </span>
658 ()
659 </div>
660
661
662
663 </div>
664 <a name="methodGetPath" id="GetPath"><!-- --></a>
665 <div class="evenrow">
666
667 <div class="method-header">
668 <img src="../../media/images/Method.png" />
669 <span class="method-title">GetPath</span> (line <span class="line-number">175</span>)
670 </div>
671
672 <!-- ========== Info from phpDoc block ========= -->
673 <p class="short-description">Return an array of elements matching the specified path</p>
674 <ul class="tags">
675 <li><span class="field">return:</span> The XMLElements within the tree which match this tag</li>
676 </ul>
677
678 <div class="method-signature">
679 <span class="method-result">array</span>
680 <span class="method-name">
681 GetPath
682 </span>
683 (<span class="var-type"></span>&nbsp;<span class="var-name">$path</span>)
684 </div>
685
686 <ul class="parameters">
687 <li>
688 <span class="var-type"></span>
689 <span class="var-name">$path</span> </li>
690 </ul>
691
692
693 </div>
694 <a name="methodGetTag" id="GetTag"><!-- --></a>
695 <div class="oddrow">
696
697 <div class="method-header">
698 <img src="../../media/images/Method.png" />
699 <span class="method-title">GetTag</span> (line <span class="line-number">103</span>)
700 </div>
701
702 <!-- ========== Info from phpDoc block ========= -->
703 <p class="short-description">Accessor for the tag name</p>
704 <ul class="tags">
705 <li><span class="field">return:</span> The tag name of the element</li>
706 </ul>
707
708 <div class="method-signature">
709 <span class="method-result">string</span>
710 <span class="method-name">
711 GetTag
712 </span>
713 ()
714 </div>
715
716
717
718 </div>
719 <a name="methodNewElement" id="NewElement"><!-- --></a>
720 <div class="evenrow">
721
722 <div class="method-header">
723 <img src="../../media/images/Method.png" />
724 <span class="method-title">NewElement</span> (line <span class="line-number">230</span>)
725 </div>
726
727 <!-- ========== Info from phpDoc block ========= -->
728 <p class="short-description">Add a new sub-element</p>
729 <ul class="tags">
730 <li><span class="field">return:</span> A reference to the new XMLElement</li>
731 </ul>
732
733 <div class="method-signature">
734 <span class="method-result">objectref</span>
735 <span class="method-name">
736 &amp;NewElement
737 </span>
738 (<span class="var-type">string</span>&nbsp;<span class="var-name">$tagname</span>, [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$content</span> = <span class="var-default">false</span>], [<span class="var-type">array</span>&nbsp;<span class="var-name">$attributes</span> = <span class="var-default">false</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$xmlns</span> = <span class="var-default">null</span>])
739 </div>
740
741 <ul class="parameters">
742 <li>
743 <span class="var-type">string</span>
744 <span class="var-name">$tagname</span><span class="var-description">: The tag name of the new element</span> </li>
745 <li>
746 <span class="var-type">mixed</span>
747 <span class="var-name">$content</span><span class="var-description">: Either a string of content, or an array of sub-elements</span> </li>
748 <li>
749 <span class="var-type">array</span>
750 <span class="var-name">$attributes</span><span class="var-description">: An array of attribute name/value pairs</span> </li>
751 <li>
752 <span class="var-type"></span>
753 <span class="var-name">$xmlns</span> </li>
754 </ul>
755
756
757 </div>
758 <a name="methodRender" id="Render"><!-- --></a>
759 <div class="oddrow">
760
761 <div class="method-header">
762 <img src="../../media/images/Method.png" />
763 <span class="method-title">Render</span> (line <span class="line-number">273</span>)
764 </div>
765
766 <!-- ========== Info from phpDoc block ========= -->
767 <p class="short-description">Render the document tree into (nicely formatted) XML</p>
768
769 <div class="method-signature">
770 <span class="method-result">void</span>
771 <span class="method-name">
772 Render
773 </span>
774 ([<span class="var-type">int</span>&nbsp;<span class="var-name">$indent</span> = <span class="var-default">0</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$xmldef</span> = <span class="var-default">&quot;&quot;</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$nslist</span> = <span class="var-default">null</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$force_xmlns</span> = <span class="var-default">false</span>])
775 </div>
776
777 <ul class="parameters">
778 <li>
779 <span class="var-type">int</span>
780 <span class="var-name">$indent</span><span class="var-description">: The indenting level for the pretty formatting of the element</span> </li>
781 <li>
782 <span class="var-type"></span>
783 <span class="var-name">$xmldef</span> </li>
784 <li>
785 <span class="var-type"></span>
786 <span class="var-name">$nslist</span> </li>
787 <li>
788 <span class="var-type"></span>
789 <span class="var-name">$force_xmlns</span> </li>
790 </ul>
791
792
793 </div>
794 <a name="methodRenderContent" id="RenderContent"><!-- --></a>
795 <div class="evenrow">
796
797 <div class="method-header">
798 <img src="../../media/images/Method.png" />
799 <span class="method-title">RenderContent</span> (line <span class="line-number">243</span>)
800 </div>
801
802 <!-- ========== Info from phpDoc block ========= -->
803 <p class="short-description">Render just the internal content</p>
804 <ul class="tags">
805 <li><span class="field">return:</span> The content of this element, as a string without this element wrapping it.</li>
806 </ul>
807
808 <div class="method-signature">
809 <span class="method-result">string</span>
810 <span class="method-name">
811 RenderContent
812 </span>
813 ([<span class="var-type"></span>&nbsp;<span class="var-name">$indent</span> = <span class="var-default">0</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$nslist</span> = <span class="var-default">null</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$force_xmlns</span> = <span class="var-default">false</span>])
814 </div>
815
816 <ul class="parameters">
817 <li>
818 <span class="var-type"></span>
819 <span class="var-name">$indent</span> </li>
820 <li>
821 <span class="var-type"></span>
822 <span class="var-name">$nslist</span> </li>
823 <li>
824 <span class="var-type"></span>
825 <span class="var-name">$force_xmlns</span> </li>
826 </ul>
827
828
829 </div>
830 <a name="methodSetAttribute" id="SetAttribute"><!-- --></a>
831 <div class="oddrow">
832
833 <div class="method-header">
834 <img src="../../media/images/Method.png" />
835 <span class="method-title">SetAttribute</span> (line <span class="line-number">81</span>)
836 </div>
837
838 <!-- ========== Info from phpDoc block ========= -->
839 <p class="short-description">Set an element attribute to a value</p>
840
841 <div class="method-signature">
842 <span class="method-result">void</span>
843 <span class="method-name">
844 SetAttribute
845 </span>
846 (<span class="var-type">string</span>&nbsp;<span class="var-name">$k</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$v</span>)
847 </div>
848
849 <ul class="parameters">
850 <li>
851 <span class="var-type">string</span>
852 <span class="var-name">$k</span><span class="var-description">: The attribute name</span> </li>
853 <li>
854 <span class="var-type">string</span>
855 <span class="var-name">$v</span><span class="var-description">: The attribute value</span> </li>
856 </ul>
857
858
859 </div>
860 <a name="methodSetContent" id="SetContent"><!-- --></a>
861 <div class="evenrow">
862
863 <div class="method-header">
864 <img src="../../media/images/Method.png" />
865 <span class="method-title">SetContent</span> (line <span class="line-number">94</span>)
866 </div>
867
868 <!-- ========== Info from phpDoc block ========= -->
869 <p class="short-description">Set the whole content to a value</p>
870
871 <div class="method-signature">
872 <span class="method-result">void</span>
873 <span class="method-name">
874 SetContent
875 </span>
876 (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$v</span>)
877 </div>
878
879 <ul class="parameters">
880 <li>
881 <span class="var-type">mixed</span>
882 <span class="var-name">$v</span><span class="var-description">: The element content, which may be text, or an array of sub-elements</span> </li>
883 </ul>
884
885
886 </div>
887 <a name="method__tostring" id="__tostring"><!-- --></a>
888 <div class="oddrow">
889
890 <div class="method-header">
891 <img src="../../media/images/Method.png" />
892 <span class="method-title">__tostring</span> (line <span class="line-number">324</span>)
893 </div>
894
895 <!-- ========== Info from phpDoc block ========= -->
896
897 <div class="method-signature">
898 <span class="method-result">void</span>
899 <span class="method-name">
900 __tostring
901 </span>
902 ()
903 </div>
904
905
906
907 </div>
908
909 </div>
910 </div>
911
912
913
914 Warning: strftime(): It is not safe to rely on the system's timezone settings. You are *required* to use the date.timezone setting or the date_default_timezone_set() function. In case you used any of those methods and you are still getting this warning, you most likely misspelled the timezone identifier. We selected the timezone 'UTC' for now, but please set date.timezone to select your timezone. in /usr/share/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty_Compiler.class.php on line 370
915 <p class="notes" id="credit">
916 Documentation generated on Sun, 17 Jun 2012 10:00:19 +0000 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
917 </p>
918 </div></body>
919 </html>
Andrew's Web Libraries