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

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

Parent Directory Parent Directory | Revision Log Revision Log

Revision 1.1 - (show annotations)
Thu Jan 30 03:29:18 2003 UTC (21 years, 6 months ago) by jonen
Branch: MAIN
Branch point for: no_vendor_tag
File MIME type: text/html 
Initial revision
1 <!DOCTYPE HTML PUBLIC '-//W3C//DTD HTML 4.0 Frameset//EN''http://www.w3.org/TR/REC-html40/frameset.dtd'>
2 <!--NewPage-->
3 <HTML>
4 <HEAD>
5 <!-- Generated by PhpDoc date: 'Mon, 25 Nov 2002 09:21:41 -0800' -->
6 <TITLE>Docs For Class XMLTagClass</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 XMLTagClass">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 XMLTagClass
33 </H2>
34
35 <pre>
36 <pre><a href="../phpHtmlLib/Container.html">Container</a>
37 |
38 --XMLTagClass</pre>
39 </pre>
40
41 <A NAME="children_summary"</A>
42 <H3>
43 Classes extended from XMLTagClass: <A HREF="#top" CLASS="links">^TOP</A>
44 </H3>
45 <a href="../phpHtmlLib/HTMLTagClass.html">HTMLTagClass</a>, <a href="../phpHtmlLib/SVGTagClass.html">SVGTagClass</a>, <a href="../phpHtmlLib/WMLTagClass.html">WMLTagClass</a>, <a href="../phpHtmlLib/DOCTYPEtag.html">DOCTYPEtag</a>, <a href="../phpHtmlLib/XMLtag.html">XMLtag</a>
46 <p>
47 <b><i>Located in File: Program_Root/XMLTagClass.inc</i></b><br>
48 </p>
49 <hr>
50 <!-- ========== Info from phpDoc block ========= -->
51 This class is used for building and rendering
52 an XML tag.
53 <BR>
54 This class is the base class for the
55 HTMLTagClass.
56
57 This is part of the phphtmllib libraries
58 released under the LGPL license.
59
60 <UL>
61
62 <LI><b>Package</b> - <CODE>phpHtmlLib</CODE></LI>
63
64 <LI><b>Author</b> - <CODE>Walter A. Boring IV &lt;<a href="mailto:waboring@buildabetterweb.com">waboring@buildabetterweb.com</a>&gt;</CODE></LI>
65
66 </UL>
67
68 <hr>
69 <!-- =========== VAR SUMMARY =========== -->
70 <A NAME='var_summary'><!-- --></A>
71 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
72 <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
73 <TD>
74 <span CLASS="font12bold">Class Variable Summary</span>
75 <A HREF="#top" CLASS="links">^TOP</A>
76 </TD>
77 </TR>
78
79
80 <!-- =========== Summary =========== -->
81 <TR BGCOLOR='white' CLASS='TableRowColor'>
82 <TD>
83 <CODE><B><A HREF='XMLTagClass.html#$newline_after_closetag'>$newline_after_closetag</A></B></CODE>
84 <BR>
85 <blockquote> Flag to place a newline after close tag. </blockquote>
86 <blockquote> Default Value: <CODE>->TRUE<-</CODE> </blockquote>
87 </TD>
88 </TR>
89
90 <!-- =========== Summary =========== -->
91 <TR BGCOLOR='white' CLASS='TableRowColor'>
92 <TD>
93 <CODE><B><A HREF='XMLTagClass.html#$newline_after_opentag'>$newline_after_opentag</A></B></CODE>
94 <BR>
95 <blockquote> Flag to place a newline after open tag. </blockquote>
96 <blockquote> Default Value: <CODE>->TRUE<-</CODE> </blockquote>
97 </TD>
98 </TR>
99
100 <!-- =========== Summary =========== -->
101 <TR BGCOLOR='white' CLASS='TableRowColor'>
102 <TD>
103 <CODE><B><A HREF='XMLTagClass.html#$_cdata_content_wrap'>$_cdata_content_wrap</A></B></CODE>
104 <BR>
105 <blockquote> Automatically wrap ALL content </blockquote>
106 <blockquote> Default Value: <CODE>->FALSE<-</CODE> </blockquote>
107 </TD>
108 </TR>
109
110 <!-- =========== Summary =========== -->
111 <TR BGCOLOR='white' CLASS='TableRowColor'>
112 <TD>
113 <CODE><B><A HREF='XMLTagClass.html#$_tag_postfix'>$_tag_postfix</A></B></CODE>
114 <BR>
115 <blockquote> holds the tag postfix </blockquote>
116 <blockquote> Default Value: <CODE>->&gt;<-</CODE> </blockquote>
117 </TD>
118 </TR>
119
120 <!-- =========== Summary =========== -->
121 <TR BGCOLOR='white' CLASS='TableRowColor'>
122 <TD>
123 <CODE><B><A HREF='XMLTagClass.html#$_tag_prefix'>$_tag_prefix</A></B></CODE>
124 <BR>
125 <blockquote> holds the tag prefix </blockquote>
126 <blockquote> Default Value: <CODE>->&lt;<-</CODE> </blockquote>
127 </TD>
128 </TR>
129
130 </TABLE>
131
132 <hr>
133 <!-- =========== VAR INHERITED SUMMARY =========== -->
134 <A NAME='var_inherited_summary'><!-- --></A>
135 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
136 <TR CLASS='TableHeadingColor'>
137 <TD>
138 <span CLASS="font12bold">Inherited Class Variable Summary</span>
139 <A HREF="#top" CLASS="links">^TOP</A>
140 </TD>
141 </TR>
142
143
144 <!-- =========== Summary =========== -->
145 <TR BGCOLOR='white'>
146 <TD>
147 <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/Container.html">Container</a></span>
148 <table CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">
149 <tr CLASS="tableheadingcolor">
150 <th>Variable</th>
151 <th>Default Value</th>
152 <th>Description</th>
153 </tr>
154
155 <tr>
156 <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#$indent_flag'>$indent_flag</A></td>
157 <td CLASS="font10" STYLE="white-space: nowrap">->TRUE<-</td>
158 <td CLASS="font10">Flag for pretty (indented) output</td>
159 </tr>
160
161 <tr>
162 <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#$_newline_after_content_flag'>$_newline_after_content_flag</A></td>
163 <td CLASS="font10" STYLE="white-space: nowrap">->TRUE<-</td>
164 <td CLASS="font10">Do we render a newline after the
165 contents has been rendered?</td>
166 </tr>
167
168 </table>
169 <BR>
170 </TD>
171 </TR>
172
173 </TABLE>
174
175 <hr>
176 <!-- =========== INHERITED METHOD SUMMARY =========== -->
177 <A NAME='functions_inherited'><!-- --></A>
178 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
179 <TR CLASS='TableHeadingColor'>
180 <TD>
181 <span CLASS="font12bold">Inherited Method Summary</span>
182 <A HREF="#top" CLASS="links">^TOP</A>
183 </TD>
184 </TR>
185
186
187 <!-- =========== Summary =========== -->
188 <TR BGCOLOR='white' CLASS='TableRowColor'>
189 <TD>
190 <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/Container.html">Container</a></span>
191 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">
192 <tr CLASS="tableheadingcolor">
193 <th>Function</th>
194 <th>Description</th>
195 </tr>
196
197 <tr>
198 <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#constructor Container'>constructor Container ( )</A></td>
199 <td CLASS="font10">The constructor.</td>
200
201 <tr>
202 <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#add'>add ( )</A></td>
203 <td CLASS="font10">add content onto content stack</td>
204
205 <tr>
206 <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#add_reference'>add_reference ( &$content )</A></td>
207 <td CLASS="font10">Add content onto content stack
208 so you can change the item later.</td>
209
210 <tr>
211 <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#count_content'>count_content ( )</A></td>
212 <td CLASS="font10">counts the number of content objects</td>
213
214 <tr>
215 <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#get_indent_flag'>get_indent_flag ( )</A></td>
216 <td CLASS="font10">This flag gets the current value
217 of the indent flag</td>
218
219 <tr>
220 <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#push'>push ( )</A></td>
221 <td CLASS="font10">Same as add().</td>
222
223 <tr>
224 <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#push_reference'>push_reference ( &$content )</A></td>
225 <td CLASS="font10">Same as add_reference
226 NOTE : only exists for compatibility with 1.1.x</td>
227
228 <tr>
229 <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#render'>render ( [$indent_level = 1], [$output_debug = 0] )</A></td>
230 <td CLASS="font10">This function is compatible with the
231 rest of the phpHtmllib API spec.</td>
232
233 <tr>
234 <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#reset_content'>reset_content ( )</A></td>
235 <td CLASS="font10">destroy existing content and start with new content.</td>
236
237 <tr>
238 <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#set_collapse'>set_collapse ( [$collapse = TRUE], [$indent = TRUE] )</A></td>
239 <td CLASS="font10">This function turns on the collapse flag</td>
240
241 <tr>
242 <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#set_indent_flag'>set_indent_flag ( $flag )</A></td>
243 <td CLASS="font10">function to set the indent flag</td>
244
245 </table>
246 <br>
247 </TD>
248 </TR>
249
250 </TABLE>
251
252 <hr>
253 <!-- should have constructor at some point -->
254 <!-- =========== Method SUMMARY =========== -->
255 <A NAME='Method_summary'><!-- --></A>
256 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' Class="border">
257 <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
258 <TD>
259 <span class="font12bold">Method Summary</span>
260 <A HREF="#top" CLASS="links">^TOP</A>
261 </TD>
262 </TR>
263
264
265 <!-- =========== Summary =========== -->
266 <TR BGCOLOR='white' CLASS='TableRowColor'>
267 <TD>
268 <CODE><B><A HREF='XMLTagClass.html#constructor XMLTagClass'>void constructor XMLTagClass ( $name, [$attributes = array()] )</A></B></CODE>
269 <BR>
270 <blockquote> The constructor </blockquote>
271 </TD>
272 </TR>
273
274 <!-- =========== Summary =========== -->
275 <TR BGCOLOR='white' CLASS='TableRowColor'>
276 <TD>
277 <CODE><B><A HREF='XMLTagClass.html#get_tag'>string get_tag ( )</A></B></CODE>
278 <BR>
279 <blockquote> This returns the tag declared for this class. </blockquote>
280 </TD>
281 </TR>
282
283 <!-- =========== Summary =========== -->
284 <TR BGCOLOR='white' CLASS='TableRowColor'>
285 <TD>
286 <CODE><B><A HREF='XMLTagClass.html#get_tag_name'>string get_tag_name ( )</A></B></CODE>
287 <BR>
288 <blockquote> This method gets the name of the tag </blockquote>
289 </TD>
290 </TR>
291
292 <!-- =========== Summary =========== -->
293 <TR BGCOLOR='white' CLASS='TableRowColor'>
294 <TD>
295 <CODE><B><A HREF='XMLTagClass.html#render'>void render ( [$indent_level = 0] )</A></B></CODE>
296 <BR>
297 <blockquote> This function is responsible </blockquote>
298 </TD>
299 </TR>
300
301 <!-- =========== Summary =========== -->
302 <TR BGCOLOR='white' CLASS='TableRowColor'>
303 <TD>
304 <CODE><B><A HREF='XMLTagClass.html#reset_attributes'>void reset_attributes ( [$attributes = array()] )</A></B></CODE>
305 <BR>
306 <blockquote> clear all attributes and start with new attributes </blockquote>
307 </TD>
308 </TR>
309
310 <!-- =========== Summary =========== -->
311 <TR BGCOLOR='white' CLASS='TableRowColor'>
312 <TD>
313 <CODE><B><A HREF='XMLTagClass.html#set_collapse'>void set_collapse ( [$collapse = TRUE], [$indent = TRUE] )</A></B></CODE>
314 <BR>
315 <blockquote> This function turns on the collapse flag </blockquote>
316 </TD>
317 </TR>
318
319 <!-- =========== Summary =========== -->
320 <TR BGCOLOR='white' CLASS='TableRowColor'>
321 <TD>
322 <CODE><B><A HREF='XMLTagClass.html#set_newline_after_closetag'>void set_newline_after_closetag ( $flag )</A></B></CODE>
323 <BR>
324 <blockquote> set the newline_after_content flag </blockquote>
325 </TD>
326 </TR>
327
328 <!-- =========== Summary =========== -->
329 <TR BGCOLOR='white' CLASS='TableRowColor'>
330 <TD>
331 <CODE><B><A HREF='XMLTagClass.html#set_newline_after_opentag'>void set_newline_after_opentag ( $flag )</A></B></CODE>
332 <BR>
333 <blockquote> set the newline_after_opentag flag </blockquote>
334 </TD>
335 </TR>
336
337 <!-- =========== Summary =========== -->
338 <TR BGCOLOR='white' CLASS='TableRowColor'>
339 <TD>
340 <CODE><B><A HREF='XMLTagClass.html#set_tag_attribute'>void set_tag_attribute ( $name, [$value = NULL] )</A></B></CODE>
341 <BR>
342 <blockquote> add a single attribute (name=&quot;value&quot;) </blockquote>
343 </TD>
344 </TR>
345
346 <!-- =========== Summary =========== -->
347 <TR BGCOLOR='white' CLASS='TableRowColor'>
348 <TD>
349 <CODE><B><A HREF='XMLTagClass.html#set_tag_attributes'>void set_tag_attributes ( [$attributes = array()] )</A></B></CODE>
350 <BR>
351 <blockquote> add multiple attributes (name=&quot;value&quot;) </blockquote>
352 </TD>
353 </TR>
354
355 <!-- =========== Summary =========== -->
356 <TR BGCOLOR='white' CLASS='TableRowColor'>
357 <TD>
358 <CODE><B><A HREF='XMLTagClass.html#set_tag_name'>void set_tag_name ( $name )</A></B></CODE>
359 <BR>
360 <blockquote> This method sets the name of the tag </blockquote>
361 </TD>
362 </TR>
363
364 <!-- =========== Summary =========== -->
365 <TR BGCOLOR='white' CLASS='TableRowColor'>
366 <TD>
367 <CODE><B><A HREF='XMLTagClass.html#_build_attribute_string'>the _build_attribute_string ( $name, $value )</A></B></CODE>
368 <BR>
369 <blockquote> this builds an attribute for an XML tag. </blockquote>
370 </TD>
371 </TR>
372
373 <!-- =========== Summary =========== -->
374 <TR BGCOLOR='white' CLASS='TableRowColor'>
375 <TD>
376 <CODE><B><A HREF='XMLTagClass.html#_get_element'>mixed _get_element ( $cell )</A></B></CODE>
377 <BR>
378 <blockquote> get the nth element from content array </blockquote>
379 </TD>
380 </TR>
381
382 <!-- =========== Summary =========== -->
383 <TR BGCOLOR='white' CLASS='TableRowColor'>
384 <TD>
385 <CODE><B><A HREF='XMLTagClass.html#_prepare_flags'>void _prepare_flags ( )</A></B></CODE>
386 <BR>
387 <blockquote> This function checks to see if </blockquote>
388 </TD>
389 </TR>
390
391 <!-- =========== Summary =========== -->
392 <TR BGCOLOR='white' CLASS='TableRowColor'>
393 <TD>
394 <CODE><B><A HREF='XMLTagClass.html#_render_close_tag'>void _render_close_tag ( $indent_level )</A></B></CODE>
395 <BR>
396 <blockquote> this function is reposnsible for
397 rendering the closing tag (if any) </blockquote>
398 </TD>
399 </TR>
400
401 <!-- =========== Summary =========== -->
402 <TR BGCOLOR='white' CLASS='TableRowColor'>
403 <TD>
404 <CODE><B><A HREF='XMLTagClass.html#_render_content'>void _render_content ( $indent_level, [$output_debug = 0] )</A></B></CODE>
405 <BR>
406 <blockquote> this function is reponsible for </blockquote>
407 </TD>
408 </TR>
409
410 <!-- =========== Summary =========== -->
411 <TR BGCOLOR='white' CLASS='TableRowColor'>
412 <TD>
413 <CODE><B><A HREF='XMLTagClass.html#_render_open_tag'>void _render_open_tag ( $indent_level, [$finish_slash = TRUE] )</A></B></CODE>
414 <BR>
415 <blockquote> this function is responsible for
416 rendering the open tag. </blockquote>
417 </TD>
418 </TR>
419
420 </TABLE>
421
422 <hr>
423 <!-- ============ VARIABLE DETAIL =========== -->
424
425 <A NAME='variable_detail'></A>
426 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
427 <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
428 <TD>
429 <span CLASS="font12bold">Variable Detail</span>
430 <A HREF="#top" CLASS="links">^TOP</A>
431 </TD>
432 </TR>
433 </TABLE>
434
435
436 <A NAME='$newline_after_closetag'><!-- --></A><H3>$newline_after_closetag</H3>
437 <b>Data type:</b> boolean<br>
438 <!-- ========== Info from phpDoc block ========= -->
439 Flag to place a newline after close tag.
440 <BR>
441 usefull for maintaining nice output inside
442 a table
443
444 <UL>
445
446 <LI><b>Access</b> - <CODE>public</CODE></LI>
447
448 </UL>
449
450 <HR>
451
452 <A NAME='$newline_after_opentag'><!-- --></A><H3>$newline_after_opentag</H3>
453 <b>Data type:</b> boolean<br>
454 <!-- ========== Info from phpDoc block ========= -->
455 Flag to place a newline after open tag.
456 <BR>
457 some tags are nice to have a \n after
458 to make reading of html easier.
459 ie &lt;table&gt;
460
461 <UL>
462
463 <LI><b>Access</b> - <CODE>public</CODE></LI>
464
465 </UL>
466
467 <HR>
468
469 <A NAME='$_cdata_content_wrap'><!-- --></A><H3>$_cdata_content_wrap</H3>
470 <b>Data type:</b> boolean<br>
471 <!-- ========== Info from phpDoc block ========= -->
472 Automatically wrap ALL content
473 <BR>
474 inside the &lt;![CDATA[ CONTENT ]]&gt;
475 tag
476
477 <UL>
478
479 </UL>
480
481 <HR>
482
483 <A NAME='$_tag_postfix'><!-- --></A><H3>$_tag_postfix</H3>
484 <b>Data type:</b> mixed<br>
485 <!-- ========== Info from phpDoc block ========= -->
486 holds the tag postfix
487 <BR>
488
489
490 <UL>
491
492 </UL>
493
494 <HR>
495
496 <A NAME='$_tag_prefix'><!-- --></A><H3>$_tag_prefix</H3>
497 <b>Data type:</b> mixed<br>
498 <!-- ========== Info from phpDoc block ========= -->
499 holds the tag prefix
500 <BR>
501
502
503 <UL>
504
505 </UL>
506
507 <HR>
508
509
510 <hr>
511 <!-- ============ FUNCTION DETAIL =========== -->
512
513 <A NAME='function_detail'></A>
514 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
515 <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
516 <TD>
517 <span class="font12bold">Method Detail</span>
518 <A HREF="#top" CLASS="links">^TOP</A>
519 </TD>
520 </TR>
521 </TABLE>
522 <BR>
523
524 <DIV CLASS="function">
525 <A NAME='constructor XMLTagClass'><!-- --></A>
526 <SPAN CLASS="font12bold">constructor XMLTagClass</SPAN>
527 <BR>
528 <SPAN CLASS="font10bold">Useage : </SPAN>
529 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
530 <span class="font10bold" style="color: #0000FF">constructor XMLTagClass ( $name, [$attributes = array()] )</SPAN>
531 <BR>
532
533 <BR>
534 <SPAN CLASS="font10bold">Description : </SPAN>
535 <!-- ========== Info from phpDoc block ========= -->
536 The constructor
537 <BR>
538
539 <DL>
540 <DT class="font10bold">Function Parameters:</DT>
541
542 <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">2</SPAN></SPAN> - n items of content to
543 add</DD>
544
545 <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 tag name</DD>
546
547 <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> - the attributes array
548 can be in name =&gt; value
549 or just value</DD>
550
551
552 <DT class="font10bold">Function Info:</DT>
553
554 </DL>
555
556 </DIV>
557 <BR>
558
559 <DIV CLASS="function">
560 <A NAME='get_tag'><!-- --></A>
561 <SPAN CLASS="font12bold">get_tag</SPAN>
562 <BR>
563 <SPAN CLASS="font10bold">Useage : </SPAN>
564 <span class="font10bold" style="color: #FF0000">string</SPAN>&nbsp;
565 <span class="font10bold" style="color: #0000FF">get_tag ( )</SPAN>
566 <BR>
567
568 <BR>
569 <SPAN CLASS="font10bold">Description : </SPAN>
570 <!-- ========== Info from phpDoc block ========= -->
571 This returns the tag declared for this class.
572 <BR>
573 This should be used in favor of
574 accessing the $this-&gt;_tag directly.
575 <DL>
576 <DT class="font10bold">Function Parameters:</DT>
577
578
579 <DT class="font10bold">Function Info:</DT>
580
581 <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - - the _tag var for this class.</DD>
582
583 </DL>
584
585 </DIV>
586 <BR>
587
588 <DIV CLASS="function">
589 <A NAME='get_tag_name'><!-- --></A>
590 <SPAN CLASS="font12bold">get_tag_name</SPAN>
591 <BR>
592 <SPAN CLASS="font10bold">Useage : </SPAN>
593 <span class="font10bold" style="color: #FF0000">string</SPAN>&nbsp;
594 <span class="font10bold" style="color: #0000FF">get_tag_name ( )</SPAN>
595 <BR>
596
597 <BR>
598 <SPAN CLASS="font10bold">Description : </SPAN>
599 <!-- ========== Info from phpDoc block ========= -->
600 This method gets the name of the tag
601 <BR>
602
603 <DL>
604 <DT class="font10bold">Function Parameters:</DT>
605
606
607 <DT class="font10bold">Function Info:</DT>
608
609 <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - - the tag name</DD>
610
611 </DL>
612
613 </DIV>
614 <BR>
615
616 <DIV CLASS="function">
617 <A NAME='render'><!-- --></A>
618 <SPAN CLASS="font12bold">render</SPAN>
619 <BR>
620 <SPAN CLASS="font10bold">Useage : </SPAN>
621 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
622 <span class="font10bold" style="color: #0000FF">render ( [$indent_level = 0] )</SPAN>
623 <BR>
624 Overridden in child class(es) as: <a href="../phpHtmlLib/HTMLTagClass.html#render">HTMLTagClass::render()</a><br><span class="font10bold" style="padding-left: 10px;">Overrides :</span> <a href="../phpHtmlLib/Container.html#render">Container::render()</a>
625 <BR>
626 <SPAN CLASS="font10bold">Description : </SPAN>
627 <!-- ========== Info from phpDoc block ========= -->
628 This function is responsible
629 <BR>
630 for rendering the tag and
631 its contents
632 <DL>
633 <DT class="font10bold">Function Parameters:</DT>
634
635 <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 current indentation
636 level for the tag</DD>
637
638
639 <DT class="font10bold">Function Info:</DT>
640
641 </DL>
642
643 </DIV>
644 <BR>
645
646 <DIV CLASS="function">
647 <A NAME='reset_attributes'><!-- --></A>
648 <SPAN CLASS="font12bold">reset_attributes</SPAN>
649 <BR>
650 <SPAN CLASS="font10bold">Useage : </SPAN>
651 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
652 <span class="font10bold" style="color: #0000FF">reset_attributes ( [$attributes = array()] )</SPAN>
653 <BR>
654
655 <BR>
656 <SPAN CLASS="font10bold">Description : </SPAN>
657 <!-- ========== Info from phpDoc block ========= -->
658 clear all attributes and start with new attributes
659 <BR>
660
661 <DL>
662 <DT class="font10bold">Function Parameters:</DT>
663
664 <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> Associative array of name=&quot;value&quot; pairs of
665 tag atributes.
666 ie array(&quot;border&quot;=&gt;&quot;0&quot;, &quot;class&quot;=&gt;&quot;hover&quot;);</DD>
667
668
669 <DT class="font10bold">Function Info:</DT>
670
671 <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Access</b> - public</DD>
672
673 </DL>
674
675 </DIV>
676 <BR>
677
678 <DIV CLASS="function">
679 <A NAME='set_collapse'><!-- --></A>
680 <SPAN CLASS="font12bold">set_collapse</SPAN>
681 <BR>
682 <SPAN CLASS="font10bold">Useage : </SPAN>
683 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
684 <span class="font10bold" style="color: #0000FF">set_collapse ( [$collapse = TRUE], [$indent = TRUE] )</SPAN>
685 <BR>
686 <span class="font10bold" style="padding-left: 10px;">Overrides :</span> <a href="../phpHtmlLib/Container.html#set_collapse">Container::set_collapse()</a>
687 <BR>
688 <SPAN CLASS="font10bold">Description : </SPAN>
689 <!-- ========== Info from phpDoc block ========= -->
690 This function turns on the collapse flag
691 <BR>
692
693 <DL>
694 <DT class="font10bold">Function Parameters:</DT>
695
696 <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">$collapse</SPAN></SPAN> - the collapse flag</DD>
697
698 <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">$indent</SPAN></SPAN> - the indent flag
699 DEFAULT: TRUE;</DD>
700
701
702 <DT class="font10bold">Function Info:</DT>
703
704 </DL>
705
706 </DIV>
707 <BR>
708
709 <DIV CLASS="function">
710 <A NAME='set_newline_after_closetag'><!-- --></A>
711 <SPAN CLASS="font12bold">set_newline_after_closetag</SPAN>
712 <BR>
713 <SPAN CLASS="font10bold">Useage : </SPAN>
714 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
715 <span class="font10bold" style="color: #0000FF">set_newline_after_closetag ( $flag )</SPAN>
716 <BR>
717
718 <BR>
719 <SPAN CLASS="font10bold">Description : </SPAN>
720 <!-- ========== Info from phpDoc block ========= -->
721 set the newline_after_content flag
722 <BR>
723
724 <DL>
725 <DT class="font10bold">Function Parameters:</DT>
726
727 <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> TRUE or FALSE</DD>
728
729
730 <DT class="font10bold">Function Info:</DT>
731
732 </DL>
733
734 </DIV>
735 <BR>
736
737 <DIV CLASS="function">
738 <A NAME='set_newline_after_opentag'><!-- --></A>
739 <SPAN CLASS="font12bold">set_newline_after_opentag</SPAN>
740 <BR>
741 <SPAN CLASS="font10bold">Useage : </SPAN>
742 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
743 <span class="font10bold" style="color: #0000FF">set_newline_after_opentag ( $flag )</SPAN>
744 <BR>
745
746 <BR>
747 <SPAN CLASS="font10bold">Description : </SPAN>
748 <!-- ========== Info from phpDoc block ========= -->
749 set the newline_after_opentag flag
750 <BR>
751
752 <DL>
753 <DT class="font10bold">Function Parameters:</DT>
754
755 <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> TRUE or FALSE</DD>
756
757
758 <DT class="font10bold">Function Info:</DT>
759
760 </DL>
761
762 </DIV>
763 <BR>
764
765 <DIV CLASS="function">
766 <A NAME='set_tag_attribute'><!-- --></A>
767 <SPAN CLASS="font12bold">set_tag_attribute</SPAN>
768 <BR>
769 <SPAN CLASS="font10bold">Useage : </SPAN>
770 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
771 <span class="font10bold" style="color: #0000FF">set_tag_attribute ( $name, [$value = NULL] )</SPAN>
772 <BR>
773
774 <BR>
775 <SPAN CLASS="font10bold">Description : </SPAN>
776 <!-- ========== Info from phpDoc block ========= -->
777 add a single attribute (name=&quot;value&quot;)
778 <BR>
779
780 <DL>
781 <DT class="font10bold">Function Parameters:</DT>
782
783 <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> attribute name</DD>
784
785 <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">$value</SPAN></SPAN> the value.</DD>
786
787
788 <DT class="font10bold">Function Info:</DT>
789
790 <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Access</b> - public</DD>
791
792 </DL>
793
794 </DIV>
795 <BR>
796
797 <DIV CLASS="function">
798 <A NAME='set_tag_attributes'><!-- --></A>
799 <SPAN CLASS="font12bold">set_tag_attributes</SPAN>
800 <BR>
801 <SPAN CLASS="font10bold">Useage : </SPAN>
802 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
803 <span class="font10bold" style="color: #0000FF">set_tag_attributes ( [$attributes = array()] )</SPAN>
804 <BR>
805
806 <BR>
807 <SPAN CLASS="font10bold">Description : </SPAN>
808 <!-- ========== Info from phpDoc block ========= -->
809 add multiple attributes (name=&quot;value&quot;)
810 <BR>
811
812 <DL>
813 <DT class="font10bold">Function Parameters:</DT>
814
815 <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> Associative array of name=&quot;value&quot; pairs of
816 tag atributes.
817 ie array(&quot;border&quot;=&gt;&quot;0&quot;, &quot;class&quot;=&gt;&quot;hover&quot;);</DD>
818
819
820 <DT class="font10bold">Function Info:</DT>
821
822 <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Access</b> - public</DD>
823
824 </DL>
825
826 </DIV>
827 <BR>
828
829 <DIV CLASS="function">
830 <A NAME='set_tag_name'><!-- --></A>
831 <SPAN CLASS="font12bold">set_tag_name</SPAN>
832 <BR>
833 <SPAN CLASS="font10bold">Useage : </SPAN>
834 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
835 <span class="font10bold" style="color: #0000FF">set_tag_name ( $name )</SPAN>
836 <BR>
837
838 <BR>
839 <SPAN CLASS="font10bold">Description : </SPAN>
840 <!-- ========== Info from phpDoc block ========= -->
841 This method sets the name of the tag
842 <BR>
843
844 <DL>
845 <DT class="font10bold">Function Parameters:</DT>
846
847 <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 tag name</DD>
848
849
850 <DT class="font10bold">Function Info:</DT>
851
852 </DL>
853
854 </DIV>
855 <BR>
856
857 <DIV CLASS="function">
858 <A NAME='_build_attribute_string'><!-- --></A>
859 <SPAN CLASS="font12bold">_build_attribute_string</SPAN>
860 <BR>
861 <SPAN CLASS="font10bold">Useage : </SPAN>
862 <span class="font10bold" style="color: #FF0000">the</SPAN>&nbsp;
863 <span class="font10bold" style="color: #0000FF">_build_attribute_string ( $name, $value )</SPAN>
864 <BR>
865 Overridden in child class(es) as: <a href="../phpHtmlLib/HTMLTagClass.html#_build_attribute_string">HTMLTagClass::_build_attribute_string()</a><br>
866 <BR>
867 <SPAN CLASS="font10bold">Description : </SPAN>
868 <!-- ========== Info from phpDoc block ========= -->
869 this builds an attribute for an XML tag.
870 <BR>
871 XML attributes MUST have a name AND a
872 value.
873 <DL>
874 <DT class="font10bold">Function Parameters:</DT>
875
876 <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> - attribute name</DD>
877
878 <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">$value</SPAN></SPAN> - attribute value</DD>
879
880
881 <DT class="font10bold">Function Info:</DT>
882
883 <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - tag attribute name=value pair.
884 to be added to the tag.</DD>
885
886 </DL>
887
888 </DIV>
889 <BR>
890
891 <DIV CLASS="function">
892 <A NAME='_get_element'><!-- --></A>
893 <SPAN CLASS="font12bold">_get_element</SPAN>
894 <BR>
895 <SPAN CLASS="font10bold">Useage : </SPAN>
896 <span class="font10bold" style="color: #FF0000">mixed</SPAN>&nbsp;
897 <span class="font10bold" style="color: #0000FF">_get_element ( $cell )</SPAN>
898 <BR>
899
900 <BR>
901 <SPAN CLASS="font10bold">Description : </SPAN>
902 <!-- ========== Info from phpDoc block ========= -->
903 get the nth element from content array
904 <BR>
905
906 <DL>
907 <DT class="font10bold">Function Parameters:</DT>
908
909 <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">$cell</SPAN></SPAN> the cell to get</DD>
910
911
912 <DT class="font10bold">Function Info:</DT>
913
914 </DL>
915
916 </DIV>
917 <BR>
918
919 <DIV CLASS="function">
920 <A NAME='_prepare_flags'><!-- --></A>
921 <SPAN CLASS="font12bold">_prepare_flags</SPAN>
922 <BR>
923 <SPAN CLASS="font10bold">Useage : </SPAN>
924 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
925 <span class="font10bold" style="color: #0000FF">_prepare_flags ( )</SPAN>
926 <BR>
927 Overridden in child class(es) as: <a href="../phpHtmlLib/SVGTagClass.html#_prepare_flags">SVGTagClass::_prepare_flags()</a><br>
928 <BR>
929 <SPAN CLASS="font10bold">Description : </SPAN>
930 <!-- ========== Info from phpDoc block ========= -->
931 This function checks to see if
932 <BR>
933 there is only 1 content data, and
934 its not an object, then it auto
935 sets some of the indentation flags
936 <DL>
937 <DT class="font10bold">Function Parameters:</DT>
938
939
940 <DT class="font10bold">Function Info:</DT>
941
942 </DL>
943
944 </DIV>
945 <BR>
946
947 <DIV CLASS="function">
948 <A NAME='_render_close_tag'><!-- --></A>
949 <SPAN CLASS="font12bold">_render_close_tag</SPAN>
950 <BR>
951 <SPAN CLASS="font10bold">Useage : </SPAN>
952 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
953 <span class="font10bold" style="color: #0000FF">_render_close_tag ( $indent_level )</SPAN>
954 <BR>
955
956 <BR>
957 <SPAN CLASS="font10bold">Description : </SPAN>
958 <!-- ========== Info from phpDoc block ========= -->
959 this function is reposnsible for
960 rendering the closing tag (if any)
961 <BR>
962
963 <DL>
964 <DT class="font10bold">Function Parameters:</DT>
965
966 <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 indent level</DD>
967
968
969 <DT class="font10bold">Function Info:</DT>
970
971 </DL>
972
973 </DIV>
974 <BR>
975
976 <DIV CLASS="function">
977 <A NAME='_render_content'><!-- --></A>
978 <SPAN CLASS="font12bold">_render_content</SPAN>
979 <BR>
980 <SPAN CLASS="font10bold">Useage : </SPAN>
981 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
982 <span class="font10bold" style="color: #0000FF">_render_content ( $indent_level, [$output_debug = 0] )</SPAN>
983 <BR>
984
985 <BR>
986 <SPAN CLASS="font10bold">Description : </SPAN>
987 <!-- ========== Info from phpDoc block ========= -->
988 this function is reponsible for
989 <BR>
990 rendering the pcdata, or content
991 of the tag (if any)
992 <DL>
993 <DT class="font10bold">Function Parameters:</DT>
994
995 <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 indent level</DD>
996
997
998 <DT class="font10bold">Function Info:</DT>
999
1000 </DL>
1001
1002 </DIV>
1003 <BR>
1004
1005 <DIV CLASS="function">
1006 <A NAME='_render_open_tag'><!-- --></A>
1007 <SPAN CLASS="font12bold">_render_open_tag</SPAN>
1008 <BR>
1009 <SPAN CLASS="font10bold">Useage : </SPAN>
1010 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
1011 <span class="font10bold" style="color: #0000FF">_render_open_tag ( $indent_level, [$finish_slash = TRUE] )</SPAN>
1012 <BR>
1013
1014 <BR>
1015 <SPAN CLASS="font10bold">Description : </SPAN>
1016 <!-- ========== Info from phpDoc block ========= -->
1017 this function is responsible for
1018 rendering the open tag.
1019 <BR>
1020
1021 <DL>
1022 <DT class="font10bold">Function Parameters:</DT>
1023
1024 <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 indent level</DD>
1025
1026 <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">$finish_slash</SPAN></SPAN> - do we add the finish / if we have no
1027 close tag and no content?</DD>
1028
1029
1030 <DT class="font10bold">Function Info:</DT>
1031
1032 </DL>
1033
1034 </DIV>
1035 <BR>
1036
1037
1038 <hr>
1039 </HTML>
MailToCvsAdmin">MailToCvsAdmin
 ViewVC Help
Powered by ViewVC 1.1.26 RSS 2.0 feed