/[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.3 - (hide annotations)
Sat Sep 20 00:24:01 2003 UTC (20 years, 11 months ago) by jonen
Branch: MAIN
Changes since 1.2: +551 -635 lines
File MIME type: text/html
+ updated whole phphtmllib to v2.3.0

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

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