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

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

Parent Directory Parent Directory | Revision Log Revision Log

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