1 |
jonen |
1.2 |
<!DOCTYPE HTML PUBLIC '-//W3C//DTD HTML 4.0 Transitional//EN' 'http://www.w3.org/TR/REC-html40/loose.dtd'> |
2 |
jonen |
1.1 |
<!--NewPage--> |
3 |
|
|
<HTML> |
4 |
|
|
<HEAD> |
5 |
jonen |
1.2 |
<!-- Generated by PhpDoc date: 'Thu, 20 Feb 2003 16:22:49 -0800' --> |
6 |
jonen |
1.1 |
<TITLE>Docs For Class FooterNav</TITLE> |
7 |
jonen |
1.2 |
<LINK REL ='stylesheet' TYPE='text/css' HREF='../media/stylesheet.css' TITLE='Style'> |
8 |
jonen |
1.1 |
</HEAD> |
9 |
|
|
<BODY style="background-color: #eeeeee; font-family: arial; font-size: .9em;"> |
10 |
|
|
<!-- Links --> |
11 |
|
|
<a NAME="top"></A> |
12 |
|
|
<table WIDTH="100%" class="links"> |
13 |
|
|
<TR> |
14 |
|
|
<TD class="font10"> |
15 |
|
|
Links: |
16 |
|
|
<A HREF="#children_summary" class="links" title="Classes extended from FooterNav">Child Classes</A> |
17 |
|
|
<A HREF="#var_summary" class="links" title="Class Variable Summary">Variables</A> |
18 |
|
|
<A HREF="#var_inherited_summary" class="links" title="Inherited Class Variable Summary">Inherited Variables</A> |
19 |
jonen |
1.2 |
<A HREF="#functions_inherited" class="links" title="Inherited Method Summary">Inherited Methods</A> |
20 |
|
|
<A HREF="#method_summary" class="links" title="Method Summary">Methods</A> |
21 |
jonen |
1.1 |
<A HREF="#variable_detail" class="links" title="Variable Detail">Variable Detail</A> |
22 |
jonen |
1.2 |
<A HREF="#method_detail" class="links" title="Method Detail">Method Detail</A> |
23 |
jonen |
1.1 |
</TD> |
24 |
|
|
</TR> |
25 |
|
|
</TABLE> |
26 |
|
|
<BR> |
27 |
|
|
<!-- Start of Class Data --> |
28 |
|
|
<H2> |
29 |
|
|
Class FooterNav |
30 |
jonen |
1.2 |
</H2> (line <span class="linenumber">26</span>) |
31 |
jonen |
1.1 |
<pre> |
32 |
jonen |
1.2 |
<a href="../phpHtmlLib/Container.html">Container</a> |
33 |
jonen |
1.1 |
| |
34 |
|
|
--<a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a> |
35 |
|
|
| |
36 |
|
|
--FooterNav</pre> |
37 |
|
|
<p> |
38 |
|
|
<b><i>Located in File: Program_Root/widgets/FooterNav.inc</i></b><br> |
39 |
|
|
</p> |
40 |
|
|
<hr> |
41 |
jonen |
1.2 |
Use this class to render footer navigation that is displayed at the bottom of a page. |
42 |
|
|
<br /> |
43 |
jonen |
1.1 |
|
44 |
|
|
<UL> |
45 |
jonen |
1.2 |
<LI><b>author</b> - <CODE>Walter A. Boring IV <<a href="mailto:waboring@buildabetterweb.com">mailto:waboring@buildabetterweb.com</a>></CODE></LI> |
46 |
|
|
</UL> |
47 |
jonen |
1.1 |
<hr> |
48 |
|
|
<!-- =========== VAR SUMMARY =========== --> |
49 |
|
|
<A NAME='var_summary'><!-- --></A> |
50 |
|
|
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
51 |
|
|
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
52 |
|
|
<TD> |
53 |
|
|
<span CLASS="font12bold">Class Variable Summary</span> |
54 |
|
|
<A HREF="#top" CLASS="links">^TOP</A> |
55 |
|
|
</TD> |
56 |
|
|
</TR> |
57 |
|
|
|
58 |
jonen |
1.2 |
</TABLE> |
59 |
jonen |
1.1 |
<hr> |
60 |
|
|
<!-- =========== VAR INHERITED SUMMARY =========== --> |
61 |
|
|
<A NAME='var_inherited_summary'><!-- --></A> |
62 |
|
|
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
63 |
jonen |
1.2 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
64 |
jonen |
1.1 |
<TD> |
65 |
|
|
<span CLASS="font12bold">Inherited Class Variable Summary</span> |
66 |
|
|
<A HREF="#top" CLASS="links">^TOP</A> |
67 |
|
|
</TD> |
68 |
|
|
</TR> |
69 |
|
|
|
70 |
jonen |
1.2 |
<!-- =========== Summary =========== --> |
71 |
jonen |
1.1 |
<TR BGCOLOR='white'> |
72 |
|
|
<TD> |
73 |
|
|
<span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a></span> |
74 |
|
|
<table CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center"> |
75 |
|
|
<tr CLASS="tableheadingcolor"> |
76 |
|
|
<th>Variable</th> |
77 |
|
|
<th>Default Value</th> |
78 |
|
|
<th>Description</th> |
79 |
|
|
</tr> |
80 |
jonen |
1.2 |
<tr> |
81 |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/BaseWidget.html#var$title">BaseWidget::$title</a></td> |
82 |
|
|
<td CLASS="font10" STYLE="white-space: nowrap">->''<-</td> |
83 |
jonen |
1.1 |
<td CLASS="font10">The title of the table.</td> |
84 |
|
|
</tr> |
85 |
jonen |
1.2 |
<tr> |
86 |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/BaseWidget.html#var$width">BaseWidget::$width</a></td> |
87 |
|
|
<td CLASS="font10" STYLE="white-space: nowrap">->"100%"<-</td> |
88 |
jonen |
1.1 |
<td CLASS="font10">the width of the widget</td> |
89 |
|
|
</tr> |
90 |
jonen |
1.2 |
</table> |
91 |
jonen |
1.1 |
<BR> |
92 |
|
|
</TD> |
93 |
|
|
</TR> |
94 |
jonen |
1.2 |
<!-- =========== Summary =========== --> |
95 |
jonen |
1.1 |
<TR BGCOLOR='white'> |
96 |
|
|
<TD> |
97 |
|
|
<span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/Container.html">Container</a></span> |
98 |
|
|
<table CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center"> |
99 |
|
|
<tr CLASS="tableheadingcolor"> |
100 |
|
|
<th>Variable</th> |
101 |
|
|
<th>Default Value</th> |
102 |
|
|
<th>Description</th> |
103 |
|
|
</tr> |
104 |
jonen |
1.2 |
<tr> |
105 |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#var$_flags">Container::$_flags</a></td> |
106 |
|
|
<td CLASS="font10" STYLE="white-space: nowrap">-> _NEWLINEAFTERCONTENT<-</td> |
107 |
|
|
<td CLASS="font10">The flags that tell us</td> |
108 |
jonen |
1.1 |
</tr> |
109 |
jonen |
1.2 |
</table> |
110 |
jonen |
1.1 |
<BR> |
111 |
|
|
</TD> |
112 |
|
|
</TR> |
113 |
jonen |
1.2 |
</TABLE> |
114 |
jonen |
1.1 |
|
115 |
|
|
<hr> |
116 |
jonen |
1.2 |
<!-- =========== METHOD SUMMARY =========== --> |
117 |
|
|
<A NAME='method_summary'><!-- --></A> |
118 |
jonen |
1.1 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' Class="border"> |
119 |
|
|
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
120 |
|
|
<TD> |
121 |
|
|
<span class="font12bold">Method Summary</span> |
122 |
|
|
<A HREF="#top" CLASS="links">^TOP</A> |
123 |
|
|
</TD> |
124 |
|
|
</TR> |
125 |
|
|
|
126 |
jonen |
1.2 |
<!-- =========== Summary =========== --> |
127 |
jonen |
1.1 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
128 |
|
|
<TD> |
129 |
jonen |
1.2 |
<CODE><B><A HREF='../phpHtmlLib/FooterNav.html#methodFooterNav'>void constructor FooterNav ( [$company_name = ""], [$date_str = NULL] )</A></B></CODE> |
130 |
jonen |
1.1 |
<BR> |
131 |
|
|
<blockquote> Constructore for this class. </blockquote> |
132 |
|
|
</TD> |
133 |
|
|
</TR> |
134 |
jonen |
1.2 |
<!-- =========== Summary =========== --> |
135 |
jonen |
1.1 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
136 |
|
|
<TD> |
137 |
jonen |
1.2 |
<CODE><B><A HREF='../phpHtmlLib/FooterNav.html#methodadd'>void add ( $url, $text )</A></B></CODE> |
138 |
jonen |
1.1 |
<BR> |
139 |
|
|
<blockquote> add an entry to the footer nav </blockquote> |
140 |
|
|
</TD> |
141 |
|
|
</TR> |
142 |
jonen |
1.2 |
<!-- =========== Summary =========== --> |
143 |
jonen |
1.1 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
144 |
|
|
<TD> |
145 |
jonen |
1.2 |
<CODE><B><A HREF='../phpHtmlLib/FooterNav.html#methodbuild_copyright_header'><a href="../phpHtmlLib/SPANtag.html">SPANtag</a> build_copyright_header ( )</A></B></CODE> |
146 |
jonen |
1.1 |
<BR> |
147 |
|
|
<blockquote> render the copyright string </blockquote> |
148 |
|
|
</TD> |
149 |
|
|
</TR> |
150 |
jonen |
1.2 |
<!-- =========== Summary =========== --> |
151 |
jonen |
1.1 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
152 |
|
|
<TD> |
153 |
jonen |
1.2 |
<CODE><B><A HREF='../phpHtmlLib/FooterNav.html#methodbuild_wrapper_table'><a href="../phpHtmlLib/TABLEtag.html">TABLEtag</a> build_wrapper_table ( )</A></B></CODE> |
154 |
jonen |
1.1 |
<BR> |
155 |
|
|
<blockquote> builds the wrapper table </blockquote> |
156 |
|
|
</TD> |
157 |
|
|
</TR> |
158 |
jonen |
1.2 |
<!-- =========== Summary =========== --> |
159 |
jonen |
1.1 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
160 |
|
|
<TD> |
161 |
jonen |
1.2 |
<CODE><B><A HREF='../phpHtmlLib/FooterNav.html#methodpush'>void push ( $url, $text )</A></B></CODE> |
162 |
jonen |
1.1 |
<BR> |
163 |
|
|
<blockquote> add an entry to the footer nav. </blockquote> |
164 |
|
|
</TD> |
165 |
|
|
</TR> |
166 |
jonen |
1.2 |
<!-- =========== Summary =========== --> |
167 |
jonen |
1.1 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
168 |
|
|
<TD> |
169 |
jonen |
1.2 |
<CODE><B><A HREF='../phpHtmlLib/FooterNav.html#methodrender'>string render ( [$indent_level = 1], [$output_debug = 0] )</A></B></CODE> |
170 |
jonen |
1.1 |
<BR> |
171 |
|
|
<blockquote> render the code for this widget. </blockquote> |
172 |
|
|
</TD> |
173 |
|
|
</TR> |
174 |
jonen |
1.2 |
<!-- =========== Summary =========== --> |
175 |
jonen |
1.1 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
176 |
|
|
<TD> |
177 |
jonen |
1.2 |
<CODE><B><A HREF='../phpHtmlLib/FooterNav.html#methodset_company_name'>void set_company_name ( $name )</A></B></CODE> |
178 |
jonen |
1.1 |
<BR> |
179 |
jonen |
1.2 |
<blockquote> set the company name for the copyright statement. </blockquote> |
180 |
jonen |
1.1 |
</TD> |
181 |
|
|
</TR> |
182 |
jonen |
1.2 |
<!-- =========== Summary =========== --> |
183 |
jonen |
1.1 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
184 |
|
|
<TD> |
185 |
jonen |
1.2 |
<CODE><B><A HREF='../phpHtmlLib/FooterNav.html#methodset_copyright_flag'>void set_copyright_flag ( $flag )</A></B></CODE> |
186 |
jonen |
1.1 |
<BR> |
187 |
jonen |
1.2 |
<blockquote> set/unset the flag to tell us to render the copyright string </blockquote> |
188 |
jonen |
1.1 |
</TD> |
189 |
|
|
</TR> |
190 |
jonen |
1.2 |
<!-- =========== Summary =========== --> |
191 |
jonen |
1.1 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
192 |
|
|
<TD> |
193 |
jonen |
1.2 |
<CODE><B><A HREF='../phpHtmlLib/FooterNav.html#methodset_date_string'>void set_date_string ( $date_str )</A></B></CODE> |
194 |
jonen |
1.1 |
<BR> |
195 |
|
|
<blockquote> set the date string for the copyright. </blockquote> |
196 |
|
|
</TD> |
197 |
|
|
</TR> |
198 |
jonen |
1.2 |
<!-- =========== Summary =========== --> |
199 |
jonen |
1.1 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
200 |
|
|
<TD> |
201 |
jonen |
1.2 |
<CODE><B><A HREF='../phpHtmlLib/FooterNav.html#methodset_legalnotice_url'>void set_legalnotice_url ( $url )</A></B></CODE> |
202 |
jonen |
1.1 |
<BR> |
203 |
|
|
<blockquote> set the legal notice url. </blockquote> |
204 |
|
|
</TD> |
205 |
|
|
</TR> |
206 |
jonen |
1.2 |
<!-- =========== Summary =========== --> |
207 |
jonen |
1.1 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
208 |
|
|
<TD> |
209 |
jonen |
1.2 |
<CODE><B><A HREF='../phpHtmlLib/FooterNav.html#methodset_privacypolicy_url'>void set_privacypolicy_url ( $url )</A></B></CODE> |
210 |
jonen |
1.1 |
<BR> |
211 |
|
|
<blockquote> sets the Privacy policy url. </blockquote> |
212 |
|
|
</TD> |
213 |
|
|
</TR> |
214 |
jonen |
1.2 |
<!-- =========== Summary =========== --> |
215 |
jonen |
1.1 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
216 |
|
|
<TD> |
217 |
jonen |
1.2 |
<CODE><B><A HREF='../phpHtmlLib/FooterNav.html#methodset_webmaster_email'>void set_webmaster_email ( $email )</A></B></CODE> |
218 |
jonen |
1.1 |
<BR> |
219 |
jonen |
1.2 |
<blockquote> sets the Webmaster email address if this is set we show the mailto for this email </blockquote> |
220 |
|
|
</TD> |
221 |
|
|
</TR> |
222 |
|
|
</TABLE> |
223 |
|
|
<!-- =========== INHERITED METHOD SUMMARY =========== --> |
224 |
|
|
<A NAME='functions_inherited'><!-- --></A> |
225 |
|
|
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
226 |
|
|
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
227 |
|
|
<TD> |
228 |
|
|
<span CLASS="font12bold">Inherited Method Summary</span> |
229 |
|
|
<A HREF="#top" CLASS="links">^TOP</A> |
230 |
jonen |
1.1 |
</TD> |
231 |
|
|
</TR> |
232 |
|
|
|
233 |
jonen |
1.2 |
<!-- =========== Summary =========== --> |
234 |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
235 |
|
|
<TD> |
236 |
|
|
<span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a></span> |
237 |
|
|
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center"> |
238 |
|
|
<tr CLASS="tableheadingcolor"> |
239 |
|
|
<th>Function</th> |
240 |
|
|
<th>Description</th> |
241 |
|
|
</tr> |
242 |
|
|
<tr> |
243 |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/BaseWidget.html#methodget_align">BaseWidget::get_align()</a></td> |
244 |
|
|
<td CLASS="font10">This gets the alignment value for the outer table</td> |
245 |
|
|
<tr> |
246 |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/BaseWidget.html#methodget_css">BaseWidget::get_css()</a></td> |
247 |
|
|
<td CLASS="font10">This function provides the mechanism to build and return the css needed by this widget</td> |
248 |
|
|
<tr> |
249 |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/BaseWidget.html#methodget_javascript">BaseWidget::get_javascript()</a></td> |
250 |
|
|
<td CLASS="font10">Function for returning the raw javascript that is required for this widget.</td> |
251 |
|
|
<tr> |
252 |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/BaseWidget.html#methodget_title">BaseWidget::get_title()</a></td> |
253 |
|
|
<td CLASS="font10">Function for accessing the title of this widget</td> |
254 |
|
|
<tr> |
255 |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/BaseWidget.html#methodget_width">BaseWidget::get_width()</a></td> |
256 |
|
|
<td CLASS="font10">Function for getting the current widget width setting.</td> |
257 |
|
|
<tr> |
258 |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/BaseWidget.html#methodset_align">BaseWidget::set_align()</a></td> |
259 |
|
|
<td CLASS="font10">This function sets the align attribute for the outer table.</td> |
260 |
|
|
<tr> |
261 |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/BaseWidget.html#methodset_title">BaseWidget::set_title()</a></td> |
262 |
|
|
<td CLASS="font10">Set the title for the widget.</td> |
263 |
|
|
<tr> |
264 |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/BaseWidget.html#methodset_width">BaseWidget::set_width()</a></td> |
265 |
|
|
<td CLASS="font10">Set the width for the widget.</td> |
266 |
|
|
</table> |
267 |
|
|
<br> |
268 |
|
|
</TD> |
269 |
|
|
</TR> |
270 |
|
|
<!-- =========== Summary =========== --> |
271 |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
272 |
|
|
<TD> |
273 |
|
|
<span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/Container.html">Container</a></span> |
274 |
|
|
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center"> |
275 |
|
|
<tr CLASS="tableheadingcolor"> |
276 |
|
|
<th>Function</th> |
277 |
|
|
<th>Description</th> |
278 |
|
|
</tr> |
279 |
|
|
<tr> |
280 |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodContainer">Container::Container()</a></td> |
281 |
|
|
<td CLASS="font10">The constructor.</td> |
282 |
|
|
<tr> |
283 |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodadd">Container::add()</a></td> |
284 |
|
|
<td CLASS="font10">add content onto content stack</td> |
285 |
|
|
<tr> |
286 |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodadd_reference">Container::add_reference()</a></td> |
287 |
|
|
<td CLASS="font10">Add content onto content stack so you can change the item later.</td> |
288 |
|
|
<tr> |
289 |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodcount_content">Container::count_content()</a></td> |
290 |
|
|
<td CLASS="font10">counts the number of content objects</td> |
291 |
|
|
<tr> |
292 |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodget_indent_flag">Container::get_indent_flag()</a></td> |
293 |
|
|
<td CLASS="font10">This flag gets the current value of the indent flag</td> |
294 |
|
|
<tr> |
295 |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodpush">Container::push()</a></td> |
296 |
|
|
<td CLASS="font10">Same as add().</td> |
297 |
|
|
<tr> |
298 |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodpush_reference">Container::push_reference()</a></td> |
299 |
|
|
<td CLASS="font10">Same as add_reference NOTE : only exists for compatibility with 1.1.x</td> |
300 |
|
|
<tr> |
301 |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodrender">Container::render()</a></td> |
302 |
|
|
<td CLASS="font10">This function is compatible with the rest of the phpHtmllib API spec.</td> |
303 |
|
|
<tr> |
304 |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodreset_content">Container::reset_content()</a></td> |
305 |
|
|
<td CLASS="font10">destroy existing content and start with new content.</td> |
306 |
|
|
<tr> |
307 |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodset_collapse">Container::set_collapse()</a></td> |
308 |
|
|
<td CLASS="font10">This function turns on the collapse flag</td> |
309 |
|
|
<tr> |
310 |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodset_indent_flag">Container::set_indent_flag()</a></td> |
311 |
|
|
<td CLASS="font10">function to set the indent flag</td> |
312 |
|
|
<tr> |
313 |
|
|
<td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#method_set_flags">Container::_set_flags()</a></td> |
314 |
|
|
<td CLASS="font10">This method is used to set the bitmask flags for this tag. It tells the class how to render the tag.</td> |
315 |
|
|
</table> |
316 |
|
|
<br> |
317 |
|
|
</TD> |
318 |
|
|
</TR> |
319 |
|
|
</TABLE> |
320 |
jonen |
1.1 |
<hr> |
321 |
|
|
<!-- ============ VARIABLE DETAIL =========== --> |
322 |
|
|
|
323 |
|
|
<A NAME='variable_detail'></A> |
324 |
|
|
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
325 |
|
|
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
326 |
|
|
<TD> |
327 |
|
|
<span CLASS="font12bold">Variable Detail</span> |
328 |
|
|
<A HREF="#top" CLASS="links">^TOP</A> |
329 |
|
|
</TD> |
330 |
|
|
</TR> |
331 |
|
|
</TABLE> |
332 |
|
|
|
333 |
|
|
<hr> |
334 |
jonen |
1.2 |
<!-- ============ METHOD DETAIL =========== --> |
335 |
jonen |
1.1 |
|
336 |
jonen |
1.2 |
<A NAME='method_detail'></A> |
337 |
jonen |
1.1 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
338 |
|
|
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
339 |
|
|
<TD> |
340 |
|
|
<span class="font12bold">Method Detail</span> |
341 |
|
|
<A HREF="#top" CLASS="links">^TOP</A> |
342 |
|
|
</TD> |
343 |
|
|
</TR> |
344 |
|
|
</TABLE> |
345 |
|
|
<BR> |
346 |
|
|
<DIV CLASS="function"> |
347 |
jonen |
1.2 |
<A NAME='methodFooterNav'><!-- --></A> |
348 |
|
|
<SPAN CLASS="font12bold">Constructor FooterNav</SPAN> (line <span class="linenumber">96</span>) |
349 |
jonen |
1.1 |
<BR> |
350 |
jonen |
1.2 |
<SPAN CLASS="font10bold">Usage : </SPAN> |
351 |
jonen |
1.1 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
352 |
jonen |
1.2 |
<span class="font10bold" style="color: #0000FF">FooterNav( |
353 |
|
|
[string |
354 |
|
|
$company_name = ""], [string |
355 |
|
|
$date_str = NULL])</SPAN> |
356 |
jonen |
1.1 |
<BR> |
357 |
|
|
|
358 |
|
|
<BR> |
359 |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
360 |
|
|
Constructore for this class. |
361 |
jonen |
1.2 |
<br /> |
362 |
jonen |
1.1 |
|
363 |
|
|
<DL> |
364 |
jonen |
1.2 |
<DT class="font10bold">Function Parameters:</DT> |
365 |
|
|
<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 - copyright</DD> |
366 |
|
|
<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 for the copyright.</DD> |
367 |
|
|
|
368 |
|
|
<DT class="font10bold">Function Info:</DT> |
369 |
|
|
</DL> |
370 |
jonen |
1.1 |
</DIV> |
371 |
|
|
<BR> |
372 |
|
|
<DIV CLASS="function"> |
373 |
jonen |
1.2 |
<A NAME='methodadd'><!-- --></A> |
374 |
|
|
<SPAN CLASS="font12bold">add</SPAN> (line <span class="linenumber">177</span>) |
375 |
jonen |
1.1 |
<BR> |
376 |
jonen |
1.2 |
<SPAN CLASS="font10bold">Usage : </SPAN> |
377 |
jonen |
1.1 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
378 |
jonen |
1.2 |
<span class="font10bold" style="color: #0000FF">add( |
379 |
|
|
string |
380 |
|
|
$url, text |
381 |
|
|
$text)</SPAN> |
382 |
jonen |
1.1 |
<BR> |
383 |
|
|
|
384 |
|
|
<BR> |
385 |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
386 |
|
|
add an entry to the footer nav |
387 |
jonen |
1.2 |
<br /> |
388 |
jonen |
1.1 |
|
389 |
|
|
<DL> |
390 |
jonen |
1.2 |
<DT class="font10bold">Function Parameters:</DT> |
391 |
|
|
<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 - url to go to</DD> |
392 |
|
|
<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> - $text - url text to click on.</DD> |
393 |
|
|
|
394 |
|
|
<DT class="font10bold">Function Info:</DT> |
395 |
|
|
</DL> |
396 |
jonen |
1.1 |
</DIV> |
397 |
|
|
<BR> |
398 |
|
|
<DIV CLASS="function"> |
399 |
jonen |
1.2 |
<A NAME='methodbuild_copyright_header'><!-- --></A> |
400 |
|
|
<SPAN CLASS="font12bold">build_copyright_header</SPAN> (line <span class="linenumber">254</span>) |
401 |
jonen |
1.1 |
<BR> |
402 |
jonen |
1.2 |
<SPAN CLASS="font10bold">Usage : </SPAN> |
403 |
jonen |
1.1 |
<span class="font10bold" style="color: #FF0000"><a href="../phpHtmlLib/SPANtag.html">SPANtag</a></SPAN> |
404 |
jonen |
1.2 |
<span class="font10bold" style="color: #0000FF">build_copyright_header( |
405 |
|
|
)</SPAN> |
406 |
jonen |
1.1 |
<BR> |
407 |
|
|
|
408 |
|
|
<BR> |
409 |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
410 |
|
|
render the copyright string |
411 |
jonen |
1.2 |
<br /> |
412 |
jonen |
1.1 |
|
413 |
|
|
<DL> |
414 |
|
|
|
415 |
jonen |
1.2 |
<DT class="font10bold">Function Info:</DT> |
416 |
|
|
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>return</b> - object that contains the copyright header.</DD> |
417 |
|
|
</DL> |
418 |
jonen |
1.1 |
</DIV> |
419 |
|
|
<BR> |
420 |
|
|
<DIV CLASS="function"> |
421 |
jonen |
1.2 |
<A NAME='methodbuild_wrapper_table'><!-- --></A> |
422 |
|
|
<SPAN CLASS="font12bold">build_wrapper_table</SPAN> (line <span class="linenumber">283</span>) |
423 |
jonen |
1.1 |
<BR> |
424 |
jonen |
1.2 |
<SPAN CLASS="font10bold">Usage : </SPAN> |
425 |
jonen |
1.1 |
<span class="font10bold" style="color: #FF0000"><a href="../phpHtmlLib/TABLEtag.html">TABLEtag</a></SPAN> |
426 |
jonen |
1.2 |
<span class="font10bold" style="color: #0000FF">build_wrapper_table( |
427 |
|
|
)</SPAN> |
428 |
jonen |
1.1 |
<BR> |
429 |
|
|
|
430 |
|
|
<BR> |
431 |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
432 |
|
|
builds the wrapper table |
433 |
jonen |
1.2 |
<br /> |
434 |
jonen |
1.1 |
|
435 |
|
|
<DL> |
436 |
|
|
|
437 |
jonen |
1.2 |
<DT class="font10bold">Function Info:</DT> |
438 |
|
|
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>return</b> - object.</DD> |
439 |
|
|
</DL> |
440 |
jonen |
1.1 |
</DIV> |
441 |
|
|
<BR> |
442 |
|
|
<DIV CLASS="function"> |
443 |
jonen |
1.2 |
<A NAME='methodpush'><!-- --></A> |
444 |
|
|
<SPAN CLASS="font12bold">push</SPAN> (line <span class="linenumber">190</span>) |
445 |
jonen |
1.1 |
<BR> |
446 |
jonen |
1.2 |
<SPAN CLASS="font10bold">Usage : </SPAN> |
447 |
jonen |
1.1 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
448 |
jonen |
1.2 |
<span class="font10bold" style="color: #0000FF">push( |
449 |
|
|
string |
450 |
|
|
$url, text |
451 |
|
|
$text)</SPAN> |
452 |
jonen |
1.1 |
<BR> |
453 |
|
|
|
454 |
|
|
<BR> |
455 |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
456 |
|
|
add an entry to the footer nav. |
457 |
jonen |
1.2 |
<br /> |
458 |
jonen |
1.1 |
|
459 |
|
|
<DL> |
460 |
jonen |
1.2 |
<DT class="font10bold">Function Parameters:</DT> |
461 |
|
|
<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 - url to go to</DD> |
462 |
|
|
<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> - $text - url text to click on.</DD> |
463 |
|
|
|
464 |
|
|
<DT class="font10bold">Function Info:</DT> |
465 |
|
|
</DL> |
466 |
jonen |
1.1 |
</DIV> |
467 |
|
|
<BR> |
468 |
|
|
<DIV CLASS="function"> |
469 |
jonen |
1.2 |
<A NAME='methodrender'><!-- --></A> |
470 |
|
|
<SPAN CLASS="font12bold">render</SPAN> (line <span class="linenumber">211</span>) |
471 |
jonen |
1.1 |
<BR> |
472 |
jonen |
1.2 |
<SPAN CLASS="font10bold">Usage : </SPAN> |
473 |
jonen |
1.1 |
<span class="font10bold" style="color: #FF0000">string</SPAN> |
474 |
jonen |
1.2 |
<span class="font10bold" style="color: #0000FF">render( |
475 |
|
|
[int |
476 |
|
|
$indent_level = 1], int |
477 |
|
|
$output_debug)</SPAN> |
478 |
jonen |
1.1 |
<BR> |
479 |
|
|
|
480 |
|
|
<BR> |
481 |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
482 |
|
|
render the code for this widget. |
483 |
jonen |
1.2 |
<br /> |
484 |
jonen |
1.1 |
|
485 |
|
|
<DL> |
486 |
jonen |
1.2 |
<DT class="font10bold">Function Parameters:</DT> |
487 |
|
|
<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 the container.</DD> |
488 |
|
|
<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 maintain compatibility w/ the API.</DD> |
489 |
|
|
|
490 |
|
|
<DT class="font10bold">Function Info:</DT> |
491 |
|
|
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>return</b> - the raw html output.</DD> |
492 |
|
|
</DL> |
493 |
jonen |
1.1 |
</DIV> |
494 |
|
|
<BR> |
495 |
|
|
<DIV CLASS="function"> |
496 |
jonen |
1.2 |
<A NAME='methodset_company_name'><!-- --></A> |
497 |
|
|
<SPAN CLASS="font12bold">set_company_name</SPAN> (line <span class="linenumber">112</span>) |
498 |
jonen |
1.1 |
<BR> |
499 |
jonen |
1.2 |
<SPAN CLASS="font10bold">Usage : </SPAN> |
500 |
jonen |
1.1 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
501 |
jonen |
1.2 |
<span class="font10bold" style="color: #0000FF">set_company_name( |
502 |
|
|
string |
503 |
|
|
$name)</SPAN> |
504 |
jonen |
1.1 |
<BR> |
505 |
|
|
|
506 |
|
|
<BR> |
507 |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
508 |
jonen |
1.2 |
set the company name for the copyright statement. |
509 |
|
|
<br /> |
510 |
jonen |
1.1 |
|
511 |
|
|
<DL> |
512 |
jonen |
1.2 |
<DT class="font10bold">Function Parameters:</DT> |
513 |
|
|
<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> - $name</DD> |
514 |
|
|
|
515 |
|
|
<DT class="font10bold">Function Info:</DT> |
516 |
|
|
</DL> |
517 |
jonen |
1.1 |
</DIV> |
518 |
|
|
<BR> |
519 |
|
|
<DIV CLASS="function"> |
520 |
jonen |
1.2 |
<A NAME='methodset_copyright_flag'><!-- --></A> |
521 |
|
|
<SPAN CLASS="font12bold">set_copyright_flag</SPAN> (line <span class="linenumber">133</span>) |
522 |
jonen |
1.1 |
<BR> |
523 |
jonen |
1.2 |
<SPAN CLASS="font10bold">Usage : </SPAN> |
524 |
jonen |
1.1 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
525 |
jonen |
1.2 |
<span class="font10bold" style="color: #0000FF">set_copyright_flag( |
526 |
|
|
boolean |
527 |
|
|
$flag)</SPAN> |
528 |
jonen |
1.1 |
<BR> |
529 |
|
|
|
530 |
|
|
<BR> |
531 |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
532 |
jonen |
1.2 |
set/unset the flag to tell us to render the copyright string |
533 |
|
|
<br /> |
534 |
jonen |
1.1 |
|
535 |
|
|
<DL> |
536 |
jonen |
1.2 |
<DT class="font10bold">Function Parameters:</DT> |
537 |
|
|
<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> - $flag</DD> |
538 |
|
|
|
539 |
|
|
<DT class="font10bold">Function Info:</DT> |
540 |
|
|
</DL> |
541 |
jonen |
1.1 |
</DIV> |
542 |
|
|
<BR> |
543 |
|
|
<DIV CLASS="function"> |
544 |
jonen |
1.2 |
<A NAME='methodset_date_string'><!-- --></A> |
545 |
|
|
<SPAN CLASS="font12bold">set_date_string</SPAN> (line <span class="linenumber">123</span>) |
546 |
jonen |
1.1 |
<BR> |
547 |
jonen |
1.2 |
<SPAN CLASS="font10bold">Usage : </SPAN> |
548 |
jonen |
1.1 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
549 |
jonen |
1.2 |
<span class="font10bold" style="color: #0000FF">set_date_string( |
550 |
|
|
string |
551 |
|
|
$date_str)</SPAN> |
552 |
jonen |
1.1 |
<BR> |
553 |
|
|
|
554 |
|
|
<BR> |
555 |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
556 |
|
|
set the date string for the copyright. |
557 |
jonen |
1.2 |
<br /> |
558 |
|
|
<p>in the form of "2001-1997", or "2001".</p> |
559 |
jonen |
1.1 |
<DL> |
560 |
jonen |
1.2 |
<DT class="font10bold">Function Parameters:</DT> |
561 |
|
|
<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> - $date_str</DD> |
562 |
|
|
|
563 |
|
|
<DT class="font10bold">Function Info:</DT> |
564 |
|
|
</DL> |
565 |
jonen |
1.1 |
</DIV> |
566 |
|
|
<BR> |
567 |
|
|
<DIV CLASS="function"> |
568 |
jonen |
1.2 |
<A NAME='methodset_legalnotice_url'><!-- --></A> |
569 |
|
|
<SPAN CLASS="font12bold">set_legalnotice_url</SPAN> (line <span class="linenumber">144</span>) |
570 |
jonen |
1.1 |
<BR> |
571 |
jonen |
1.2 |
<SPAN CLASS="font10bold">Usage : </SPAN> |
572 |
jonen |
1.1 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
573 |
jonen |
1.2 |
<span class="font10bold" style="color: #0000FF">set_legalnotice_url( |
574 |
|
|
string |
575 |
|
|
$url)</SPAN> |
576 |
jonen |
1.1 |
<BR> |
577 |
|
|
|
578 |
|
|
<BR> |
579 |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
580 |
|
|
set the legal notice url. |
581 |
jonen |
1.2 |
<br /> |
582 |
|
|
<p>if this is set we show the legal notice link that points to $url.</p> |
583 |
jonen |
1.1 |
<DL> |
584 |
jonen |
1.2 |
<DT class="font10bold">Function Parameters:</DT> |
585 |
|
|
<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</DD> |
586 |
|
|
|
587 |
|
|
<DT class="font10bold">Function Info:</DT> |
588 |
|
|
</DL> |
589 |
jonen |
1.1 |
</DIV> |
590 |
|
|
<BR> |
591 |
|
|
<DIV CLASS="function"> |
592 |
jonen |
1.2 |
<A NAME='methodset_privacypolicy_url'><!-- --></A> |
593 |
|
|
<SPAN CLASS="font12bold">set_privacypolicy_url</SPAN> (line <span class="linenumber">155</span>) |
594 |
jonen |
1.1 |
<BR> |
595 |
jonen |
1.2 |
<SPAN CLASS="font10bold">Usage : </SPAN> |
596 |
jonen |
1.1 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
597 |
jonen |
1.2 |
<span class="font10bold" style="color: #0000FF">set_privacypolicy_url( |
598 |
|
|
string |
599 |
|
|
$url)</SPAN> |
600 |
jonen |
1.1 |
<BR> |
601 |
|
|
|
602 |
|
|
<BR> |
603 |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
604 |
|
|
sets the Privacy policy url. |
605 |
jonen |
1.2 |
<br /> |
606 |
|
|
<p>if this is set we show the privacy policy link that points to $url</p> |
607 |
jonen |
1.1 |
<DL> |
608 |
jonen |
1.2 |
<DT class="font10bold">Function Parameters:</DT> |
609 |
|
|
<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</DD> |
610 |
|
|
|
611 |
|
|
<DT class="font10bold">Function Info:</DT> |
612 |
|
|
</DL> |
613 |
jonen |
1.1 |
</DIV> |
614 |
|
|
<BR> |
615 |
|
|
<DIV CLASS="function"> |
616 |
jonen |
1.2 |
<A NAME='methodset_webmaster_email'><!-- --></A> |
617 |
|
|
<SPAN CLASS="font12bold">set_webmaster_email</SPAN> (line <span class="linenumber">166</span>) |
618 |
jonen |
1.1 |
<BR> |
619 |
jonen |
1.2 |
<SPAN CLASS="font10bold">Usage : </SPAN> |
620 |
jonen |
1.1 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
621 |
jonen |
1.2 |
<span class="font10bold" style="color: #0000FF">set_webmaster_email( |
622 |
|
|
string |
623 |
|
|
$email)</SPAN> |
624 |
jonen |
1.1 |
<BR> |
625 |
|
|
|
626 |
|
|
<BR> |
627 |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
628 |
jonen |
1.2 |
sets the Webmaster email address if this is set we show the mailto for this email |
629 |
|
|
<br /> |
630 |
|
|
|
631 |
jonen |
1.1 |
<DL> |
632 |
jonen |
1.2 |
<DT class="font10bold">Function Parameters:</DT> |
633 |
|
|
<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> - $email</DD> |
634 |
|
|
|
635 |
|
|
<DT class="font10bold">Function Info:</DT> |
636 |
|
|
</DL> |
637 |
jonen |
1.1 |
</DIV> |
638 |
|
|
<BR> |
639 |
jonen |
1.2 |
<div id="credit"> |
640 |
|
|
<hr> |
641 |
|
|
Documention generated on Thu, 20 Feb 2003 16:22:49 -0800 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.0rc1</a> |
642 |
|
|
</div> |
643 |
|
|
</body> |
644 |
|
|
</html> |