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