/[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.1 - (show annotations)
Thu Jan 30 03:29:16 2003 UTC (21 years, 6 months ago) by jonen
Branch: MAIN
Branch point for: no_vendor_tag
File MIME type: text/html 
Initial revision
1 <!DOCTYPE HTML PUBLIC '-//W3C//DTD HTML 4.0 Frameset//EN''http://www.w3.org/TR/REC-html40/frameset.dtd'>
2 <!--NewPage-->
3 <HTML>
4 <HEAD>
5 <!-- Generated by PhpDoc date: 'Mon, 25 Nov 2002 09:21:41 -0800' -->
6 <TITLE>Docs For Class XMLDocumentClass</TITLE>
7 <LINK REL ='stylesheet' TYPE='text/css' HREF='stylesheet.css' TITLE='Style'>
8 </HEAD>
9 <BODY style="background-color: #eeeeee; font-family: arial; font-size: .9em;">
10
11
12 <!-- Links -->
13 <a NAME="top"></A>
14 <table WIDTH="100%" class="links">
15 <TR>
16 <TD class="font10">
17 Links:
18 <A HREF="#children_summary" class="links" title="Classes extended from XMLDocumentClass">Child Classes</A>
19 <A HREF="#var_summary" class="links" title="Class Variable Summary">Variables</A>
20 <A HREF="#var_inherited_summary" class="links" title="Inherited Class Variable Summary">Inherited Variables</A>
21 <A HREF="#functions_inherited" class="links" title="Inherited Method Summary">Inerited Methods</A>
22 <A HREF="#functions_summary" class="links" title="Method Summary">Methods</A>
23 <A HREF="#variable_detail" class="links" title="Variable Detail">Variable Detail</A>
24 <A HREF="#function_detail" class="links" title="Method Detail">Method Detail</A>
25 </TD>
26 </TR>
27 </TABLE>
28 <BR>
29
30 <!-- Start of Class Data -->
31 <H2>
32 Class XMLDocumentClass
33 </H2>
34
35 <pre>
36 <pre><a href="../phpHtmlLib/Container.html">Container</a>
37 |
38 --XMLDocumentClass</pre>
39 </pre>
40
41 <A NAME="children_summary"</A>
42 <H3>
43 Classes extended from XMLDocumentClass: <A HREF="#top" CLASS="links">^TOP</A>
44 </H3>
45 <a href="../phpHtmlLib/SVGDocumentClass.html">SVGDocumentClass</a>, <a href="../phpHtmlLib/WMLDocumentClass.html">WMLDocumentClass</a>
46 <p>
47 <b><i>Located in File: Program_Root/widgets/XMLDocumentClass.inc</i></b><br>
48 </p>
49 <hr>
50 <!-- ========== Info from phpDoc block ========= -->
51 This class lets you build a complete
52 <BR>
53 xml document and render it.
54
55 It automatically creates the root xml tag
56 that will contain all of the content.
57 The name of the tag is the first parameter to
58 the constructor. You can add/change the attributes
59 to the root tag via the set_root_attributes() or
60 the set_root_attribute() methods.
61
62 <UL>
63
64 <LI><b>Package</b> - <CODE>phpHtmlLib</CODE></LI>
65
66 <LI><b>Author</b> - <CODE>Walter A. Boring IV &lt;<a href="mailto:waboring@buildabetterweb.com">waboring@buildabetterweb.com</a>&gt;</CODE></LI>
67
68 </UL>
69
70 <hr>
71 <!-- =========== VAR SUMMARY =========== -->
72 <A NAME='var_summary'><!-- --></A>
73 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
74 <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
75 <TD>
76 <span CLASS="font12bold">Class Variable Summary</span>
77 <A HREF="#top" CLASS="links">^TOP</A>
78 </TD>
79 </TR>
80
81
82 <!-- =========== Summary =========== -->
83 <TR BGCOLOR='white' CLASS='TableRowColor'>
84 <TD>
85 <CODE><B><A HREF='XMLDocumentClass.html#$dtd'>$dtd</A></B></CODE>
86 <BR>
87 <blockquote> Holds the url of dtd </blockquote>
88 <blockquote> Default Value: <CODE>->NULL<-</CODE> </blockquote>
89 </TD>
90 </TR>
91
92 <!-- =========== Summary =========== -->
93 <TR BGCOLOR='white' CLASS='TableRowColor'>
94 <TD>
95 <CODE><B><A HREF='XMLDocumentClass.html#$root_name'>$root_name</A></B></CODE>
96 <BR>
97 <blockquote> Holds the name of the root xml </blockquote>
98 <blockquote> Default Value: <CODE>->NULL<-</CODE> </blockquote>
99 </TD>
100 </TR>
101
102 <!-- =========== Summary =========== -->
103 <TR BGCOLOR='white' CLASS='TableRowColor'>
104 <TD>
105 <CODE><B><A HREF='XMLDocumentClass.html#$_doctype_links'>$_doctype_links</A></B></CODE>
106 <BR>
107 <blockquote> This contains the doctype links
108 attributes. </blockquote>
109 <blockquote> Default Value: <CODE>->array()<-</CODE> </blockquote>
110 </TD>
111 </TR>
112
113 <!-- =========== Summary =========== -->
114 <TR BGCOLOR='white' CLASS='TableRowColor'>
115 <TD>
116 <CODE><B><A HREF='XMLDocumentClass.html#$_doctype_source'>$_doctype_source</A></B></CODE>
117 <BR>
118 <blockquote> the DOCTYPE source attribute </blockquote>
119 <blockquote> Default Value: <CODE>->SYSTEM<-</CODE> </blockquote>
120 </TD>
121 </TR>
122
123 <!-- =========== Summary =========== -->
124 <TR BGCOLOR='white' CLASS='TableRowColor'>
125 <TD>
126 <CODE><B><A HREF='XMLDocumentClass.html#$_http_content_type'>$_http_content_type</A></B></CODE>
127 <BR>
128 <blockquote> The http content-type </blockquote>
129 <blockquote> Default Value: <CODE>->application/xml<-</CODE> </blockquote>
130 </TD>
131 </TR>
132
133 <!-- =========== Summary =========== -->
134 <TR BGCOLOR='white' CLASS='TableRowColor'>
135 <TD>
136 <CODE><B><A HREF='XMLDocumentClass.html#$_root_tag'>$_root_tag</A></B></CODE>
137 <BR>
138 <blockquote> The root xml tag for all data </blockquote>
139 <blockquote> Default Value: <CODE>->NULL<-</CODE> </blockquote>
140 </TD>
141 </TR>
142
143 <!-- =========== Summary =========== -->
144 <TR BGCOLOR='white' CLASS='TableRowColor'>
145 <TD>
146 <CODE><B><A HREF='XMLDocumentClass.html#$_show_char_encoding'>$_show_char_encoding</A></B></CODE>
147 <BR>
148 <blockquote> this is a hack to show the
149 character encoding or not. </blockquote>
150 <blockquote> Default Value: <CODE>->TRUE<-</CODE> </blockquote>
151 </TD>
152 </TR>
153
154 <!-- =========== Summary =========== -->
155 <TR BGCOLOR='white' CLASS='TableRowColor'>
156 <TD>
157 <CODE><B><A HREF='XMLDocumentClass.html#$_show_http_header'>$_show_http_header</A></B></CODE>
158 <BR>
159 <blockquote> This flag tells if we should
160 output the header content type. </blockquote>
161 <blockquote> Default Value: <CODE>->FALSE<-</CODE> </blockquote>
162 </TD>
163 </TR>
164
165 <!-- =========== Summary =========== -->
166 <TR BGCOLOR='white' CLASS='TableRowColor'>
167 <TD>
168 <CODE><B><A HREF='XMLDocumentClass.html#$_xml_obj'>$_xml_obj</A></B></CODE>
169 <BR>
170 <blockquote> holds the xml tag object that
171 all content will be wrapped in </blockquote>
172 <blockquote> Default Value: <CODE>->NULL<-</CODE> </blockquote>
173 </TD>
174 </TR>
175
176 <!-- =========== Summary =========== -->
177 <TR BGCOLOR='white' CLASS='TableRowColor'>
178 <TD>
179 <CODE><B><A HREF='XMLDocumentClass.html#$_xml_stylesheet_container'>$_xml_stylesheet_container</A></B></CODE>
180 <BR>
181 <blockquote> The container for all the
182 xml-stylesheet tags </blockquote>
183 <blockquote> Default Value: <CODE>->NULL<-</CODE> </blockquote>
184 </TD>
185 </TR>
186
187 </TABLE>
188
189 <hr>
190 <!-- =========== VAR INHERITED SUMMARY =========== -->
191 <A NAME='var_inherited_summary'><!-- --></A>
192 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
193 <TR CLASS='TableHeadingColor'>
194 <TD>
195 <span CLASS="font12bold">Inherited Class Variable Summary</span>
196 <A HREF="#top" CLASS="links">^TOP</A>
197 </TD>
198 </TR>
199
200
201 <!-- =========== Summary =========== -->
202 <TR BGCOLOR='white'>
203 <TD>
204 <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/Container.html">Container</a></span>
205 <table CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">
206 <tr CLASS="tableheadingcolor">
207 <th>Variable</th>
208 <th>Default Value</th>
209 <th>Description</th>
210 </tr>
211
212 <tr>
213 <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#$indent_flag'>$indent_flag</A></td>
214 <td CLASS="font10" STYLE="white-space: nowrap">->TRUE<-</td>
215 <td CLASS="font10">Flag for pretty (indented) output</td>
216 </tr>
217
218 <tr>
219 <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#$_newline_after_content_flag'>$_newline_after_content_flag</A></td>
220 <td CLASS="font10" STYLE="white-space: nowrap">->TRUE<-</td>
221 <td CLASS="font10">Do we render a newline after the
222 contents has been rendered?</td>
223 </tr>
224
225 </table>
226 <BR>
227 </TD>
228 </TR>
229
230 </TABLE>
231
232 <hr>
233 <!-- =========== INHERITED METHOD SUMMARY =========== -->
234 <A NAME='functions_inherited'><!-- --></A>
235 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
236 <TR CLASS='TableHeadingColor'>
237 <TD>
238 <span CLASS="font12bold">Inherited Method Summary</span>
239 <A HREF="#top" CLASS="links">^TOP</A>
240 </TD>
241 </TR>
242
243
244 <!-- =========== Summary =========== -->
245 <TR BGCOLOR='white' CLASS='TableRowColor'>
246 <TD>
247 <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/Container.html">Container</a></span>
248 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">
249 <tr CLASS="tableheadingcolor">
250 <th>Function</th>
251 <th>Description</th>
252 </tr>
253
254 <tr>
255 <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#constructor Container'>constructor Container ( )</A></td>
256 <td CLASS="font10">The constructor.</td>
257
258 <tr>
259 <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#add'>add ( )</A></td>
260 <td CLASS="font10">add content onto content stack</td>
261
262 <tr>
263 <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#add_reference'>add_reference ( &$content )</A></td>
264 <td CLASS="font10">Add content onto content stack
265 so you can change the item later.</td>
266
267 <tr>
268 <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#count_content'>count_content ( )</A></td>
269 <td CLASS="font10">counts the number of content objects</td>
270
271 <tr>
272 <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#get_indent_flag'>get_indent_flag ( )</A></td>
273 <td CLASS="font10">This flag gets the current value
274 of the indent flag</td>
275
276 <tr>
277 <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#push'>push ( )</A></td>
278 <td CLASS="font10">Same as add().</td>
279
280 <tr>
281 <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#push_reference'>push_reference ( &$content )</A></td>
282 <td CLASS="font10">Same as add_reference
283 NOTE : only exists for compatibility with 1.1.x</td>
284
285 <tr>
286 <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#render'>render ( [$indent_level = 1], [$output_debug = 0] )</A></td>
287 <td CLASS="font10">This function is compatible with the
288 rest of the phpHtmllib API spec.</td>
289
290 <tr>
291 <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#reset_content'>reset_content ( )</A></td>
292 <td CLASS="font10">destroy existing content and start with new content.</td>
293
294 <tr>
295 <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#set_collapse'>set_collapse ( [$collapse = TRUE], [$indent = TRUE] )</A></td>
296 <td CLASS="font10">This function turns on the collapse flag</td>
297
298 <tr>
299 <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#set_indent_flag'>set_indent_flag ( $flag )</A></td>
300 <td CLASS="font10">function to set the indent flag</td>
301
302 </table>
303 <br>
304 </TD>
305 </TR>
306
307 </TABLE>
308
309 <hr>
310 <!-- should have constructor at some point -->
311 <!-- =========== Method SUMMARY =========== -->
312 <A NAME='Method_summary'><!-- --></A>
313 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' Class="border">
314 <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
315 <TD>
316 <span class="font12bold">Method Summary</span>
317 <A HREF="#top" CLASS="links">^TOP</A>
318 </TD>
319 </TR>
320
321
322 <!-- =========== Summary =========== -->
323 <TR BGCOLOR='white' CLASS='TableRowColor'>
324 <TD>
325 <CODE><B><A HREF='XMLDocumentClass.html#constructor XMLDocumentClass'>void constructor XMLDocumentClass ( $root_name, [$dtd = NULL], [$root_attributes = array()] )</A></B></CODE>
326 <BR>
327 <blockquote> The constructor </blockquote>
328 </TD>
329 </TR>
330
331 <!-- =========== Summary =========== -->
332 <TR BGCOLOR='white' CLASS='TableRowColor'>
333 <TD>
334 <CODE><B><A HREF='XMLDocumentClass.html#add'>void add ( )</A></B></CODE>
335 <BR>
336 <blockquote> we override this class to make sure </blockquote>
337 </TD>
338 </TR>
339
340 <!-- =========== Summary =========== -->
341 <TR BGCOLOR='white' CLASS='TableRowColor'>
342 <TD>
343 <CODE><B><A HREF='XMLDocumentClass.html#add_reference'>void add_reference ( &$content )</A></B></CODE>
344 <BR>
345 <blockquote> we override this class to make sure </blockquote>
346 </TD>
347 </TR>
348
349 <!-- =========== Summary =========== -->
350 <TR BGCOLOR='white' CLASS='TableRowColor'>
351 <TD>
352 <CODE><B><A HREF='XMLDocumentClass.html#add_xml_stylesheet_link'>void add_xml_stylesheet_link ( $href )</A></B></CODE>
353 <BR>
354 <blockquote> This function is used to add a new
355 xml-stylesheet tag to the top
356 portion of the document. </blockquote>
357 </TD>
358 </TR>
359
360 <!-- =========== Summary =========== -->
361 <TR BGCOLOR='white' CLASS='TableRowColor'>
362 <TD>
363 <CODE><B><A HREF='XMLDocumentClass.html#dump_http_header'>void dump_http_header ( )</A></B></CODE>
364 <BR>
365 <blockquote> This function is used to output the http
366 header for this document. </blockquote>
367 </TD>
368 </TR>
369
370 <!-- =========== Summary =========== -->
371 <TR BGCOLOR='white' CLASS='TableRowColor'>
372 <TD>
373 <CODE><B><A HREF='XMLDocumentClass.html#get_doctype_source'>string get_doctype_source ( )</A></B></CODE>
374 <BR>
375 <blockquote> This function returns the current
376 DOCTYPE tag's source attribute </blockquote>
377 </TD>
378 </TR>
379
380 <!-- =========== Summary =========== -->
381 <TR BGCOLOR='white' CLASS='TableRowColor'>
382 <TD>
383 <CODE><B><A HREF='XMLDocumentClass.html#get_encoding'>string get_encoding ( )</A></B></CODE>
384 <BR>
385 <blockquote> This function gets the current encoding type </blockquote>
386 </TD>
387 </TR>
388
389 <!-- =========== Summary =========== -->
390 <TR BGCOLOR='white' CLASS='TableRowColor'>
391 <TD>
392 <CODE><B><A HREF='XMLDocumentClass.html#get_http_content_type'>string get_http_content_type ( )</A></B></CODE>
393 <BR>
394 <blockquote> This function returns the current
395 value of the http header content type </blockquote>
396 </TD>
397 </TR>
398
399 <!-- =========== Summary =========== -->
400 <TR BGCOLOR='white' CLASS='TableRowColor'>
401 <TD>
402 <CODE><B><A HREF='XMLDocumentClass.html#get_root_attributes'>array get_root_attributes ( )</A></B></CODE>
403 <BR>
404 <blockquote> This function is used to get the
405 root xml tag's attributes </blockquote>
406 </TD>
407 </TR>
408
409 <!-- =========== Summary =========== -->
410 <TR BGCOLOR='white' CLASS='TableRowColor'>
411 <TD>
412 <CODE><B><A HREF='XMLDocumentClass.html#get_root_name'>string get_root_name ( )</A></B></CODE>
413 <BR>
414 <blockquote> This function gets the document name </blockquote>
415 </TD>
416 </TR>
417
418 <!-- =========== Summary =========== -->
419 <TR BGCOLOR='white' CLASS='TableRowColor'>
420 <TD>
421 <CODE><B><A HREF='XMLDocumentClass.html#push'>void push ( )</A></B></CODE>
422 <BR>
423 <blockquote> Same as add(). </blockquote>
424 </TD>
425 </TR>
426
427 <!-- =========== Summary =========== -->
428 <TR BGCOLOR='white' CLASS='TableRowColor'>
429 <TD>
430 <CODE><B><A HREF='XMLDocumentClass.html#push_reference'>void push_reference ( &$content )</A></B></CODE>
431 <BR>
432 <blockquote> Same as add_reference
433 NOTE : only exists for compatibility with 1.1.x </blockquote>
434 </TD>
435 </TR>
436
437 <!-- =========== Summary =========== -->
438 <TR BGCOLOR='white' CLASS='TableRowColor'>
439 <TD>
440 <CODE><B><A HREF='XMLDocumentClass.html#render'>string render ( [$indent_level = 0] )</A></B></CODE>
441 <BR>
442 <blockquote> function that will render the XML Document. </blockquote>
443 </TD>
444 </TR>
445
446 <!-- =========== Summary =========== -->
447 <TR BGCOLOR='white' CLASS='TableRowColor'>
448 <TD>
449 <CODE><B><A HREF='XMLDocumentClass.html#reset_content'>void reset_content ( )</A></B></CODE>
450 <BR>
451 <blockquote> we override this class to make sure </blockquote>
452 </TD>
453 </TR>
454
455 <!-- =========== Summary =========== -->
456 <TR BGCOLOR='white' CLASS='TableRowColor'>
457 <TD>
458 <CODE><B><A HREF='XMLDocumentClass.html#set_doctype_link'>void set_doctype_link ( $link )</A></B></CODE>
459 <BR>
460 <blockquote> This method is used to set the link attributes
461 for the DOCTYPE tag </blockquote>
462 </TD>
463 </TR>
464
465 <!-- =========== Summary =========== -->
466 <TR BGCOLOR='white' CLASS='TableRowColor'>
467 <TD>
468 <CODE><B><A HREF='XMLDocumentClass.html#set_doctype_source'>void set_doctype_source ( $source )</A></B></CODE>
469 <BR>
470 <blockquote> this function is used to change the
471 DOCTYPE tag's source attribute. </blockquote>
472 </TD>
473 </TR>
474
475 <!-- =========== Summary =========== -->
476 <TR BGCOLOR='white' CLASS='TableRowColor'>
477 <TD>
478 <CODE><B><A HREF='XMLDocumentClass.html#set_encoding'>void set_encoding ( $charset )</A></B></CODE>
479 <BR>
480 <blockquote> set the character set </blockquote>
481 </TD>
482 </TR>
483
484 <!-- =========== Summary =========== -->
485 <TR BGCOLOR='white' CLASS='TableRowColor'>
486 <TD>
487 <CODE><B><A HREF='XMLDocumentClass.html#set_http_content_type'>void set_http_content_type ( [$type = "application/xml"] )</A></B></CODE>
488 <BR>
489 <blockquote> This function is used to set the
490 http header content-type for output to browsers </blockquote>
491 </TD>
492 </TR>
493
494 <!-- =========== Summary =========== -->
495 <TR BGCOLOR='white' CLASS='TableRowColor'>
496 <TD>
497 <CODE><B><A HREF='XMLDocumentClass.html#set_root_attribute'>void set_root_attribute ( $name, $value )</A></B></CODE>
498 <BR>
499 <blockquote> This sets 1 root tag attribute value pair </blockquote>
500 </TD>
501 </TR>
502
503 <!-- =========== Summary =========== -->
504 <TR BGCOLOR='white' CLASS='TableRowColor'>
505 <TD>
506 <CODE><B><A HREF='XMLDocumentClass.html#set_root_attributes'>void set_root_attributes ( $attributes )</A></B></CODE>
507 <BR>
508 <blockquote> This function is used to set the
509 root xml tag's attributes </blockquote>
510 </TD>
511 </TR>
512
513 <!-- =========== Summary =========== -->
514 <TR BGCOLOR='white' CLASS='TableRowColor'>
515 <TD>
516 <CODE><B><A HREF='XMLDocumentClass.html#set_root_name'>void set_root_name ( $root_name )</A></B></CODE>
517 <BR>
518 <blockquote> Set the document name
519 and the root tag's name. </blockquote>
520 </TD>
521 </TR>
522
523 <!-- =========== Summary =========== -->
524 <TR BGCOLOR='white' CLASS='TableRowColor'>
525 <TD>
526 <CODE><B><A HREF='XMLDocumentClass.html#show_character_encoding'>void show_character_encoding ( [$flag = TRUE] )</A></B></CODE>
527 <BR>
528 <blockquote> method to update the flag that lets us know </blockquote>
529 </TD>
530 </TR>
531
532 <!-- =========== Summary =========== -->
533 <TR BGCOLOR='white' CLASS='TableRowColor'>
534 <TD>
535 <CODE><B><A HREF='XMLDocumentClass.html#show_http_header'>void show_http_header ( [$flag = TRUE] )</A></B></CODE>
536 <BR>
537 <blockquote> this function is used to set the flag </blockquote>
538 </TD>
539 </TR>
540
541 <!-- =========== Summary =========== -->
542 <TR BGCOLOR='white' CLASS='TableRowColor'>
543 <TD>
544 <CODE><B><A HREF='XMLDocumentClass.html#_build_doctype'>void _build_doctype ( )</A></B></CODE>
545 <BR>
546 <blockquote> This method builds the DOCTYPE tag for the document </blockquote>
547 </TD>
548 </TR>
549
550 <!-- =========== Summary =========== -->
551 <TR BGCOLOR='white' CLASS='TableRowColor'>
552 <TD>
553 <CODE><B><A HREF='XMLDocumentClass.html#_build_root_tag'>void _build_root_tag ( )</A></B></CODE>
554 <BR>
555 <blockquote> This function builds the root xml </blockquote>
556 </TD>
557 </TR>
558
559 <!-- =========== Summary =========== -->
560 <TR BGCOLOR='white' CLASS='TableRowColor'>
561 <TD>
562 <CODE><B><A HREF='XMLDocumentClass.html#_build_xml_stylesheet_container'>void _build_xml_stylesheet_container ( )</A></B></CODE>
563 <BR>
564 <blockquote> This function builds the _xml_stylesheet_container </blockquote>
565 </TD>
566 </TR>
567
568 <!-- =========== Summary =========== -->
569 <TR BGCOLOR='white' CLASS='TableRowColor'>
570 <TD>
571 <CODE><B><A HREF='XMLDocumentClass.html#_create_xml_obj'><a href="../phpHtmlLib/XMLtag.html">XMLtag</a> _create_xml_obj ( )</A></B></CODE>
572 <BR>
573 <blockquote> This function builds the local </blockquote>
574 </TD>
575 </TR>
576
577 </TABLE>
578
579 <hr>
580 <!-- ============ VARIABLE DETAIL =========== -->
581
582 <A NAME='variable_detail'></A>
583 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
584 <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
585 <TD>
586 <span CLASS="font12bold">Variable Detail</span>
587 <A HREF="#top" CLASS="links">^TOP</A>
588 </TD>
589 </TR>
590 </TABLE>
591
592
593 <A NAME='$dtd'><!-- --></A><H3>$dtd</H3>
594 <b>Data type:</b> mixed<br>
595 <!-- ========== Info from phpDoc block ========= -->
596 Holds the url of dtd
597 <BR>
598
599
600 <UL>
601
602 </UL>
603
604 <HR>
605
606 <A NAME='$root_name'><!-- --></A><H3>$root_name</H3>
607 <b>Data type:</b> mixed<br>
608 <!-- ========== Info from phpDoc block ========= -->
609 Holds the name of the root xml
610 <BR>
611 element as well as the DOCTYPE
612 document_element attribute
613
614 <UL>
615
616 </UL>
617
618 <HR>
619
620 <A NAME='$_doctype_links'><!-- --></A><H3>$_doctype_links</H3>
621 <b>Data type:</b> mixed<br>
622 <!-- ========== Info from phpDoc block ========= -->
623 This contains the doctype links
624 attributes.
625 <BR>
626 There can be a maximum
627 of 2 according to the XML spec
628
629 <UL>
630
631 </UL>
632
633 <HR>
634
635 <A NAME='$_doctype_source'><!-- --></A><H3>$_doctype_source</H3>
636 <b>Data type:</b> string<br>
637 <!-- ========== Info from phpDoc block ========= -->
638 the DOCTYPE source attribute
639 <BR>
640
641
642 <UL>
643
644 </UL>
645
646 <HR>
647
648 <A NAME='$_http_content_type'><!-- --></A><H3>$_http_content_type</H3>
649 <b>Data type:</b> mixed<br>
650 <!-- ========== Info from phpDoc block ========= -->
651 The http content-type
652 <BR>
653
654
655 <UL>
656
657 </UL>
658
659 <HR>
660
661 <A NAME='$_root_tag'><!-- --></A><H3>$_root_tag</H3>
662 <b>Data type:</b> <a href="../phpHtmlLib/XMLTagClass.html">XMLTagClass</a><br>
663 <!-- ========== Info from phpDoc block ========= -->
664 The root xml tag for all data
665 <BR>
666
667
668 <UL>
669
670 <LI><b>Var</b> - <CODE>object</CODE></LI>
671
672 </UL>
673
674 <HR>
675
676 <A NAME='$_show_char_encoding'><!-- --></A><H3>$_show_char_encoding</H3>
677 <b>Data type:</b> boolean<br>
678 <!-- ========== Info from phpDoc block ========= -->
679 this is a hack to show the
680 character encoding or not.
681 <BR>
682 DEFAULT: on
683
684 <UL>
685
686 </UL>
687
688 <HR>
689
690 <A NAME='$_show_http_header'><!-- --></A><H3>$_show_http_header</H3>
691 <b>Data type:</b> mixed<br>
692 <!-- ========== Info from phpDoc block ========= -->
693 This flag tells if we should
694 output the header content type.
695 <BR>
696 this is usefull for folks using
697 this class for output not destined
698 for a browser.
699
700 <UL>
701
702 </UL>
703
704 <HR>
705
706 <A NAME='$_xml_obj'><!-- --></A><H3>$_xml_obj</H3>
707 <b>Data type:</b> mixed<br>
708 <!-- ========== Info from phpDoc block ========= -->
709 holds the xml tag object that
710 all content will be wrapped in
711 <BR>
712
713
714 <UL>
715
716 </UL>
717
718 <HR>
719
720 <A NAME='$_xml_stylesheet_container'><!-- --></A><H3>$_xml_stylesheet_container</H3>
721 <b>Data type:</b> object<br>
722 <!-- ========== Info from phpDoc block ========= -->
723 The container for all the
724 xml-stylesheet tags
725 <BR>
726
727
728 <UL>
729
730 </UL>
731
732 <HR>
733
734
735 <hr>
736 <!-- ============ FUNCTION DETAIL =========== -->
737
738 <A NAME='function_detail'></A>
739 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
740 <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
741 <TD>
742 <span class="font12bold">Method Detail</span>
743 <A HREF="#top" CLASS="links">^TOP</A>
744 </TD>
745 </TR>
746 </TABLE>
747 <BR>
748
749 <DIV CLASS="function">
750 <A NAME='constructor XMLDocumentClass'><!-- --></A>
751 <SPAN CLASS="font12bold">constructor XMLDocumentClass</SPAN>
752 <BR>
753 <SPAN CLASS="font10bold">Useage : </SPAN>
754 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
755 <span class="font10bold" style="color: #0000FF">constructor XMLDocumentClass ( $root_name, [$dtd = NULL], [$root_attributes = array()] )</SPAN>
756 <BR>
757
758 <BR>
759 <SPAN CLASS="font10bold">Description : </SPAN>
760 <!-- ========== Info from phpDoc block ========= -->
761 The constructor
762 <BR>
763
764 <DL>
765 <DT class="font10bold">Function Parameters:</DT>
766
767 <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">string</SPAN> <span style="color: #0000FF;font-weight:bold">$root_name</SPAN></SPAN> - the root xml tag's name</DD>
768
769 <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">string</SPAN> <span style="color: #0000FF;font-weight:bold">$dtd</SPAN></SPAN> - the link path to the DTD (if any)</DD>
770
771 <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">array</SPAN> <span style="color: #0000FF;font-weight:bold">$root_attributes</SPAN></SPAN> - the root tag's attributes</DD>
772
773
774 <DT class="font10bold">Function Info:</DT>
775
776 </DL>
777
778 </DIV>
779 <BR>
780
781 <DIV CLASS="function">
782 <A NAME='add'><!-- --></A>
783 <SPAN CLASS="font12bold">add</SPAN>
784 <BR>
785 <SPAN CLASS="font10bold">Useage : </SPAN>
786 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
787 <span class="font10bold" style="color: #0000FF">add ( )</SPAN>
788 <BR>
789 <span class="font10bold" style="padding-left: 10px;">Overrides :</span> <a href="../phpHtmlLib/Container.html#add">Container::add()</a>
790 <BR>
791 <SPAN CLASS="font10bold">Description : </SPAN>
792 <!-- ========== Info from phpDoc block ========= -->
793 we override this class to make sure
794 <BR>
795 we push all content inside the
796 local _xml_obj tag
797
798 push content onto content stack
799 adds content to tag as a FIFO.
800 You can have n number of parameters.
801 each one will get added in succession to the content.
802 <DL>
803 <DT class="font10bold">Function Parameters:</DT>
804
805 <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">mixed</SPAN> <span style="color: #0000FF;font-weight:bold">$content</SPAN></SPAN> - either string, or tag object.</DD>
806
807
808 <DT class="font10bold">Function Info:</DT>
809
810 <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Access</b> - public</DD>
811
812 </DL>
813
814 </DIV>
815 <BR>
816
817 <DIV CLASS="function">
818 <A NAME='add_reference'><!-- --></A>
819 <SPAN CLASS="font12bold">add_reference</SPAN>
820 <BR>
821 <SPAN CLASS="font10bold">Useage : </SPAN>
822 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
823 <span class="font10bold" style="color: #0000FF">add_reference ( &$content )</SPAN>
824 <BR>
825 <span class="font10bold" style="padding-left: 10px;">Overrides :</span> <a href="../phpHtmlLib/Container.html#add_reference">Container::add_reference()</a>
826 <BR>
827 <SPAN CLASS="font10bold">Description : </SPAN>
828 <!-- ========== Info from phpDoc block ========= -->
829 we override this class to make sure
830 <BR>
831 we push all content inside the
832 local _xml_obj tag
833
834 push content onto content stack
835 adds content to tag as a FIFO
836 You can only add 1 element at a time, and
837 it will be added as a reference. So you can't do
838 push_reference(&quot;something&quot;);, since &quot;something&quot; is a
839 static.
840 <DL>
841 <DT class="font10bold">Function Parameters:</DT>
842
843 <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">mixed</SPAN> <span style="color: #0000FF;font-weight:bold">$content</SPAN></SPAN> - either string, or tag object.
844 the tag object gets stored as a
845 reference to the original, so you
846 can push it, then modify it later.</DD>
847
848
849 <DT class="font10bold">Function Info:</DT>
850
851 <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Access</b> - public</DD>
852
853 </DL>
854
855 </DIV>
856 <BR>
857
858 <DIV CLASS="function">
859 <A NAME='add_xml_stylesheet_link'><!-- --></A>
860 <SPAN CLASS="font12bold">add_xml_stylesheet_link</SPAN>
861 <BR>
862 <SPAN CLASS="font10bold">Useage : </SPAN>
863 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
864 <span class="font10bold" style="color: #0000FF">add_xml_stylesheet_link ( $href )</SPAN>
865 <BR>
866
867 <BR>
868 <SPAN CLASS="font10bold">Description : </SPAN>
869 <!-- ========== Info from phpDoc block ========= -->
870 This function is used to add a new
871 xml-stylesheet tag to the top
872 portion of the document.
873 <BR>
874 This will automatically get added
875 after the xml tag and before the
876 &lt;!DOCTYPE &gt; tag
877 <DL>
878 <DT class="font10bold">Function Parameters:</DT>
879
880 <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">string</SPAN> <span style="color: #0000FF;font-weight:bold">$href</SPAN></SPAN> - the href for the stylesheet link</DD>
881
882
883 <DT class="font10bold">Function Info:</DT>
884
885 </DL>
886
887 </DIV>
888 <BR>
889
890 <DIV CLASS="function">
891 <A NAME='dump_http_header'><!-- --></A>
892 <SPAN CLASS="font12bold">dump_http_header</SPAN>
893 <BR>
894 <SPAN CLASS="font10bold">Useage : </SPAN>
895 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
896 <span class="font10bold" style="color: #0000FF">dump_http_header ( )</SPAN>
897 <BR>
898
899 <BR>
900 <SPAN CLASS="font10bold">Description : </SPAN>
901 <!-- ========== Info from phpDoc block ========= -->
902 This function is used to output the http
903 header for this document.
904 <BR>
905 It makes a call to php's Header() to
906 set the Content-type
907 <DL>
908 <DT class="font10bold">Function Parameters:</DT>
909
910
911 <DT class="font10bold">Function Info:</DT>
912
913 </DL>
914
915 </DIV>
916 <BR>
917
918 <DIV CLASS="function">
919 <A NAME='get_doctype_source'><!-- --></A>
920 <SPAN CLASS="font12bold">get_doctype_source</SPAN>
921 <BR>
922 <SPAN CLASS="font10bold">Useage : </SPAN>
923 <span class="font10bold" style="color: #FF0000">string</SPAN>&nbsp;
924 <span class="font10bold" style="color: #0000FF">get_doctype_source ( )</SPAN>
925 <BR>
926
927 <BR>
928 <SPAN CLASS="font10bold">Description : </SPAN>
929 <!-- ========== Info from phpDoc block ========= -->
930 This function returns the current
931 DOCTYPE tag's source attribute
932 <BR>
933
934 <DL>
935 <DT class="font10bold">Function Parameters:</DT>
936
937
938 <DT class="font10bold">Function Info:</DT>
939
940 </DL>
941
942 </DIV>
943 <BR>
944
945 <DIV CLASS="function">
946 <A NAME='get_encoding'><!-- --></A>
947 <SPAN CLASS="font12bold">get_encoding</SPAN>
948 <BR>
949 <SPAN CLASS="font10bold">Useage : </SPAN>
950 <span class="font10bold" style="color: #FF0000">string</SPAN>&nbsp;
951 <span class="font10bold" style="color: #0000FF">get_encoding ( )</SPAN>
952 <BR>
953
954 <BR>
955 <SPAN CLASS="font10bold">Description : </SPAN>
956 <!-- ========== Info from phpDoc block ========= -->
957 This function gets the current encoding type
958 <BR>
959
960 <DL>
961 <DT class="font10bold">Function Parameters:</DT>
962
963
964 <DT class="font10bold">Function Info:</DT>
965
966 <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - - the current encoding type
967 for the xml</DD>
968
969 </DL>
970
971 </DIV>
972 <BR>
973
974 <DIV CLASS="function">
975 <A NAME='get_http_content_type'><!-- --></A>
976 <SPAN CLASS="font12bold">get_http_content_type</SPAN>
977 <BR>
978 <SPAN CLASS="font10bold">Useage : </SPAN>
979 <span class="font10bold" style="color: #FF0000">string</SPAN>&nbsp;
980 <span class="font10bold" style="color: #0000FF">get_http_content_type ( )</SPAN>
981 <BR>
982
983 <BR>
984 <SPAN CLASS="font10bold">Description : </SPAN>
985 <!-- ========== Info from phpDoc block ========= -->
986 This function returns the current
987 value of the http header content type
988 <BR>
989
990 <DL>
991 <DT class="font10bold">Function Parameters:</DT>
992
993
994 <DT class="font10bold">Function Info:</DT>
995
996 </DL>
997
998 </DIV>
999 <BR>
1000
1001 <DIV CLASS="function">
1002 <A NAME='get_root_attributes'><!-- --></A>
1003 <SPAN CLASS="font12bold">get_root_attributes</SPAN>
1004 <BR>
1005 <SPAN CLASS="font10bold">Useage : </SPAN>
1006 <span class="font10bold" style="color: #FF0000">array</SPAN>&nbsp;
1007 <span class="font10bold" style="color: #0000FF">get_root_attributes ( )</SPAN>
1008 <BR>
1009
1010 <BR>
1011 <SPAN CLASS="font10bold">Description : </SPAN>
1012 <!-- ========== Info from phpDoc block ========= -->
1013 This function is used to get the
1014 root xml tag's attributes
1015 <BR>
1016
1017 <DL>
1018 <DT class="font10bold">Function Parameters:</DT>
1019
1020
1021 <DT class="font10bold">Function Info:</DT>
1022
1023 </DL>
1024
1025 </DIV>
1026 <BR>
1027
1028 <DIV CLASS="function">
1029 <A NAME='get_root_name'><!-- --></A>
1030 <SPAN CLASS="font12bold">get_root_name</SPAN>
1031 <BR>
1032 <SPAN CLASS="font10bold">Useage : </SPAN>
1033 <span class="font10bold" style="color: #FF0000">string</SPAN>&nbsp;
1034 <span class="font10bold" style="color: #0000FF">get_root_name ( )</SPAN>
1035 <BR>
1036
1037 <BR>
1038 <SPAN CLASS="font10bold">Description : </SPAN>
1039 <!-- ========== Info from phpDoc block ========= -->
1040 This function gets the document name
1041 <BR>
1042
1043 <DL>
1044 <DT class="font10bold">Function Parameters:</DT>
1045
1046
1047 <DT class="font10bold">Function Info:</DT>
1048
1049 <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - - the current document name
1050 for the xml</DD>
1051
1052 </DL>
1053
1054 </DIV>
1055 <BR>
1056
1057 <DIV CLASS="function">
1058 <A NAME='push'><!-- --></A>
1059 <SPAN CLASS="font12bold">push</SPAN>
1060 <BR>
1061 <SPAN CLASS="font10bold">Useage : </SPAN>
1062 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
1063 <span class="font10bold" style="color: #0000FF">push ( )</SPAN>
1064 <BR>
1065 <span class="font10bold" style="padding-left: 10px;">Overrides :</span> <a href="../phpHtmlLib/Container.html#push">Container::push()</a>
1066 <BR>
1067 <SPAN CLASS="font10bold">Description : </SPAN>
1068 <!-- ========== Info from phpDoc block ========= -->
1069 Same as add().
1070 <BR>
1071 NOTE: only exists for 1.1.x compatibility
1072 <DL>
1073 <DT class="font10bold">Function Parameters:</DT>
1074
1075 <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">mixed</SPAN> <span style="color: #0000FF;font-weight:bold">$content</SPAN></SPAN> - either string, or tag object.</DD>
1076
1077
1078 <DT class="font10bold">Function Info:</DT>
1079
1080 <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Access</b> - public</DD>
1081
1082 <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Deprecated</b> - </DD>
1083
1084 </DL>
1085
1086 </DIV>
1087 <BR>
1088
1089 <DIV CLASS="function">
1090 <A NAME='push_reference'><!-- --></A>
1091 <SPAN CLASS="font12bold">push_reference</SPAN>
1092 <BR>
1093 <SPAN CLASS="font10bold">Useage : </SPAN>
1094 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
1095 <span class="font10bold" style="color: #0000FF">push_reference ( &$content )</SPAN>
1096 <BR>
1097 <span class="font10bold" style="padding-left: 10px;">Overrides :</span> <a href="../phpHtmlLib/Container.html#push_reference">Container::push_reference()</a>
1098 <BR>
1099 <SPAN CLASS="font10bold">Description : </SPAN>
1100 <!-- ========== Info from phpDoc block ========= -->
1101 Same as add_reference
1102 NOTE : only exists for compatibility with 1.1.x
1103 <BR>
1104
1105 <DL>
1106 <DT class="font10bold">Function Parameters:</DT>
1107
1108 <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">mixed</SPAN> <span style="color: #0000FF;font-weight:bold">&$content</SPAN></SPAN> - a reference to some variable.</DD>
1109
1110
1111 <DT class="font10bold">Function Info:</DT>
1112
1113 <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Access</b> - public</DD>
1114
1115 <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Deprecated</b> - </DD>
1116
1117 </DL>
1118
1119 </DIV>
1120 <BR>
1121
1122 <DIV CLASS="function">
1123 <A NAME='render'><!-- --></A>
1124 <SPAN CLASS="font12bold">render</SPAN>
1125 <BR>
1126 <SPAN CLASS="font10bold">Useage : </SPAN>
1127 <span class="font10bold" style="color: #FF0000">string</SPAN>&nbsp;
1128 <span class="font10bold" style="color: #0000FF">render ( [$indent_level = 0] )</SPAN>
1129 <BR>
1130 <span class="font10bold" style="padding-left: 10px;">Overrides :</span> <a href="../phpHtmlLib/Container.html#render">Container::render()</a>
1131 <BR>
1132 <SPAN CLASS="font10bold">Description : </SPAN>
1133 <!-- ========== Info from phpDoc block ========= -->
1134 function that will render the XML Document.
1135 <BR>
1136
1137 <DL>
1138 <DT class="font10bold">Function Parameters:</DT>
1139
1140 <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">int</SPAN> <span style="color: #0000FF;font-weight:bold">1</SPAN></SPAN> - the output debug flag to
1141 maintain compatibility w/ the API.</DD>
1142
1143 <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">int</SPAN> <span style="color: #0000FF;font-weight:bold">$indent_level</SPAN></SPAN> - the indentation level for
1144 the container.</DD>
1145
1146
1147 <DT class="font10bold">Function Info:</DT>
1148
1149 <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - the raw html output.</DD>
1150
1151 </DL>
1152
1153 </DIV>
1154 <BR>
1155
1156 <DIV CLASS="function">
1157 <A NAME='reset_content'><!-- --></A>
1158 <SPAN CLASS="font12bold">reset_content</SPAN>
1159 <BR>
1160 <SPAN CLASS="font10bold">Useage : </SPAN>
1161 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
1162 <span class="font10bold" style="color: #0000FF">reset_content ( )</SPAN>
1163 <BR>
1164 <span class="font10bold" style="padding-left: 10px;">Overrides :</span> <a href="../phpHtmlLib/Container.html#reset_content">Container::reset_content()</a>
1165 <BR>
1166 <SPAN CLASS="font10bold">Description : </SPAN>
1167 <!-- ========== Info from phpDoc block ========= -->
1168 we override this class to make sure
1169 <BR>
1170 we push all content inside the
1171 local _xml_obj tag
1172
1173 destroy existing content and start with new content.
1174 <DL>
1175 <DT class="font10bold">Function Parameters:</DT>
1176
1177 <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">mixed</SPAN> <span style="color: #0000FF;font-weight:bold">$content</SPAN></SPAN> can be tag object, or raw (string).</DD>
1178
1179
1180 <DT class="font10bold">Function Info:</DT>
1181
1182 <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Access</b> - public</DD>
1183
1184 </DL>
1185
1186 </DIV>
1187 <BR>
1188
1189 <DIV CLASS="function">
1190 <A NAME='set_doctype_link'><!-- --></A>
1191 <SPAN CLASS="font12bold">set_doctype_link</SPAN>
1192 <BR>
1193 <SPAN CLASS="font10bold">Useage : </SPAN>
1194 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
1195 <span class="font10bold" style="color: #0000FF">set_doctype_link ( $link )</SPAN>
1196 <BR>
1197
1198 <BR>
1199 <SPAN CLASS="font10bold">Description : </SPAN>
1200 <!-- ========== Info from phpDoc block ========= -->
1201 This method is used to set the link attributes
1202 for the DOCTYPE tag
1203 <BR>
1204
1205 <DL>
1206 <DT class="font10bold">Function Parameters:</DT>
1207
1208
1209 <DT class="font10bold">Function Info:</DT>
1210
1211 </DL>
1212
1213 </DIV>
1214 <BR>
1215
1216 <DIV CLASS="function">
1217 <A NAME='set_doctype_source'><!-- --></A>
1218 <SPAN CLASS="font12bold">set_doctype_source</SPAN>
1219 <BR>
1220 <SPAN CLASS="font10bold">Useage : </SPAN>
1221 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
1222 <span class="font10bold" style="color: #0000FF">set_doctype_source ( $source )</SPAN>
1223 <BR>
1224
1225 <BR>
1226 <SPAN CLASS="font10bold">Description : </SPAN>
1227 <!-- ========== Info from phpDoc block ========= -->
1228 this function is used to change the
1229 DOCTYPE tag's source attribute.
1230 <BR>
1231 By
1232 default it is set to SYSTEM.
1233 (ie &lt;!DOCTYPE html SYSTEM &gt; )
1234 ^^^^^^
1235
1236 NOTE: only 2 valid values 'SYSTEM', 'PUBLIC'
1237 <DL>
1238 <DT class="font10bold">Function Parameters:</DT>
1239
1240 <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">string</SPAN> <span style="color: #0000FF;font-weight:bold">$source</SPAN></SPAN> - the new source attribute</DD>
1241
1242
1243 <DT class="font10bold">Function Info:</DT>
1244
1245 </DL>
1246
1247 </DIV>
1248 <BR>
1249
1250 <DIV CLASS="function">
1251 <A NAME='set_encoding'><!-- --></A>
1252 <SPAN CLASS="font12bold">set_encoding</SPAN>
1253 <BR>
1254 <SPAN CLASS="font10bold">Useage : </SPAN>
1255 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
1256 <span class="font10bold" style="color: #0000FF">set_encoding ( $charset )</SPAN>
1257 <BR>
1258
1259 <BR>
1260 <SPAN CLASS="font10bold">Description : </SPAN>
1261 <!-- ========== Info from phpDoc block ========= -->
1262 set the character set
1263 <BR>
1264
1265 <DL>
1266 <DT class="font10bold">Function Parameters:</DT>
1267
1268 <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">string</SPAN> <span style="color: #0000FF;font-weight:bold">$charset</SPAN></SPAN> - the charset for the meta tag</DD>
1269
1270
1271 <DT class="font10bold">Function Info:</DT>
1272
1273 </DL>
1274
1275 </DIV>
1276 <BR>
1277
1278 <DIV CLASS="function">
1279 <A NAME='set_http_content_type'><!-- --></A>
1280 <SPAN CLASS="font12bold">set_http_content_type</SPAN>
1281 <BR>
1282 <SPAN CLASS="font10bold">Useage : </SPAN>
1283 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
1284 <span class="font10bold" style="color: #0000FF">set_http_content_type ( [$type = "application/xml"] )</SPAN>
1285 <BR>
1286
1287 <BR>
1288 <SPAN CLASS="font10bold">Description : </SPAN>
1289 <!-- ========== Info from phpDoc block ========= -->
1290 This function is used to set the
1291 http header content-type for output to browsers
1292 <BR>
1293
1294 <DL>
1295 <DT class="font10bold">Function Parameters:</DT>
1296
1297 <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">string</SPAN> <span style="color: #0000FF;font-weight:bold">$type</SPAN></SPAN> </DD>
1298
1299
1300 <DT class="font10bold">Function Info:</DT>
1301
1302 </DL>
1303
1304 </DIV>
1305 <BR>
1306
1307 <DIV CLASS="function">
1308 <A NAME='set_root_attribute'><!-- --></A>
1309 <SPAN CLASS="font12bold">set_root_attribute</SPAN>
1310 <BR>
1311 <SPAN CLASS="font10bold">Useage : </SPAN>
1312 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
1313 <span class="font10bold" style="color: #0000FF">set_root_attribute ( $name, $value )</SPAN>
1314 <BR>
1315
1316 <BR>
1317 <SPAN CLASS="font10bold">Description : </SPAN>
1318 <!-- ========== Info from phpDoc block ========= -->
1319 This sets 1 root tag attribute value pair
1320 <BR>
1321
1322 <DL>
1323 <DT class="font10bold">Function Parameters:</DT>
1324
1325 <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">string</SPAN> <span style="color: #0000FF;font-weight:bold">$name</SPAN></SPAN> - the attribute name</DD>
1326
1327 <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">string</SPAN> <span style="color: #0000FF;font-weight:bold">$value</SPAN></SPAN> - the attribute value</DD>
1328
1329
1330 <DT class="font10bold">Function Info:</DT>
1331
1332 </DL>
1333
1334 </DIV>
1335 <BR>
1336
1337 <DIV CLASS="function">
1338 <A NAME='set_root_attributes'><!-- --></A>
1339 <SPAN CLASS="font12bold">set_root_attributes</SPAN>
1340 <BR>
1341 <SPAN CLASS="font10bold">Useage : </SPAN>
1342 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
1343 <span class="font10bold" style="color: #0000FF">set_root_attributes ( $attributes )</SPAN>
1344 <BR>
1345
1346 <BR>
1347 <SPAN CLASS="font10bold">Description : </SPAN>
1348 <!-- ========== Info from phpDoc block ========= -->
1349 This function is used to set the
1350 root xml tag's attributes
1351 <BR>
1352
1353 <DL>
1354 <DT class="font10bold">Function Parameters:</DT>
1355
1356 <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">array</SPAN> <span style="color: #0000FF;font-weight:bold">$attributes</SPAN></SPAN> </DD>
1357
1358
1359 <DT class="font10bold">Function Info:</DT>
1360
1361 </DL>
1362
1363 </DIV>
1364 <BR>
1365
1366 <DIV CLASS="function">
1367 <A NAME='set_root_name'><!-- --></A>
1368 <SPAN CLASS="font12bold">set_root_name</SPAN>
1369 <BR>
1370 <SPAN CLASS="font10bold">Useage : </SPAN>
1371 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
1372 <span class="font10bold" style="color: #0000FF">set_root_name ( $root_name )</SPAN>
1373 <BR>
1374
1375 <BR>
1376 <SPAN CLASS="font10bold">Description : </SPAN>
1377 <!-- ========== Info from phpDoc block ========= -->
1378 Set the document name
1379 and the root tag's name.
1380 <BR>
1381
1382 <DL>
1383 <DT class="font10bold">Function Parameters:</DT>
1384
1385 <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">string</SPAN> <span style="color: #0000FF;font-weight:bold">$doc_name</SPAN></SPAN> </DD>
1386
1387
1388 <DT class="font10bold">Function Info:</DT>
1389
1390 </DL>
1391
1392 </DIV>
1393 <BR>
1394
1395 <DIV CLASS="function">
1396 <A NAME='show_character_encoding'><!-- --></A>
1397 <SPAN CLASS="font12bold">show_character_encoding</SPAN>
1398 <BR>
1399 <SPAN CLASS="font10bold">Useage : </SPAN>
1400 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
1401 <span class="font10bold" style="color: #0000FF">show_character_encoding ( [$flag = TRUE] )</SPAN>
1402 <BR>
1403
1404 <BR>
1405 <SPAN CLASS="font10bold">Description : </SPAN>
1406 <!-- ========== Info from phpDoc block ========= -->
1407 method to update the flag that lets us know
1408 <BR>
1409 to show/render the character encoding string
1410 in the xml tag or not
1411 <DL>
1412 <DT class="font10bold">Function Parameters:</DT>
1413
1414 <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">boolean</SPAN> <span style="color: #0000FF;font-weight:bold">$flag</SPAN></SPAN> </DD>
1415
1416
1417 <DT class="font10bold">Function Info:</DT>
1418
1419 </DL>
1420
1421 </DIV>
1422 <BR>
1423
1424 <DIV CLASS="function">
1425 <A NAME='show_http_header'><!-- --></A>
1426 <SPAN CLASS="font12bold">show_http_header</SPAN>
1427 <BR>
1428 <SPAN CLASS="font10bold">Useage : </SPAN>
1429 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
1430 <span class="font10bold" style="color: #0000FF">show_http_header ( [$flag = TRUE] )</SPAN>
1431 <BR>
1432
1433 <BR>
1434 <SPAN CLASS="font10bold">Description : </SPAN>
1435 <!-- ========== Info from phpDoc block ========= -->
1436 this function is used to set the flag
1437 <BR>
1438 that tells this class to automatically
1439 output the content type in the http header
1440 <DL>
1441 <DT class="font10bold">Function Parameters:</DT>
1442
1443 <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">boolean</SPAN> <span style="color: #0000FF;font-weight:bold">$flag</SPAN></SPAN> </DD>
1444
1445
1446 <DT class="font10bold">Function Info:</DT>
1447
1448 </DL>
1449
1450 </DIV>
1451 <BR>
1452
1453 <DIV CLASS="function">
1454 <A NAME='_build_doctype'><!-- --></A>
1455 <SPAN CLASS="font12bold">_build_doctype</SPAN>
1456 <BR>
1457 <SPAN CLASS="font10bold">Useage : </SPAN>
1458 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
1459 <span class="font10bold" style="color: #0000FF">_build_doctype ( )</SPAN>
1460 <BR>
1461
1462 <BR>
1463 <SPAN CLASS="font10bold">Description : </SPAN>
1464 <!-- ========== Info from phpDoc block ========= -->
1465 This method builds the DOCTYPE tag for the document
1466 <BR>
1467
1468 <DL>
1469 <DT class="font10bold">Function Parameters:</DT>
1470
1471
1472 <DT class="font10bold">Function Info:</DT>
1473
1474 </DL>
1475
1476 </DIV>
1477 <BR>
1478
1479 <DIV CLASS="function">
1480 <A NAME='_build_root_tag'><!-- --></A>
1481 <SPAN CLASS="font12bold">_build_root_tag</SPAN>
1482 <BR>
1483 <SPAN CLASS="font10bold">Useage : </SPAN>
1484 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
1485 <span class="font10bold" style="color: #0000FF">_build_root_tag ( )</SPAN>
1486 <BR>
1487
1488 <BR>
1489 <SPAN CLASS="font10bold">Description : </SPAN>
1490 <!-- ========== Info from phpDoc block ========= -->
1491 This function builds the root xml
1492 <BR>
1493 tag that will contain all of the Document's
1494 xml tags
1495 <DL>
1496 <DT class="font10bold">Function Parameters:</DT>
1497
1498
1499 <DT class="font10bold">Function Info:</DT>
1500
1501 </DL>
1502
1503 </DIV>
1504 <BR>
1505
1506 <DIV CLASS="function">
1507 <A NAME='_build_xml_stylesheet_container'><!-- --></A>
1508 <SPAN CLASS="font12bold">_build_xml_stylesheet_container</SPAN>
1509 <BR>
1510 <SPAN CLASS="font10bold">Useage : </SPAN>
1511 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
1512 <span class="font10bold" style="color: #0000FF">_build_xml_stylesheet_container ( )</SPAN>
1513 <BR>
1514
1515 <BR>
1516 <SPAN CLASS="font10bold">Description : </SPAN>
1517 <!-- ========== Info from phpDoc block ========= -->
1518 This function builds the _xml_stylesheet_container
1519 <BR>
1520
1521 <DL>
1522 <DT class="font10bold">Function Parameters:</DT>
1523
1524
1525 <DT class="font10bold">Function Info:</DT>
1526
1527 </DL>
1528
1529 </DIV>
1530 <BR>
1531
1532 <DIV CLASS="function">
1533 <A NAME='_create_xml_obj'><!-- --></A>
1534 <SPAN CLASS="font12bold">_create_xml_obj</SPAN>
1535 <BR>
1536 <SPAN CLASS="font10bold">Useage : </SPAN>
1537 <span class="font10bold" style="color: #FF0000"><a href="../phpHtmlLib/XMLtag.html">XMLtag</a></SPAN>&nbsp;
1538 <span class="font10bold" style="color: #0000FF">_create_xml_obj ( )</SPAN>
1539 <BR>
1540
1541 <BR>
1542 <SPAN CLASS="font10bold">Description : </SPAN>
1543 <!-- ========== Info from phpDoc block ========= -->
1544 This function builds the local
1545 <BR>
1546 xml container object that holds
1547 all xml tags that are pushed into
1548 this class
1549 <DL>
1550 <DT class="font10bold">Function Parameters:</DT>
1551
1552
1553 <DT class="font10bold">Function Info:</DT>
1554
1555 <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - object</DD>
1556
1557 </DL>
1558
1559 </DIV>
1560 <BR>
1561
1562
1563 <hr>
1564 </HTML>
MailToCvsAdmin">MailToCvsAdmin
 ViewVC Help
Powered by ViewVC 1.1.26 RSS 2.0 feed