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