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

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

Parent Directory Parent Directory | Revision Log Revision Log

Revision 1.4 - (show annotations)
Thu May 6 16:24:20 2004 UTC (21 years, 6 months ago) by jonen
Branch: MAIN
CVS Tags: HEAD
Changes since 1.3: +552 -556 lines
File MIME type: text/html
Error occurred while calculating annotation data. 
 updated all to v2.4.1 - Apr 01, 2004
1 <?xml version="1.0" encoding="iso-8859-1"?>
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml">
4 <head>
5 <!-- template designed by Marco Von Ballmoos -->
6 <title>Docs For Class FooterNav</title>
7 <link rel="stylesheet" href="../media/stylesheet.css" />
8 <meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
9 </head>
10 <body>
11 <div class="page-body">
12
13 <h2 class="class-name">Class FooterNav</h2>
14
15 <a name="sec-description"></a>
16 <div class="info-box">
17 <div class="info-box-title">Description</div>
18 <div class="nav-bar">
19 <span class="disabled">Description</span> |
20 <a href="#sec-vars">Vars</a>
21 | <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
22
23 </div>
24 <div class="info-box-body">
25 <!-- ========== Info from phpDoc block ========= -->
26 <p class="short-description">Use this class to render footer navigation that is displayed at the bottom of a page.</p>
27 <ul class="tags">
28 <li><span class="field">author:</span> Walter A. Boring IV &lt;<a href="mailto:waboring@buildabetterweb.com">waboring@buildabetterweb.com</a>&gt;</li>
29 </ul>
30 <p class="notes">
31 Located in <a class="field" href="_widgets_FooterNav_inc.html">/widgets/FooterNav.inc</a> (line <span class="field">26</span>)
32 </p>
33
34
35 <pre><a href="../phpHtmlLib/Container.html">Container</a>
36 |
37 --<a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a>
38 |
39 --FooterNav</pre>
40
41 </div>
42 </div>
43
44
45
46
47 <a name="sec-method-summary"></a>
48 <div class="info-box">
49 <div class="info-box-title">Method Summary</span></div>
50 <div class="nav-bar">
51 <a href="#sec-description">Description</a> |
52 <a href="#sec-vars">Vars</a>
53
54 |
55 <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
56 </div>
57 <div class="info-box-body">
58 <div class="method-summary">
59
60 <div class="method-definition">
61 <span class="method-result">FooterNav</span>
62 <a href="#FooterNav" title="details" class="method-name">FooterNav</a>
63 ([<span class="var-type">string</span>&nbsp;<span class="var-name">$company_name</span> = <span class="var-default">""</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$date_str</span> = <span class="var-default">NULL</span>])
64 </div>
65
66 <div class="method-definition">
67 <span class="method-result">void</span>
68 <a href="#add" title="details" class="method-name">add</a>
69 (<span class="var-type">string</span>&nbsp;<span class="var-name">$url</span>, <span class="var-type">text</span>&nbsp;<span class="var-name">$text</span>)
70 </div>
71
72 <div class="method-definition">
73 <span class="method-result"><a href="../phpHtmlLib/SPANtag.html">SPANtag</a></span>
74 <a href="#build_copyright_header" title="details" class="method-name">build_copyright_header</a>
75 ()
76 </div>
77
78 <div class="method-definition">
79 <span class="method-result"><a href="../phpHtmlLib/TABLEtag.html">TABLEtag</a></span>
80 <a href="#build_wrapper_table" title="details" class="method-name">build_wrapper_table</a>
81 ()
82 </div>
83
84 <div class="method-definition">
85 <span class="method-result">void</span>
86 <a href="#push" title="details" class="method-name">push</a>
87 (<span class="var-type">string</span>&nbsp;<span class="var-name">$url</span>, <span class="var-type">text</span>&nbsp;<span class="var-name">$text</span>)
88 </div>
89
90 <div class="method-definition">
91 <span class="method-result">string</span>
92 <a href="#render" title="details" class="method-name">render</a>
93 ([<span class="var-type">int</span>&nbsp;<span class="var-name">$indent_level</span> = <span class="var-default">1</span>], <span class="var-type">int</span>&nbsp;<span class="var-name">$output_debug</span>)
94 </div>
95
96 <div class="method-definition">
97 <span class="method-result">void</span>
98 <a href="#set_company_name" title="details" class="method-name">set_company_name</a>
99 (<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>)
100 </div>
101
102 <div class="method-definition">
103 <span class="method-result">void</span>
104 <a href="#set_copyright_flag" title="details" class="method-name">set_copyright_flag</a>
105 (<span class="var-type">boolean</span>&nbsp;<span class="var-name">$flag</span>)
106 </div>
107
108 <div class="method-definition">
109 <span class="method-result">void</span>
110 <a href="#set_date_string" title="details" class="method-name">set_date_string</a>
111 (<span class="var-type">string</span>&nbsp;<span class="var-name">$date_str</span>)
112 </div>
113
114 <div class="method-definition">
115 <span class="method-result">void</span>
116 <a href="#set_legalnotice_url" title="details" class="method-name">set_legalnotice_url</a>
117 (<span class="var-type">string</span>&nbsp;<span class="var-name">$url</span>)
118 </div>
119
120 <div class="method-definition">
121 <span class="method-result">void</span>
122 <a href="#set_privacypolicy_url" title="details" class="method-name">set_privacypolicy_url</a>
123 (<span class="var-type">string</span>&nbsp;<span class="var-name">$url</span>)
124 </div>
125
126 <div class="method-definition">
127 <span class="method-result">void</span>
128 <a href="#set_webmaster_email" title="details" class="method-name">set_webmaster_email</a>
129 (<span class="var-type">string</span>&nbsp;<span class="var-name">$email</span>)
130 </div>
131 </div>
132 </div>
133 </div>
134
135 <a name="sec-vars"></a>
136 <div class="info-box">
137 <div class="info-box-title">Variables</div>
138 <div class="nav-bar">
139 <a href="#sec-description">Description</a> |
140 <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
141
142
143 |
144 <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
145
146 </div>
147 <div class="info-box-body">
148
149 <h4>Inherited Variables</h4>
150 <A NAME='inherited_vars'><!-- --></A>
151 <p>Inherited from <span class="classname"><a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a></span></p>
152 <blockquote>
153 <span class="var-title">
154 <span class="var-name"><a href="../phpHtmlLib/BaseWidget.html#var$title">BaseWidget::$title</a></span><br>
155 </span>
156 <span class="var-title">
157 <span class="var-name"><a href="../phpHtmlLib/BaseWidget.html#var$width">BaseWidget::$width</a></span><br>
158 </span>
159 </blockquote>
160
161 </div>
162 </div>
163
164 <a name="sec-methods"></a>
165 <div class="info-box">
166 <div class="info-box-title">Methods</div>
167 <div class="nav-bar">
168 <a href="#sec-description">Description</a> |
169 <a href="#sec-vars">Vars</a>
170 <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
171
172 </div>
173 <div class="info-box-body">
174 <A NAME='method_detail'></A>
175 <a name="methodFooterNav" id="FooterNav"><!-- --></a>
176 <div class="oddrow">
177
178 <div class="method-header">
179 <span class="method-title">Constructor FooterNav</span> (line <span class="line-number">96</span>)
180 </div>
181
182 <!-- ========== Info from phpDoc block ========= -->
183 <p class="short-description">Constructore for this class.</p>
184
185 <div class="method-signature">
186 <span class="method-result">FooterNav</span>
187 <span class="method-name">
188 FooterNav
189 </span>
190 ([<span class="var-type">string</span>&nbsp;<span class="var-name">$company_name</span> = <span class="var-default">""</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$date_str</span> = <span class="var-default">NULL</span>])
191 </div>
192
193 <ul class="parameters">
194 <li>
195 <span class="var-type">string</span>
196 <span class="var-name">$company_name</span><span class="var-description">: - used in the <ul><li>copyright</li></ul></span> </li>
197 <li>
198 <span class="var-type">string</span>
199 <span class="var-name">$date_str</span><span class="var-description">: - a date string to be used for the copyright.</span> </li>
200 </ul>
201
202
203 </div>
204 <a name="methodadd" id="add"><!-- --></a>
205 <div class="evenrow">
206
207 <div class="method-header">
208 <span class="method-title">add</span> (line <span class="line-number">177</span>)
209 </div>
210
211 <!-- ========== Info from phpDoc block ========= -->
212 <p class="short-description">add an entry to the footer nav</p>
213
214 <div class="method-signature">
215 <span class="method-result">void</span>
216 <span class="method-name">
217 add
218 </span>
219 (<span class="var-type">string</span>&nbsp;<span class="var-name">$url</span>, <span class="var-type">text</span>&nbsp;<span class="var-name">$text</span>)
220 </div>
221
222 <ul class="parameters">
223 <li>
224 <span class="var-type">string</span>
225 <span class="var-name">$url</span><span class="var-description">: - $url - url to go to</span> </li>
226 <li>
227 <span class="var-type">text</span>
228 <span class="var-name">$text</span><span class="var-description">: - $text - url text to click on.</span> </li>
229 </ul>
230
231 <hr class="separator" />
232 <div class="notes">Redefinition of:</div>
233 <dl>
234 <dt><a href="../phpHtmlLib/Container.html#methodadd">Container::add()</a></dt>
235 <dd>add content onto content stack</dd>
236 </dl>
237
238 </div>
239 <a name="methodbuild_copyright_header" id="build_copyright_header"><!-- --></a>
240 <div class="oddrow">
241
242 <div class="method-header">
243 <span class="method-title">build_copyright_header</span> (line <span class="line-number">254</span>)
244 </div>
245
246 <!-- ========== Info from phpDoc block ========= -->
247 <p class="short-description">render the copyright string</p>
248 <ul class="tags">
249 <li><span class="field">return:</span> object that contains the copyright header.</li>
250 </ul>
251
252 <div class="method-signature">
253 <span class="method-result"><a href="../phpHtmlLib/SPANtag.html">SPANtag</a></span>
254 <span class="method-name">
255 build_copyright_header
256 </span>
257 ()
258 </div>
259
260
261
262 </div>
263 <a name="methodbuild_wrapper_table" id="build_wrapper_table"><!-- --></a>
264 <div class="evenrow">
265
266 <div class="method-header">
267 <span class="method-title">build_wrapper_table</span> (line <span class="line-number">283</span>)
268 </div>
269
270 <!-- ========== Info from phpDoc block ========= -->
271 <p class="short-description">builds the wrapper table</p>
272 <ul class="tags">
273 <li><span class="field">return:</span> object.</li>
274 </ul>
275
276 <div class="method-signature">
277 <span class="method-result"><a href="../phpHtmlLib/TABLEtag.html">TABLEtag</a></span>
278 <span class="method-name">
279 build_wrapper_table
280 </span>
281 ()
282 </div>
283
284
285
286 </div>
287 <a name="methodpush" id="push"><!-- --></a>
288 <div class="oddrow">
289
290 <div class="method-header">
291 <span class="method-title">push</span> (line <span class="line-number">190</span>)
292 </div>
293
294 <!-- ========== Info from phpDoc block ========= -->
295 <p class="short-description">add an entry to the footer nav.</p>
296
297 <div class="method-signature">
298 <span class="method-result">void</span>
299 <span class="method-name">
300 push
301 </span>
302 (<span class="var-type">string</span>&nbsp;<span class="var-name">$url</span>, <span class="var-type">text</span>&nbsp;<span class="var-name">$text</span>)
303 </div>
304
305 <ul class="parameters">
306 <li>
307 <span class="var-type">string</span>
308 <span class="var-name">$url</span><span class="var-description">: - $url - url to go to</span> </li>
309 <li>
310 <span class="var-type">text</span>
311 <span class="var-name">$text</span><span class="var-description">: - $text - url text to click on.</span> </li>
312 </ul>
313
314 <hr class="separator" />
315 <div class="notes">Redefinition of:</div>
316 <dl>
317 <dt><a href="../phpHtmlLib/Container.html#methodpush">Container::push()</a></dt>
318 <dd>Same as add().</dd>
319 </dl>
320
321 </div>
322 <a name="methodrender" id="render"><!-- --></a>
323 <div class="evenrow">
324
325 <div class="method-header">
326 <span class="method-title">render</span> (line <span class="line-number">211</span>)
327 </div>
328
329 <!-- ========== Info from phpDoc block ========= -->
330 <p class="short-description">render the code for this widget.</p>
331 <ul class="tags">
332 <li><span class="field">return:</span> the raw html output.</li>
333 </ul>
334
335 <div class="method-signature">
336 <span class="method-result">string</span>
337 <span class="method-name">
338 render
339 </span>
340 ([<span class="var-type">int</span>&nbsp;<span class="var-name">$indent_level</span> = <span class="var-default">1</span>], <span class="var-type">int</span>&nbsp;<span class="var-name">$output_debug</span>)
341 </div>
342
343 <ul class="parameters">
344 <li>
345 <span class="var-type">int</span>
346 <span class="var-name">$indent_level</span><span class="var-description">: - the indentation level for the container.</span> </li>
347 <li>
348 <span class="var-type">int</span>
349 <span class="var-name">$output_debug</span><span class="var-description">: - the output debug flag to maintain compatibility w/ the API.</span> </li>
350 </ul>
351
352 <hr class="separator" />
353 <div class="notes">Redefinition of:</div>
354 <dl>
355 <dt><a href="../phpHtmlLib/Container.html#methodrender">Container::render()</a></dt>
356 <dd>This function is compatible with the rest of the phpHtmllib API spec.</dd>
357 </dl>
358
359 </div>
360 <a name="methodset_company_name" id="set_company_name"><!-- --></a>
361 <div class="oddrow">
362
363 <div class="method-header">
364 <span class="method-title">set_company_name</span> (line <span class="line-number">112</span>)
365 </div>
366
367 <!-- ========== Info from phpDoc block ========= -->
368 <p class="short-description">set the company name for the copyright statement.</p>
369
370 <div class="method-signature">
371 <span class="method-result">void</span>
372 <span class="method-name">
373 set_company_name
374 </span>
375 (<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>)
376 </div>
377
378 <ul class="parameters">
379 <li>
380 <span class="var-type">string</span>
381 <span class="var-name">$name</span><span class="var-description">: - $name</span> </li>
382 </ul>
383
384
385 </div>
386 <a name="methodset_copyright_flag" id="set_copyright_flag"><!-- --></a>
387 <div class="evenrow">
388
389 <div class="method-header">
390 <span class="method-title">set_copyright_flag</span> (line <span class="line-number">133</span>)
391 </div>
392
393 <!-- ========== Info from phpDoc block ========= -->
394 <p class="short-description">set/unset the flag to tell us to render the copyright string</p>
395
396 <div class="method-signature">
397 <span class="method-result">void</span>
398 <span class="method-name">
399 set_copyright_flag
400 </span>
401 (<span class="var-type">boolean</span>&nbsp;<span class="var-name">$flag</span>)
402 </div>
403
404 <ul class="parameters">
405 <li>
406 <span class="var-type">boolean</span>
407 <span class="var-name">$flag</span><span class="var-description">: - $flag</span> </li>
408 </ul>
409
410
411 </div>
412 <a name="methodset_date_string" id="set_date_string"><!-- --></a>
413 <div class="oddrow">
414
415 <div class="method-header">
416 <span class="method-title">set_date_string</span> (line <span class="line-number">123</span>)
417 </div>
418
419 <!-- ========== Info from phpDoc block ========= -->
420 <p class="short-description">set the date string for the copyright.</p>
421 <p class="description"><p>in the form of &quot;2001-1997&quot;, or &quot;2001&quot;.</p></p>
422
423 <div class="method-signature">
424 <span class="method-result">void</span>
425 <span class="method-name">
426 set_date_string
427 </span>
428 (<span class="var-type">string</span>&nbsp;<span class="var-name">$date_str</span>)
429 </div>
430
431 <ul class="parameters">
432 <li>
433 <span class="var-type">string</span>
434 <span class="var-name">$date_str</span><span class="var-description">: - $date_str</span> </li>
435 </ul>
436
437
438 </div>
439 <a name="methodset_legalnotice_url" id="set_legalnotice_url"><!-- --></a>
440 <div class="evenrow">
441
442 <div class="method-header">
443 <span class="method-title">set_legalnotice_url</span> (line <span class="line-number">144</span>)
444 </div>
445
446 <!-- ========== Info from phpDoc block ========= -->
447 <p class="short-description">set the legal notice url.</p>
448 <p class="description"><p>if this is set we show the legal notice link that points to $url.</p></p>
449
450 <div class="method-signature">
451 <span class="method-result">void</span>
452 <span class="method-name">
453 set_legalnotice_url
454 </span>
455 (<span class="var-type">string</span>&nbsp;<span class="var-name">$url</span>)
456 </div>
457
458 <ul class="parameters">
459 <li>
460 <span class="var-type">string</span>
461 <span class="var-name">$url</span><span class="var-description">: - $url</span> </li>
462 </ul>
463
464
465 </div>
466 <a name="methodset_privacypolicy_url" id="set_privacypolicy_url"><!-- --></a>
467 <div class="oddrow">
468
469 <div class="method-header">
470 <span class="method-title">set_privacypolicy_url</span> (line <span class="line-number">155</span>)
471 </div>
472
473 <!-- ========== Info from phpDoc block ========= -->
474 <p class="short-description">sets the Privacy policy url.</p>
475 <p class="description"><p>if this is set we show the privacy policy link that points to $url</p></p>
476
477 <div class="method-signature">
478 <span class="method-result">void</span>
479 <span class="method-name">
480 set_privacypolicy_url
481 </span>
482 (<span class="var-type">string</span>&nbsp;<span class="var-name">$url</span>)
483 </div>
484
485 <ul class="parameters">
486 <li>
487 <span class="var-type">string</span>
488 <span class="var-name">$url</span><span class="var-description">: - $url</span> </li>
489 </ul>
490
491
492 </div>
493 <a name="methodset_webmaster_email" id="set_webmaster_email"><!-- --></a>
494 <div class="evenrow">
495
496 <div class="method-header">
497 <span class="method-title">set_webmaster_email</span> (line <span class="line-number">166</span>)
498 </div>
499
500 <!-- ========== Info from phpDoc block ========= -->
501 <p class="short-description">sets the Webmaster email address if this is set we show the mailto for this email</p>
502
503 <div class="method-signature">
504 <span class="method-result">void</span>
505 <span class="method-name">
506 set_webmaster_email
507 </span>
508 (<span class="var-type">string</span>&nbsp;<span class="var-name">$email</span>)
509 </div>
510
511 <ul class="parameters">
512 <li>
513 <span class="var-type">string</span>
514 <span class="var-name">$email</span><span class="var-description">: - $email</span> </li>
515 </ul>
516
517
518 </div>
519 <h4>Inherited Methods</h4>
520 <a name='inherited_methods'><!-- --></a>
521 <!-- =========== Summary =========== -->
522 <p>Inherited From <span class="classname"><a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a></span></p>
523 <blockquote>
524 <span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_align">BaseWidget::get_align()</a></span><br>
525 <span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_css">BaseWidget::get_css()</a></span><br>
526 <span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_javascript">BaseWidget::get_javascript()</a></span><br>
527 <span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_title">BaseWidget::get_title()</a></span><br>
528 <span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_width">BaseWidget::get_width()</a></span><br>
529 <span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodset_align">BaseWidget::set_align()</a></span><br>
530 <span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodset_title">BaseWidget::set_title()</a></span><br>
531 <span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodset_width">BaseWidget::set_width()</a></span><br>
532 </blockquote>
533 <!-- =========== Summary =========== -->
534 <p>Inherited From <span class="classname"><a href="../phpHtmlLib/Container.html">Container</a></span></p>
535 <blockquote>
536 <span class="method-name"><a href="../phpHtmlLib/Container.html#methodContainer">Container::Container()</a></span><br>
537 <span class="method-name"><a href="../phpHtmlLib/Container.html#methodadd">Container::add()</a></span><br>
538 <span class="method-name"><a href="../phpHtmlLib/Container.html#methodadd_reference">Container::add_reference()</a></span><br>
539 <span class="method-name"><a href="../phpHtmlLib/Container.html#methodcount_content">Container::count_content()</a></span><br>
540 <span class="method-name"><a href="../phpHtmlLib/Container.html#methodget_element">Container::get_element()</a></span><br>
541 <span class="method-name"><a href="../phpHtmlLib/Container.html#methodget_indent_flag">Container::get_indent_flag()</a></span><br>
542 <span class="method-name"><a href="../phpHtmlLib/Container.html#methodpush">Container::push()</a></span><br>
543 <span class="method-name"><a href="../phpHtmlLib/Container.html#methodpush_reference">Container::push_reference()</a></span><br>
544 <span class="method-name"><a href="../phpHtmlLib/Container.html#methodrender">Container::render()</a></span><br>
545 <span class="method-name"><a href="../phpHtmlLib/Container.html#methodreset_content">Container::reset_content()</a></span><br>
546 <span class="method-name"><a href="../phpHtmlLib/Container.html#methodset_collapse">Container::set_collapse()</a></span><br>
547 <span class="method-name"><a href="../phpHtmlLib/Container.html#methodset_indent_flag">Container::set_indent_flag()</a></span><br>
548 </blockquote>
549
550 </div>
551 </div>
552
553
554 <p class="notes" id="credit">
555 Documentation generated on Thu, 1 Apr 2004 09:38:43 -0800 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0RC2</a>
556 </p>
557 </div></body>
558 </html>
MailToCvsAdmin">MailToCvsAdmin
 ViewVC Help
Powered by ViewVC 1.1.26 RSS 2.0 feed