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

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

Parent Directory Parent Directory | Revision Log Revision Log

Revision 1.1 - (hide annotations)
Thu Jan 30 03:29:33 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 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 FooterNav</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 FooterNav">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 FooterNav
33     </H2>
34    
35     <pre>
36     <pre><a href="../phpHtmlLib/Container.html">Container</a>
37     |
38     --<a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a>
39     |
40     --FooterNav</pre>
41     </pre>
42    
43     <A NAME="children_summary"</A>
44     <H3>
45     Classes extended from FooterNav: <A HREF="#top" CLASS="links">^TOP</A>
46     </H3>
47    
48     <p>
49     <b><i>Located in File: Program_Root/widgets/FooterNav.inc</i></b><br>
50     </p>
51     <hr>
52     <!-- ========== Info from phpDoc block ========= -->
53     Use this class to render footer navigation that
54     is displayed at the bottom of a page.
55     <BR>
56    
57    
58     <UL>
59    
60     <LI><b>Package</b> - <CODE>phpHtmlLib</CODE></LI>
61    
62     <LI><b>Author</b> - <CODE>Walter A. Boring IV &lt;<a href="mailto:waboring@buildabetterweb.com">waboring@buildabetterweb.com</a>&gt;</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     </TABLE>
79    
80     <hr>
81     <!-- =========== VAR INHERITED SUMMARY =========== -->
82     <A NAME='var_inherited_summary'><!-- --></A>
83     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
84     <TR CLASS='TableHeadingColor'>
85     <TD>
86     <span CLASS="font12bold">Inherited Class Variable Summary</span>
87     <A HREF="#top" CLASS="links">^TOP</A>
88     </TD>
89     </TR>
90    
91    
92     <!-- =========== Summary =========== -->
93     <TR BGCOLOR='white'>
94     <TD>
95     <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a></span>
96     <table CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">
97     <tr CLASS="tableheadingcolor">
98     <th>Variable</th>
99     <th>Default Value</th>
100     <th>Description</th>
101     </tr>
102    
103     <tr>
104     <td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#$title'>$title</A></td>
105     <td CLASS="font10" STYLE="white-space: nowrap">-><-</td>
106     <td CLASS="font10">The title of the table.</td>
107     </tr>
108    
109     <tr>
110     <td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#$width'>$width</A></td>
111     <td CLASS="font10" STYLE="white-space: nowrap">->100%<-</td>
112     <td CLASS="font10">the width of the widget</td>
113     </tr>
114    
115     </table>
116     <BR>
117     </TD>
118     </TR>
119    
120     <!-- =========== Summary =========== -->
121     <TR BGCOLOR='white'>
122     <TD>
123     <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/Container.html">Container</a></span>
124     <table CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">
125     <tr CLASS="tableheadingcolor">
126     <th>Variable</th>
127     <th>Default Value</th>
128     <th>Description</th>
129     </tr>
130    
131     <tr>
132     <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#$indent_flag'>$indent_flag</A></td>
133     <td CLASS="font10" STYLE="white-space: nowrap">->TRUE<-</td>
134     <td CLASS="font10">Flag for pretty (indented) output</td>
135     </tr>
136    
137     <tr>
138     <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#$_newline_after_content_flag'>$_newline_after_content_flag</A></td>
139     <td CLASS="font10" STYLE="white-space: nowrap">->TRUE<-</td>
140     <td CLASS="font10">Do we render a newline after the
141     contents has been rendered?</td>
142     </tr>
143    
144     </table>
145     <BR>
146     </TD>
147     </TR>
148    
149     </TABLE>
150    
151     <hr>
152     <!-- =========== INHERITED METHOD SUMMARY =========== -->
153     <A NAME='functions_inherited'><!-- --></A>
154     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
155     <TR CLASS='TableHeadingColor'>
156     <TD>
157     <span CLASS="font12bold">Inherited Method Summary</span>
158     <A HREF="#top" CLASS="links">^TOP</A>
159     </TD>
160     </TR>
161    
162    
163     <!-- =========== Summary =========== -->
164     <TR BGCOLOR='white' CLASS='TableRowColor'>
165     <TD>
166     <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a></span>
167     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">
168     <tr CLASS="tableheadingcolor">
169     <th>Function</th>
170     <th>Description</th>
171     </tr>
172    
173     <tr>
174     <td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#get_align'>get_align ( )</A></td>
175     <td CLASS="font10">This gets the alignment value
176     for the outer table</td>
177    
178     <tr>
179     <td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#get_css'>get_css ( )</A></td>
180     <td CLASS="font10">This function provides the</td>
181    
182     <tr>
183     <td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#get_javascript'>get_javascript ( )</A></td>
184     <td CLASS="font10">Function for returning the raw javascript
185     that is required for this widget.</td>
186    
187     <tr>
188     <td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#get_title'>get_title ( )</A></td>
189     <td CLASS="font10">Function for accessing the
190     title of this widget</td>
191    
192     <tr>
193     <td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#get_width'>get_width ( )</A></td>
194     <td CLASS="font10">Function for getting the current
195     widget width setting.</td>
196    
197     <tr>
198     <td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#set_align'>set_align ( $align )</A></td>
199     <td CLASS="font10">This function sets the align attribute
200     for the outer table.</td>
201    
202     <tr>
203     <td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#set_title'>set_title ( [$title = ] )</A></td>
204     <td CLASS="font10">Set the title for the widget.</td>
205    
206     <tr>
207     <td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#set_width'>set_width ( $width )</A></td>
208     <td CLASS="font10">Set the width for the widget.</td>
209    
210     </table>
211     <br>
212     </TD>
213     </TR>
214    
215     <!-- =========== Summary =========== -->
216     <TR BGCOLOR='white' CLASS='TableRowColor'>
217     <TD>
218     <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/Container.html">Container</a></span>
219     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">
220     <tr CLASS="tableheadingcolor">
221     <th>Function</th>
222     <th>Description</th>
223     </tr>
224    
225     <tr>
226     <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#constructor Container'>constructor Container ( )</A></td>
227     <td CLASS="font10">The constructor.</td>
228    
229     <tr>
230     <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#add'>add ( )</A></td>
231     <td CLASS="font10">add content onto content stack</td>
232    
233     <tr>
234     <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#add_reference'>add_reference ( &$content )</A></td>
235     <td CLASS="font10">Add content onto content stack
236     so you can change the item later.</td>
237    
238     <tr>
239     <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#count_content'>count_content ( )</A></td>
240     <td CLASS="font10">counts the number of content objects</td>
241    
242     <tr>
243     <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#get_indent_flag'>get_indent_flag ( )</A></td>
244     <td CLASS="font10">This flag gets the current value
245     of the indent flag</td>
246    
247     <tr>
248     <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#push'>push ( )</A></td>
249     <td CLASS="font10">Same as add().</td>
250    
251     <tr>
252     <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#push_reference'>push_reference ( &$content )</A></td>
253     <td CLASS="font10">Same as add_reference
254     NOTE : only exists for compatibility with 1.1.x</td>
255    
256     <tr>
257     <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#render'>render ( [$indent_level = 1], [$output_debug = 0] )</A></td>
258     <td CLASS="font10">This function is compatible with the
259     rest of the phpHtmllib API spec.</td>
260    
261     <tr>
262     <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#reset_content'>reset_content ( )</A></td>
263     <td CLASS="font10">destroy existing content and start with new content.</td>
264    
265     <tr>
266     <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#set_collapse'>set_collapse ( [$collapse = TRUE], [$indent = TRUE] )</A></td>
267     <td CLASS="font10">This function turns on the collapse flag</td>
268    
269     <tr>
270     <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#set_indent_flag'>set_indent_flag ( $flag )</A></td>
271     <td CLASS="font10">function to set the indent flag</td>
272    
273     </table>
274     <br>
275     </TD>
276     </TR>
277    
278     </TABLE>
279    
280     <hr>
281     <!-- should have constructor at some point -->
282     <!-- =========== Method SUMMARY =========== -->
283     <A NAME='Method_summary'><!-- --></A>
284     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' Class="border">
285     <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
286     <TD>
287     <span class="font12bold">Method Summary</span>
288     <A HREF="#top" CLASS="links">^TOP</A>
289     </TD>
290     </TR>
291    
292    
293     <!-- =========== Summary =========== -->
294     <TR BGCOLOR='white' CLASS='TableRowColor'>
295     <TD>
296     <CODE><B><A HREF='FooterNav.html#constructor FooterNav'>void constructor FooterNav ( $company_name, [$date_str = ""NULL] )</A></B></CODE>
297     <BR>
298     <blockquote> Constructore for this class. </blockquote>
299     </TD>
300     </TR>
301    
302     <!-- =========== Summary =========== -->
303     <TR BGCOLOR='white' CLASS='TableRowColor'>
304     <TD>
305     <CODE><B><A HREF='FooterNav.html#add'>void add ( $url, $text )</A></B></CODE>
306     <BR>
307     <blockquote> add an entry to the footer nav </blockquote>
308     </TD>
309     </TR>
310    
311     <!-- =========== Summary =========== -->
312     <TR BGCOLOR='white' CLASS='TableRowColor'>
313     <TD>
314     <CODE><B><A HREF='FooterNav.html#build_copyright_header'><a href="../phpHtmlLib/SPANtag.html">SPANtag</a> build_copyright_header ( )</A></B></CODE>
315     <BR>
316     <blockquote> render the copyright string </blockquote>
317     </TD>
318     </TR>
319    
320     <!-- =========== Summary =========== -->
321     <TR BGCOLOR='white' CLASS='TableRowColor'>
322     <TD>
323     <CODE><B><A HREF='FooterNav.html#build_wrapper_table'><a href="../phpHtmlLib/TABLEtag.html">TABLEtag</a> build_wrapper_table ( )</A></B></CODE>
324     <BR>
325     <blockquote> builds the wrapper table </blockquote>
326     </TD>
327     </TR>
328    
329     <!-- =========== Summary =========== -->
330     <TR BGCOLOR='white' CLASS='TableRowColor'>
331     <TD>
332     <CODE><B><A HREF='FooterNav.html#push'>void push ( $url, $text )</A></B></CODE>
333     <BR>
334     <blockquote> add an entry to the footer nav. </blockquote>
335     </TD>
336     </TR>
337    
338     <!-- =========== Summary =========== -->
339     <TR BGCOLOR='white' CLASS='TableRowColor'>
340     <TD>
341     <CODE><B><A HREF='FooterNav.html#render'>string render ( [$indent_level = 1], [$output_debug = 0] )</A></B></CODE>
342     <BR>
343     <blockquote> render the code for this widget. </blockquote>
344     </TD>
345     </TR>
346    
347     <!-- =========== Summary =========== -->
348     <TR BGCOLOR='white' CLASS='TableRowColor'>
349     <TD>
350     <CODE><B><A HREF='FooterNav.html#set_company_name'>void set_company_name ( $name )</A></B></CODE>
351     <BR>
352     <blockquote> set the company name for the copyright
353     statement. </blockquote>
354     </TD>
355     </TR>
356    
357     <!-- =========== Summary =========== -->
358     <TR BGCOLOR='white' CLASS='TableRowColor'>
359     <TD>
360     <CODE><B><A HREF='FooterNav.html#set_copyright_flag'>void set_copyright_flag ( $flag )</A></B></CODE>
361     <BR>
362     <blockquote> set/unset the flag to tell us to
363     render the copyright string </blockquote>
364     </TD>
365     </TR>
366    
367     <!-- =========== Summary =========== -->
368     <TR BGCOLOR='white' CLASS='TableRowColor'>
369     <TD>
370     <CODE><B><A HREF='FooterNav.html#set_date_string'>void set_date_string ( $date_str )</A></B></CODE>
371     <BR>
372     <blockquote> set the date string for the copyright. </blockquote>
373     </TD>
374     </TR>
375    
376     <!-- =========== Summary =========== -->
377     <TR BGCOLOR='white' CLASS='TableRowColor'>
378     <TD>
379     <CODE><B><A HREF='FooterNav.html#set_legalnotice_url'>void set_legalnotice_url ( $url )</A></B></CODE>
380     <BR>
381     <blockquote> set the legal notice url. </blockquote>
382     </TD>
383     </TR>
384    
385     <!-- =========== Summary =========== -->
386     <TR BGCOLOR='white' CLASS='TableRowColor'>
387     <TD>
388     <CODE><B><A HREF='FooterNav.html#set_privacypolicy_url'>void set_privacypolicy_url ( $url )</A></B></CODE>
389     <BR>
390     <blockquote> sets the Privacy policy url. </blockquote>
391     </TD>
392     </TR>
393    
394     <!-- =========== Summary =========== -->
395     <TR BGCOLOR='white' CLASS='TableRowColor'>
396     <TD>
397     <CODE><B><A HREF='FooterNav.html#set_webmaster_email'>void set_webmaster_email ( $email )</A></B></CODE>
398     <BR>
399     <blockquote> sets the Webmaster email address </blockquote>
400     </TD>
401     </TR>
402    
403     </TABLE>
404    
405     <hr>
406     <!-- ============ VARIABLE DETAIL =========== -->
407    
408     <A NAME='variable_detail'></A>
409     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
410     <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
411     <TD>
412     <span CLASS="font12bold">Variable Detail</span>
413     <A HREF="#top" CLASS="links">^TOP</A>
414     </TD>
415     </TR>
416     </TABLE>
417    
418    
419    
420     <hr>
421     <!-- ============ FUNCTION DETAIL =========== -->
422    
423     <A NAME='function_detail'></A>
424     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
425     <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
426     <TD>
427     <span class="font12bold">Method Detail</span>
428     <A HREF="#top" CLASS="links">^TOP</A>
429     </TD>
430     </TR>
431     </TABLE>
432     <BR>
433    
434     <DIV CLASS="function">
435     <A NAME='constructor FooterNav'><!-- --></A>
436     <SPAN CLASS="font12bold">constructor FooterNav</SPAN>
437     <BR>
438     <SPAN CLASS="font10bold">Useage : </SPAN>
439     <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
440     <span class="font10bold" style="color: #0000FF">constructor FooterNav ( $company_name, [$date_str = ""NULL] )</SPAN>
441     <BR>
442    
443     <BR>
444     <SPAN CLASS="font10bold">Description : </SPAN>
445     <!-- ========== Info from phpDoc block ========= -->
446     Constructore for this class.
447     <BR>
448    
449     <DL>
450     <DT class="font10bold">Function Parameters:</DT>
451    
452     <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">$company_name</SPAN></SPAN> - used in the
453     - copyright</DD>
454    
455     <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">$date_str</SPAN></SPAN> - a date string to be used
456     for the copyright.</DD>
457    
458    
459     <DT class="font10bold">Function Info:</DT>
460    
461     </DL>
462    
463     </DIV>
464     <BR>
465    
466     <DIV CLASS="function">
467     <A NAME='add'><!-- --></A>
468     <SPAN CLASS="font12bold">add</SPAN>
469     <BR>
470     <SPAN CLASS="font10bold">Useage : </SPAN>
471     <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
472     <span class="font10bold" style="color: #0000FF">add ( $url, $text )</SPAN>
473     <BR>
474    
475     <BR>
476     <SPAN CLASS="font10bold">Description : </SPAN>
477     <!-- ========== Info from phpDoc block ========= -->
478     add an entry to the footer nav
479     <BR>
480    
481     <DL>
482     <DT class="font10bold">Function Parameters:</DT>
483    
484     <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">$url</SPAN></SPAN> - - url to go to</DD>
485    
486     <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">text</SPAN> <span style="color: #0000FF;font-weight:bold">$text</SPAN></SPAN> - - url text to click on.</DD>
487    
488    
489     <DT class="font10bold">Function Info:</DT>
490    
491     </DL>
492    
493     </DIV>
494     <BR>
495    
496     <DIV CLASS="function">
497     <A NAME='build_copyright_header'><!-- --></A>
498     <SPAN CLASS="font12bold">build_copyright_header</SPAN>
499     <BR>
500     <SPAN CLASS="font10bold">Useage : </SPAN>
501     <span class="font10bold" style="color: #FF0000"><a href="../phpHtmlLib/SPANtag.html">SPANtag</a></SPAN>&nbsp;
502     <span class="font10bold" style="color: #0000FF">build_copyright_header ( )</SPAN>
503     <BR>
504    
505     <BR>
506     <SPAN CLASS="font10bold">Description : </SPAN>
507     <!-- ========== Info from phpDoc block ========= -->
508     render the copyright string
509     <BR>
510    
511     <DL>
512     <DT class="font10bold">Function Parameters:</DT>
513    
514    
515     <DT class="font10bold">Function Info:</DT>
516    
517     <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - object that
518     contains the copyright
519     header.</DD>
520    
521     </DL>
522    
523     </DIV>
524     <BR>
525    
526     <DIV CLASS="function">
527     <A NAME='build_wrapper_table'><!-- --></A>
528     <SPAN CLASS="font12bold">build_wrapper_table</SPAN>
529     <BR>
530     <SPAN CLASS="font10bold">Useage : </SPAN>
531     <span class="font10bold" style="color: #FF0000"><a href="../phpHtmlLib/TABLEtag.html">TABLEtag</a></SPAN>&nbsp;
532     <span class="font10bold" style="color: #0000FF">build_wrapper_table ( )</SPAN>
533     <BR>
534    
535     <BR>
536     <SPAN CLASS="font10bold">Description : </SPAN>
537     <!-- ========== Info from phpDoc block ========= -->
538     builds the wrapper table
539     <BR>
540    
541     <DL>
542     <DT class="font10bold">Function Parameters:</DT>
543    
544    
545     <DT class="font10bold">Function Info:</DT>
546    
547     <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - object.</DD>
548    
549     </DL>
550    
551     </DIV>
552     <BR>
553    
554     <DIV CLASS="function">
555     <A NAME='push'><!-- --></A>
556     <SPAN CLASS="font12bold">push</SPAN>
557     <BR>
558     <SPAN CLASS="font10bold">Useage : </SPAN>
559     <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
560     <span class="font10bold" style="color: #0000FF">push ( $url, $text )</SPAN>
561     <BR>
562    
563     <BR>
564     <SPAN CLASS="font10bold">Description : </SPAN>
565     <!-- ========== Info from phpDoc block ========= -->
566     add an entry to the footer nav.
567     <BR>
568    
569     <DL>
570     <DT class="font10bold">Function Parameters:</DT>
571    
572     <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">$url</SPAN></SPAN> - - url to go to</DD>
573    
574     <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">text</SPAN> <span style="color: #0000FF;font-weight:bold">$text</SPAN></SPAN> - - url text to click on.</DD>
575    
576    
577     <DT class="font10bold">Function Info:</DT>
578    
579     <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Deprecated</b> - </DD>
580    
581     </DL>
582    
583     </DIV>
584     <BR>
585    
586     <DIV CLASS="function">
587     <A NAME='render'><!-- --></A>
588     <SPAN CLASS="font12bold">render</SPAN>
589     <BR>
590     <SPAN CLASS="font10bold">Useage : </SPAN>
591     <span class="font10bold" style="color: #FF0000">string</SPAN>&nbsp;
592     <span class="font10bold" style="color: #0000FF">render ( [$indent_level = 1], [$output_debug = 0] )</SPAN>
593     <BR>
594    
595     <BR>
596     <SPAN CLASS="font10bold">Description : </SPAN>
597     <!-- ========== Info from phpDoc block ========= -->
598     render the code for this widget.
599     <BR>
600    
601     <DL>
602     <DT class="font10bold">Function Parameters:</DT>
603    
604     <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
605     the container.</DD>
606    
607     <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">$output_debug</SPAN></SPAN> - the output debug flag to
608     maintain compatibility w/ the API.</DD>
609    
610    
611     <DT class="font10bold">Function Info:</DT>
612    
613     <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - the raw html output.</DD>
614    
615     </DL>
616    
617     </DIV>
618     <BR>
619    
620     <DIV CLASS="function">
621     <A NAME='set_company_name'><!-- --></A>
622     <SPAN CLASS="font12bold">set_company_name</SPAN>
623     <BR>
624     <SPAN CLASS="font10bold">Useage : </SPAN>
625     <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
626     <span class="font10bold" style="color: #0000FF">set_company_name ( $name )</SPAN>
627     <BR>
628    
629     <BR>
630     <SPAN CLASS="font10bold">Description : </SPAN>
631     <!-- ========== Info from phpDoc block ========= -->
632     set the company name for the copyright
633     statement.
634     <BR>
635    
636     <DL>
637     <DT class="font10bold">Function Parameters:</DT>
638    
639     <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> -</DD>
640    
641    
642     <DT class="font10bold">Function Info:</DT>
643    
644     </DL>
645    
646     </DIV>
647     <BR>
648    
649     <DIV CLASS="function">
650     <A NAME='set_copyright_flag'><!-- --></A>
651     <SPAN CLASS="font12bold">set_copyright_flag</SPAN>
652     <BR>
653     <SPAN CLASS="font10bold">Useage : </SPAN>
654     <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
655     <span class="font10bold" style="color: #0000FF">set_copyright_flag ( $flag )</SPAN>
656     <BR>
657    
658     <BR>
659     <SPAN CLASS="font10bold">Description : </SPAN>
660     <!-- ========== Info from phpDoc block ========= -->
661     set/unset the flag to tell us to
662     render the copyright string
663     <BR>
664    
665     <DL>
666     <DT class="font10bold">Function Parameters:</DT>
667    
668     <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> -</DD>
669    
670    
671     <DT class="font10bold">Function Info:</DT>
672    
673     </DL>
674    
675     </DIV>
676     <BR>
677    
678     <DIV CLASS="function">
679     <A NAME='set_date_string'><!-- --></A>
680     <SPAN CLASS="font12bold">set_date_string</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_date_string ( $date_str )</SPAN>
685     <BR>
686    
687     <BR>
688     <SPAN CLASS="font10bold">Description : </SPAN>
689     <!-- ========== Info from phpDoc block ========= -->
690     set the date string for the copyright.
691     <BR>
692     in the form of &quot;2001-1997&quot;, or
693     &quot;2001&quot;.
694     <DL>
695     <DT class="font10bold">Function Parameters:</DT>
696    
697     <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">$date_str</SPAN></SPAN> -</DD>
698    
699    
700     <DT class="font10bold">Function Info:</DT>
701    
702     </DL>
703    
704     </DIV>
705     <BR>
706    
707     <DIV CLASS="function">
708     <A NAME='set_legalnotice_url'><!-- --></A>
709     <SPAN CLASS="font12bold">set_legalnotice_url</SPAN>
710     <BR>
711     <SPAN CLASS="font10bold">Useage : </SPAN>
712     <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
713     <span class="font10bold" style="color: #0000FF">set_legalnotice_url ( $url )</SPAN>
714     <BR>
715    
716     <BR>
717     <SPAN CLASS="font10bold">Description : </SPAN>
718     <!-- ========== Info from phpDoc block ========= -->
719     set the legal notice url.
720     <BR>
721     if this is set we show the
722     legal notice link that points to $url.
723     <DL>
724     <DT class="font10bold">Function Parameters:</DT>
725    
726     <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">$url</SPAN></SPAN> -</DD>
727    
728    
729     <DT class="font10bold">Function Info:</DT>
730    
731     </DL>
732    
733     </DIV>
734     <BR>
735    
736     <DIV CLASS="function">
737     <A NAME='set_privacypolicy_url'><!-- --></A>
738     <SPAN CLASS="font12bold">set_privacypolicy_url</SPAN>
739     <BR>
740     <SPAN CLASS="font10bold">Useage : </SPAN>
741     <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
742     <span class="font10bold" style="color: #0000FF">set_privacypolicy_url ( $url )</SPAN>
743     <BR>
744    
745     <BR>
746     <SPAN CLASS="font10bold">Description : </SPAN>
747     <!-- ========== Info from phpDoc block ========= -->
748     sets the Privacy policy url.
749     <BR>
750     if this is set we show the
751     privacy policy link that points to $url
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;">string</SPAN> <span style="color: #0000FF;font-weight:bold">$url</SPAN></SPAN> -</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_webmaster_email'><!-- --></A>
767     <SPAN CLASS="font12bold">set_webmaster_email</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_webmaster_email ( $email )</SPAN>
772     <BR>
773    
774     <BR>
775     <SPAN CLASS="font10bold">Description : </SPAN>
776     <!-- ========== Info from phpDoc block ========= -->
777     sets the Webmaster email address
778     <BR>
779     if this is set we show the
780     mailto for this email
781     <DL>
782     <DT class="font10bold">Function Parameters:</DT>
783    
784     <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">$email</SPAN></SPAN> -</DD>
785    
786    
787     <DT class="font10bold">Function Info:</DT>
788    
789     </DL>
790    
791     </DIV>
792     <BR>
793    
794    
795     <hr>
796     </HTML>
MailToCvsAdmin">MailToCvsAdmin
 ViewVC Help
Powered by ViewVC 1.1.26 RSS 2.0 feed