/[cvs]/nfo/php/libs/com.newsblob.phphtmllib/doc/phpHtmlLib/XMLDocumentClass.html
ViewVC logotype

Contents of /nfo/php/libs/com.newsblob.phphtmllib/doc/phpHtmlLib/XMLDocumentClass.html

Parent Directory Parent Directory | Revision Log Revision Log

Revision 1.4 - (show annotations)
Thu May 6 16:24:30 2004 UTC (20 years, 8 months ago) by jonen
Branch: MAIN
CVS Tags: HEAD
Changes since 1.3: +1298 -1304 lines
File MIME type: text/html 
 updated all to v2.4.1 - Apr 01, 2004
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 XMLDocumentClass</title>
7 <link rel="stylesheet" href="../media/stylesheet.css" />
8 <meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
9 </head>
10 <body>
11 <div class="page-body">
12
13 <h2 class="class-name">Class XMLDocumentClass</h2>
14
15 <a name="sec-description"></a>
16 <div class="info-box">
17 <div class="info-box-title">Description</div>
18 <div class="nav-bar">
19 <span class="disabled">Description</span> |
20 <a href="#sec-descendents">Descendents</a>
21 | <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
22 | <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
23
24 </div>
25 <div class="info-box-body">
26 <!-- ========== Info from phpDoc block ========= -->
27 <p class="short-description">This class lets you build a complete xml document and render it.</p>
28 <p class="description"><p>It automatically creates the root xml tag that will contain all of the content. The name of the tag is the first parameter to the constructor. You can add/change the attributes to the root tag via the set_root_attributes() or the set_root_attribute() methods.</p></p>
29 <ul class="tags">
30 <li><span class="field">author:</span> Walter A. Boring IV &lt;<a href="mailto:waboring@buildabetterweb.com">waboring@buildabetterweb.com</a>&gt;</li>
31 </ul>
32 <p class="notes">
33 Located in <a class="field" href="_widgets_xml_XMLDocumentClass_inc.html">/widgets/xml/XMLDocumentClass.inc</a> (line <span class="field">29</span>)
34 </p>
35
36
37 <pre><a href="../phpHtmlLib/Container.html">Container</a>
38 |
39 --XMLDocumentClass</pre>
40
41 </div>
42 </div>
43
44 <a name="sec-descendents"></a>
45 <div class="info-box">
46 <div class="info-box-title">Direct descendents</div>
47 <div class="nav-bar">
48 <a href="#sec-description">Description</a> |
49 <span class="disabled">Descendents</span>
50 | <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
51 | <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
52
53 </div>
54 <div class="info-box-body">
55 <table cellpadding="2" cellspacing="0" class="class-table">
56 <tr>
57 <th class="class-table-header">Class</th>
58 <th class="class-table-header">Description</th>
59 </tr>
60 <tr>
61 <td style="padding-right: 2em"><a href="../phpHtmlLib/SVGDocumentClass.html">SVGDocumentClass</a></td>
62 <td>
63 This class lets you build a complete SVG document.
64 </td>
65 </tr>
66 <tr>
67 <td style="padding-right: 2em"><a href="../phpHtmlLib/WMLDocumentClass.html">WMLDocumentClass</a></td>
68 <td>
69 This class lets you build a complete WML document and render it
70 </td>
71 </tr>
72 </table>
73 </div>
74 </div>
75
76
77 <a name="sec-var-summary"></a>
78 <div class="info-box">
79 <div class="info-box-title">Variable Summary</span></div>
80 <div class="nav-bar">
81 <a href="#sec-description">Description</a> |
82 <a href="#sec-descendents">Descendents</a> |
83 <span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
84 |
85 <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
86
87 </div>
88 <div class="info-box-body">
89 <div class="var-summary">
90 <div class="var-title">
91 <span class="var-type">mixed</span>
92 <a href="#$dtd" title="details" class="var-name">$dtd</a>
93 </div>
94 <div class="var-title">
95 <span class="var-type">mixed</span>
96 <a href="#$root_name" title="details" class="var-name">$root_name</a>
97 </div>
98 <div class="var-title">
99 <span class="var-type">mixed</span>
100 <a href="#$_doctype_links" title="details" class="var-name">$_doctype_links</a>
101 </div>
102 <div class="var-title">
103 <span class="var-type">string</span>
104 <a href="#$_doctype_source" title="details" class="var-name">$_doctype_source</a>
105 </div>
106 <div class="var-title">
107 <span class="var-type">mixed</span>
108 <a href="#$_http_content_type" title="details" class="var-name">$_http_content_type</a>
109 </div>
110 <div class="var-title">
111 <span class="var-type"><a href="../phpHtmlLib/XMLTagClass.html">XMLTagClass</a></span>
112 <a href="#$_root_tag" title="details" class="var-name">$_root_tag</a>
113 </div>
114 <div class="var-title">
115 <span class="var-type">boolean</span>
116 <a href="#$_show_char_encoding" title="details" class="var-name">$_show_char_encoding</a>
117 </div>
118 <div class="var-title">
119 <span class="var-type">mixed</span>
120 <a href="#$_show_http_header" title="details" class="var-name">$_show_http_header</a>
121 </div>
122 <div class="var-title">
123 <span class="var-type">mixed</span>
124 <a href="#$_xml_obj" title="details" class="var-name">$_xml_obj</a>
125 </div>
126 <div class="var-title">
127 <span class="var-type">object</span>
128 <a href="#$_xml_stylesheet_container" title="details" class="var-name">$_xml_stylesheet_container</a>
129 </div>
130 </div>
131 </div>
132 </div>
133
134 <a name="sec-method-summary"></a>
135 <div class="info-box">
136 <div class="info-box-title">Method Summary</span></div>
137 <div class="nav-bar">
138 <a href="#sec-description">Description</a> |
139 <a href="#sec-descendents">Descendents</a> |
140 <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
141
142 |
143 <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
144 </div>
145 <div class="info-box-body">
146 <div class="method-summary">
147
148 <div class="method-definition">
149 <span class="method-result">XMLDocumentClass</span>
150 <a href="#XMLDocumentClass" title="details" class="method-name">XMLDocumentClass</a>
151 (<span class="var-type">string</span>&nbsp;<span class="var-name">$root_name</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$dtd</span> = <span class="var-default">NULL</span>], [<span class="var-type">array</span>&nbsp;<span class="var-name">$root_attributes</span> = <span class="var-default">array()</span>])
152 </div>
153
154 <div class="method-definition">
155 <span class="method-result">void</span>
156 <a href="#add" title="details" class="method-name">add</a>
157 (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$content</span>)
158 </div>
159
160 <div class="method-definition">
161 <span class="method-result">void</span>
162 <a href="#add_reference" title="details" class="method-name">add_reference</a>
163 (<span class="var-type">mixed</span>&nbsp;<span class="var-name">&$content</span>)
164 </div>
165
166 <div class="method-definition">
167 <span class="method-result">void</span>
168 <a href="#add_xml_stylesheet_link" title="details" class="method-name">add_xml_stylesheet_link</a>
169 (<span class="var-type">string</span>&nbsp;<span class="var-name">$href</span>)
170 </div>
171
172 <div class="method-definition">
173 <span class="method-result">void</span>
174 <a href="#dump_http_header" title="details" class="method-name">dump_http_header</a>
175 ()
176 </div>
177
178 <div class="method-definition">
179 <span class="method-result">string</span>
180 <a href="#get_doctype_source" title="details" class="method-name">get_doctype_source</a>
181 ()
182 </div>
183
184 <div class="method-definition">
185 <span class="method-result">string</span>
186 <a href="#get_encoding" title="details" class="method-name">get_encoding</a>
187 ()
188 </div>
189
190 <div class="method-definition">
191 <span class="method-result">string</span>
192 <a href="#get_http_content_type" title="details" class="method-name">get_http_content_type</a>
193 ()
194 </div>
195
196 <div class="method-definition">
197 <span class="method-result">array</span>
198 <a href="#get_root_attributes" title="details" class="method-name">get_root_attributes</a>
199 ()
200 </div>
201
202 <div class="method-definition">
203 <span class="method-result">string</span>
204 <a href="#get_root_name" title="details" class="method-name">get_root_name</a>
205 ()
206 </div>
207
208 <div class="method-definition">
209 <span class="method-result">void</span>
210 <a href="#push" title="details" class="method-name">push</a>
211 (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$content</span>)
212 </div>
213
214 <div class="method-definition">
215 <span class="method-result">void</span>
216 <a href="#push_reference" title="details" class="method-name">push_reference</a>
217 (<span class="var-type">mixed</span>&nbsp;<span class="var-name">&$content</span>)
218 </div>
219
220 <div class="method-definition">
221 <span class="method-result">string</span>
222 <a href="#render" title="details" class="method-name">render</a>
223 (<span class="var-type">int</span>&nbsp;<span class="var-name">$indent_level</span>, <span class="var-type">int</span>&nbsp;<span class="var-name">1</span>)
224 </div>
225
226 <div class="method-definition">
227 <span class="method-result">void</span>
228 <a href="#reset_content" title="details" class="method-name">reset_content</a>
229 (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$content</span>)
230 </div>
231
232 <div class="method-definition">
233 <span class="method-result">void</span>
234 <a href="#set_doctype_link" title="details" class="method-name">set_doctype_link</a>
235 (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$link</span>)
236 </div>
237
238 <div class="method-definition">
239 <span class="method-result">void</span>
240 <a href="#set_doctype_source" title="details" class="method-name">set_doctype_source</a>
241 (<span class="var-type">string</span>&nbsp;<span class="var-name">$source</span>)
242 </div>
243
244 <div class="method-definition">
245 <span class="method-result">void</span>
246 <a href="#set_encoding" title="details" class="method-name">set_encoding</a>
247 (<span class="var-type">string</span>&nbsp;<span class="var-name">$charset</span>)
248 </div>
249
250 <div class="method-definition">
251 <span class="method-result">void</span>
252 <a href="#set_http_content_type" title="details" class="method-name">set_http_content_type</a>
253 ([<span class="var-type">string</span>&nbsp;<span class="var-name">$type</span> = <span class="var-default">"application/xml"</span>])
254 </div>
255
256 <div class="method-definition">
257 <span class="method-result">void</span>
258 <a href="#set_root_attribute" title="details" class="method-name">set_root_attribute</a>
259 (<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>)
260 </div>
261
262 <div class="method-definition">
263 <span class="method-result">void</span>
264 <a href="#set_root_attributes" title="details" class="method-name">set_root_attributes</a>
265 (<span class="var-type">array</span>&nbsp;<span class="var-name">$attributes</span>)
266 </div>
267
268 <div class="method-definition">
269 <span class="method-result">void</span>
270 <a href="#set_root_name" title="details" class="method-name">set_root_name</a>
271 (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$root_name</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$doc_name</span>)
272 </div>
273
274 <div class="method-definition">
275 <span class="method-result">void</span>
276 <a href="#show_character_encoding" title="details" class="method-name">show_character_encoding</a>
277 ([<span class="var-type">boolean</span>&nbsp;<span class="var-name">$flag</span> = <span class="var-default">TRUE</span>])
278 </div>
279
280 <div class="method-definition">
281 <span class="method-result">void</span>
282 <a href="#show_http_header" title="details" class="method-name">show_http_header</a>
283 ([<span class="var-type">boolean</span>&nbsp;<span class="var-name">$flag</span> = <span class="var-default">TRUE</span>])
284 </div>
285
286 <div class="method-definition">
287 <span class="method-result">void</span>
288 <a href="#_build_doctype" title="details" class="method-name">_build_doctype</a>
289 ()
290 </div>
291
292 <div class="method-definition">
293 <span class="method-result">void</span>
294 <a href="#_build_root_tag" title="details" class="method-name">_build_root_tag</a>
295 ()
296 </div>
297
298 <div class="method-definition">
299 <span class="method-result">void</span>
300 <a href="#_build_xml_stylesheet_container" title="details" class="method-name">_build_xml_stylesheet_container</a>
301 ()
302 </div>
303
304 <div class="method-definition">
305 <span class="method-result"><a href="../phpHtmlLib/XMLtag.html">XMLtag</a></span>
306 <a href="#_create_xml_obj" title="details" class="method-name">_create_xml_obj</a>
307 ()
308 </div>
309 </div>
310 </div>
311 </div>
312
313 <a name="sec-vars"></a>
314 <div class="info-box">
315 <div class="info-box-title">Variables</div>
316 <div class="nav-bar">
317 <a href="#sec-description">Description</a> |
318 <a href="#sec-descendents">Descendents</a> |
319 <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
320
321
322 |
323 <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
324
325 </div>
326 <div class="info-box-body">
327 <a name="var$dtd" id="$dtd"><!-- --></A>
328 <div class="evenrow">
329
330 <div class="var-header">
331 <span class="var-title">
332 <span class="var-type">mixed</span>
333 <span class="var-name">$dtd</span>
334 = <span class="var-default"> NULL</span> (line <span class="line-number">69</span>)
335 </span>
336 </div>
337
338 <!-- ========== Info from phpDoc block ========= -->
339 <p class="short-description">Holds the url of dtd</p>
340
341
342
343
344
345 </div>
346 <a name="var$root_name" id="$root_name"><!-- --></A>
347 <div class="oddrow">
348
349 <div class="var-header">
350 <span class="var-title">
351 <span class="var-type">mixed</span>
352 <span class="var-name">$root_name</span>
353 = <span class="var-default"> NULL</span> (line <span class="line-number">76</span>)
354 </span>
355 </div>
356
357 <!-- ========== Info from phpDoc block ========= -->
358 <p class="short-description">Holds the name of the root xml</p>
359 <p class="description"><p>element as well as the DOCTYPE document_element attribute</p></p>
360
361
362
363
364
365 </div>
366 <a name="var$_doctype_links" id="$_doctype_links"><!-- --></A>
367 <div class="evenrow">
368
369 <div class="var-header">
370 <span class="var-title">
371 <span class="var-type">mixed</span>
372 <span class="var-name">$_doctype_links</span>
373 = <span class="var-default">array()</span> (line <span class="line-number">105</span>)
374 </span>
375 </div>
376
377 <!-- ========== Info from phpDoc block ========= -->
378 <p class="short-description">This contains the doctype links</p>
379 <p class="description"><p>attributes. There can be a maximum of 2 according to the XML spec</p></p>
380
381
382
383
384
385 </div>
386 <a name="var$_doctype_source" id="$_doctype_source"><!-- --></A>
387 <div class="oddrow">
388
389 <div class="var-header">
390 <span class="var-title">
391 <span class="var-type">string</span>
392 <span class="var-name">$_doctype_source</span>
393 = <span class="var-default"> &quot;SYSTEM&quot;</span> (line <span class="line-number">98</span>)
394 </span>
395 </div>
396
397 <!-- ========== Info from phpDoc block ========= -->
398 <p class="short-description">the DOCTYPE source attribute</p>
399
400
401
402
403
404 </div>
405 <a name="var$_http_content_type" id="$_http_content_type"><!-- --></A>
406 <div class="evenrow">
407
408 <div class="var-header">
409 <span class="var-title">
410 <span class="var-type">mixed</span>
411 <span class="var-name">$_http_content_type</span>
412 = <span class="var-default"> &quot;application/xml&quot;</span> (line <span class="line-number">111</span>)
413 </span>
414 </div>
415
416 <!-- ========== Info from phpDoc block ========= -->
417 <p class="short-description">The http content-type</p>
418
419
420
421
422
423 </div>
424 <a name="var$_root_tag" id="$_root_tag"><!-- --></A>
425 <div class="oddrow">
426
427 <div class="var-header">
428 <span class="var-title">
429 <span class="var-type"><a href="../phpHtmlLib/XMLTagClass.html">XMLTagClass</a></span>
430 <span class="var-name">$_root_tag</span>
431 = <span class="var-default"> NULL</span> (line <span class="line-number">83</span>)
432 </span>
433 </div>
434
435 <!-- ========== Info from phpDoc block ========= -->
436 <p class="short-description">The root xml tag for all data</p>
437 <ul class="tags">
438 <li><span class="field">var:</span> object</li>
439 </ul>
440
441
442
443
444
445 </div>
446 <a name="var$_show_char_encoding" id="$_show_char_encoding"><!-- --></A>
447 <div class="evenrow">
448
449 <div class="var-header">
450 <span class="var-title">
451 <span class="var-type">boolean</span>
452 <span class="var-name">$_show_char_encoding</span>
453 = <span class="var-default"> TRUE</span> (line <span class="line-number">64</span>)
454 </span>
455 </div>
456
457 <!-- ========== Info from phpDoc block ========= -->
458 <p class="short-description">this is a hack to show the character encoding or not.</p>
459 <p class="description"><p>DEFAULT: on</p></p>
460
461
462
463
464
465 </div>
466 <a name="var$_show_http_header" id="$_show_http_header"><!-- --></A>
467 <div class="oddrow">
468
469 <div class="var-header">
470 <span class="var-title">
471 <span class="var-type">mixed</span>
472 <span class="var-name">$_show_http_header</span>
473 = <span class="var-default"> FALSE</span> (line <span class="line-number">55</span>)
474 </span>
475 </div>
476
477 <!-- ========== Info from phpDoc block ========= -->
478 <p class="short-description">This flag tells if we should output the header content type.</p>
479 <p class="description"><p>this is usefull for folks using this class for output not destined for a browser.</p></p>
480
481
482
483
484
485 </div>
486 <a name="var$_xml_obj" id="$_xml_obj"><!-- --></A>
487 <div class="evenrow">
488
489 <div class="var-header">
490 <span class="var-title">
491 <span class="var-type">mixed</span>
492 <span class="var-name">$_xml_obj</span>
493 = <span class="var-default"> NULL</span> (line <span class="line-number">37</span>)
494 </span>
495 </div>
496
497 <!-- ========== Info from phpDoc block ========= -->
498 <p class="short-description">holds the xml tag object that</p>
499 <p class="description"><p>all content will be wrapped in</p></p>
500
501
502
503
504
505 </div>
506 <a name="var$_xml_stylesheet_container" id="$_xml_stylesheet_container"><!-- --></A>
507 <div class="oddrow">
508
509 <div class="var-header">
510 <span class="var-title">
511 <span class="var-type">object</span>
512 <span class="var-name">$_xml_stylesheet_container</span>
513 = <span class="var-default"> NULL</span> (line <span class="line-number">119</span>)
514 </span>
515 </div>
516
517 <!-- ========== Info from phpDoc block ========= -->
518 <p class="short-description">The container for all the xml-stylesheet tags</p>
519
520
521
522
523
524 </div>
525
526
527 </div>
528 </div>
529
530 <a name="sec-methods"></a>
531 <div class="info-box">
532 <div class="info-box-title">Methods</div>
533 <div class="nav-bar">
534 <a href="#sec-description">Description</a> |
535 <a href="#sec-descendents">Descendents</a> |
536 <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
537 <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
538
539 </div>
540 <div class="info-box-body">
541 <A NAME='method_detail'></A>
542 <a name="methodXMLDocumentClass" id="XMLDocumentClass"><!-- --></a>
543 <div class="evenrow">
544
545 <div class="method-header">
546 <span class="method-title">Constructor XMLDocumentClass</span> (line <span class="line-number">130</span>)
547 </div>
548
549 <!-- ========== Info from phpDoc block ========= -->
550 <p class="short-description">The constructor</p>
551
552 <div class="method-signature">
553 <span class="method-result">XMLDocumentClass</span>
554 <span class="method-name">
555 XMLDocumentClass
556 </span>
557 (<span class="var-type">string</span>&nbsp;<span class="var-name">$root_name</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$dtd</span> = <span class="var-default">NULL</span>], [<span class="var-type">array</span>&nbsp;<span class="var-name">$root_attributes</span> = <span class="var-default">array()</span>])
558 </div>
559
560 <ul class="parameters">
561 <li>
562 <span class="var-type">string</span>
563 <span class="var-name">$root_name</span><span class="var-description">: - the root xml tag's name</span> </li>
564 <li>
565 <span class="var-type">string</span>
566 <span class="var-name">$dtd</span><span class="var-description">: - the link path to the DTD (if any)</span> </li>
567 <li>
568 <span class="var-type">array</span>
569 <span class="var-name">$root_attributes</span><span class="var-description">: - the root tag's attributes</span> </li>
570 </ul>
571
572
573 </div>
574 <a name="methodadd" id="add"><!-- --></a>
575 <div class="oddrow">
576
577 <div class="method-header">
578 <span class="method-title">add</span> (line <span class="line-number">197</span>)
579 </div>
580
581 <!-- ========== Info from phpDoc block ========= -->
582 <p class="short-description">we override this class to make sure we push all content inside the local _xml_obj tag</p>
583 <p class="description"><p>push content onto content stack adds content to tag as a FIFO. You can have n number of parameters. each one will get added in succession to the content.</p></p>
584 <ul class="tags">
585 <li><span class="field">access:</span> public</li>
586 </ul>
587
588 <div class="method-signature">
589 <span class="method-result">void</span>
590 <span class="method-name">
591 add
592 </span>
593 (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$content</span>)
594 </div>
595
596 <ul class="parameters">
597 <li>
598 <span class="var-type">mixed</span>
599 <span class="var-name">$content</span><span class="var-description">: - either string, or tag object.</span> </li>
600 </ul>
601
602 <hr class="separator" />
603 <div class="notes">Redefinition of:</div>
604 <dl>
605 <dt><a href="../phpHtmlLib/Container.html#methodadd">Container::add()</a></dt>
606 <dd>add content onto content stack</dd>
607 </dl>
608
609 </div>
610 <a name="methodadd_reference" id="add_reference"><!-- --></a>
611 <div class="evenrow">
612
613 <div class="method-header">
614 <span class="method-title">add_reference</span> (line <span class="line-number">239</span>)
615 </div>
616
617 <!-- ========== Info from phpDoc block ========= -->
618 <p class="short-description">we override this class to make sure we push all content inside the local _xml_obj tag</p>
619 <p class="description"><p>push content onto content stack adds content to tag as a FIFO You can only add 1 element at a time, and it will be added as a reference. So you can't do push_reference(&quot;something&quot;);, since &quot;something&quot; is a static.</p></p>
620 <ul class="tags">
621 <li><span class="field">access:</span> public</li>
622 </ul>
623
624 <div class="method-signature">
625 <span class="method-result">void</span>
626 <span class="method-name">
627 add_reference
628 </span>
629 (<span class="var-type">mixed</span>&nbsp;<span class="var-name">&$content</span>)
630 </div>
631
632 <ul class="parameters">
633 <li>
634 <span class="var-type">mixed</span>
635 <span class="var-name">$content</span><span class="var-description">: - either string, or tag object. the tag object gets stored as a reference to the original, so you can push it, then modify it later.</span> </li>
636 </ul>
637
638 <hr class="separator" />
639 <div class="notes">Redefinition of:</div>
640 <dl>
641 <dt><a href="../phpHtmlLib/Container.html#methodadd_reference">Container::add_reference()</a></dt>
642 <dd>Add content onto content stack so you can change the item later.</dd>
643 </dl>
644
645 </div>
646 <a name="methodadd_xml_stylesheet_link" id="add_xml_stylesheet_link"><!-- --></a>
647 <div class="oddrow">
648
649 <div class="method-header">
650 <span class="method-title">add_xml_stylesheet_link</span> (line <span class="line-number">269</span>)
651 </div>
652
653 <!-- ========== Info from phpDoc block ========= -->
654 <p class="short-description">This function is used to add a new xml-stylesheet tag to the top portion of the document.</p>
655 <p class="description"><p>This will automatically get added after the xml tag and before the &lt;!DOCTYPE &gt; tag</p></p>
656
657 <div class="method-signature">
658 <span class="method-result">void</span>
659 <span class="method-name">
660 add_xml_stylesheet_link
661 </span>
662 (<span class="var-type">string</span>&nbsp;<span class="var-name">$href</span>)
663 </div>
664
665 <ul class="parameters">
666 <li>
667 <span class="var-type">string</span>
668 <span class="var-name">$href</span><span class="var-description">: - the href for the stylesheet link</span> </li>
669 </ul>
670
671
672 </div>
673 <a name="methoddump_http_header" id="dump_http_header"><!-- --></a>
674 <div class="evenrow">
675
676 <div class="method-header">
677 <span class="method-title">dump_http_header</span> (line <span class="line-number">447</span>)
678 </div>
679
680 <!-- ========== Info from phpDoc block ========= -->
681 <p class="short-description">This function is used to output the http header for this document.</p>
682 <p class="description"><p>It makes a call to php's Header() to set the Content-type</p></p>
683
684 <div class="method-signature">
685 <span class="method-result">void</span>
686 <span class="method-name">
687 dump_http_header
688 </span>
689 ()
690 </div>
691
692
693
694 </div>
695 <a name="methodget_doctype_source" id="get_doctype_source"><!-- --></a>
696 <div class="oddrow">
697
698 <div class="method-header">
699 <span class="method-title">get_doctype_source</span> (line <span class="line-number">483</span>)
700 </div>
701
702 <!-- ========== Info from phpDoc block ========= -->
703 <p class="short-description">This function returns the current DOCTYPE tag's source attribute</p>
704
705 <div class="method-signature">
706 <span class="method-result">string</span>
707 <span class="method-name">
708 get_doctype_source
709 </span>
710 ()
711 </div>
712
713
714
715 </div>
716 <a name="methodget_encoding" id="get_encoding"><!-- --></a>
717 <div class="evenrow">
718
719 <div class="method-header">
720 <span class="method-title">get_encoding</span> (line <span class="line-number">333</span>)
721 </div>
722
723 <!-- ========== Info from phpDoc block ========= -->
724 <p class="short-description">This function gets the current encoding type</p>
725 <ul class="tags">
726 <li><span class="field">return:</span> - the current encoding type for the xml</li>
727 </ul>
728
729 <div class="method-signature">
730 <span class="method-result">string</span>
731 <span class="method-name">
732 get_encoding
733 </span>
734 ()
735 </div>
736
737
738
739 </div>
740 <a name="methodget_http_content_type" id="get_http_content_type"><!-- --></a>
741 <div class="oddrow">
742
743 <div class="method-header">
744 <span class="method-title">get_http_content_type</span> (line <span class="line-number">436</span>)
745 </div>
746
747 <!-- ========== Info from phpDoc block ========= -->
748 <p class="short-description">This function returns the current value of the http header content type</p>
749
750 <div class="method-signature">
751 <span class="method-result">string</span>
752 <span class="method-name">
753 get_http_content_type
754 </span>
755 ()
756 </div>
757
758
759
760 </div>
761 <a name="methodget_root_attributes" id="get_root_attributes"><!-- --></a>
762 <div class="evenrow">
763
764 <div class="method-header">
765 <span class="method-title">get_root_attributes</span> (line <span class="line-number">383</span>)
766 </div>
767
768 <!-- ========== Info from phpDoc block ========= -->
769 <p class="short-description">This function is used to get the root xml tag's attributes</p>
770
771 <div class="method-signature">
772 <span class="method-result">array</span>
773 <span class="method-name">
774 get_root_attributes
775 </span>
776 ()
777 </div>
778
779
780
781 </div>
782 <a name="methodget_root_name" id="get_root_name"><!-- --></a>
783 <div class="oddrow">
784
785 <div class="method-header">
786 <span class="method-title">get_root_name</span> (line <span class="line-number">353</span>)
787 </div>
788
789 <!-- ========== Info from phpDoc block ========= -->
790 <p class="short-description">This function gets the document name</p>
791 <ul class="tags">
792 <li><span class="field">return:</span> - the current document name for the xml</li>
793 </ul>
794
795 <div class="method-signature">
796 <span class="method-result">string</span>
797 <span class="method-name">
798 get_root_name
799 </span>
800 ()
801 </div>
802
803
804
805 </div>
806 <a name="methodpush" id="push"><!-- --></a>
807 <div class="evenrow">
808
809 <div class="method-header">
810 <span class="method-title">push</span> (line <span class="line-number">216</span>)
811 </div>
812
813 <!-- ========== Info from phpDoc block ========= -->
814 <p class="short-description">Same as add().</p>
815 <p class="description"><p>NOTE: only exists for 1.1.x compatibility</p></p>
816 <ul class="tags">
817 <li><span class="field">access:</span> public</li>
818 <li><span class="field">deprecated:</span> </li>
819 </ul>
820
821 <div class="method-signature">
822 <span class="method-result">void</span>
823 <span class="method-name">
824 push
825 </span>
826 (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$content</span>)
827 </div>
828
829 <ul class="parameters">
830 <li>
831 <span class="var-type">mixed</span>
832 <span class="var-name">$content</span><span class="var-description">: - either string, or tag object.</span> </li>
833 </ul>
834
835 <hr class="separator" />
836 <div class="notes">Redefinition of:</div>
837 <dl>
838 <dt><a href="../phpHtmlLib/Container.html#methodpush">Container::push()</a></dt>
839 <dd>Same as add().</dd>
840 </dl>
841
842 </div>
843 <a name="methodpush_reference" id="push_reference"><!-- --></a>
844 <div class="oddrow">
845
846 <div class="method-header">
847 <span class="method-title">push_reference</span> (line <span class="line-number">255</span>)
848 </div>
849
850 <!-- ========== Info from phpDoc block ========= -->
851 <p class="short-description">Same as add_reference NOTE : only exists for compatibility with 1.1.x</p>
852 <ul class="tags">
853 <li><span class="field">access:</span> public</li>
854 </ul>
855
856 <div class="method-signature">
857 <span class="method-result">void</span>
858 <span class="method-name">
859 push_reference
860 </span>
861 (<span class="var-type">mixed</span>&nbsp;<span class="var-name">&$content</span>)
862 </div>
863
864 <ul class="parameters">
865 <li>
866 <span class="var-type">mixed</span>
867 <span class="var-name">&$content</span><span class="var-description">: - a reference to some variable.</span> </li>
868 </ul>
869
870 <hr class="separator" />
871 <div class="notes">Redefinition of:</div>
872 <dl>
873 <dt><a href="../phpHtmlLib/Container.html#methodpush_reference">Container::push_reference()</a></dt>
874 <dd>Same as add_reference NOTE : only exists for compatibility with 1.1.x</dd>
875 </dl>
876
877 </div>
878 <a name="methodrender" id="render"><!-- --></a>
879 <div class="evenrow">
880
881 <div class="method-header">
882 <span class="method-title">render</span> (line <span class="line-number">152</span>)
883 </div>
884
885 <!-- ========== Info from phpDoc block ========= -->
886 <p class="short-description">function that will render the XML Document.</p>
887 <ul class="tags">
888 <li><span class="field">return:</span> the raw html output.</li>
889 </ul>
890
891 <div class="method-signature">
892 <span class="method-result">string</span>
893 <span class="method-name">
894 render
895 </span>
896 (<span class="var-type">int</span>&nbsp;<span class="var-name">$indent_level</span>, <span class="var-type">int</span>&nbsp;<span class="var-name">1</span>)
897 </div>
898
899 <ul class="parameters">
900 <li>
901 <span class="var-type">int</span>
902 <span class="var-name">1</span><span class="var-description">: - the output debug flag to maintain compatibility w/ the API.</span> </li>
903 <li>
904 <span class="var-type">int</span>
905 <span class="var-name">$indent_level</span><span class="var-description">: - the indentation level for the container.</span> </li>
906 </ul>
907
908 <hr class="separator" />
909 <div class="notes">Redefinition of:</div>
910 <dl>
911 <dt><a href="../phpHtmlLib/Container.html#methodrender">Container::render()</a></dt>
912 <dd>This function is compatible with the rest of the phpHtmllib API spec.</dd>
913 </dl>
914
915 </div>
916 <a name="methodreset_content" id="reset_content"><!-- --></a>
917 <div class="oddrow">
918
919 <div class="method-header">
920 <span class="method-title">reset_content</span> (line <span class="line-number">291</span>)
921 </div>
922
923 <!-- ========== Info from phpDoc block ========= -->
924 <p class="short-description">we override this class to make sure we push all content inside the local _xml_obj tag</p>
925 <p class="description"><p>destroy existing content and start with new content.</p></p>
926 <ul class="tags">
927 <li><span class="field">access:</span> public</li>
928 </ul>
929
930 <div class="method-signature">
931 <span class="method-result">void</span>
932 <span class="method-name">
933 reset_content
934 </span>
935 (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$content</span>)
936 </div>
937
938 <ul class="parameters">
939 <li>
940 <span class="var-type">mixed</span>
941 <span class="var-name">$content</span><span class="var-description">: can be tag object, or raw (string).</span> </li>
942 </ul>
943
944 <hr class="separator" />
945 <div class="notes">Redefinition of:</div>
946 <dl>
947 <dt><a href="../phpHtmlLib/Container.html#methodreset_content">Container::reset_content()</a></dt>
948 <dd>destroy existing content and start with new content.</dd>
949 </dl>
950
951 </div>
952 <a name="methodset_doctype_link" id="set_doctype_link"><!-- --></a>
953 <div class="evenrow">
954
955 <div class="method-header">
956 <span class="method-title">set_doctype_link</span> (line <span class="line-number">392</span>)
957 </div>
958
959 <!-- ========== Info from phpDoc block ========= -->
960 <p class="short-description">This method is used to set the link attributes</p>
961 <p class="description"><p>for the DOCTYPE tag</p></p>
962
963 <div class="method-signature">
964 <span class="method-result">void</span>
965 <span class="method-name">
966 set_doctype_link
967 </span>
968 (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$link</span>)
969 </div>
970
971
972
973 </div>
974 <a name="methodset_doctype_source" id="set_doctype_source"><!-- --></a>
975 <div class="oddrow">
976
977 <div class="method-header">
978 <span class="method-title">set_doctype_source</span> (line <span class="line-number">464</span>)
979 </div>
980
981 <!-- ========== Info from phpDoc block ========= -->
982 <p class="short-description">this function is used to change the DOCTYPE tag's source attribute. By default it is set to SYSTEM.</p>
983 <p class="description"><p>(ie &lt;!DOCTYPE html SYSTEM &gt; ) ^^^^^^</p><p>NOTE: only 2 valid values 'SYSTEM', 'PUBLIC'</p></p>
984
985 <div class="method-signature">
986 <span class="method-result">void</span>
987 <span class="method-name">
988 set_doctype_source
989 </span>
990 (<span class="var-type">string</span>&nbsp;<span class="var-name">$source</span>)
991 </div>
992
993 <ul class="parameters">
994 <li>
995 <span class="var-type">string</span>
996 <span class="var-name">$source</span><span class="var-description">: - the new source attribute</span> </li>
997 </ul>
998
999
1000 </div>
1001 <a name="methodset_encoding" id="set_encoding"><!-- --></a>
1002 <div class="evenrow">
1003
1004 <div class="method-header">
1005 <span class="method-title">set_encoding</span> (line <span class="line-number">323</span>)
1006 </div>
1007
1008 <!-- ========== Info from phpDoc block ========= -->
1009 <p class="short-description">set the character set</p>
1010
1011 <div class="method-signature">
1012 <span class="method-result">void</span>
1013 <span class="method-name">
1014 set_encoding
1015 </span>
1016 (<span class="var-type">string</span>&nbsp;<span class="var-name">$charset</span>)
1017 </div>
1018
1019 <ul class="parameters">
1020 <li>
1021 <span class="var-type">string</span>
1022 <span class="var-name">$charset</span><span class="var-description">: - the charset for the meta tag</span> </li>
1023 </ul>
1024
1025
1026 </div>
1027 <a name="methodset_http_content_type" id="set_http_content_type"><!-- --></a>
1028 <div class="oddrow">
1029
1030 <div class="method-header">
1031 <span class="method-title">set_http_content_type</span> (line <span class="line-number">426</span>)
1032 </div>
1033
1034 <!-- ========== Info from phpDoc block ========= -->
1035 <p class="short-description">This function is used to set the http header content-type for output to browsers</p>
1036
1037 <div class="method-signature">
1038 <span class="method-result">void</span>
1039 <span class="method-name">
1040 set_http_content_type
1041 </span>
1042 ([<span class="var-type">string</span>&nbsp;<span class="var-name">$type</span> = <span class="var-default">"application/xml"</span>])
1043 </div>
1044
1045 <ul class="parameters">
1046 <li>
1047 <span class="var-type">string</span>
1048 <span class="var-name">$type</span> </li>
1049 </ul>
1050
1051
1052 </div>
1053 <a name="methodset_root_attribute" id="set_root_attribute"><!-- --></a>
1054 <div class="evenrow">
1055
1056 <div class="method-header">
1057 <span class="method-title">set_root_attribute</span> (line <span class="line-number">373</span>)
1058 </div>
1059
1060 <!-- ========== Info from phpDoc block ========= -->
1061 <p class="short-description">This sets 1 root tag attribute value pair</p>
1062
1063 <div class="method-signature">
1064 <span class="method-result">void</span>
1065 <span class="method-name">
1066 set_root_attribute
1067 </span>
1068 (<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>)
1069 </div>
1070
1071 <ul class="parameters">
1072 <li>
1073 <span class="var-type">string</span>
1074 <span class="var-name">$name</span><span class="var-description">: - the attribute name</span> </li>
1075 <li>
1076 <span class="var-type">string</span>
1077 <span class="var-name">$value</span><span class="var-description">: - the attribute value</span> </li>
1078 </ul>
1079
1080
1081 </div>
1082 <a name="methodset_root_attributes" id="set_root_attributes"><!-- --></a>
1083 <div class="oddrow">
1084
1085 <div class="method-header">
1086 <span class="method-title">set_root_attributes</span> (line <span class="line-number">363</span>)
1087 </div>
1088
1089 <!-- ========== Info from phpDoc block ========= -->
1090 <p class="short-description">This function is used to set the root xml tag's attributes</p>
1091
1092 <div class="method-signature">
1093 <span class="method-result">void</span>
1094 <span class="method-name">
1095 set_root_attributes
1096 </span>
1097 (<span class="var-type">array</span>&nbsp;<span class="var-name">$attributes</span>)
1098 </div>
1099
1100 <ul class="parameters">
1101 <li>
1102 <span class="var-type">array</span>
1103 <span class="var-name">$attributes</span> </li>
1104 </ul>
1105
1106
1107 </div>
1108 <a name="methodset_root_name" id="set_root_name"><!-- --></a>
1109 <div class="evenrow">
1110
1111 <div class="method-header">
1112 <span class="method-title">set_root_name</span> (line <span class="line-number">343</span>)
1113 </div>
1114
1115 <!-- ========== Info from phpDoc block ========= -->
1116 <p class="short-description">Set the document name and the root tag's name.</p>
1117
1118 <div class="method-signature">
1119 <span class="method-result">void</span>
1120 <span class="method-name">
1121 set_root_name
1122 </span>
1123 (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$root_name</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$doc_name</span>)
1124 </div>
1125
1126 <ul class="parameters">
1127 <li>
1128 <span class="var-type">string</span>
1129 <span class="var-name">$doc_name</span> </li>
1130 </ul>
1131
1132
1133 </div>
1134 <a name="methodshow_character_encoding" id="show_character_encoding"><!-- --></a>
1135 <div class="oddrow">
1136
1137 <div class="method-header">
1138 <span class="method-title">show_character_encoding</span> (line <span class="line-number">405</span>)
1139 </div>
1140
1141 <!-- ========== Info from phpDoc block ========= -->
1142 <p class="short-description">method to update the flag that lets us know to show/render the character encoding string in the xml tag or not</p>
1143
1144 <div class="method-signature">
1145 <span class="method-result">void</span>
1146 <span class="method-name">
1147 show_character_encoding
1148 </span>
1149 ([<span class="var-type">boolean</span>&nbsp;<span class="var-name">$flag</span> = <span class="var-default">TRUE</span>])
1150 </div>
1151
1152 <ul class="parameters">
1153 <li>
1154 <span class="var-type">boolean</span>
1155 <span class="var-name">$flag</span> </li>
1156 </ul>
1157
1158
1159 </div>
1160 <a name="methodshow_http_header" id="show_http_header"><!-- --></a>
1161 <div class="evenrow">
1162
1163 <div class="method-header">
1164 <span class="method-title">show_http_header</span> (line <span class="line-number">416</span>)
1165 </div>
1166
1167 <!-- ========== Info from phpDoc block ========= -->
1168 <p class="short-description">this function is used to set the flag that tells this class to automatically output the content type in the http header</p>
1169
1170 <div class="method-signature">
1171 <span class="method-result">void</span>
1172 <span class="method-name">
1173 show_http_header
1174 </span>
1175 ([<span class="var-type">boolean</span>&nbsp;<span class="var-name">$flag</span> = <span class="var-default">TRUE</span>])
1176 </div>
1177
1178 <ul class="parameters">
1179 <li>
1180 <span class="var-type">boolean</span>
1181 <span class="var-name">$flag</span> </li>
1182 </ul>
1183
1184
1185 </div>
1186 <a name="method_build_doctype" id="_build_doctype"><!-- --></a>
1187 <div class="oddrow">
1188
1189 <div class="method-header">
1190 <span class="method-title">_build_doctype</span> (line <span class="line-number">492</span>)
1191 </div>
1192
1193 <!-- ========== Info from phpDoc block ========= -->
1194 <p class="short-description">This method builds the DOCTYPE tag for the document</p>
1195
1196 <div class="method-signature">
1197 <span class="method-result">void</span>
1198 <span class="method-name">
1199 _build_doctype
1200 </span>
1201 ()
1202 </div>
1203
1204
1205
1206 </div>
1207 <a name="method_build_root_tag" id="_build_root_tag"><!-- --></a>
1208 <div class="evenrow">
1209
1210 <div class="method-header">
1211 <span class="method-title">_build_root_tag</span> (line <span class="line-number">314</span>)
1212 </div>
1213
1214 <!-- ========== Info from phpDoc block ========= -->
1215 <p class="short-description">This function builds the root xml</p>
1216 <p class="description"><p>tag that will contain all of the Document's xml tags</p></p>
1217
1218 <div class="method-signature">
1219 <span class="method-result">void</span>
1220 <span class="method-name">
1221 _build_root_tag
1222 </span>
1223 ()
1224 </div>
1225
1226
1227
1228 </div>
1229 <a name="method_build_xml_stylesheet_container" id="_build_xml_stylesheet_container"><!-- --></a>
1230 <div class="oddrow">
1231
1232 <div class="method-header">
1233 <span class="method-title">_build_xml_stylesheet_container</span> (line <span class="line-number">277</span>)
1234 </div>
1235
1236 <!-- ========== Info from phpDoc block ========= -->
1237 <p class="short-description">This function builds the _xml_stylesheet_container</p>
1238
1239 <div class="method-signature">
1240 <span class="method-result">void</span>
1241 <span class="method-name">
1242 _build_xml_stylesheet_container
1243 </span>
1244 ()
1245 </div>
1246
1247
1248
1249 </div>
1250 <a name="method_create_xml_obj" id="_create_xml_obj"><!-- --></a>
1251 <div class="evenrow">
1252
1253 <div class="method-header">
1254 <span class="method-title">_create_xml_obj</span> (line <span class="line-number">304</span>)
1255 </div>
1256
1257 <!-- ========== Info from phpDoc block ========= -->
1258 <p class="short-description">This function builds the local</p>
1259 <p class="description"><p>xml container object that holds all xml tags that are pushed into this class</p></p>
1260 <ul class="tags">
1261 <li><span class="field">return:</span> object</li>
1262 </ul>
1263
1264 <div class="method-signature">
1265 <span class="method-result"><a href="../phpHtmlLib/XMLtag.html">XMLtag</a></span>
1266 <span class="method-name">
1267 _create_xml_obj
1268 </span>
1269 ()
1270 </div>
1271
1272
1273
1274 </div>
1275 <h4>Inherited Methods</h4>
1276 <a name='inherited_methods'><!-- --></a>
1277 <!-- =========== Summary =========== -->
1278 <p>Inherited From <span class="classname"><a href="../phpHtmlLib/Container.html">Container</a></span></p>
1279 <blockquote>
1280 <span class="method-name"><a href="../phpHtmlLib/Container.html#methodContainer">Container::Container()</a></span><br>
1281 <span class="method-name"><a href="../phpHtmlLib/Container.html#methodadd">Container::add()</a></span><br>
1282 <span class="method-name"><a href="../phpHtmlLib/Container.html#methodadd_reference">Container::add_reference()</a></span><br>
1283 <span class="method-name"><a href="../phpHtmlLib/Container.html#methodcount_content">Container::count_content()</a></span><br>
1284 <span class="method-name"><a href="../phpHtmlLib/Container.html#methodget_element">Container::get_element()</a></span><br>
1285 <span class="method-name"><a href="../phpHtmlLib/Container.html#methodget_indent_flag">Container::get_indent_flag()</a></span><br>
1286 <span class="method-name"><a href="../phpHtmlLib/Container.html#methodpush">Container::push()</a></span><br>
1287 <span class="method-name"><a href="../phpHtmlLib/Container.html#methodpush_reference">Container::push_reference()</a></span><br>
1288 <span class="method-name"><a href="../phpHtmlLib/Container.html#methodrender">Container::render()</a></span><br>
1289 <span class="method-name"><a href="../phpHtmlLib/Container.html#methodreset_content">Container::reset_content()</a></span><br>
1290 <span class="method-name"><a href="../phpHtmlLib/Container.html#methodset_collapse">Container::set_collapse()</a></span><br>
1291 <span class="method-name"><a href="../phpHtmlLib/Container.html#methodset_indent_flag">Container::set_indent_flag()</a></span><br>
1292 </blockquote>
1293
1294 </div>
1295 </div>
1296
1297
1298 <p class="notes" id="credit">
1299 Documentation generated on Thu, 1 Apr 2004 09:40:24 -0800 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0RC2</a>
1300 </p>
1301 </div></body>
1302 </html>
MailToCvsAdmin">MailToCvsAdmin
 ViewVC Help
Powered by ViewVC 1.1.26 RSS 2.0 feed