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

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

Parent Directory Parent Directory | Revision Log Revision Log

Revision 1.1.1.1 - (show annotations) (vendor branch)
Thu Jan 30 03:29:30 2003 UTC (22 years, 9 months ago) by jonen
Branch: no_vendor_tag
CVS Tags: v2-1-3, no_release_tag
Changes since 1.1: +0 -0 lines
File MIME type: text/html
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:40 -0800' -->
6 <TITLE>Docs For Class WMLDocumentClass</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 WMLDocumentClass">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 WMLDocumentClass
33 </H2>
34
35 <pre>
36 <pre><a href="../phpHtmlLib/Container.html">Container</a>
37 |
38 --<a href="../phpHtmlLib/XMLDocumentClass.html">XMLDocumentClass</a>
39 |
40 --WMLDocumentClass</pre>
41 </pre>
42
43 <A NAME="children_summary"</A>
44 <H3>
45 Classes extended from WMLDocumentClass: <A HREF="#top" CLASS="links">^TOP</A>
46 </H3>
47
48 <p>
49 <b><i>Located in File: Program_Root/widgets/WMLDocumentClass.inc</i></b><br>
50 </p>
51 <hr>
52 <!-- ========== Info from phpDoc block ========= -->
53 This class lets you build a complete
54 <BR>
55 WML document and render it
56
57 <UL>
58
59 <LI><b>Package</b> - <CODE>phpHtmlLib</CODE></LI>
60
61 <LI><b>Author</b> - <CODE>Walter A. Boring IV &lt;<a href="mailto:waboring@buildabetterweb.com">waboring@buildabetterweb.com</a>&gt;</CODE></LI>
62
63 </UL>
64
65 <hr>
66 <!-- =========== VAR SUMMARY =========== -->
67 <A NAME='var_summary'><!-- --></A>
68 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
69 <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
70 <TD>
71 <span CLASS="font12bold">Class Variable Summary</span>
72 <A HREF="#top" CLASS="links">^TOP</A>
73 </TD>
74 </TR>
75
76
77 </TABLE>
78
79 <hr>
80 <!-- =========== VAR INHERITED SUMMARY =========== -->
81 <A NAME='var_inherited_summary'><!-- --></A>
82 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
83 <TR CLASS='TableHeadingColor'>
84 <TD>
85 <span CLASS="font12bold">Inherited Class Variable Summary</span>
86 <A HREF="#top" CLASS="links">^TOP</A>
87 </TD>
88 </TR>
89
90
91 <!-- =========== Summary =========== -->
92 <TR BGCOLOR='white'>
93 <TD>
94 <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/XMLDocumentClass.html">XMLDocumentClass</a></span>
95 <table CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">
96 <tr CLASS="tableheadingcolor">
97 <th>Variable</th>
98 <th>Default Value</th>
99 <th>Description</th>
100 </tr>
101
102 <tr>
103 <td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLDocumentClass.html#$dtd'>$dtd</A></td>
104 <td CLASS="font10" STYLE="white-space: nowrap">->NULL<-</td>
105 <td CLASS="font10">Holds the url of dtd</td>
106 </tr>
107
108 <tr>
109 <td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLDocumentClass.html#$root_name'>$root_name</A></td>
110 <td CLASS="font10" STYLE="white-space: nowrap">->NULL<-</td>
111 <td CLASS="font10">Holds the name of the root xml</td>
112 </tr>
113
114 <tr>
115 <td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLDocumentClass.html#$_doctype_links'>$_doctype_links</A></td>
116 <td CLASS="font10" STYLE="white-space: nowrap">->array()<-</td>
117 <td CLASS="font10">This contains the doctype links
118 attributes.</td>
119 </tr>
120
121 <tr>
122 <td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLDocumentClass.html#$_doctype_source'>$_doctype_source</A></td>
123 <td CLASS="font10" STYLE="white-space: nowrap">->SYSTEM<-</td>
124 <td CLASS="font10">the DOCTYPE source attribute</td>
125 </tr>
126
127 <tr>
128 <td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLDocumentClass.html#$_http_content_type'>$_http_content_type</A></td>
129 <td CLASS="font10" STYLE="white-space: nowrap">->application/xml<-</td>
130 <td CLASS="font10">The http content-type</td>
131 </tr>
132
133 <tr>
134 <td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLDocumentClass.html#$_root_tag'>$_root_tag</A></td>
135 <td CLASS="font10" STYLE="white-space: nowrap">->NULL<-</td>
136 <td CLASS="font10">The root xml tag for all data</td>
137 </tr>
138
139 <tr>
140 <td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLDocumentClass.html#$_show_char_encoding'>$_show_char_encoding</A></td>
141 <td CLASS="font10" STYLE="white-space: nowrap">->TRUE<-</td>
142 <td CLASS="font10">this is a hack to show the
143 character encoding or not.</td>
144 </tr>
145
146 <tr>
147 <td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLDocumentClass.html#$_show_http_header'>$_show_http_header</A></td>
148 <td CLASS="font10" STYLE="white-space: nowrap">->FALSE<-</td>
149 <td CLASS="font10">This flag tells if we should
150 output the header content type.</td>
151 </tr>
152
153 <tr>
154 <td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLDocumentClass.html#$_xml_obj'>$_xml_obj</A></td>
155 <td CLASS="font10" STYLE="white-space: nowrap">->NULL<-</td>
156 <td CLASS="font10">holds the xml tag object that
157 all content will be wrapped in</td>
158 </tr>
159
160 <tr>
161 <td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLDocumentClass.html#$_xml_stylesheet_container'>$_xml_stylesheet_container</A></td>
162 <td CLASS="font10" STYLE="white-space: nowrap">->NULL<-</td>
163 <td CLASS="font10">The container for all the
164 xml-stylesheet tags</td>
165 </tr>
166
167 </table>
168 <BR>
169 </TD>
170 </TR>
171
172 <!-- =========== Summary =========== -->
173 <TR BGCOLOR='white'>
174 <TD>
175 <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/Container.html">Container</a></span>
176 <table CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">
177 <tr CLASS="tableheadingcolor">
178 <th>Variable</th>
179 <th>Default Value</th>
180 <th>Description</th>
181 </tr>
182
183 <tr>
184 <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#$indent_flag'>$indent_flag</A></td>
185 <td CLASS="font10" STYLE="white-space: nowrap">->TRUE<-</td>
186 <td CLASS="font10">Flag for pretty (indented) output</td>
187 </tr>
188
189 <tr>
190 <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#$_newline_after_content_flag'>$_newline_after_content_flag</A></td>
191 <td CLASS="font10" STYLE="white-space: nowrap">->TRUE<-</td>
192 <td CLASS="font10">Do we render a newline after the
193 contents has been rendered?</td>
194 </tr>
195
196 </table>
197 <BR>
198 </TD>
199 </TR>
200
201 </TABLE>
202
203 <hr>
204 <!-- =========== INHERITED METHOD SUMMARY =========== -->
205 <A NAME='functions_inherited'><!-- --></A>
206 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
207 <TR CLASS='TableHeadingColor'>
208 <TD>
209 <span CLASS="font12bold">Inherited Method Summary</span>
210 <A HREF="#top" CLASS="links">^TOP</A>
211 </TD>
212 </TR>
213
214
215 <!-- =========== Summary =========== -->
216 <TR BGCOLOR='white' CLASS='TableRowColor'>
217 <TD>
218 <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/XMLDocumentClass.html">XMLDocumentClass</a></span>
219 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">
220 <tr CLASS="tableheadingcolor">
221 <th>Function</th>
222 <th>Description</th>
223 </tr>
224
225 <tr>
226 <td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLDocumentClass.html#constructor XMLDocumentClass'>constructor XMLDocumentClass ( [$root_name = ], [$dtd = NULL], [$root_attributes = array()] )</A></td>
227 <td CLASS="font10">The constructor</td>
228
229 <tr>
230 <td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLDocumentClass.html#add'>add ( )</A></td>
231 <td CLASS="font10">we override this class to make sure</td>
232
233 <tr>
234 <td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLDocumentClass.html#add_reference'>add_reference ( &$content )</A></td>
235 <td CLASS="font10">we override this class to make sure</td>
236
237 <tr>
238 <td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLDocumentClass.html#add_xml_stylesheet_link'>add_xml_stylesheet_link ( $href )</A></td>
239 <td CLASS="font10">This function is used to add a new
240 xml-stylesheet tag to the top
241 portion of the document.</td>
242
243 <tr>
244 <td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLDocumentClass.html#dump_http_header'>dump_http_header ( )</A></td>
245 <td CLASS="font10">This function is used to output the http
246 header for this document.</td>
247
248 <tr>
249 <td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLDocumentClass.html#get_doctype_source'>get_doctype_source ( )</A></td>
250 <td CLASS="font10">This function returns the current
251 DOCTYPE tag's source attribute</td>
252
253 <tr>
254 <td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLDocumentClass.html#get_encoding'>get_encoding ( )</A></td>
255 <td CLASS="font10">This function gets the current encoding type</td>
256
257 <tr>
258 <td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLDocumentClass.html#get_http_content_type'>get_http_content_type ( )</A></td>
259 <td CLASS="font10">This function returns the current
260 value of the http header content type</td>
261
262 <tr>
263 <td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLDocumentClass.html#get_root_attributes'>get_root_attributes ( )</A></td>
264 <td CLASS="font10">This function is used to get the
265 root xml tag's attributes</td>
266
267 <tr>
268 <td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLDocumentClass.html#get_root_name'>get_root_name ( )</A></td>
269 <td CLASS="font10">This function gets the document name</td>
270
271 <tr>
272 <td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLDocumentClass.html#push'>push ( )</A></td>
273 <td CLASS="font10">Same as add().</td>
274
275 <tr>
276 <td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLDocumentClass.html#push_reference'>push_reference ( &$content )</A></td>
277 <td CLASS="font10">Same as add_reference
278 NOTE : only exists for compatibility with 1.1.x</td>
279
280 <tr>
281 <td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLDocumentClass.html#render'>render ( [$indent_level = 0] )</A></td>
282 <td CLASS="font10">function that will render the XML Document.</td>
283
284 <tr>
285 <td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLDocumentClass.html#reset_content'>reset_content ( )</A></td>
286 <td CLASS="font10">we override this class to make sure</td>
287
288 <tr>
289 <td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLDocumentClass.html#set_doctype_link'>set_doctype_link ( $link )</A></td>
290 <td CLASS="font10">This method is used to set the link attributes
291 for the DOCTYPE tag</td>
292
293 <tr>
294 <td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLDocumentClass.html#set_doctype_source'>set_doctype_source ( $source )</A></td>
295 <td CLASS="font10">this function is used to change the
296 DOCTYPE tag's source attribute.</td>
297
298 <tr>
299 <td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLDocumentClass.html#set_encoding'>set_encoding ( $charset )</A></td>
300 <td CLASS="font10">set the character set</td>
301
302 <tr>
303 <td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLDocumentClass.html#set_http_content_type'>set_http_content_type ( [$type = "application/xml"] )</A></td>
304 <td CLASS="font10">This function is used to set the
305 http header content-type for output to browsers</td>
306
307 <tr>
308 <td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLDocumentClass.html#set_root_attribute'>set_root_attribute ( $name, $value )</A></td>
309 <td CLASS="font10">This sets 1 root tag attribute value pair</td>
310
311 <tr>
312 <td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLDocumentClass.html#set_root_attributes'>set_root_attributes ( $attributes )</A></td>
313 <td CLASS="font10">This function is used to set the
314 root xml tag's attributes</td>
315
316 <tr>
317 <td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLDocumentClass.html#set_root_name'>set_root_name ( $root_name )</A></td>
318 <td CLASS="font10">Set the document name
319 and the root tag's name.</td>
320
321 <tr>
322 <td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLDocumentClass.html#show_character_encoding'>show_character_encoding ( [$flag = TRUE] )</A></td>
323 <td CLASS="font10">method to update the flag that lets us know</td>
324
325 <tr>
326 <td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLDocumentClass.html#show_http_header'>show_http_header ( [$flag = TRUE] )</A></td>
327 <td CLASS="font10">this function is used to set the flag</td>
328
329 <tr>
330 <td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLDocumentClass.html#_build_doctype'>_build_doctype ( )</A></td>
331 <td CLASS="font10">This method builds the DOCTYPE tag for the document</td>
332
333 <tr>
334 <td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLDocumentClass.html#_build_root_tag'>_build_root_tag ( )</A></td>
335 <td CLASS="font10">This function builds the root xml</td>
336
337 <tr>
338 <td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLDocumentClass.html#_build_xml_stylesheet_container'>_build_xml_stylesheet_container ( )</A></td>
339 <td CLASS="font10">This function builds the _xml_stylesheet_container</td>
340
341 <tr>
342 <td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLDocumentClass.html#_create_xml_obj'>_create_xml_obj ( )</A></td>
343 <td CLASS="font10">This function builds the local</td>
344
345 </table>
346 <br>
347 </TD>
348 </TR>
349
350 <!-- =========== Summary =========== -->
351 <TR BGCOLOR='white' CLASS='TableRowColor'>
352 <TD>
353 <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/Container.html">Container</a></span>
354 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">
355 <tr CLASS="tableheadingcolor">
356 <th>Function</th>
357 <th>Description</th>
358 </tr>
359
360 <tr>
361 <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#constructor Container'>constructor Container ( )</A></td>
362 <td CLASS="font10">The constructor.</td>
363
364 <tr>
365 <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#add'>add ( )</A></td>
366 <td CLASS="font10">add content onto content stack</td>
367
368 <tr>
369 <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#add_reference'>add_reference ( &$content )</A></td>
370 <td CLASS="font10">Add content onto content stack
371 so you can change the item later.</td>
372
373 <tr>
374 <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#count_content'>count_content ( )</A></td>
375 <td CLASS="font10">counts the number of content objects</td>
376
377 <tr>
378 <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#get_indent_flag'>get_indent_flag ( )</A></td>
379 <td CLASS="font10">This flag gets the current value
380 of the indent flag</td>
381
382 <tr>
383 <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#push'>push ( )</A></td>
384 <td CLASS="font10">Same as add().</td>
385
386 <tr>
387 <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#push_reference'>push_reference ( &$content )</A></td>
388 <td CLASS="font10">Same as add_reference
389 NOTE : only exists for compatibility with 1.1.x</td>
390
391 <tr>
392 <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#render'>render ( [$indent_level = 1], [$output_debug = 0] )</A></td>
393 <td CLASS="font10">This function is compatible with the
394 rest of the phpHtmllib API spec.</td>
395
396 <tr>
397 <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#reset_content'>reset_content ( )</A></td>
398 <td CLASS="font10">destroy existing content and start with new content.</td>
399
400 <tr>
401 <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#set_collapse'>set_collapse ( [$collapse = TRUE], [$indent = TRUE] )</A></td>
402 <td CLASS="font10">This function turns on the collapse flag</td>
403
404 <tr>
405 <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#set_indent_flag'>set_indent_flag ( $flag )</A></td>
406 <td CLASS="font10">function to set the indent flag</td>
407
408 </table>
409 <br>
410 </TD>
411 </TR>
412
413 </TABLE>
414
415 <hr>
416 <!-- should have constructor at some point -->
417 <!-- =========== Method SUMMARY =========== -->
418 <A NAME='Method_summary'><!-- --></A>
419 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' Class="border">
420 <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
421 <TD>
422 <span class="font12bold">Method Summary</span>
423 <A HREF="#top" CLASS="links">^TOP</A>
424 </TD>
425 </TR>
426
427
428 <!-- =========== Summary =========== -->
429 <TR BGCOLOR='white' CLASS='TableRowColor'>
430 <TD>
431 <CODE><B><A HREF='WMLDocumentClass.html#constructor WMLDocumentClass'>void constructor WMLDocumentClass ( )</A></B></CODE>
432 <BR>
433 <blockquote> </blockquote>
434 </TD>
435 </TR>
436
437 </TABLE>
438
439 <hr>
440 <!-- ============ VARIABLE DETAIL =========== -->
441
442 <A NAME='variable_detail'></A>
443 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
444 <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
445 <TD>
446 <span CLASS="font12bold">Variable Detail</span>
447 <A HREF="#top" CLASS="links">^TOP</A>
448 </TD>
449 </TR>
450 </TABLE>
451
452
453
454 <hr>
455 <!-- ============ FUNCTION DETAIL =========== -->
456
457 <A NAME='function_detail'></A>
458 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
459 <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
460 <TD>
461 <span class="font12bold">Method Detail</span>
462 <A HREF="#top" CLASS="links">^TOP</A>
463 </TD>
464 </TR>
465 </TABLE>
466 <BR>
467
468 <DIV CLASS="function">
469 <A NAME='constructor WMLDocumentClass'><!-- --></A>
470 <SPAN CLASS="font12bold">constructor WMLDocumentClass</SPAN>
471 <BR>
472 <SPAN CLASS="font10bold">Useage : </SPAN>
473 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
474 <span class="font10bold" style="color: #0000FF">constructor WMLDocumentClass ( )</SPAN>
475 <BR>
476
477 <BR>
478 <SPAN CLASS="font10bold">Description : </SPAN>
479 <!-- ========== Info from phpDoc block ========= -->
480
481 <BR>
482
483 <DL>
484 <DT class="font10bold">Function Parameters:</DT>
485
486
487 <DT class="font10bold">Function Info:</DT>
488
489 </DL>
490
491 </DIV>
492 <BR>
493
494
495 <hr>
496 </HTML>
MailToCvsAdmin">MailToCvsAdmin
 ViewVC Help
Powered by ViewVC 1.1.26 RSS 2.0 feed