?  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 / XMLElement / XMLElement.html
blob3ae03ac95c92622fefc37ffff528d067f48dda84
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 XMLElement</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"> XMLElement</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 XML elements which may have attributes, or contain other XML sub-elements</p>
105 <p class="notes">
106 Located in <a class="field" href="_XMLElement.php.html">/XMLElement.php</a> (line <span class="field">20</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">mixed</span>
132 <a href="#$attributes" title="details" class="var-name">$attributes</a>
133 </div>
134 <div class="var-title">
135 <img src="../../media/images/Variable.png" alt=" " />
136 <span class="var-type">mixed</span>
137 <a href="#$content" title="details" class="var-name">$content</a>
138 </div>
139 <div class="var-title">
140 <img src="../../media/images/Variable.png" alt=" " />
141 <span class="var-type">mixed</span>
142 <a href="#$tagname" title="details" class="var-name">$tagname</a>
143 </div>
144 <div class="var-title">
145 <img src="../../media/images/Variable.png" alt=" " />
146 <span class="var-type">mixed</span>
147 <a href="#$xmlns" title="details" class="var-name">$xmlns</a>
148 </div>
149 <div class="var-title">
150 <img src="../../media/images/Variable.png" alt=" " />
151 <span class="var-type">mixed</span>
152 <a href="#$_parent" title="details" class="var-name">$_parent</a>
153 </div>
154 </div>
155 </div>
156 </div>
157
158 <a name="sec-method-summary"></a>
159 <div class="info-box">
160 <div class="info-box-title">Method Summary</span></div>
161 <div class="nav-bar">
162 <a href="#sec-description">Description</a> |
163 <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
164
165 |
166 <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
167 </div>
168 <div class="info-box-body">
169 <div class="method-summary">
170
171 <div class="method-definition">
172 <img src="../../media/images/Constructor.png" alt=" "/>
173 <span class="method-result">XMLElement</span>
174 <a href="#__construct" title="details" class="method-name">__construct</a>
175 (<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">array</span>&nbsp;<span class="var-name">$xmlns</span> = <span class="var-default">null</span>])
176 </div>
177
178 <div class="method-definition">
179 <img src="../../media/images/Method.png" alt=" "/>
180 <span class="method-result">void</span>
181 <a href="#AddSubTag" title="details" class="method-name">AddSubTag</a>
182 (<span class="var-type">object An</span>&nbsp;<span class="var-name">&$v</span>)
183 </div>
184
185 <div class="method-definition">
186 <img src="../../media/images/Method.png" alt=" "/>
187 <span class="method-result">int</span>
188 <a href="#CountElements" title="details" class="method-name">CountElements</a>
189 ()
190 </div>
191
192 <div class="method-definition">
193 <img src="../../media/images/Method.png" alt=" "/>
194 <span class="method-result">string</span>
195 <a href="#GetAttribute" title="details" class="method-name">GetAttribute</a>
196 (<span class="var-type">string</span>&nbsp;<span class="var-name">$attr</span>)
197 </div>
198
199 <div class="method-definition">
200 <img src="../../media/images/Method.png" alt=" "/>
201 <span class="method-result">array</span>
202 <a href="#GetAttributes" title="details" class="method-name">GetAttributes</a>
203 ()
204 </div>
205
206 <div class="method-definition">
207 <img src="../../media/images/Method.png" alt=" "/>
208 <span class="method-result">array</span>
209 <a href="#GetContent" title="details" class="method-name">GetContent</a>
210 ()
211 </div>
212
213 <div class="method-definition">
214 <img src="../../media/images/Method.png" alt=" "/>
215 <span class="method-result">array</span>
216 <a href="#GetElements" title="details" class="method-name">GetElements</a>
217 ([<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>])
218 </div>
219
220 <div class="method-definition">
221 <img src="../../media/images/Method.png" alt=" "/>
222 <span class="method-result">string</span>
223 <a href="#GetNSTag" title="details" class="method-name">GetNSTag</a>
224 ()
225 </div>
226
227 <div class="method-definition">
228 <img src="../../media/images/Method.png" alt=" "/>
229 <span class="method-result">array</span>
230 <a href="#GetPath" title="details" class="method-name">GetPath</a>
231 (<span class="var-type"></span>&nbsp;<span class="var-name">$path</span>)
232 </div>
233
234 <div class="method-definition">
235 <img src="../../media/images/Method.png" alt=" "/>
236 <span class="method-result">string</span>
237 <a href="#GetTag" title="details" class="method-name">GetTag</a>
238 ()
239 </div>
240
241 <div class="method-definition">
242 <img src="../../media/images/Method.png" alt=" "/>
243 <span class="method-result">objectref</span>
244 <a href="#NewElement" title="details" class="method-name">&amp;NewElement</a>
245 (<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>])
246 </div>
247
248 <div class="method-definition">
249 <img src="../../media/images/Method.png" alt=" "/>
250 <span class="method-result">void</span>
251 <a href="#Render" title="details" class="method-name">Render</a>
252 ([<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>])
253 </div>
254
255 <div class="method-definition">
256 <img src="../../media/images/Method.png" alt=" "/>
257 <span class="method-result">string</span>
258 <a href="#RenderContent" title="details" class="method-name">RenderContent</a>
259 ([<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>])
260 </div>
261
262 <div class="method-definition">
263 <img src="../../media/images/Method.png" alt=" "/>
264 <span class="method-result">void</span>
265 <a href="#SetAttribute" title="details" class="method-name">SetAttribute</a>
266 (<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>)
267 </div>
268
269 <div class="method-definition">
270 <img src="../../media/images/Method.png" alt=" "/>
271 <span class="method-result">void</span>
272 <a href="#SetContent" title="details" class="method-name">SetContent</a>
273 (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$v</span>)
274 </div>
275
276 <div class="method-definition">
277 <img src="../../media/images/Method.png" alt=" "/>
278 <span class="method-result">void</span>
279 <a href="#__tostring" title="details" class="method-name">__tostring</a>
280 ()
281 </div>
282 </div>
283 </div>
284 </div>
285
286 <a name="sec-vars"></a>
287 <div class="info-box">
288 <div class="info-box-title">Variables</div>
289 <div class="nav-bar">
290 <a href="#sec-description">Description</a> |
291 <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
292
293
294 |
295 <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
296
297 </div>
298 <div class="info-box-body">
299
300 <a name="var$attributes" id="$attributes"><!-- --></A>
301 <div class="evenrow">
302
303 <div class="var-header">
304 <img src="../../media/images/Variable.png" />
305 <span class="var-title">
306 <span class="var-type">mixed</span>
307 <span class="var-name">$attributes</span>
308 (line <span class="line-number">23</span>)
309 </span>
310 </div>
311
312 <!-- ========== Info from phpDoc block ========= -->
313 <ul class="tags">
314 <li><span class="field">access:</span> protected</li>
315 </ul>
316
317
318
319
320
321 </div>
322 <a name="var$content" id="$content"><!-- --></A>
323 <div class="oddrow">
324
325 <div class="var-header">
326 <img src="../../media/images/Variable.png" />
327 <span class="var-title">
328 <span class="var-type">mixed</span>
329 <span class="var-name">$content</span>
330 (line <span class="line-number">24</span>)
331 </span>
332 </div>
333
334 <!-- ========== Info from phpDoc block ========= -->
335 <ul class="tags">
336 <li><span class="field">access:</span> protected</li>
337 </ul>
338
339
340
341
342
343 </div>
344 <a name="var$tagname" id="$tagname"><!-- --></A>
345 <div class="evenrow">
346
347 <div class="var-header">
348 <img src="../../media/images/Variable.png" />
349 <span class="var-title">
350 <span class="var-type">mixed</span>
351 <span class="var-name">$tagname</span>
352 (line <span class="line-number">21</span>)
353 </span>
354 </div>
355
356 <!-- ========== Info from phpDoc block ========= -->
357 <ul class="tags">
358 <li><span class="field">access:</span> protected</li>
359 </ul>
360
361
362
363
364
365 </div>
366 <a name="var$xmlns" id="$xmlns"><!-- --></A>
367 <div class="oddrow">
368
369 <div class="var-header">
370 <img src="../../media/images/Variable.png" />
371 <span class="var-title">
372 <span class="var-type">mixed</span>
373 <span class="var-name">$xmlns</span>
374 (line <span class="line-number">22</span>)
375 </span>
376 </div>
377
378 <!-- ========== Info from phpDoc block ========= -->
379 <ul class="tags">
380 <li><span class="field">access:</span> protected</li>
381 </ul>
382
383
384
385
386
387 </div>
388 <a name="var$_parent" id="$_parent"><!-- --></A>
389 <div class="evenrow">
390
391 <div class="var-header">
392 <img src="../../media/images/Variable.png" />
393 <span class="var-title">
394 <span class="var-type">mixed</span>
395 <span class="var-name">$_parent</span>
396 (line <span class="line-number">25</span>)
397 </span>
398 </div>
399
400 <!-- ========== Info from phpDoc block ========= -->
401 <ul class="tags">
402 <li><span class="field">access:</span> protected</li>
403 </ul>
404
405
406
407
408
409 </div>
410
411 </div>
412 </div>
413
414 <a name="sec-methods"></a>
415 <div class="info-box">
416 <div class="info-box-title">Methods</div>
417 <div class="nav-bar">
418 <a href="#sec-description">Description</a> |
419 <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
420 <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
421
422 </div>
423 <div class="info-box-body">
424 <A NAME='method_detail'></A>
425 <a name="method__construct" id="__construct"><!-- --></a>
426 <div class="oddrow">
427
428 <div class="method-header">
429 <img src="../../media/images/Constructor.png" />
430 <span class="method-title">Constructor __construct</span> (line <span class="line-number">35</span>)
431 </div>
432
433 <!-- ========== Info from phpDoc block ========= -->
434 <p class="short-description">Constructor - nothing fancy as yet.</p>
435
436 <div class="method-signature">
437 <span class="method-result">XMLElement</span>
438 <span class="method-name">
439 __construct
440 </span>
441 (<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">array</span>&nbsp;<span class="var-name">$xmlns</span> = <span class="var-default">null</span>])
442 </div>
443
444 <ul class="parameters">
445 <li>
446 <span class="var-type">string</span>
447 <span class="var-name">$tagname</span><span class="var-description">: The tag name of the new element</span> </li>
448 <li>
449 <span class="var-type">mixed</span>
450 <span class="var-name">$content</span><span class="var-description">: Either a string of content, or an array of sub-elements</span> </li>
451 <li>
452 <span class="var-type">array</span>
453 <span class="var-name">$attributes</span><span class="var-description">: An array of attribute name/value pairs</span> </li>
454 <li>
455 <span class="var-type">array</span>
456 <span class="var-name">$xmlns</span><span class="var-description">: An XML namespace specifier</span> </li>
457 </ul>
458
459
460 </div>
461 <a name="methodAddSubTag" id="AddSubTag"><!-- --></a>
462 <div class="evenrow">
463
464 <div class="method-header">
465 <img src="../../media/images/Method.png" />
466 <span class="method-title">AddSubTag</span> (line <span class="line-number">206</span>)
467 </div>
468
469 <!-- ========== Info from phpDoc block ========= -->
470 <p class="short-description">Add a sub-element</p>
471
472 <div class="method-signature">
473 <span class="method-result">void</span>
474 <span class="method-name">
475 AddSubTag
476 </span>
477 (<span class="var-type">object An</span>&nbsp;<span class="var-name">&$v</span>)
478 </div>
479
480 <ul class="parameters">
481 <li>
482 <span class="var-type">object An</span>
483 <span class="var-name">&$v</span><span class="var-description">: XMLElement to be appended to the array of sub-elements</span> </li>
484 </ul>
485
486
487 </div>
488 <a name="methodCountElements" id="CountElements"><!-- --></a>
489 <div class="oddrow">
490
491 <div class="method-header">
492 <img src="../../media/images/Method.png" />
493 <span class="method-title">CountElements</span> (line <span class="line-number">59</span>)
494 </div>
495
496 <!-- ========== Info from phpDoc block ========= -->
497 <p class="short-description">Count the number of elements</p>
498 <ul class="tags">
499 <li><span class="field">return:</span> The number of elements</li>
500 </ul>
501
502 <div class="method-signature">
503 <span class="method-result">int</span>
504 <span class="method-name">
505 CountElements
506 </span>
507 ()
508 </div>
509
510
511
512 </div>
513 <a name="methodGetAttribute" id="GetAttribute"><!-- --></a>
514 <div class="evenrow">
515
516 <div class="method-header">
517 <img src="../../media/images/Method.png" />
518 <span class="method-title">GetAttribute</span> (line <span class="line-number">112</span>)
519 </div>
520
521 <!-- ========== Info from phpDoc block ========= -->
522 <p class="short-description">Accessor for a single attribute</p>
523 <ul class="tags">
524 <li><span class="field">return:</span> The value of that attribute of the element</li>
525 </ul>
526
527 <div class="method-signature">
528 <span class="method-result">string</span>
529 <span class="method-name">
530 GetAttribute
531 </span>
532 (<span class="var-type">string</span>&nbsp;<span class="var-name">$attr</span>)
533 </div>
534
535 <ul class="parameters">
536 <li>
537 <span class="var-type">string</span>
538 <span class="var-name">$attr</span><span class="var-description">: The name of the attribute.</span> </li>
539 </ul>
540
541
542 </div>
543 <a name="methodGetAttributes" id="GetAttributes"><!-- --></a>
544 <div class="oddrow">
545
546 <div class="method-header">
547 <img src="../../media/images/Method.png" />
548 <span class="method-title">GetAttributes</span> (line <span class="line-number">123</span>)
549 </div>
550
551 <!-- ========== Info from phpDoc block ========= -->
552 <p class="short-description">Accessor for the attributes</p>
553 <ul class="tags">
554 <li><span class="field">return:</span> The attributes of this element</li>
555 </ul>
556
557 <div class="method-signature">
558 <span class="method-result">array</span>
559 <span class="method-name">
560 GetAttributes
561 </span>
562 ()
563 </div>
564
565
566
567 </div>
568 <a name="methodGetContent" id="GetContent"><!-- --></a>
569 <div class="evenrow">
570
571 <div class="method-header">
572 <img src="../../media/images/Method.png" />
573 <span class="method-title">GetContent</span> (line <span class="line-number">132</span>)
574 </div>
575
576 <!-- ========== Info from phpDoc block ========= -->
577 <p class="short-description">Accessor for the content</p>
578 <ul class="tags">
579 <li><span class="field">return:</span> The content of this element</li>
580 </ul>
581
582 <div class="method-signature">
583 <span class="method-result">array</span>
584 <span class="method-name">
585 GetContent
586 </span>
587 ()
588 </div>
589
590
591
592 </div>
593 <a name="methodGetElements" id="GetElements"><!-- --></a>
594 <div class="oddrow">
595
596 <div class="method-header">
597 <img src="../../media/images/Method.png" />
598 <span class="method-title">GetElements</span> (line <span class="line-number">142</span>)
599 </div>
600
601 <!-- ========== Info from phpDoc block ========= -->
602 <p class="short-description">Return an array of elements matching the specified tag, or all elements if no tag is supplied.</p>
603 <p class="description"><p>Unlike GetContent() this will always return an array.</p></p>
604 <ul class="tags">
605 <li><span class="field">return:</span> The XMLElements within the tree which match this tag</li>
606 </ul>
607
608 <div class="method-signature">
609 <span class="method-result">array</span>
610 <span class="method-name">
611 GetElements
612 </span>
613 ([<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>])
614 </div>
615
616 <ul class="parameters">
617 <li>
618 <span class="var-type"></span>
619 <span class="var-name">$tag</span> </li>
620 <li>
621 <span class="var-type"></span>
622 <span class="var-name">$recursive</span> </li>
623 </ul>
624
625
626 </div>
627 <a name="methodGetNSTag" id="GetNSTag"><!-- --></a>
628 <div class="evenrow">
629
630 <div class="method-header">
631 <img src="../../media/images/Method.png" />
632 <span class="method-title">GetNSTag</span> (line <span class="line-number">103</span>)
633 </div>
634
635 <!-- ========== Info from phpDoc block ========= -->
636 <p class="short-description">Accessor for the full-namespaced tag name</p>
637 <ul class="tags">
638 <li><span class="field">return:</span> The tag name of the element, prefixed by the namespace</li>
639 </ul>
640
641 <div class="method-signature">
642 <span class="method-result">string</span>
643 <span class="method-name">
644 GetNSTag
645 </span>
646 ()
647 </div>
648
649
650
651 </div>
652 <a name="methodGetPath" id="GetPath"><!-- --></a>
653 <div class="oddrow">
654
655 <div class="method-header">
656 <img src="../../media/images/Method.png" />
657 <span class="method-title">GetPath</span> (line <span class="line-number">166</span>)
658 </div>
659
660 <!-- ========== Info from phpDoc block ========= -->
661 <p class="short-description">Return an array of elements matching the specified path</p>
662 <ul class="tags">
663 <li><span class="field">return:</span> The XMLElements within the tree which match this tag</li>
664 </ul>
665
666 <div class="method-signature">
667 <span class="method-result">array</span>
668 <span class="method-name">
669 GetPath
670 </span>
671 (<span class="var-type"></span>&nbsp;<span class="var-name">$path</span>)
672 </div>
673
674 <ul class="parameters">
675 <li>
676 <span class="var-type"></span>
677 <span class="var-name">$path</span> </li>
678 </ul>
679
680
681 </div>
682 <a name="methodGetTag" id="GetTag"><!-- --></a>
683 <div class="evenrow">
684
685 <div class="method-header">
686 <img src="../../media/images/Method.png" />
687 <span class="method-title">GetTag</span> (line <span class="line-number">94</span>)
688 </div>
689
690 <!-- ========== Info from phpDoc block ========= -->
691 <p class="short-description">Accessor for the tag name</p>
692 <ul class="tags">
693 <li><span class="field">return:</span> The tag name of the element</li>
694 </ul>
695
696 <div class="method-signature">
697 <span class="method-result">string</span>
698 <span class="method-name">
699 GetTag
700 </span>
701 ()
702 </div>
703
704
705
706 </div>
707 <a name="methodNewElement" id="NewElement"><!-- --></a>
708 <div class="oddrow">
709
710 <div class="method-header">
711 <img src="../../media/images/Method.png" />
712 <span class="method-title">NewElement</span> (line <span class="line-number">221</span>)
713 </div>
714
715 <!-- ========== Info from phpDoc block ========= -->
716 <p class="short-description">Add a new sub-element</p>
717 <ul class="tags">
718 <li><span class="field">return:</span> A reference to the new XMLElement</li>
719 </ul>
720
721 <div class="method-signature">
722 <span class="method-result">objectref</span>
723 <span class="method-name">
724 &amp;NewElement
725 </span>
726 (<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>])
727 </div>
728
729 <ul class="parameters">
730 <li>
731 <span class="var-type">string</span>
732 <span class="var-name">$tagname</span><span class="var-description">: The tag name of the new element</span> </li>
733 <li>
734 <span class="var-type">mixed</span>
735 <span class="var-name">$content</span><span class="var-description">: Either a string of content, or an array of sub-elements</span> </li>
736 <li>
737 <span class="var-type">array</span>
738 <span class="var-name">$attributes</span><span class="var-description">: An array of attribute name/value pairs</span> </li>
739 <li>
740 <span class="var-type"></span>
741 <span class="var-name">$xmlns</span> </li>
742 </ul>
743
744
745 </div>
746 <a name="methodRender" id="Render"><!-- --></a>
747 <div class="evenrow">
748
749 <div class="method-header">
750 <img src="../../media/images/Method.png" />
751 <span class="method-title">Render</span> (line <span class="line-number">264</span>)
752 </div>
753
754 <!-- ========== Info from phpDoc block ========= -->
755 <p class="short-description">Render the document tree into (nicely formatted) XML</p>
756
757 <div class="method-signature">
758 <span class="method-result">void</span>
759 <span class="method-name">
760 Render
761 </span>
762 ([<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>])
763 </div>
764
765 <ul class="parameters">
766 <li>
767 <span class="var-type">int</span>
768 <span class="var-name">$indent</span><span class="var-description">: The indenting level for the pretty formatting of the element</span> </li>
769 <li>
770 <span class="var-type"></span>
771 <span class="var-name">$xmldef</span> </li>
772 <li>
773 <span class="var-type"></span>
774 <span class="var-name">$nslist</span> </li>
775 </ul>
776
777
778 </div>
779 <a name="methodRenderContent" id="RenderContent"><!-- --></a>
780 <div class="oddrow">
781
782 <div class="method-header">
783 <img src="../../media/images/Method.png" />
784 <span class="method-title">RenderContent</span> (line <span class="line-number">234</span>)
785 </div>
786
787 <!-- ========== Info from phpDoc block ========= -->
788 <p class="short-description">Render just the internal content</p>
789 <ul class="tags">
790 <li><span class="field">return:</span> The content of this element, as a string without this element wrapping it.</li>
791 </ul>
792
793 <div class="method-signature">
794 <span class="method-result">string</span>
795 <span class="method-name">
796 RenderContent
797 </span>
798 ([<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>])
799 </div>
800
801 <ul class="parameters">
802 <li>
803 <span class="var-type"></span>
804 <span class="var-name">$indent</span> </li>
805 <li>
806 <span class="var-type"></span>
807 <span class="var-name">$nslist</span> </li>
808 </ul>
809
810
811 </div>
812 <a name="methodSetAttribute" id="SetAttribute"><!-- --></a>
813 <div class="evenrow">
814
815 <div class="method-header">
816 <img src="../../media/images/Method.png" />
817 <span class="method-title">SetAttribute</span> (line <span class="line-number">72</span>)
818 </div>
819
820 <!-- ========== Info from phpDoc block ========= -->
821 <p class="short-description">Set an element attribute to a value</p>
822
823 <div class="method-signature">
824 <span class="method-result">void</span>
825 <span class="method-name">
826 SetAttribute
827 </span>
828 (<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>)
829 </div>
830
831 <ul class="parameters">
832 <li>
833 <span class="var-type">string</span>
834 <span class="var-name">$k</span><span class="var-description">: The attribute name</span> </li>
835 <li>
836 <span class="var-type">string</span>
837 <span class="var-name">$v</span><span class="var-description">: The attribute value</span> </li>
838 </ul>
839
840
841 </div>
842 <a name="methodSetContent" id="SetContent"><!-- --></a>
843 <div class="oddrow">
844
845 <div class="method-header">
846 <img src="../../media/images/Method.png" />
847 <span class="method-title">SetContent</span> (line <span class="line-number">85</span>)
848 </div>
849
850 <!-- ========== Info from phpDoc block ========= -->
851 <p class="short-description">Set the whole content to a value</p>
852
853 <div class="method-signature">
854 <span class="method-result">void</span>
855 <span class="method-name">
856 SetContent
857 </span>
858 (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$v</span>)
859 </div>
860
861 <ul class="parameters">
862 <li>
863 <span class="var-type">mixed</span>
864 <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>
865 </ul>
866
867
868 </div>
869 <a name="method__tostring" id="__tostring"><!-- --></a>
870 <div class="evenrow">
871
872 <div class="method-header">
873 <img src="../../media/images/Method.png" />
874 <span class="method-title">__tostring</span> (line <span class="line-number">302</span>)
875 </div>
876
877 <!-- ========== Info from phpDoc block ========= -->
878
879 <div class="method-signature">
880 <span class="method-result">void</span>
881 <span class="method-name">
882 __tostring
883 </span>
884 ()
885 </div>
886
887
888
889 </div>
890
891 </div>
892 </div>
893
894
895 <p class="notes" id="credit">
896 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>
897 </p>
898 </div></body>
899 </html>
Andrew's Web Libraries