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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.1 - (hide annotations)
Thu Jan 30 03:29:21 2003 UTC (21 years, 7 months ago) by jonen
Branch: MAIN
Branch point for: no_vendor_tag
File MIME type: text/html
Initial revision

1 jonen 1.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:31 -0800' -->
6     <TITLE>Docs For Class HTMLTagClass</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 HTMLTagClass">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 HTMLTagClass
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     --HTMLTagClass</pre>
41     </pre>
42    
43     <A NAME="children_summary"</A>
44     <H3>
45     Classes extended from HTMLTagClass: <A HREF="#top" CLASS="links">^TOP</A>
46     </H3>
47     <a href="../phpHtmlLib/Atag.html">Atag</a>, <a href="../phpHtmlLib/ABBRtag.html">ABBRtag</a>, <a href="../phpHtmlLib/ACRONYMtag.html">ACRONYMtag</a>, <a href="../phpHtmlLib/ADDRESStag.html">ADDRESStag</a>, <a href="../phpHtmlLib/APPLETtag.html">APPLETtag</a>, <a href="../phpHtmlLib/AREAtag.html">AREAtag</a>, <a href="../phpHtmlLib/Btag.html">Btag</a>, <a href="../phpHtmlLib/BASEtag.html">BASEtag</a>, <a href="../phpHtmlLib/BDOtag.html">BDOtag</a>, <a href="../phpHtmlLib/BIGtag.html">BIGtag</a>, <a href="../phpHtmlLib/BLOCKQUOTEtag.html">BLOCKQUOTEtag</a>, <a href="../phpHtmlLib/BODYtag.html">BODYtag</a>, <a href="../phpHtmlLib/BRtag.html">BRtag</a>, <a href="../phpHtmlLib/BUTTONtag.html">BUTTONtag</a>, <a href="../phpHtmlLib/CAPTIONtag.html">CAPTIONtag</a>, <a href="../phpHtmlLib/CENTERtag.html">CENTERtag</a>, <a href="../phpHtmlLib/CITEtag.html">CITEtag</a>, <a href="../phpHtmlLib/CODEtag.html">CODEtag</a>, <a href="../phpHtmlLib/COLtag.html">COLtag</a>, <a href="../phpHtmlLib/COLGROUPtag.html">COLGROUPtag</a>, <a href="../phpHtmlLib/DDtag.html">DDtag</a>, <a href="../phpHtmlLib/DELtag.html">DELtag</a>, <a href="../phpHtmlLib/DFNtag.html">DFNtag</a>, <a href="../phpHtmlLib/DIVtag.html">DIVtag</a>, <a href="../phpHtmlLib/DLtag.html">DLtag</a>, <a href="../phpHtmlLib/DTtag.html">DTtag</a>, <a href="../phpHtmlLib/EMtag.html">EMtag</a>, <a href="../phpHtmlLib/FIELDSETtag.html">FIELDSETtag</a>, <a href="../phpHtmlLib/FONTtag.html">FONTtag</a>, <a href="../phpHtmlLib/FORMtag.html">FORMtag</a>, <a href="../phpHtmlLib/FRAMEtag.html">FRAMEtag</a>, <a href="../phpHtmlLib/FRAMESETtag.html">FRAMESETtag</a>, <a href="../phpHtmlLib/H1tag.html">H1tag</a>, <a href="../phpHtmlLib/H2tag.html">H2tag</a>, <a href="../phpHtmlLib/H3tag.html">H3tag</a>, <a href="../phpHtmlLib/H4tag.html">H4tag</a>, <a href="../phpHtmlLib/H5tag.html">H5tag</a>, <a href="../phpHtmlLib/H6tag.html">H6tag</a>, <a href="../phpHtmlLib/HEADtag.html">HEADtag</a>, <a href="../phpHtmlLib/HRtag.html">HRtag</a>, <a href="../phpHtmlLib/HTMLtag.html">HTMLtag</a>, <a href="../phpHtmlLib/Itag.html">Itag</a>, <a href="../phpHtmlLib/IFRAMEtag.html">IFRAMEtag</a>, <a href="../phpHtmlLib/IMGtag.html">IMGtag</a>, <a href="../phpHtmlLib/INPUTtag.html">INPUTtag</a>, <a href="../phpHtmlLib/INStag.html">INStag</a>, <a href="../phpHtmlLib/KBDtag.html">KBDtag</a>, <a href="../phpHtmlLib/LABELtag.html">LABELtag</a>, <a href="../phpHtmlLib/LEGENDtag.html">LEGENDtag</a>, <a href="../phpHtmlLib/LItag.html">LItag</a>, <a href="../phpHtmlLib/LINKtag.html">LINKtag</a>, <a href="../phpHtmlLib/MAPtag.html">MAPtag</a>, <a href="../phpHtmlLib/METAtag.html">METAtag</a>, <a href="../phpHtmlLib/NOBRtag.html">NOBRtag</a>, <a href="../phpHtmlLib/NOFRAMEStag.html">NOFRAMEStag</a>, <a href="../phpHtmlLib/NOSCRIPTtag.html">NOSCRIPTtag</a>, <a href="../phpHtmlLib/OBJECTtag.html">OBJECTtag</a>, <a href="../phpHtmlLib/OLtag.html">OLtag</a>, <a href="../phpHtmlLib/OPTGROUPtag.html">OPTGROUPtag</a>, <a href="../phpHtmlLib/OPTIONtag.html">OPTIONtag</a>, <a href="../phpHtmlLib/Ptag.html">Ptag</a>, <a href="../phpHtmlLib/PARAMtag.html">PARAMtag</a>, <a href="../phpHtmlLib/PREtag.html">PREtag</a>, <a href="../phpHtmlLib/Qtag.html">Qtag</a>, <a href="../phpHtmlLib/Stag.html">Stag</a>, <a href="../phpHtmlLib/SAMPtag.html">SAMPtag</a>, <a href="../phpHtmlLib/SCRIPTtag.html">SCRIPTtag</a>, <a href="../phpHtmlLib/SELECTtag.html">SELECTtag</a>, <a href="../phpHtmlLib/SMALLtag.html">SMALLtag</a>, <a href="../phpHtmlLib/SPANtag.html">SPANtag</a>, <a href="../phpHtmlLib/STRONGtag.html">STRONGtag</a>, <a href="../phpHtmlLib/STYLEtag.html">STYLEtag</a>, <a href="../phpHtmlLib/SUBtag.html">SUBtag</a>, <a href="../phpHtmlLib/SUPtag.html">SUPtag</a>, <a href="../phpHtmlLib/TABLEtag.html">TABLEtag</a>, <a href="../phpHtmlLib/TDtag.html">TDtag</a>, <a href="../phpHtmlLib/TEXTAREAtag.html">TEXTAREAtag</a>, <a href="../phpHtmlLib/THtag.html">THtag</a>, <a href="../phpHtmlLib/TITLEtag.html">TITLEtag</a>, <a href="../phpHtmlLib/TRtag.html">TRtag</a>, <a href="../phpHtmlLib/TTtag.html">TTtag</a>, <a href="../phpHtmlLib/Utag.html">Utag</a>, <a href="../phpHtmlLib/VARtag.html">VARtag</a>, <a href="../phpHtmlLib/XMPtag.html">XMPtag</a>
48     <p>
49     <b><i>Located in File: Program_Root/HTMLTagClass.inc</i></b><br>
50     </p>
51     <hr>
52     <!-- ========== Info from phpDoc block ========= -->
53     Base class for all HTML Tag classes.
54     <BR>
55     Tag class renders an html tag, its
56     attributes, the content (if any),
57     and close tag (if needed).
58    
59     <UL>
60    
61     <LI><b>Package</b> - <CODE>phpHtmlLib</CODE></LI>
62    
63     <LI><b>Link</b> - <CODE>http://phphtmllib.sourceforge.net</CODE></LI>
64    
65     <LI><b>Author</b> - <CODE>Walter A. Boring IV &lt;<a href="mailto:waboring@buildabetterweb.com">waboring@buildabetterweb.com</a>&gt;</CODE></LI>
66    
67     </UL>
68    
69     <hr>
70     <!-- =========== VAR SUMMARY =========== -->
71     <A NAME='var_summary'><!-- --></A>
72     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
73     <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
74     <TD>
75     <span CLASS="font12bold">Class Variable Summary</span>
76     <A HREF="#top" CLASS="links">^TOP</A>
77     </TD>
78     </TR>
79    
80    
81     <!-- =========== Summary =========== -->
82     <TR BGCOLOR='white' CLASS='TableRowColor'>
83     <TD>
84     <CODE><B><A HREF='HTMLTagClass.html#$_depricated'>$_depricated</A></B></CODE>
85     <BR>
86     <blockquote> Flag to denote that this tag is
87     depricated by the HTML standard. </blockquote>
88     <blockquote> Default Value: <CODE>->FALSE<-</CODE> </blockquote>
89     </TD>
90     </TR>
91    
92     <!-- =========== Summary =========== -->
93     <TR BGCOLOR='white' CLASS='TableRowColor'>
94     <TD>
95     <CODE><B><A HREF='HTMLTagClass.html#$_no_finish_slash_xhtml'>$_no_finish_slash_xhtml</A></B></CODE>
96     <BR>
97     <blockquote> Flag to tell the renderer not to
98     place the /&gt; if we are in xhtml
99     compliant mode. </blockquote>
100     <blockquote> Default Value: <CODE>->FALSE<-</CODE> </blockquote>
101     </TD>
102     </TR>
103    
104     <!-- =========== Summary =========== -->
105     <TR BGCOLOR='white' CLASS='TableRowColor'>
106     <TD>
107     <CODE><B><A HREF='HTMLTagClass.html#$_xhtml_strict_attributes'>$_xhtml_strict_attributes</A></B></CODE>
108     <BR>
109     <blockquote> The list of attributes not to render
110     if HTML_RENDER_TYPE is &quot;XHTML STRICT&quot; </blockquote>
111     <blockquote> Default Value: <CODE>->array()<-</CODE> </blockquote>
112     </TD>
113     </TR>
114    
115     </TABLE>
116    
117     <hr>
118     <!-- =========== VAR INHERITED SUMMARY =========== -->
119     <A NAME='var_inherited_summary'><!-- --></A>
120     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
121     <TR CLASS='TableHeadingColor'>
122     <TD>
123     <span CLASS="font12bold">Inherited Class Variable Summary</span>
124     <A HREF="#top" CLASS="links">^TOP</A>
125     </TD>
126     </TR>
127    
128    
129     <!-- =========== Summary =========== -->
130     <TR BGCOLOR='white'>
131     <TD>
132     <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/XMLTagClass.html">XMLTagClass</a></span>
133     <table CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">
134     <tr CLASS="tableheadingcolor">
135     <th>Variable</th>
136     <th>Default Value</th>
137     <th>Description</th>
138     </tr>
139    
140     <tr>
141     <td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLTagClass.html#$newline_after_closetag'>$newline_after_closetag</A></td>
142     <td CLASS="font10" STYLE="white-space: nowrap">->TRUE<-</td>
143     <td CLASS="font10">Flag to place a newline after close tag.</td>
144     </tr>
145    
146     <tr>
147     <td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLTagClass.html#$newline_after_opentag'>$newline_after_opentag</A></td>
148     <td CLASS="font10" STYLE="white-space: nowrap">->TRUE<-</td>
149     <td CLASS="font10">Flag to place a newline after open tag.</td>
150     </tr>
151    
152     <tr>
153     <td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLTagClass.html#$_cdata_content_wrap'>$_cdata_content_wrap</A></td>
154     <td CLASS="font10" STYLE="white-space: nowrap">->FALSE<-</td>
155     <td CLASS="font10">Automatically wrap ALL content</td>
156     </tr>
157    
158     <tr>
159     <td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLTagClass.html#$_tag_postfix'>$_tag_postfix</A></td>
160     <td CLASS="font10" STYLE="white-space: nowrap">->&gt;<-</td>
161     <td CLASS="font10">holds the tag postfix</td>
162     </tr>
163    
164     <tr>
165     <td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLTagClass.html#$_tag_prefix'>$_tag_prefix</A></td>
166     <td CLASS="font10" STYLE="white-space: nowrap">->&lt;<-</td>
167     <td CLASS="font10">holds the tag prefix</td>
168     </tr>
169    
170     </table>
171     <BR>
172     </TD>
173     </TR>
174    
175     <!-- =========== Summary =========== -->
176     <TR BGCOLOR='white'>
177     <TD>
178     <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/Container.html">Container</a></span>
179     <table CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">
180     <tr CLASS="tableheadingcolor">
181     <th>Variable</th>
182     <th>Default Value</th>
183     <th>Description</th>
184     </tr>
185    
186     <tr>
187     <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#$indent_flag'>$indent_flag</A></td>
188     <td CLASS="font10" STYLE="white-space: nowrap">->TRUE<-</td>
189     <td CLASS="font10">Flag for pretty (indented) output</td>
190     </tr>
191    
192     <tr>
193     <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#$_newline_after_content_flag'>$_newline_after_content_flag</A></td>
194     <td CLASS="font10" STYLE="white-space: nowrap">->TRUE<-</td>
195     <td CLASS="font10">Do we render a newline after the
196     contents has been rendered?</td>
197     </tr>
198    
199     </table>
200     <BR>
201     </TD>
202     </TR>
203    
204     </TABLE>
205    
206     <hr>
207     <!-- =========== INHERITED METHOD SUMMARY =========== -->
208     <A NAME='functions_inherited'><!-- --></A>
209     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
210     <TR CLASS='TableHeadingColor'>
211     <TD>
212     <span CLASS="font12bold">Inherited Method Summary</span>
213     <A HREF="#top" CLASS="links">^TOP</A>
214     </TD>
215     </TR>
216    
217    
218     <!-- =========== Summary =========== -->
219     <TR BGCOLOR='white' CLASS='TableRowColor'>
220     <TD>
221     <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/XMLTagClass.html">XMLTagClass</a></span>
222     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">
223     <tr CLASS="tableheadingcolor">
224     <th>Function</th>
225     <th>Description</th>
226     </tr>
227    
228     <tr>
229     <td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLTagClass.html#constructor XMLTagClass'>constructor XMLTagClass ( [$name = ], [$attributes = array()] )</A></td>
230     <td CLASS="font10">The constructor</td>
231    
232     <tr>
233     <td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLTagClass.html#get_tag'>get_tag ( )</A></td>
234     <td CLASS="font10">This returns the tag declared for this class.</td>
235    
236     <tr>
237     <td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLTagClass.html#get_tag_name'>get_tag_name ( )</A></td>
238     <td CLASS="font10">This method gets the name of the tag</td>
239    
240     <tr>
241     <td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLTagClass.html#render'>render ( [$indent_level = 0] )</A></td>
242     <td CLASS="font10">This function is responsible</td>
243    
244     <tr>
245     <td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLTagClass.html#reset_attributes'>reset_attributes ( [$attributes = array()] )</A></td>
246     <td CLASS="font10">clear all attributes and start with new attributes</td>
247    
248     <tr>
249     <td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLTagClass.html#set_collapse'>set_collapse ( [$collapse = TRUE], [$indent = TRUE] )</A></td>
250     <td CLASS="font10">This function turns on the collapse flag</td>
251    
252     <tr>
253     <td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLTagClass.html#set_newline_after_closetag'>set_newline_after_closetag ( $flag )</A></td>
254     <td CLASS="font10">set the newline_after_content flag</td>
255    
256     <tr>
257     <td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLTagClass.html#set_newline_after_opentag'>set_newline_after_opentag ( $flag )</A></td>
258     <td CLASS="font10">set the newline_after_opentag flag</td>
259    
260     <tr>
261     <td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLTagClass.html#set_tag_attribute'>set_tag_attribute ( $name, [$value = NULL] )</A></td>
262     <td CLASS="font10">add a single attribute (name=&quot;value&quot;)</td>
263    
264     <tr>
265     <td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLTagClass.html#set_tag_attributes'>set_tag_attributes ( [$attributes = array()] )</A></td>
266     <td CLASS="font10">add multiple attributes (name=&quot;value&quot;)</td>
267    
268     <tr>
269     <td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLTagClass.html#set_tag_name'>set_tag_name ( $name )</A></td>
270     <td CLASS="font10">This method sets the name of the tag</td>
271    
272     <tr>
273     <td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLTagClass.html#_build_attribute_string'>_build_attribute_string ( $name, $value )</A></td>
274     <td CLASS="font10">this builds an attribute for an XML tag.</td>
275    
276     <tr>
277     <td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLTagClass.html#_get_element'>_get_element ( $cell )</A></td>
278     <td CLASS="font10">get the nth element from content array</td>
279    
280     <tr>
281     <td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLTagClass.html#_prepare_flags'>_prepare_flags ( )</A></td>
282     <td CLASS="font10">This function checks to see if</td>
283    
284     <tr>
285     <td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLTagClass.html#_render_close_tag'>_render_close_tag ( $indent_level )</A></td>
286     <td CLASS="font10">this function is reposnsible for
287     rendering the closing tag (if any)</td>
288    
289     <tr>
290     <td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLTagClass.html#_render_content'>_render_content ( $indent_level, [$output_debug = 0] )</A></td>
291     <td CLASS="font10">this function is reponsible for</td>
292    
293     <tr>
294     <td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLTagClass.html#_render_open_tag'>_render_open_tag ( $indent_level, [$finish_slash = TRUE] )</A></td>
295     <td CLASS="font10">this function is responsible for
296     rendering the open tag.</td>
297    
298     </table>
299     <br>
300     </TD>
301     </TR>
302    
303     <!-- =========== Summary =========== -->
304     <TR BGCOLOR='white' CLASS='TableRowColor'>
305     <TD>
306     <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/Container.html">Container</a></span>
307     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">
308     <tr CLASS="tableheadingcolor">
309     <th>Function</th>
310     <th>Description</th>
311     </tr>
312    
313     <tr>
314     <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#constructor Container'>constructor Container ( )</A></td>
315     <td CLASS="font10">The constructor.</td>
316    
317     <tr>
318     <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#add'>add ( )</A></td>
319     <td CLASS="font10">add content onto content stack</td>
320    
321     <tr>
322     <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#add_reference'>add_reference ( &$content )</A></td>
323     <td CLASS="font10">Add content onto content stack
324     so you can change the item later.</td>
325    
326     <tr>
327     <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#count_content'>count_content ( )</A></td>
328     <td CLASS="font10">counts the number of content objects</td>
329    
330     <tr>
331     <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#get_indent_flag'>get_indent_flag ( )</A></td>
332     <td CLASS="font10">This flag gets the current value
333     of the indent flag</td>
334    
335     <tr>
336     <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#push'>push ( )</A></td>
337     <td CLASS="font10">Same as add().</td>
338    
339     <tr>
340     <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#push_reference'>push_reference ( &$content )</A></td>
341     <td CLASS="font10">Same as add_reference
342     NOTE : only exists for compatibility with 1.1.x</td>
343    
344     <tr>
345     <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#render'>render ( [$indent_level = 1], [$output_debug = 0] )</A></td>
346     <td CLASS="font10">This function is compatible with the
347     rest of the phpHtmllib API spec.</td>
348    
349     <tr>
350     <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#reset_content'>reset_content ( )</A></td>
351     <td CLASS="font10">destroy existing content and start with new content.</td>
352    
353     <tr>
354     <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#set_collapse'>set_collapse ( [$collapse = TRUE], [$indent = TRUE] )</A></td>
355     <td CLASS="font10">This function turns on the collapse flag</td>
356    
357     <tr>
358     <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#set_indent_flag'>set_indent_flag ( $flag )</A></td>
359     <td CLASS="font10">function to set the indent flag</td>
360    
361     </table>
362     <br>
363     </TD>
364     </TR>
365    
366     </TABLE>
367    
368     <hr>
369     <!-- should have constructor at some point -->
370     <!-- =========== Method SUMMARY =========== -->
371     <A NAME='Method_summary'><!-- --></A>
372     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' Class="border">
373     <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
374     <TD>
375     <span class="font12bold">Method Summary</span>
376     <A HREF="#top" CLASS="links">^TOP</A>
377     </TD>
378     </TR>
379    
380    
381     <!-- =========== Summary =========== -->
382     <TR BGCOLOR='white' CLASS='TableRowColor'>
383     <TD>
384     <CODE><B><A HREF='HTMLTagClass.html#constructor HTMLTagClass'>void constructor HTMLTagClass ( [$attributes = NULL] )</A></B></CODE>
385     <BR>
386     <blockquote> Class Constructor </blockquote>
387     </TD>
388     </TR>
389    
390     <!-- =========== Summary =========== -->
391     <TR BGCOLOR='white' CLASS='TableRowColor'>
392     <TD>
393     <CODE><B><A HREF='HTMLTagClass.html#render'>string render ( [$indent_level = NULL], [$output_debug = 0] )</A></B></CODE>
394     <BR>
395     <blockquote> Renders the tag, attributes, content and close tag. </blockquote>
396     </TD>
397     </TR>
398    
399     <!-- =========== Summary =========== -->
400     <TR BGCOLOR='white' CLASS='TableRowColor'>
401     <TD>
402     <CODE><B><A HREF='HTMLTagClass.html#set_class'>void set_class ( $value )</A></B></CODE>
403     <BR>
404     <blockquote> This function is a shorthand helper
405     to setting the class attribute on a
406     tag. </blockquote>
407     </TD>
408     </TR>
409    
410     <!-- =========== Summary =========== -->
411     <TR BGCOLOR='white' CLASS='TableRowColor'>
412     <TD>
413     <CODE><B><A HREF='HTMLTagClass.html#set_id'>void set_id ( $value )</A></B></CODE>
414     <BR>
415     <blockquote> This function is a shorthand helper
416     to setting the id attribute on a
417     tag. </blockquote>
418     </TD>
419     </TR>
420    
421     <!-- =========== Summary =========== -->
422     <TR BGCOLOR='white' CLASS='TableRowColor'>
423     <TD>
424     <CODE><B><A HREF='HTMLTagClass.html#set_style'>void set_style ( $value )</A></B></CODE>
425     <BR>
426     <blockquote> This function is a shorthand helper
427     to setting the style attribute on a
428     tag. </blockquote>
429     </TD>
430     </TR>
431    
432     <!-- =========== Summary =========== -->
433     <TR BGCOLOR='white' CLASS='TableRowColor'>
434     <TD>
435     <CODE><B><A HREF='HTMLTagClass.html#_build_attribute_string'>the _build_attribute_string ( $name, $value, [$debug = 0] )</A></B></CODE>
436     <BR>
437     <blockquote> this builds an attribute for a tag. </blockquote>
438     </TD>
439     </TR>
440    
441     <!-- =========== Summary =========== -->
442     <TR BGCOLOR='white' CLASS='TableRowColor'>
443     <TD>
444     <CODE><B><A HREF='HTMLTagClass.html#_render_tag_debug'>void _render_tag_debug ( $indent_level )</A></B></CODE>
445     <BR>
446     <blockquote> This renders that open tag in debug mode. </blockquote>
447     </TD>
448     </TR>
449    
450     </TABLE>
451    
452     <hr>
453     <!-- ============ VARIABLE DETAIL =========== -->
454    
455     <A NAME='variable_detail'></A>
456     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
457     <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
458     <TD>
459     <span CLASS="font12bold">Variable Detail</span>
460     <A HREF="#top" CLASS="links">^TOP</A>
461     </TD>
462     </TR>
463     </TABLE>
464    
465    
466     <A NAME='$_depricated'><!-- --></A><H3>$_depricated</H3>
467     <b>Data type:</b> mixed<br>
468     <!-- ========== Info from phpDoc block ========= -->
469     Flag to denote that this tag is
470     depricated by the HTML standard.
471     <BR>
472    
473    
474     <UL>
475    
476     </UL>
477    
478     <HR>
479    
480     <A NAME='$_no_finish_slash_xhtml'><!-- --></A><H3>$_no_finish_slash_xhtml</H3>
481     <b>Data type:</b> mixed<br>
482     <!-- ========== Info from phpDoc block ========= -->
483     Flag to tell the renderer not to
484     place the /&gt; if we are in xhtml
485     compliant mode.
486     <BR>
487    
488    
489     <UL>
490    
491     </UL>
492    
493     <HR>
494    
495     <A NAME='$_xhtml_strict_attributes'><!-- --></A><H3>$_xhtml_strict_attributes</H3>
496     <b>Data type:</b> mixed<br>
497     <!-- ========== Info from phpDoc block ========= -->
498     The list of attributes not to render
499     if HTML_RENDER_TYPE is &quot;XHTML STRICT&quot;
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 HTMLTagClass'><!-- --></A>
526     <SPAN CLASS="font12bold">constructor HTMLTagClass</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 HTMLTagClass ( [$attributes = NULL] )</SPAN>
531     <BR>
532    
533     <BR>
534     <SPAN CLASS="font10bold">Description : </SPAN>
535     <!-- ========== Info from phpDoc block ========= -->
536     Class 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">1</SPAN></SPAN> You can have any number
543     of parameters that will
544     be added to the content
545     of the tag automatically.</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> - Associative array of
548     name=&quot;value&quot; pairs of
549     tag atributes.
550     ie array(&quot;border&quot;=&gt;0, &quot;class&quot;=&gt;&quot;hover&quot;);</DD>
551    
552    
553     <DT class="font10bold">Function Info:</DT>
554    
555     <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Access</b> - public</DD>
556    
557     </DL>
558    
559     </DIV>
560     <BR>
561    
562     <DIV CLASS="function">
563     <A NAME='render'><!-- --></A>
564     <SPAN CLASS="font12bold">render</SPAN>
565     <BR>
566     <SPAN CLASS="font10bold">Useage : </SPAN>
567     <span class="font10bold" style="color: #FF0000">string</SPAN>&nbsp;
568     <span class="font10bold" style="color: #0000FF">render ( [$indent_level = NULL], [$output_debug = 0] )</SPAN>
569     <BR>
570     <span class="font10bold" style="padding-left: 10px;">Overrides :</span> <a href="../phpHtmlLib/XMLTagClass.html#render">XMLTagClass::render()</a>
571     <BR>
572     <SPAN CLASS="font10bold">Description : </SPAN>
573     <!-- ========== Info from phpDoc block ========= -->
574     Renders the tag, attributes, content and close tag.
575     <BR>
576    
577     <DL>
578     <DT class="font10bold">Function Parameters:</DT>
579    
580     <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 this tag.</DD>
581    
582    
583     <DT class="font10bold">Function Info:</DT>
584    
585     <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Access</b> - public</DD>
586    
587     </DL>
588    
589     </DIV>
590     <BR>
591    
592     <DIV CLASS="function">
593     <A NAME='set_class'><!-- --></A>
594     <SPAN CLASS="font12bold">set_class</SPAN>
595     <BR>
596     <SPAN CLASS="font10bold">Useage : </SPAN>
597     <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
598     <span class="font10bold" style="color: #0000FF">set_class ( $value )</SPAN>
599     <BR>
600    
601     <BR>
602     <SPAN CLASS="font10bold">Description : </SPAN>
603     <!-- ========== Info from phpDoc block ========= -->
604     This function is a shorthand helper
605     to setting the class attribute on a
606     tag.
607     <BR>
608    
609     <DL>
610     <DT class="font10bold">Function Parameters:</DT>
611    
612     <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 class value.</DD>
613    
614    
615     <DT class="font10bold">Function Info:</DT>
616    
617     </DL>
618    
619     </DIV>
620     <BR>
621    
622     <DIV CLASS="function">
623     <A NAME='set_id'><!-- --></A>
624     <SPAN CLASS="font12bold">set_id</SPAN>
625     <BR>
626     <SPAN CLASS="font10bold">Useage : </SPAN>
627     <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
628     <span class="font10bold" style="color: #0000FF">set_id ( $value )</SPAN>
629     <BR>
630    
631     <BR>
632     <SPAN CLASS="font10bold">Description : </SPAN>
633     <!-- ========== Info from phpDoc block ========= -->
634     This function is a shorthand helper
635     to setting the id attribute on a
636     tag.
637     <BR>
638    
639     <DL>
640     <DT class="font10bold">Function Parameters:</DT>
641    
642     <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 class value.</DD>
643    
644    
645     <DT class="font10bold">Function Info:</DT>
646    
647     </DL>
648    
649     </DIV>
650     <BR>
651    
652     <DIV CLASS="function">
653     <A NAME='set_style'><!-- --></A>
654     <SPAN CLASS="font12bold">set_style</SPAN>
655     <BR>
656     <SPAN CLASS="font10bold">Useage : </SPAN>
657     <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
658     <span class="font10bold" style="color: #0000FF">set_style ( $value )</SPAN>
659     <BR>
660    
661     <BR>
662     <SPAN CLASS="font10bold">Description : </SPAN>
663     <!-- ========== Info from phpDoc block ========= -->
664     This function is a shorthand helper
665     to setting the style attribute on a
666     tag.
667     <BR>
668    
669     <DL>
670     <DT class="font10bold">Function Parameters:</DT>
671    
672     <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 style value.</DD>
673    
674    
675     <DT class="font10bold">Function Info:</DT>
676    
677     </DL>
678    
679     </DIV>
680     <BR>
681    
682     <DIV CLASS="function">
683     <A NAME='_build_attribute_string'><!-- --></A>
684     <SPAN CLASS="font12bold">_build_attribute_string</SPAN>
685     <BR>
686     <SPAN CLASS="font10bold">Useage : </SPAN>
687     <span class="font10bold" style="color: #FF0000">the</SPAN>&nbsp;
688     <span class="font10bold" style="color: #0000FF">_build_attribute_string ( $name, $value, [$debug = 0] )</SPAN>
689     <BR>
690     <span class="font10bold" style="padding-left: 10px;">Overrides :</span> <a href="../phpHtmlLib/XMLTagClass.html#_build_attribute_string">XMLTagClass::_build_attribute_string()</a>
691     <BR>
692     <SPAN CLASS="font10bold">Description : </SPAN>
693     <!-- ========== Info from phpDoc block ========= -->
694     this builds an attribute for a tag.
695     <BR>
696     It also filters out any attributes
697     that shouldn't be rendered if they
698     are in the $this-&gt;_xhtml_strict_attributes
699     array and HTML_RENDER_TYPE = XHTML STRICT
700     <DL>
701     <DT class="font10bold">Function Parameters:</DT>
702    
703     <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>
704    
705     <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>
706    
707    
708     <DT class="font10bold">Function Info:</DT>
709    
710     <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - tag attribute name=value pair.
711     to be added to the tag.</DD>
712    
713     </DL>
714    
715     </DIV>
716     <BR>
717    
718     <DIV CLASS="function">
719     <A NAME='_render_tag_debug'><!-- --></A>
720     <SPAN CLASS="font12bold">_render_tag_debug</SPAN>
721     <BR>
722     <SPAN CLASS="font10bold">Useage : </SPAN>
723     <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
724     <span class="font10bold" style="color: #0000FF">_render_tag_debug ( $indent_level )</SPAN>
725     <BR>
726    
727     <BR>
728     <SPAN CLASS="font10bold">Description : </SPAN>
729     <!-- ========== Info from phpDoc block ========= -->
730     This renders that open tag in debug mode.
731     <BR>
732     We do this as a seperate function,
733     so we can override this by the child
734     tag, so it can add a link on content or
735     one of the attributes.
736     <DL>
737     <DT class="font10bold">Function Parameters:</DT>
738    
739    
740     <DT class="font10bold">Function Info:</DT>
741    
742     </DL>
743    
744     </DIV>
745     <BR>
746    
747    
748     <hr>
749     </HTML>

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