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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.2 - (show annotations)
Sat Feb 22 20:56:30 2003 UTC (21 years, 6 months ago) by jonen
Branch: MAIN
Changes since 1.1: +194 -395 lines
File MIME type: text/html
+ updated whole lib to version 2.2.1 (new FormProcessing since 2.2.0!)

1 <!DOCTYPE HTML PUBLIC '-//W3C//DTD HTML 4.0 Transitional//EN' 'http://www.w3.org/TR/REC-html40/loose.dtd'>
2 <!--NewPage-->
3 <HTML>
4 <HEAD>
5 <!-- Generated by PhpDoc date: 'Thu, 20 Feb 2003 16:22:16 -0800' -->
6 <TITLE>Docs For Class OLtag</TITLE>
7 <LINK REL ='stylesheet' TYPE='text/css' HREF='../media/stylesheet.css' TITLE='Style'>
8 </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 OLtag">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 <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 <A HREF="#variable_detail" class="links" title="Variable Detail">Variable Detail</A>
22 <A HREF="#method_detail" class="links" title="Method Detail">Method Detail</A>
23 </TD>
24 </TR>
25 </TABLE>
26 <BR>
27 <!-- Start of Class Data -->
28 <H2>
29 Class OLtag
30 </H2> (line <span class="linenumber">874</span>)
31 <pre>
32 <a href="../phpHtmlLib/Container.html">Container</a>
33 |
34 --<a href="../phpHtmlLib/XMLTagClass.html">XMLTagClass</a>
35 |
36 --<a href="../phpHtmlLib/HTMLTagClass.html">HTMLTagClass</a>
37 |
38 --OLtag</pre>
39 <SPAN class="type">Classes extended from OLtag:</SPAN>
40 <dl>
41 <dt><a href="../phpHtmlLib/ULtag.html">ULtag</a></dt>
42 <dd>&lt;UL&gt; tag class</dd>
43 </dl>
44 </p>
45 <p>
46 <b><i>Located in File: Program_Root/tag_classes/ALLTAGS.inc</i></b><br>
47 </p>
48 <hr>
49 &lt;OL&gt; tag class
50 <br />
51 <p>The</p>
52 <UL>
53 <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 <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 <!-- =========== Summary =========== -->
67 <TR BGCOLOR='white' CLASS='TableRowColor'>
68 <TD>
69 <CODE><B><A HREF="../phpHtmlLib/OLtag.html#var$_tag">$_tag</A></B></CODE>
70 <BR>
71 <blockquote> </blockquote>
72 <blockquote> Default Value: <CODE>->&nbsp;"ol"<-</CODE> </blockquote>
73 </TD>
74 </TR>
75 </TABLE>
76 <hr>
77 <!-- =========== VAR INHERITED SUMMARY =========== -->
78 <A NAME='var_inherited_summary'><!-- --></A>
79 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
80 <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
81 <TD>
82 <span CLASS="font12bold">Inherited Class Variable Summary</span>
83 <A HREF="#top" CLASS="links">^TOP</A>
84 </TD>
85 </TR>
86
87 <!-- =========== Summary =========== -->
88 <TR BGCOLOR='white'>
89 <TD>
90 <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/Container.html">Container</a></span>
91 <table CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">
92 <tr CLASS="tableheadingcolor">
93 <th>Variable</th>
94 <th>Default Value</th>
95 <th>Description</th>
96 </tr>
97 <tr>
98 <td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#var$_flags">Container::$_flags</a></td>
99 <td CLASS="font10" STYLE="white-space: nowrap">-> _NEWLINEAFTERCONTENT<-</td>
100 <td CLASS="font10">The flags that tell us</td>
101 </tr>
102 </table>
103 <BR>
104 </TD>
105 </TR>
106 </TABLE>
107
108 <hr>
109 <!-- =========== METHOD SUMMARY =========== -->
110 <A NAME='method_summary'><!-- --></A>
111 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' Class="border">
112 <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
113 <TD>
114 <span class="font12bold">Method Summary</span>
115 <A HREF="#top" CLASS="links">^TOP</A>
116 </TD>
117 </TR>
118
119 <!-- =========== Summary =========== -->
120 <TR BGCOLOR='white' CLASS='TableRowColor'>
121 <TD>
122 <CODE><B><A HREF='../phpHtmlLib/OLtag.html#methodadd'>void add ( )</A></B></CODE>
123 <BR>
124 <blockquote> add content onto content stack adds content to tag as a FIFO. </blockquote>
125 </TD>
126 </TR>
127 <!-- =========== Summary =========== -->
128 <TR BGCOLOR='white' CLASS='TableRowColor'>
129 <TD>
130 <CODE><B><A HREF='../phpHtmlLib/OLtag.html#methodadd_reference'>void add_reference ( &$content )</A></B></CODE>
131 <BR>
132 <blockquote> push content onto content stack </blockquote>
133 </TD>
134 </TR>
135 </TABLE>
136 <!-- =========== INHERITED METHOD SUMMARY =========== -->
137 <A NAME='functions_inherited'><!-- --></A>
138 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
139 <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
140 <TD>
141 <span CLASS="font12bold">Inherited Method Summary</span>
142 <A HREF="#top" CLASS="links">^TOP</A>
143 </TD>
144 </TR>
145
146 <!-- =========== Summary =========== -->
147 <TR BGCOLOR='white' CLASS='TableRowColor'>
148 <TD>
149 <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/HTMLTagClass.html">HTMLTagClass</a></span>
150 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">
151 <tr CLASS="tableheadingcolor">
152 <th>Function</th>
153 <th>Description</th>
154 </tr>
155 <tr>
156 <td CLASS="font10bold"><a href="../phpHtmlLib/HTMLTagClass.html#methodHTMLTagClass">HTMLTagClass::HTMLTagClass()</a></td>
157 <td CLASS="font10">Class Constructor</td>
158 <tr>
159 <td CLASS="font10bold"><a href="../phpHtmlLib/HTMLTagClass.html#methodrender">HTMLTagClass::render()</a></td>
160 <td CLASS="font10">Renders the tag, attributes, content and close tag.</td>
161 <tr>
162 <td CLASS="font10bold"><a href="../phpHtmlLib/HTMLTagClass.html#methodset_class">HTMLTagClass::set_class()</a></td>
163 <td CLASS="font10">This function is a shorthand helper to setting the class attribute on a tag.</td>
164 <tr>
165 <td CLASS="font10bold"><a href="../phpHtmlLib/HTMLTagClass.html#methodset_id">HTMLTagClass::set_id()</a></td>
166 <td CLASS="font10">This function is a shorthand helper to setting the id attribute on a tag.</td>
167 <tr>
168 <td CLASS="font10bold"><a href="../phpHtmlLib/HTMLTagClass.html#methodset_style">HTMLTagClass::set_style()</a></td>
169 <td CLASS="font10">This function is a shorthand helper to setting the style attribute on a tag.</td>
170 <tr>
171 <td CLASS="font10bold"><a href="../phpHtmlLib/HTMLTagClass.html#method_build_attribute_string">HTMLTagClass::_build_attribute_string()</a></td>
172 <td CLASS="font10">this builds an attribute for a tag.</td>
173 <tr>
174 <td CLASS="font10bold"><a href="../phpHtmlLib/HTMLTagClass.html#method_render_tag_debug">HTMLTagClass::_render_tag_debug()</a></td>
175 <td CLASS="font10">This renders that open tag in debug mode.</td>
176 </table>
177 <br>
178 </TD>
179 </TR>
180 <!-- =========== Summary =========== -->
181 <TR BGCOLOR='white' CLASS='TableRowColor'>
182 <TD>
183 <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/XMLTagClass.html">XMLTagClass</a></span>
184 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">
185 <tr CLASS="tableheadingcolor">
186 <th>Function</th>
187 <th>Description</th>
188 </tr>
189 <tr>
190 <td CLASS="font10bold"><a href="../phpHtmlLib/XMLTagClass.html#methodXMLTagClass">XMLTagClass::XMLTagClass()</a></td>
191 <td CLASS="font10">The constructor</td>
192 <tr>
193 <td CLASS="font10bold"><a href="../phpHtmlLib/XMLTagClass.html#methodget_tag">XMLTagClass::get_tag()</a></td>
194 <td CLASS="font10">This returns the tag declared for this class.</td>
195 <tr>
196 <td CLASS="font10bold"><a href="../phpHtmlLib/XMLTagClass.html#methodget_tag_name">XMLTagClass::get_tag_name()</a></td>
197 <td CLASS="font10">This method gets the name of the tag</td>
198 <tr>
199 <td CLASS="font10bold"><a href="../phpHtmlLib/XMLTagClass.html#methodrender">XMLTagClass::render()</a></td>
200 <td CLASS="font10">This function is responsible for rendering the tag and its contents</td>
201 <tr>
202 <td CLASS="font10bold"><a href="../phpHtmlLib/XMLTagClass.html#methodreset_attributes">XMLTagClass::reset_attributes()</a></td>
203 <td CLASS="font10">clear all attributes and start with new attributes</td>
204 <tr>
205 <td CLASS="font10bold"><a href="../phpHtmlLib/XMLTagClass.html#methodset_collapse">XMLTagClass::set_collapse()</a></td>
206 <td CLASS="font10">This function turns on the collapse flag</td>
207 <tr>
208 <td CLASS="font10bold"><a href="../phpHtmlLib/XMLTagClass.html#methodset_newline_after_closetag">XMLTagClass::set_newline_after_closetag()</a></td>
209 <td CLASS="font10">set the newline_after_content flag</td>
210 <tr>
211 <td CLASS="font10bold"><a href="../phpHtmlLib/XMLTagClass.html#methodset_newline_after_opentag">XMLTagClass::set_newline_after_opentag()</a></td>
212 <td CLASS="font10">set the newline_after_opentag flag</td>
213 <tr>
214 <td CLASS="font10bold"><a href="../phpHtmlLib/XMLTagClass.html#methodset_tag_attribute">XMLTagClass::set_tag_attribute()</a></td>
215 <td CLASS="font10">add a single attribute (name="value")</td>
216 <tr>
217 <td CLASS="font10bold"><a href="../phpHtmlLib/XMLTagClass.html#methodset_tag_attributes">XMLTagClass::set_tag_attributes()</a></td>
218 <td CLASS="font10">add multiple attributes (name="value")</td>
219 <tr>
220 <td CLASS="font10bold"><a href="../phpHtmlLib/XMLTagClass.html#methodset_tag_name">XMLTagClass::set_tag_name()</a></td>
221 <td CLASS="font10">This method sets the name of the tag</td>
222 <tr>
223 <td CLASS="font10bold"><a href="../phpHtmlLib/XMLTagClass.html#method_build_attribute_string">XMLTagClass::_build_attribute_string()</a></td>
224 <td CLASS="font10">this builds an attribute for an XML tag.</td>
225 <tr>
226 <td CLASS="font10bold"><a href="../phpHtmlLib/XMLTagClass.html#method_get_element">XMLTagClass::_get_element()</a></td>
227 <td CLASS="font10">get the nth element from content array</td>
228 <tr>
229 <td CLASS="font10bold"><a href="../phpHtmlLib/XMLTagClass.html#method_prepare_flags">XMLTagClass::_prepare_flags()</a></td>
230 <td CLASS="font10">This function checks to see if</td>
231 <tr>
232 <td CLASS="font10bold"><a href="../phpHtmlLib/XMLTagClass.html#method_render_close_tag">XMLTagClass::_render_close_tag()</a></td>
233 <td CLASS="font10">this function is reposnsible for rendering the closing tag (if any)</td>
234 <tr>
235 <td CLASS="font10bold"><a href="../phpHtmlLib/XMLTagClass.html#method_render_content">XMLTagClass::_render_content()</a></td>
236 <td CLASS="font10">this function is reponsible for rendering the pcdata, or content of the tag (if any)</td>
237 <tr>
238 <td CLASS="font10bold"><a href="../phpHtmlLib/XMLTagClass.html#method_render_open_tag">XMLTagClass::_render_open_tag()</a></td>
239 <td CLASS="font10">this function is responsible for rendering the open tag.</td>
240 <tr>
241 <td CLASS="font10bold"><a href="../phpHtmlLib/XMLTagClass.html#method_set_flags">XMLTagClass::_set_flags()</a></td>
242 <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>
243 </table>
244 <br>
245 </TD>
246 </TR>
247 <!-- =========== Summary =========== -->
248 <TR BGCOLOR='white' CLASS='TableRowColor'>
249 <TD>
250 <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/Container.html">Container</a></span>
251 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">
252 <tr CLASS="tableheadingcolor">
253 <th>Function</th>
254 <th>Description</th>
255 </tr>
256 <tr>
257 <td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodContainer">Container::Container()</a></td>
258 <td CLASS="font10">The constructor.</td>
259 <tr>
260 <td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodadd">Container::add()</a></td>
261 <td CLASS="font10">add content onto content stack</td>
262 <tr>
263 <td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodadd_reference">Container::add_reference()</a></td>
264 <td CLASS="font10">Add content onto content stack so you can change the item later.</td>
265 <tr>
266 <td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodcount_content">Container::count_content()</a></td>
267 <td CLASS="font10">counts the number of content objects</td>
268 <tr>
269 <td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodget_indent_flag">Container::get_indent_flag()</a></td>
270 <td CLASS="font10">This flag gets the current value of the indent flag</td>
271 <tr>
272 <td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodpush">Container::push()</a></td>
273 <td CLASS="font10">Same as add().</td>
274 <tr>
275 <td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodpush_reference">Container::push_reference()</a></td>
276 <td CLASS="font10">Same as add_reference NOTE : only exists for compatibility with 1.1.x</td>
277 <tr>
278 <td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodrender">Container::render()</a></td>
279 <td CLASS="font10">This function is compatible with the rest of the phpHtmllib API spec.</td>
280 <tr>
281 <td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodreset_content">Container::reset_content()</a></td>
282 <td CLASS="font10">destroy existing content and start with new content.</td>
283 <tr>
284 <td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodset_collapse">Container::set_collapse()</a></td>
285 <td CLASS="font10">This function turns on the collapse flag</td>
286 <tr>
287 <td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodset_indent_flag">Container::set_indent_flag()</a></td>
288 <td CLASS="font10">function to set the indent flag</td>
289 <tr>
290 <td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#method_set_flags">Container::_set_flags()</a></td>
291 <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>
292 </table>
293 <br>
294 </TD>
295 </TR>
296 </TABLE>
297 <hr>
298 <!-- ============ VARIABLE DETAIL =========== -->
299
300 <A NAME='variable_detail'></A>
301 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
302 <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
303 <TD>
304 <span CLASS="font12bold">Variable Detail</span>
305 <A HREF="#top" CLASS="links">^TOP</A>
306 </TD>
307 </TR>
308 </TABLE>
309
310 <A NAME='var$_tag'><!-- --></A><H3>$_tag</H3> (line <span class="linenumber">875</span>)<br />
311 <b>Data type:</b> mixed<br>
312 <br />
313
314 <UL>
315 </UL>
316 <HR>
317 <hr>
318 <!-- ============ METHOD DETAIL =========== -->
319
320 <A NAME='method_detail'></A>
321 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
322 <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
323 <TD>
324 <span class="font12bold">Method Detail</span>
325 <A HREF="#top" CLASS="links">^TOP</A>
326 </TD>
327 </TR>
328 </TABLE>
329 <BR>
330 <DIV CLASS="function">
331 <A NAME='methodadd'><!-- --></A>
332 <SPAN CLASS="font12bold">add</SPAN> (line <span class="linenumber">889</span>)
333 <BR>
334 <SPAN CLASS="font10bold">Usage : </SPAN>
335 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
336 <span class="font10bold" style="color: #0000FF">add(
337 mixed
338 $content)</SPAN>
339 <BR>
340
341 <BR>
342 <SPAN CLASS="font10bold">Description : </SPAN>
343 add content onto content stack adds content to tag as a FIFO.
344 <br />
345 <p>You can have n number of parameters. each one will get added in succession to the content.</p><p>we override this from the parent so we can auto detect if the user is adding raw strings instead of objects. If they are trying to add raw strings, then we wrap that in an LItag object, since you can't add anything other then an &lt;LI&gt;</p>
346 <DL>
347 <DT class="font10bold">Function Parameters:</DT>
348 <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>
349
350 <DT class="font10bold">Function Info:</DT>
351 <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>access</b> - public</DD>
352 </DL>
353 </DIV>
354 <BR>
355 <DIV CLASS="function">
356 <A NAME='methodadd_reference'><!-- --></A>
357 <SPAN CLASS="font12bold">add_reference</SPAN> (line <span class="linenumber">928</span>)
358 <BR>
359 <SPAN CLASS="font10bold">Usage : </SPAN>
360 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
361 <span class="font10bold" style="color: #0000FF">add_reference(
362 mixed
363 &$content, mixed
364 $content)</SPAN>
365 <BR>
366
367 <BR>
368 <SPAN CLASS="font10bold">Description : </SPAN>
369 push content onto content stack
370 <br />
371 <p>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><p>we override this from the parent so we can auto detect if the user is adding raw strings instead of objects. If they are trying to add raw strings, then we wrap that in an LItag object, since you can't add anything other then an &lt;LI&gt;</p>
372 <DL>
373 <DT class="font10bold">Function Parameters:</DT>
374 <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>
375
376 <DT class="font10bold">Function Info:</DT>
377 <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>access</b> - public</DD>
378 </DL>
379 </DIV>
380 <BR>
381 <div id="credit">
382 <hr>
383 Documention generated on Thu, 20 Feb 2003 16:22:16 -0800 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.0rc1</a>
384 </div>
385 </body>
386 </html>

MailToCvsAdmin">MailToCvsAdmin
ViewVC Help
Powered by ViewVC 1.1.26 RSS 2.0 feed