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 WMLtag</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 WMLtag">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 WMLtag |
33 |
</H2> |
34 |
|
35 |
<pre> |
36 |
<pre><a href="../phpHtmlLib/Container.html">Container</a> |
37 |
| |
38 |
--<a href="../phpHtmlLib/XMLTagClass.html">XMLTagClass</a> |
39 |
| |
40 |
--<a href="../phpHtmlLib/WMLTagClass.html">WMLTagClass</a> |
41 |
| |
42 |
--WMLtag</pre> |
43 |
</pre> |
44 |
|
45 |
<A NAME="children_summary"</A> |
46 |
<H3> |
47 |
Classes extended from WMLtag: <A HREF="#top" CLASS="links">^TOP</A> |
48 |
</H3> |
49 |
|
50 |
<p> |
51 |
<b><i>Located in File: Program_Root/tag_classes/WMLTAGS.inc</i></b><br> |
52 |
</p> |
53 |
<hr> |
54 |
<!-- ========== Info from phpDoc block ========= --> |
55 |
<WML> tag class |
56 |
<BR> |
57 |
The root tag for all |
58 |
WML documents |
59 |
|
60 |
<UL> |
61 |
|
62 |
<LI><b>Package</b> - <CODE>phpHtmlLib</CODE></LI> |
63 |
|
64 |
</UL> |
65 |
|
66 |
<hr> |
67 |
<!-- =========== VAR SUMMARY =========== --> |
68 |
<A NAME='var_summary'><!-- --></A> |
69 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
70 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
71 |
<TD> |
72 |
<span CLASS="font12bold">Class Variable Summary</span> |
73 |
<A HREF="#top" CLASS="links">^TOP</A> |
74 |
</TD> |
75 |
</TR> |
76 |
|
77 |
|
78 |
<!-- =========== Summary =========== --> |
79 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
80 |
<TD> |
81 |
<CODE><B><A HREF='WMLtag.html#$_tag'>$_tag</A></B></CODE> |
82 |
<BR> |
83 |
<blockquote> </blockquote> |
84 |
<blockquote> Default Value: <CODE>->wml<-</CODE> </blockquote> |
85 |
</TD> |
86 |
</TR> |
87 |
|
88 |
</TABLE> |
89 |
|
90 |
<hr> |
91 |
<!-- =========== VAR INHERITED SUMMARY =========== --> |
92 |
<A NAME='var_inherited_summary'><!-- --></A> |
93 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
94 |
<TR CLASS='TableHeadingColor'> |
95 |
<TD> |
96 |
<span CLASS="font12bold">Inherited Class Variable Summary</span> |
97 |
<A HREF="#top" CLASS="links">^TOP</A> |
98 |
</TD> |
99 |
</TR> |
100 |
|
101 |
|
102 |
<!-- =========== Summary =========== --> |
103 |
<TR BGCOLOR='white'> |
104 |
<TD> |
105 |
<span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/XMLTagClass.html">XMLTagClass</a></span> |
106 |
<table CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center"> |
107 |
<tr CLASS="tableheadingcolor"> |
108 |
<th>Variable</th> |
109 |
<th>Default Value</th> |
110 |
<th>Description</th> |
111 |
</tr> |
112 |
|
113 |
<tr> |
114 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLTagClass.html#$newline_after_closetag'>$newline_after_closetag</A></td> |
115 |
<td CLASS="font10" STYLE="white-space: nowrap">->TRUE<-</td> |
116 |
<td CLASS="font10">Flag to place a newline after close tag.</td> |
117 |
</tr> |
118 |
|
119 |
<tr> |
120 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLTagClass.html#$newline_after_opentag'>$newline_after_opentag</A></td> |
121 |
<td CLASS="font10" STYLE="white-space: nowrap">->TRUE<-</td> |
122 |
<td CLASS="font10">Flag to place a newline after open tag.</td> |
123 |
</tr> |
124 |
|
125 |
<tr> |
126 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLTagClass.html#$_cdata_content_wrap'>$_cdata_content_wrap</A></td> |
127 |
<td CLASS="font10" STYLE="white-space: nowrap">->FALSE<-</td> |
128 |
<td CLASS="font10">Automatically wrap ALL content</td> |
129 |
</tr> |
130 |
|
131 |
<tr> |
132 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLTagClass.html#$_tag_postfix'>$_tag_postfix</A></td> |
133 |
<td CLASS="font10" STYLE="white-space: nowrap">->><-</td> |
134 |
<td CLASS="font10">holds the tag postfix</td> |
135 |
</tr> |
136 |
|
137 |
<tr> |
138 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLTagClass.html#$_tag_prefix'>$_tag_prefix</A></td> |
139 |
<td CLASS="font10" STYLE="white-space: nowrap">-><<-</td> |
140 |
<td CLASS="font10">holds the tag prefix</td> |
141 |
</tr> |
142 |
|
143 |
</table> |
144 |
<BR> |
145 |
</TD> |
146 |
</TR> |
147 |
|
148 |
<!-- =========== Summary =========== --> |
149 |
<TR BGCOLOR='white'> |
150 |
<TD> |
151 |
<span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/Container.html">Container</a></span> |
152 |
<table CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center"> |
153 |
<tr CLASS="tableheadingcolor"> |
154 |
<th>Variable</th> |
155 |
<th>Default Value</th> |
156 |
<th>Description</th> |
157 |
</tr> |
158 |
|
159 |
<tr> |
160 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#$indent_flag'>$indent_flag</A></td> |
161 |
<td CLASS="font10" STYLE="white-space: nowrap">->TRUE<-</td> |
162 |
<td CLASS="font10">Flag for pretty (indented) output</td> |
163 |
</tr> |
164 |
|
165 |
<tr> |
166 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#$_newline_after_content_flag'>$_newline_after_content_flag</A></td> |
167 |
<td CLASS="font10" STYLE="white-space: nowrap">->TRUE<-</td> |
168 |
<td CLASS="font10">Do we render a newline after the |
169 |
contents has been rendered?</td> |
170 |
</tr> |
171 |
|
172 |
</table> |
173 |
<BR> |
174 |
</TD> |
175 |
</TR> |
176 |
|
177 |
</TABLE> |
178 |
|
179 |
<hr> |
180 |
<!-- =========== INHERITED METHOD SUMMARY =========== --> |
181 |
<A NAME='functions_inherited'><!-- --></A> |
182 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
183 |
<TR CLASS='TableHeadingColor'> |
184 |
<TD> |
185 |
<span CLASS="font12bold">Inherited Method Summary</span> |
186 |
<A HREF="#top" CLASS="links">^TOP</A> |
187 |
</TD> |
188 |
</TR> |
189 |
|
190 |
|
191 |
<!-- =========== Summary =========== --> |
192 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
193 |
<TD> |
194 |
<span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/WMLTagClass.html">WMLTagClass</a></span> |
195 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center"> |
196 |
<tr CLASS="tableheadingcolor"> |
197 |
<th>Function</th> |
198 |
<th>Description</th> |
199 |
</tr> |
200 |
|
201 |
<tr> |
202 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/WMLTagClass.html#constructor WMLTagClass'>constructor WMLTagClass ( [$attributes = array()] )</A></td> |
203 |
<td CLASS="font10"></td> |
204 |
|
205 |
<tr> |
206 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/WMLTagClass.html#set_class'>set_class ( $value )</A></td> |
207 |
<td CLASS="font10">This function is a shorthand helper |
208 |
to setting the class attribute on a |
209 |
tag.</td> |
210 |
|
211 |
<tr> |
212 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/WMLTagClass.html#set_id'>set_id ( $value )</A></td> |
213 |
<td CLASS="font10">This function is a shorthand helper |
214 |
to setting the id attribute on a |
215 |
tag.</td> |
216 |
|
217 |
</table> |
218 |
<br> |
219 |
</TD> |
220 |
</TR> |
221 |
|
222 |
<!-- =========== Summary =========== --> |
223 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
224 |
<TD> |
225 |
<span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/XMLTagClass.html">XMLTagClass</a></span> |
226 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center"> |
227 |
<tr CLASS="tableheadingcolor"> |
228 |
<th>Function</th> |
229 |
<th>Description</th> |
230 |
</tr> |
231 |
|
232 |
<tr> |
233 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLTagClass.html#constructor XMLTagClass'>constructor XMLTagClass ( [$name = ], [$attributes = array()] )</A></td> |
234 |
<td CLASS="font10">The constructor</td> |
235 |
|
236 |
<tr> |
237 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLTagClass.html#get_tag'>get_tag ( )</A></td> |
238 |
<td CLASS="font10">This returns the tag declared for this class.</td> |
239 |
|
240 |
<tr> |
241 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLTagClass.html#get_tag_name'>get_tag_name ( )</A></td> |
242 |
<td CLASS="font10">This method gets the name of the tag</td> |
243 |
|
244 |
<tr> |
245 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLTagClass.html#render'>render ( [$indent_level = 0] )</A></td> |
246 |
<td CLASS="font10">This function is responsible</td> |
247 |
|
248 |
<tr> |
249 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLTagClass.html#reset_attributes'>reset_attributes ( [$attributes = array()] )</A></td> |
250 |
<td CLASS="font10">clear all attributes and start with new attributes</td> |
251 |
|
252 |
<tr> |
253 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLTagClass.html#set_collapse'>set_collapse ( [$collapse = TRUE], [$indent = TRUE] )</A></td> |
254 |
<td CLASS="font10">This function turns on the collapse flag</td> |
255 |
|
256 |
<tr> |
257 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLTagClass.html#set_newline_after_closetag'>set_newline_after_closetag ( $flag )</A></td> |
258 |
<td CLASS="font10">set the newline_after_content flag</td> |
259 |
|
260 |
<tr> |
261 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLTagClass.html#set_newline_after_opentag'>set_newline_after_opentag ( $flag )</A></td> |
262 |
<td CLASS="font10">set the newline_after_opentag flag</td> |
263 |
|
264 |
<tr> |
265 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLTagClass.html#set_tag_attribute'>set_tag_attribute ( $name, [$value = NULL] )</A></td> |
266 |
<td CLASS="font10">add a single attribute (name="value")</td> |
267 |
|
268 |
<tr> |
269 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLTagClass.html#set_tag_attributes'>set_tag_attributes ( [$attributes = array()] )</A></td> |
270 |
<td CLASS="font10">add multiple attributes (name="value")</td> |
271 |
|
272 |
<tr> |
273 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLTagClass.html#set_tag_name'>set_tag_name ( $name )</A></td> |
274 |
<td CLASS="font10">This method sets the name of the tag</td> |
275 |
|
276 |
<tr> |
277 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLTagClass.html#_build_attribute_string'>_build_attribute_string ( $name, $value )</A></td> |
278 |
<td CLASS="font10">this builds an attribute for an XML tag.</td> |
279 |
|
280 |
<tr> |
281 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLTagClass.html#_get_element'>_get_element ( $cell )</A></td> |
282 |
<td CLASS="font10">get the nth element from content array</td> |
283 |
|
284 |
<tr> |
285 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLTagClass.html#_prepare_flags'>_prepare_flags ( )</A></td> |
286 |
<td CLASS="font10">This function checks to see if</td> |
287 |
|
288 |
<tr> |
289 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLTagClass.html#_render_close_tag'>_render_close_tag ( $indent_level )</A></td> |
290 |
<td CLASS="font10">this function is reposnsible for |
291 |
rendering the closing tag (if any)</td> |
292 |
|
293 |
<tr> |
294 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLTagClass.html#_render_content'>_render_content ( $indent_level, [$output_debug = 0] )</A></td> |
295 |
<td CLASS="font10">this function is reponsible for</td> |
296 |
|
297 |
<tr> |
298 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLTagClass.html#_render_open_tag'>_render_open_tag ( $indent_level, [$finish_slash = TRUE] )</A></td> |
299 |
<td CLASS="font10">this function is responsible for |
300 |
rendering the open tag.</td> |
301 |
|
302 |
</table> |
303 |
<br> |
304 |
</TD> |
305 |
</TR> |
306 |
|
307 |
<!-- =========== Summary =========== --> |
308 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
309 |
<TD> |
310 |
<span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/Container.html">Container</a></span> |
311 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center"> |
312 |
<tr CLASS="tableheadingcolor"> |
313 |
<th>Function</th> |
314 |
<th>Description</th> |
315 |
</tr> |
316 |
|
317 |
<tr> |
318 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#constructor Container'>constructor Container ( )</A></td> |
319 |
<td CLASS="font10">The constructor.</td> |
320 |
|
321 |
<tr> |
322 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#add'>add ( )</A></td> |
323 |
<td CLASS="font10">add content onto content stack</td> |
324 |
|
325 |
<tr> |
326 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#add_reference'>add_reference ( &$content )</A></td> |
327 |
<td CLASS="font10">Add content onto content stack |
328 |
so you can change the item later.</td> |
329 |
|
330 |
<tr> |
331 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#count_content'>count_content ( )</A></td> |
332 |
<td CLASS="font10">counts the number of content objects</td> |
333 |
|
334 |
<tr> |
335 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#get_indent_flag'>get_indent_flag ( )</A></td> |
336 |
<td CLASS="font10">This flag gets the current value |
337 |
of the indent flag</td> |
338 |
|
339 |
<tr> |
340 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#push'>push ( )</A></td> |
341 |
<td CLASS="font10">Same as add().</td> |
342 |
|
343 |
<tr> |
344 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#push_reference'>push_reference ( &$content )</A></td> |
345 |
<td CLASS="font10">Same as add_reference |
346 |
NOTE : only exists for compatibility with 1.1.x</td> |
347 |
|
348 |
<tr> |
349 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#render'>render ( [$indent_level = 1], [$output_debug = 0] )</A></td> |
350 |
<td CLASS="font10">This function is compatible with the |
351 |
rest of the phpHtmllib API spec.</td> |
352 |
|
353 |
<tr> |
354 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#reset_content'>reset_content ( )</A></td> |
355 |
<td CLASS="font10">destroy existing content and start with new content.</td> |
356 |
|
357 |
<tr> |
358 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#set_collapse'>set_collapse ( [$collapse = TRUE], [$indent = TRUE] )</A></td> |
359 |
<td CLASS="font10">This function turns on the collapse flag</td> |
360 |
|
361 |
<tr> |
362 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#set_indent_flag'>set_indent_flag ( $flag )</A></td> |
363 |
<td CLASS="font10">function to set the indent flag</td> |
364 |
|
365 |
</table> |
366 |
<br> |
367 |
</TD> |
368 |
</TR> |
369 |
|
370 |
</TABLE> |
371 |
|
372 |
<hr> |
373 |
<!-- should have constructor at some point --> |
374 |
<!-- =========== Method SUMMARY =========== --> |
375 |
<A NAME='Method_summary'><!-- --></A> |
376 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' Class="border"> |
377 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
378 |
<TD> |
379 |
<span class="font12bold">Method Summary</span> |
380 |
<A HREF="#top" CLASS="links">^TOP</A> |
381 |
</TD> |
382 |
</TR> |
383 |
|
384 |
|
385 |
</TABLE> |
386 |
|
387 |
<hr> |
388 |
<!-- ============ VARIABLE DETAIL =========== --> |
389 |
|
390 |
<A NAME='variable_detail'></A> |
391 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
392 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
393 |
<TD> |
394 |
<span CLASS="font12bold">Variable Detail</span> |
395 |
<A HREF="#top" CLASS="links">^TOP</A> |
396 |
</TD> |
397 |
</TR> |
398 |
</TABLE> |
399 |
|
400 |
|
401 |
<A NAME='$_tag'><!-- --></A><H3>$_tag</H3> |
402 |
<b>Data type:</b> mixed<br> |
403 |
<!-- ========== Info from phpDoc block ========= --> |
404 |
|
405 |
<BR> |
406 |
|
407 |
|
408 |
<UL> |
409 |
|
410 |
</UL> |
411 |
|
412 |
<HR> |
413 |
|
414 |
|
415 |
<hr> |
416 |
<!-- ============ FUNCTION DETAIL =========== --> |
417 |
|
418 |
<A NAME='function_detail'></A> |
419 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
420 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
421 |
<TD> |
422 |
<span class="font12bold">Method Detail</span> |
423 |
<A HREF="#top" CLASS="links">^TOP</A> |
424 |
</TD> |
425 |
</TR> |
426 |
</TABLE> |
427 |
<BR> |
428 |
|
429 |
|
430 |
<hr> |
431 |
</HTML> |