1 |
<!DOCTYPE HTML PUBLIC '-//W3C//DTD HTML 4.0 Frameset//EN''http://www.w3.org/TR/REC-html40/frameset.dtd'> |
<?xml version="1.0" encoding="iso-8859-1"?> |
2 |
<!--NewPage--> |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
3 |
<HTML> |
<html xmlns="http://www.w3.org/1999/xhtml"> |
4 |
<HEAD> |
<head> |
5 |
<!-- Generated by PhpDoc date: 'Mon, 25 Nov 2002 09:21:31 -0800' --> |
<!-- template designed by Marco Von Ballmoos --> |
6 |
<TITLE>Docs For Class FooterNav</TITLE> |
<title>Docs For Class FooterNav</title> |
7 |
<LINK REL ='stylesheet' TYPE='text/css' HREF='stylesheet.css' TITLE='Style'> |
<link rel="stylesheet" href="../media/stylesheet.css" /> |
8 |
</HEAD> |
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/> |
9 |
<BODY style="background-color: #eeeeee; font-family: arial; font-size: .9em;"> |
</head> |
10 |
|
<body> |
11 |
|
<div class="page-body"> |
12 |
<!-- Links --> |
<h2 class="class-name">Class FooterNav</h2> |
13 |
<a NAME="top"></A> |
|
14 |
<table WIDTH="100%" class="links"> |
<a name="sec-description"></a> |
15 |
<TR> |
<div class="info-box"> |
16 |
<TD class="font10"> |
<div class="info-box-title">Description</div> |
17 |
Links: |
<div class="nav-bar"> |
18 |
<A HREF="#children_summary" class="links" title="Classes extended from FooterNav">Child Classes</A> |
<span class="disabled">Description</span> | |
19 |
<A HREF="#var_summary" class="links" title="Class Variable Summary">Variables</A> |
<a href="#sec-vars">Vars</a> |
20 |
<A HREF="#var_inherited_summary" class="links" title="Inherited Class Variable Summary">Inherited Variables</A> |
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
21 |
<A HREF="#functions_inherited" class="links" title="Inherited Method Summary">Inerited Methods</A> |
|
22 |
<A HREF="#functions_summary" class="links" title="Method Summary">Methods</A> |
</div> |
23 |
<A HREF="#variable_detail" class="links" title="Variable Detail">Variable Detail</A> |
<div class="info-box-body"> |
24 |
<A HREF="#function_detail" class="links" title="Method Detail">Method Detail</A> |
<!-- ========== Info from phpDoc block ========= --> |
25 |
</TD> |
<p class="short-description">Use this class to render footer navigation that is displayed at the bottom of a page.</p> |
26 |
</TR> |
<ul class="tags"> |
27 |
</TABLE> |
<li><span class="field">author:</span> Walter A. Boring IV <<a href="mailto:waboring@buildabetterweb.com">waboring@buildabetterweb.com</a>></li> |
28 |
<BR> |
</ul> |
29 |
|
<p class="notes"> |
30 |
<!-- Start of Class Data --> |
Located in <a class="field" href="_widgets_FooterNav_inc.html">/widgets/FooterNav.inc</a> (line <span class="field">26</span>) |
31 |
<H2> |
</p> |
32 |
Class FooterNav |
|
33 |
</H2> |
|
34 |
|
<pre><a href="../phpHtmlLib/Container.html">Container</a> |
|
<pre> |
|
|
<pre><a href="../phpHtmlLib/Container.html">Container</a> |
|
35 |
| |
| |
36 |
--<a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a> |
--<a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a> |
37 |
| |
| |
38 |
--FooterNav</pre> |
--FooterNav</pre> |
39 |
</pre> |
|
40 |
|
</div> |
41 |
<A NAME="children_summary"</A> |
</div> |
42 |
<H3> |
|
43 |
Classes extended from FooterNav: <A HREF="#top" CLASS="links">^TOP</A> |
|
44 |
</H3> |
|
45 |
|
|
46 |
<p> |
<a name="sec-method-summary"></a> |
47 |
<b><i>Located in File: Program_Root/widgets/FooterNav.inc</i></b><br> |
<div class="info-box"> |
48 |
</p> |
<div class="info-box-title">Method Summary</span></div> |
49 |
<hr> |
<div class="nav-bar"> |
50 |
<!-- ========== Info from phpDoc block ========= --> |
<a href="#sec-description">Description</a> | |
51 |
Use this class to render footer navigation that |
<a href="#sec-vars">Vars</a> |
52 |
is displayed at the bottom of a page. |
|
53 |
<BR> |
| |
54 |
|
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>) |
55 |
|
</div> |
56 |
<UL> |
<div class="info-box-body"> |
57 |
|
<div class="method-summary"> |
58 |
<LI><b>Package</b> - <CODE>phpHtmlLib</CODE></LI> |
|
59 |
|
<div class="method-definition"> |
60 |
<LI><b>Author</b> - <CODE>Walter A. Boring IV <<a href="mailto:waboring@buildabetterweb.com">waboring@buildabetterweb.com</a>></CODE></LI> |
<span class="method-result">FooterNav</span> |
61 |
|
<a href="#FooterNav" title="details" class="method-name">FooterNav</a> |
62 |
</UL> |
([<span class="var-type">string</span> <span class="var-name">$company_name</span> = <span class="var-default">""</span>], [<span class="var-type">string</span> <span class="var-name">$date_str</span> = <span class="var-default">NULL</span>]) |
63 |
|
</div> |
64 |
<hr> |
|
65 |
<!-- =========== VAR SUMMARY =========== --> |
<div class="method-definition"> |
66 |
<A NAME='var_summary'><!-- --></A> |
<span class="method-result">void</span> |
67 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
<a href="#add" title="details" class="method-name">add</a> |
68 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
(<span class="var-type">string</span> <span class="var-name">$url</span>, <span class="var-type">text</span> <span class="var-name">$text</span>) |
69 |
<TD> |
</div> |
70 |
<span CLASS="font12bold">Class Variable Summary</span> |
|
71 |
<A HREF="#top" CLASS="links">^TOP</A> |
<div class="method-definition"> |
72 |
</TD> |
<span class="method-result"><a href="../phpHtmlLib/SPANtag.html">SPANtag</a></span> |
73 |
</TR> |
<a href="#build_copyright_header" title="details" class="method-name">build_copyright_header</a> |
74 |
|
() |
75 |
|
</div> |
76 |
</TABLE> |
|
77 |
|
<div class="method-definition"> |
78 |
<hr> |
<span class="method-result"><a href="../phpHtmlLib/TABLEtag.html">TABLEtag</a></span> |
79 |
<!-- =========== VAR INHERITED SUMMARY =========== --> |
<a href="#build_wrapper_table" title="details" class="method-name">build_wrapper_table</a> |
80 |
<A NAME='var_inherited_summary'><!-- --></A> |
() |
81 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
</div> |
82 |
<TR CLASS='TableHeadingColor'> |
|
83 |
<TD> |
<div class="method-definition"> |
84 |
<span CLASS="font12bold">Inherited Class Variable Summary</span> |
<span class="method-result">void</span> |
85 |
<A HREF="#top" CLASS="links">^TOP</A> |
<a href="#push" title="details" class="method-name">push</a> |
86 |
</TD> |
(<span class="var-type">string</span> <span class="var-name">$url</span>, <span class="var-type">text</span> <span class="var-name">$text</span>) |
87 |
</TR> |
</div> |
88 |
|
|
89 |
|
<div class="method-definition"> |
90 |
<!-- =========== Summary =========== --> |
<span class="method-result">string</span> |
91 |
<TR BGCOLOR='white'> |
<a href="#render" title="details" class="method-name">render</a> |
92 |
<TD> |
([<span class="var-type">int</span> <span class="var-name">$indent_level</span> = <span class="var-default">1</span>], <span class="var-type">int</span> <span class="var-name">$output_debug</span>) |
93 |
<span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a></span> |
</div> |
94 |
<table CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center"> |
|
95 |
<tr CLASS="tableheadingcolor"> |
<div class="method-definition"> |
96 |
<th>Variable</th> |
<span class="method-result">void</span> |
97 |
<th>Default Value</th> |
<a href="#set_company_name" title="details" class="method-name">set_company_name</a> |
98 |
<th>Description</th> |
(<span class="var-type">string</span> <span class="var-name">$name</span>) |
99 |
</tr> |
</div> |
100 |
|
|
101 |
<tr> |
<div class="method-definition"> |
102 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#$title'>$title</A></td> |
<span class="method-result">void</span> |
103 |
<td CLASS="font10" STYLE="white-space: nowrap">-><-</td> |
<a href="#set_copyright_flag" title="details" class="method-name">set_copyright_flag</a> |
104 |
<td CLASS="font10">The title of the table.</td> |
(<span class="var-type">boolean</span> <span class="var-name">$flag</span>) |
105 |
</tr> |
</div> |
106 |
|
|
107 |
<tr> |
<div class="method-definition"> |
108 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#$width'>$width</A></td> |
<span class="method-result">void</span> |
109 |
<td CLASS="font10" STYLE="white-space: nowrap">->100%<-</td> |
<a href="#set_date_string" title="details" class="method-name">set_date_string</a> |
110 |
<td CLASS="font10">the width of the widget</td> |
(<span class="var-type">string</span> <span class="var-name">$date_str</span>) |
111 |
</tr> |
</div> |
112 |
|
|
113 |
</table> |
<div class="method-definition"> |
114 |
<BR> |
<span class="method-result">void</span> |
115 |
</TD> |
<a href="#set_legalnotice_url" title="details" class="method-name">set_legalnotice_url</a> |
116 |
</TR> |
(<span class="var-type">string</span> <span class="var-name">$url</span>) |
117 |
|
</div> |
118 |
<!-- =========== Summary =========== --> |
|
119 |
<TR BGCOLOR='white'> |
<div class="method-definition"> |
120 |
<TD> |
<span class="method-result">void</span> |
121 |
<span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/Container.html">Container</a></span> |
<a href="#set_privacypolicy_url" title="details" class="method-name">set_privacypolicy_url</a> |
122 |
<table CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center"> |
(<span class="var-type">string</span> <span class="var-name">$url</span>) |
123 |
<tr CLASS="tableheadingcolor"> |
</div> |
124 |
<th>Variable</th> |
|
125 |
<th>Default Value</th> |
<div class="method-definition"> |
126 |
<th>Description</th> |
<span class="method-result">void</span> |
127 |
</tr> |
<a href="#set_webmaster_email" title="details" class="method-name">set_webmaster_email</a> |
128 |
|
(<span class="var-type">string</span> <span class="var-name">$email</span>) |
129 |
<tr> |
</div> |
130 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#$indent_flag'>$indent_flag</A></td> |
</div> |
131 |
<td CLASS="font10" STYLE="white-space: nowrap">->TRUE<-</td> |
</div> |
132 |
<td CLASS="font10">Flag for pretty (indented) output</td> |
</div> |
133 |
</tr> |
|
134 |
|
<a name="sec-vars"></a> |
135 |
<tr> |
<div class="info-box"> |
136 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#$_newline_after_content_flag'>$_newline_after_content_flag</A></td> |
<div class="info-box-title">Variables</div> |
137 |
<td CLASS="font10" STYLE="white-space: nowrap">->TRUE<-</td> |
<div class="nav-bar"> |
138 |
<td CLASS="font10">Do we render a newline after the |
<a href="#sec-description">Description</a> | |
139 |
contents has been rendered?</td> |
<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>) |
140 |
</tr> |
|
141 |
|
|
142 |
</table> |
| |
143 |
<BR> |
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
144 |
</TD> |
|
145 |
</TR> |
</div> |
146 |
|
<div class="info-box-body"> |
147 |
</TABLE> |
<h4>Inherited Variables</h4> |
148 |
|
<A NAME='inherited_vars'><!-- --></A> |
149 |
<hr> |
<p>Inherited from <span class="classname"><a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a></span></p> |
150 |
<!-- =========== INHERITED METHOD SUMMARY =========== --> |
<blockquote> |
151 |
<A NAME='functions_inherited'><!-- --></A> |
<span class="var-title"> |
152 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
<span class="var-name"><a href="../phpHtmlLib/BaseWidget.html#var$title">BaseWidget::$title</a></span><br> |
153 |
<TR CLASS='TableHeadingColor'> |
</span> |
154 |
<TD> |
<span class="var-title"> |
155 |
<span CLASS="font12bold">Inherited Method Summary</span> |
<span class="var-name"><a href="../phpHtmlLib/BaseWidget.html#var$width">BaseWidget::$width</a></span><br> |
156 |
<A HREF="#top" CLASS="links">^TOP</A> |
</span> |
157 |
</TD> |
</blockquote> |
158 |
</TR> |
|
159 |
|
</div> |
160 |
|
</div> |
161 |
<!-- =========== Summary =========== --> |
|
162 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<a name="sec-methods"></a> |
163 |
<TD> |
<div class="info-box"> |
164 |
<span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a></span> |
<div class="info-box-title">Methods</div> |
165 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center"> |
<div class="nav-bar"> |
166 |
<tr CLASS="tableheadingcolor"> |
<a href="#sec-description">Description</a> | |
167 |
<th>Function</th> |
<a href="#sec-vars">Vars</a> |
168 |
<th>Description</th> |
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>) |
169 |
</tr> |
|
170 |
|
</div> |
171 |
<tr> |
<div class="info-box-body"> |
172 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#get_align'>get_align ( )</A></td> |
<A NAME='method_detail'></A> |
173 |
<td CLASS="font10">This gets the alignment value |
<a name="methodFooterNav" id="FooterNav"><!-- --></a> |
174 |
for the outer table</td> |
<div class="oddrow"> |
175 |
|
|
176 |
<tr> |
<div class="method-header"> |
177 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#get_css'>get_css ( )</A></td> |
<span class="method-title">Constructor FooterNav</span> (line <span class="line-number">96</span>) |
178 |
<td CLASS="font10">This function provides the</td> |
</div> |
179 |
|
|
180 |
<tr> |
<!-- ========== Info from phpDoc block ========= --> |
181 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#get_javascript'>get_javascript ( )</A></td> |
<p class="short-description">Constructore for this class.</p> |
182 |
<td CLASS="font10">Function for returning the raw javascript |
|
183 |
that is required for this widget.</td> |
<div class="method-signature"> |
184 |
|
<span class="method-result">FooterNav</span> |
185 |
<tr> |
<span class="method-name"> |
186 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#get_title'>get_title ( )</A></td> |
FooterNav |
187 |
<td CLASS="font10">Function for accessing the |
</span> |
188 |
title of this widget</td> |
([<span class="var-type">string</span> <span class="var-name">$company_name</span> = <span class="var-default">""</span>], [<span class="var-type">string</span> <span class="var-name">$date_str</span> = <span class="var-default">NULL</span>]) |
189 |
|
</div> |
190 |
<tr> |
|
191 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#get_width'>get_width ( )</A></td> |
<ul class="parameters"> |
192 |
<td CLASS="font10">Function for getting the current |
<li> |
193 |
widget width setting.</td> |
<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 |
<tr> |
<li> |
196 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#set_align'>set_align ( $align )</A></td> |
<span class="var-type">string</span> |
197 |
<td CLASS="font10">This function sets the align attribute |
<span class="var-name">$date_str</span><span class="var-description">: - a date string to be used for the copyright.</span> </li> |
198 |
for the outer table.</td> |
</ul> |
199 |
|
|
200 |
<tr> |
|
201 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#set_title'>set_title ( [$title = ] )</A></td> |
</div> |
202 |
<td CLASS="font10">Set the title for the widget.</td> |
<a name="methodadd" id="add"><!-- --></a> |
203 |
|
<div class="evenrow"> |
204 |
<tr> |
|
205 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#set_width'>set_width ( $width )</A></td> |
<div class="method-header"> |
206 |
<td CLASS="font10">Set the width for the widget.</td> |
<span class="method-title">add</span> (line <span class="line-number">177</span>) |
207 |
|
</div> |
208 |
</table> |
|
209 |
<br> |
<!-- ========== Info from phpDoc block ========= --> |
210 |
</TD> |
<p class="short-description">add an entry to the footer nav</p> |
211 |
</TR> |
|
212 |
|
<div class="method-signature"> |
213 |
<!-- =========== Summary =========== --> |
<span class="method-result">void</span> |
214 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<span class="method-name"> |
215 |
<TD> |
add |
216 |
<span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/Container.html">Container</a></span> |
</span> |
217 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center"> |
(<span class="var-type">string</span> <span class="var-name">$url</span>, <span class="var-type">text</span> <span class="var-name">$text</span>) |
218 |
<tr CLASS="tableheadingcolor"> |
</div> |
219 |
<th>Function</th> |
|
220 |
<th>Description</th> |
<ul class="parameters"> |
221 |
</tr> |
<li> |
222 |
|
<span class="var-type">string</span> |
223 |
<tr> |
<span class="var-name">$url</span><span class="var-description">: - $url - url to go to</span> </li> |
224 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#constructor Container'>constructor Container ( )</A></td> |
<li> |
225 |
<td CLASS="font10">The constructor.</td> |
<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 |
<tr> |
</ul> |
228 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#add'>add ( )</A></td> |
|
229 |
<td CLASS="font10">add content onto content stack</td> |
<hr class="separator" /> |
230 |
|
<div class="notes">Redefinition of:</div> |
231 |
<tr> |
<dl> |
232 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#add_reference'>add_reference ( &$content )</A></td> |
<dt><a href="../phpHtmlLib/Container.html#methodadd">Container::add()</a></dt> |
233 |
<td CLASS="font10">Add content onto content stack |
<dd>add content onto content stack</dd> |
234 |
so you can change the item later.</td> |
</dl> |
235 |
|
|
236 |
<tr> |
</div> |
237 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#count_content'>count_content ( )</A></td> |
<a name="methodbuild_copyright_header" id="build_copyright_header"><!-- --></a> |
238 |
<td CLASS="font10">counts the number of content objects</td> |
<div class="oddrow"> |
239 |
|
|
240 |
<tr> |
<div class="method-header"> |
241 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#get_indent_flag'>get_indent_flag ( )</A></td> |
<span class="method-title">build_copyright_header</span> (line <span class="line-number">254</span>) |
242 |
<td CLASS="font10">This flag gets the current value |
</div> |
243 |
of the indent flag</td> |
|
244 |
|
<!-- ========== Info from phpDoc block ========= --> |
245 |
<tr> |
<p class="short-description">render the copyright string</p> |
246 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#push'>push ( )</A></td> |
<ul class="tags"> |
247 |
<td CLASS="font10">Same as add().</td> |
<li><span class="field">return:</span> object that contains the copyright header.</li> |
248 |
|
</ul> |
249 |
<tr> |
|
250 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#push_reference'>push_reference ( &$content )</A></td> |
<div class="method-signature"> |
251 |
<td CLASS="font10">Same as add_reference |
<span class="method-result"><a href="../phpHtmlLib/SPANtag.html">SPANtag</a></span> |
252 |
NOTE : only exists for compatibility with 1.1.x</td> |
<span class="method-name"> |
253 |
|
build_copyright_header |
254 |
<tr> |
</span> |
255 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#render'>render ( [$indent_level = 1], [$output_debug = 0] )</A></td> |
() |
256 |
<td CLASS="font10">This function is compatible with the |
</div> |
257 |
rest of the phpHtmllib API spec.</td> |
|
258 |
|
|
259 |
<tr> |
|
260 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#reset_content'>reset_content ( )</A></td> |
</div> |
261 |
<td CLASS="font10">destroy existing content and start with new content.</td> |
<a name="methodbuild_wrapper_table" id="build_wrapper_table"><!-- --></a> |
262 |
|
<div class="evenrow"> |
263 |
<tr> |
|
264 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#set_collapse'>set_collapse ( [$collapse = TRUE], [$indent = TRUE] )</A></td> |
<div class="method-header"> |
265 |
<td CLASS="font10">This function turns on the collapse flag</td> |
<span class="method-title">build_wrapper_table</span> (line <span class="line-number">283</span>) |
266 |
|
</div> |
267 |
<tr> |
|
268 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#set_indent_flag'>set_indent_flag ( $flag )</A></td> |
<!-- ========== Info from phpDoc block ========= --> |
269 |
<td CLASS="font10">function to set the indent flag</td> |
<p class="short-description">builds the wrapper table</p> |
270 |
|
<ul class="tags"> |
271 |
</table> |
<li><span class="field">return:</span> object.</li> |
272 |
<br> |
</ul> |
273 |
</TD> |
|
274 |
</TR> |
<div class="method-signature"> |
275 |
|
<span class="method-result"><a href="../phpHtmlLib/TABLEtag.html">TABLEtag</a></span> |
276 |
</TABLE> |
<span class="method-name"> |
277 |
|
build_wrapper_table |
278 |
<hr> |
</span> |
279 |
<!-- should have constructor at some point --> |
() |
280 |
<!-- =========== Method SUMMARY =========== --> |
</div> |
281 |
<A NAME='Method_summary'><!-- --></A> |
|
282 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' Class="border"> |
|
283 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
|
284 |
<TD> |
</div> |
285 |
<span class="font12bold">Method Summary</span> |
<a name="methodpush" id="push"><!-- --></a> |
286 |
<A HREF="#top" CLASS="links">^TOP</A> |
<div class="oddrow"> |
287 |
</TD> |
|
288 |
</TR> |
<div class="method-header"> |
289 |
|
<span class="method-title">push</span> (line <span class="line-number">190</span>) |
290 |
|
</div> |
291 |
<!-- =========== Summary =========== --> |
|
292 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<!-- ========== Info from phpDoc block ========= --> |
293 |
<TD> |
<p class="short-description">add an entry to the footer nav.</p> |
294 |
<CODE><B><A HREF='FooterNav.html#constructor FooterNav'>void constructor FooterNav ( $company_name, [$date_str = ""NULL] )</A></B></CODE> |
|
295 |
<BR> |
<div class="method-signature"> |
296 |
<blockquote> Constructore for this class. </blockquote> |
<span class="method-result">void</span> |
297 |
</TD> |
<span class="method-name"> |
298 |
</TR> |
push |
299 |
|
</span> |
300 |
<!-- =========== Summary =========== --> |
(<span class="var-type">string</span> <span class="var-name">$url</span>, <span class="var-type">text</span> <span class="var-name">$text</span>) |
301 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
</div> |
302 |
<TD> |
|
303 |
<CODE><B><A HREF='FooterNav.html#add'>void add ( $url, $text )</A></B></CODE> |
<ul class="parameters"> |
304 |
<BR> |
<li> |
305 |
<blockquote> add an entry to the footer nav </blockquote> |
<span class="var-type">string</span> |
306 |
</TD> |
<span class="var-name">$url</span><span class="var-description">: - $url - url to go to</span> </li> |
307 |
</TR> |
<li> |
308 |
|
<span class="var-type">text</span> |
309 |
<!-- =========== Summary =========== --> |
<span class="var-name">$text</span><span class="var-description">: - $text - url text to click on.</span> </li> |
310 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
</ul> |
311 |
<TD> |
|
312 |
<CODE><B><A HREF='FooterNav.html#build_copyright_header'><a href="../phpHtmlLib/SPANtag.html">SPANtag</a> build_copyright_header ( )</A></B></CODE> |
<hr class="separator" /> |
313 |
<BR> |
<div class="notes">Redefinition of:</div> |
314 |
<blockquote> render the copyright string </blockquote> |
<dl> |
315 |
</TD> |
<dt><a href="../phpHtmlLib/Container.html#methodpush">Container::push()</a></dt> |
316 |
</TR> |
<dd>Same as add().</dd> |
317 |
|
</dl> |
318 |
<!-- =========== Summary =========== --> |
|
319 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
</div> |
320 |
<TD> |
<a name="methodrender" id="render"><!-- --></a> |
321 |
<CODE><B><A HREF='FooterNav.html#build_wrapper_table'><a href="../phpHtmlLib/TABLEtag.html">TABLEtag</a> build_wrapper_table ( )</A></B></CODE> |
<div class="evenrow"> |
322 |
<BR> |
|
323 |
<blockquote> builds the wrapper table </blockquote> |
<div class="method-header"> |
324 |
</TD> |
<span class="method-title">render</span> (line <span class="line-number">211</span>) |
325 |
</TR> |
</div> |
326 |
|
|
327 |
<!-- =========== Summary =========== --> |
<!-- ========== Info from phpDoc block ========= --> |
328 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<p class="short-description">render the code for this widget.</p> |
329 |
<TD> |
<ul class="tags"> |
330 |
<CODE><B><A HREF='FooterNav.html#push'>void push ( $url, $text )</A></B></CODE> |
<li><span class="field">return:</span> the raw html output.</li> |
331 |
<BR> |
</ul> |
332 |
<blockquote> add an entry to the footer nav. </blockquote> |
|
333 |
</TD> |
<div class="method-signature"> |
334 |
</TR> |
<span class="method-result">string</span> |
335 |
|
<span class="method-name"> |
336 |
<!-- =========== Summary =========== --> |
render |
337 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
</span> |
338 |
<TD> |
([<span class="var-type">int</span> <span class="var-name">$indent_level</span> = <span class="var-default">1</span>], <span class="var-type">int</span> <span class="var-name">$output_debug</span>) |
339 |
<CODE><B><A HREF='FooterNav.html#render'>string render ( [$indent_level = 1], [$output_debug = 0] )</A></B></CODE> |
</div> |
340 |
<BR> |
|
341 |
<blockquote> render the code for this widget. </blockquote> |
<ul class="parameters"> |
342 |
</TD> |
<li> |
343 |
</TR> |
<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 |
<!-- =========== Summary =========== --> |
<li> |
346 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<span class="var-type">int</span> |
347 |
<TD> |
<span class="var-name">$output_debug</span><span class="var-description">: - the output debug flag to maintain compatibility w/ the API.</span> </li> |
348 |
<CODE><B><A HREF='FooterNav.html#set_company_name'>void set_company_name ( $name )</A></B></CODE> |
</ul> |
349 |
<BR> |
|
350 |
<blockquote> set the company name for the copyright |
<hr class="separator" /> |
351 |
statement. </blockquote> |
<div class="notes">Redefinition of:</div> |
352 |
</TD> |
<dl> |
353 |
</TR> |
<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 |
<!-- =========== Summary =========== --> |
</dl> |
356 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
357 |
<TD> |
</div> |
358 |
<CODE><B><A HREF='FooterNav.html#set_copyright_flag'>void set_copyright_flag ( $flag )</A></B></CODE> |
<a name="methodset_company_name" id="set_company_name"><!-- --></a> |
359 |
<BR> |
<div class="oddrow"> |
360 |
<blockquote> set/unset the flag to tell us to |
|
361 |
render the copyright string </blockquote> |
<div class="method-header"> |
362 |
</TD> |
<span class="method-title">set_company_name</span> (line <span class="line-number">112</span>) |
363 |
</TR> |
</div> |
364 |
|
|
365 |
<!-- =========== Summary =========== --> |
<!-- ========== Info from phpDoc block ========= --> |
366 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<p class="short-description">set the company name for the copyright statement.</p> |
367 |
<TD> |
|
368 |
<CODE><B><A HREF='FooterNav.html#set_date_string'>void set_date_string ( $date_str )</A></B></CODE> |
<div class="method-signature"> |
369 |
<BR> |
<span class="method-result">void</span> |
370 |
<blockquote> set the date string for the copyright. </blockquote> |
<span class="method-name"> |
371 |
</TD> |
set_company_name |
372 |
</TR> |
</span> |
373 |
|
(<span class="var-type">string</span> <span class="var-name">$name</span>) |
374 |
<!-- =========== Summary =========== --> |
</div> |
375 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
376 |
<TD> |
<ul class="parameters"> |
377 |
<CODE><B><A HREF='FooterNav.html#set_legalnotice_url'>void set_legalnotice_url ( $url )</A></B></CODE> |
<li> |
378 |
<BR> |
<span class="var-type">string</span> |
379 |
<blockquote> set the legal notice url. </blockquote> |
<span class="var-name">$name</span><span class="var-description">: - $name</span> </li> |
380 |
</TD> |
</ul> |
381 |
</TR> |
|
382 |
|
|
383 |
<!-- =========== Summary =========== --> |
</div> |
384 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<a name="methodset_copyright_flag" id="set_copyright_flag"><!-- --></a> |
385 |
<TD> |
<div class="evenrow"> |
386 |
<CODE><B><A HREF='FooterNav.html#set_privacypolicy_url'>void set_privacypolicy_url ( $url )</A></B></CODE> |
|
387 |
<BR> |
<div class="method-header"> |
388 |
<blockquote> sets the Privacy policy url. </blockquote> |
<span class="method-title">set_copyright_flag</span> (line <span class="line-number">133</span>) |
389 |
</TD> |
</div> |
390 |
</TR> |
|
391 |
|
<!-- ========== Info from phpDoc block ========= --> |
392 |
<!-- =========== Summary =========== --> |
<p class="short-description">set/unset the flag to tell us to render the copyright string</p> |
393 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
394 |
<TD> |
<div class="method-signature"> |
395 |
<CODE><B><A HREF='FooterNav.html#set_webmaster_email'>void set_webmaster_email ( $email )</A></B></CODE> |
<span class="method-result">void</span> |
396 |
<BR> |
<span class="method-name"> |
397 |
<blockquote> sets the Webmaster email address </blockquote> |
set_copyright_flag |
398 |
</TD> |
</span> |
399 |
</TR> |
(<span class="var-type">boolean</span> <span class="var-name">$flag</span>) |
400 |
|
</div> |
401 |
</TABLE> |
|
402 |
|
<ul class="parameters"> |
403 |
<hr> |
<li> |
404 |
<!-- ============ VARIABLE DETAIL =========== --> |
<span class="var-type">boolean</span> |
405 |
|
<span class="var-name">$flag</span><span class="var-description">: - $flag</span> </li> |
406 |
<A NAME='variable_detail'></A> |
</ul> |
407 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
|
408 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
|
409 |
<TD> |
</div> |
410 |
<span CLASS="font12bold">Variable Detail</span> |
<a name="methodset_date_string" id="set_date_string"><!-- --></a> |
411 |
<A HREF="#top" CLASS="links">^TOP</A> |
<div class="oddrow"> |
412 |
</TD> |
|
413 |
</TR> |
<div class="method-header"> |
414 |
</TABLE> |
<span class="method-title">set_date_string</span> (line <span class="line-number">123</span>) |
415 |
|
</div> |
416 |
|
|
417 |
|
<!-- ========== Info from phpDoc block ========= --> |
418 |
<hr> |
<p class="short-description">set the date string for the copyright.</p> |
419 |
<!-- ============ FUNCTION DETAIL =========== --> |
<p class="description"><p>in the form of "2001-1997", or "2001".</p></p> |
420 |
|
|
421 |
<A NAME='function_detail'></A> |
<div class="method-signature"> |
422 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
<span class="method-result">void</span> |
423 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
<span class="method-name"> |
424 |
<TD> |
set_date_string |
425 |
<span class="font12bold">Method Detail</span> |
</span> |
426 |
<A HREF="#top" CLASS="links">^TOP</A> |
(<span class="var-type">string</span> <span class="var-name">$date_str</span>) |
427 |
</TD> |
</div> |
428 |
</TR> |
|
429 |
</TABLE> |
<ul class="parameters"> |
430 |
<BR> |
<li> |
431 |
|
<span class="var-type">string</span> |
432 |
<DIV CLASS="function"> |
<span class="var-name">$date_str</span><span class="var-description">: - $date_str</span> </li> |
433 |
<A NAME='constructor FooterNav'><!-- --></A> |
</ul> |
434 |
<SPAN CLASS="font12bold">constructor FooterNav</SPAN> |
|
435 |
<BR> |
|
436 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
</div> |
437 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
<a name="methodset_legalnotice_url" id="set_legalnotice_url"><!-- --></a> |
438 |
<span class="font10bold" style="color: #0000FF">constructor FooterNav ( $company_name, [$date_str = ""NULL] )</SPAN> |
<div class="evenrow"> |
439 |
<BR> |
|
440 |
|
<div class="method-header"> |
441 |
<BR> |
<span class="method-title">set_legalnotice_url</span> (line <span class="line-number">144</span>) |
442 |
<SPAN CLASS="font10bold">Description : </SPAN> |
</div> |
443 |
<!-- ========== Info from phpDoc block ========= --> |
|
444 |
Constructore for this class. |
<!-- ========== Info from phpDoc block ========= --> |
445 |
<BR> |
<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 |
<DL> |
|
448 |
<DT class="font10bold">Function Parameters:</DT> |
<div class="method-signature"> |
449 |
|
<span class="method-result">void</span> |
450 |
<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 |
<span class="method-name"> |
451 |
- copyright</DD> |
set_legalnotice_url |
452 |
|
</span> |
453 |
<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 |
(<span class="var-type">string</span> <span class="var-name">$url</span>) |
454 |
for the copyright.</DD> |
</div> |
455 |
|
|
456 |
|
<ul class="parameters"> |
457 |
<DT class="font10bold">Function Info:</DT> |
<li> |
458 |
|
<span class="var-type">string</span> |
459 |
</DL> |
<span class="var-name">$url</span><span class="var-description">: - $url</span> </li> |
460 |
|
</ul> |
461 |
</DIV> |
|
462 |
<BR> |
|
463 |
|
</div> |
464 |
<DIV CLASS="function"> |
<a name="methodset_privacypolicy_url" id="set_privacypolicy_url"><!-- --></a> |
465 |
<A NAME='add'><!-- --></A> |
<div class="oddrow"> |
466 |
<SPAN CLASS="font12bold">add</SPAN> |
|
467 |
<BR> |
<div class="method-header"> |
468 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
<span class="method-title">set_privacypolicy_url</span> (line <span class="line-number">155</span>) |
469 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
</div> |
470 |
<span class="font10bold" style="color: #0000FF">add ( $url, $text )</SPAN> |
|
471 |
<BR> |
<!-- ========== Info from phpDoc block ========= --> |
472 |
|
<p class="short-description">sets the Privacy policy url.</p> |
473 |
<BR> |
<p class="description"><p>if this is set we show the privacy policy link that points to $url</p></p> |
474 |
<SPAN CLASS="font10bold">Description : </SPAN> |
|
475 |
<!-- ========== Info from phpDoc block ========= --> |
<div class="method-signature"> |
476 |
add an entry to the footer nav |
<span class="method-result">void</span> |
477 |
<BR> |
<span class="method-name"> |
478 |
|
set_privacypolicy_url |
479 |
<DL> |
</span> |
480 |
<DT class="font10bold">Function Parameters:</DT> |
(<span class="var-type">string</span> <span class="var-name">$url</span>) |
481 |
|
</div> |
482 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">string</SPAN> <span style="color: #0000FF;font-weight:bold">$url</SPAN></SPAN> - - url to go to</DD> |
|
483 |
|
<ul class="parameters"> |
484 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">text</SPAN> <span style="color: #0000FF;font-weight:bold">$text</SPAN></SPAN> - - url text to click on.</DD> |
<li> |
485 |
|
<span class="var-type">string</span> |
486 |
|
<span class="var-name">$url</span><span class="var-description">: - $url</span> </li> |
487 |
<DT class="font10bold">Function Info:</DT> |
</ul> |
488 |
|
|
489 |
</DL> |
|
490 |
|
</div> |
491 |
</DIV> |
<a name="methodset_webmaster_email" id="set_webmaster_email"><!-- --></a> |
492 |
<BR> |
<div class="evenrow"> |
493 |
|
|
494 |
<DIV CLASS="function"> |
<div class="method-header"> |
495 |
<A NAME='build_copyright_header'><!-- --></A> |
<span class="method-title">set_webmaster_email</span> (line <span class="line-number">166</span>) |
496 |
<SPAN CLASS="font12bold">build_copyright_header</SPAN> |
</div> |
497 |
<BR> |
|
498 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
<!-- ========== Info from phpDoc block ========= --> |
499 |
<span class="font10bold" style="color: #FF0000"><a href="../phpHtmlLib/SPANtag.html">SPANtag</a></SPAN> |
<p class="short-description">sets the Webmaster email address if this is set we show the mailto for this email</p> |
500 |
<span class="font10bold" style="color: #0000FF">build_copyright_header ( )</SPAN> |
|
501 |
<BR> |
<div class="method-signature"> |
502 |
|
<span class="method-result">void</span> |
503 |
<BR> |
<span class="method-name"> |
504 |
<SPAN CLASS="font10bold">Description : </SPAN> |
set_webmaster_email |
505 |
<!-- ========== Info from phpDoc block ========= --> |
</span> |
506 |
render the copyright string |
(<span class="var-type">string</span> <span class="var-name">$email</span>) |
507 |
<BR> |
</div> |
508 |
|
|
509 |
<DL> |
<ul class="parameters"> |
510 |
<DT class="font10bold">Function Parameters:</DT> |
<li> |
511 |
|
<span class="var-type">string</span> |
512 |
|
<span class="var-name">$email</span><span class="var-description">: - $email</span> </li> |
513 |
<DT class="font10bold">Function Info:</DT> |
</ul> |
514 |
|
|
515 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - object that |
|
516 |
contains the copyright |
</div> |
517 |
header.</DD> |
<h4>Inherited Methods</h4> |
518 |
|
<a name='inherited_methods'><!-- --></a> |
519 |
</DL> |
<!-- =========== Summary =========== --> |
520 |
|
<p>Inherited From <span class="classname"><a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a></span></p> |
521 |
</DIV> |
<blockquote> |
522 |
<BR> |
<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 |
<DIV CLASS="function"> |
<span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_javascript">BaseWidget::get_javascript()</a></span><br> |
525 |
<A NAME='build_wrapper_table'><!-- --></A> |
<span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_title">BaseWidget::get_title()</a></span><br> |
526 |
<SPAN CLASS="font12bold">build_wrapper_table</SPAN> |
<span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_width">BaseWidget::get_width()</a></span><br> |
527 |
<BR> |
<span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodset_align">BaseWidget::set_align()</a></span><br> |
528 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
<span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodset_title">BaseWidget::set_title()</a></span><br> |
529 |
<span class="font10bold" style="color: #FF0000"><a href="../phpHtmlLib/TABLEtag.html">TABLEtag</a></SPAN> |
<span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodset_width">BaseWidget::set_width()</a></span><br> |
530 |
<span class="font10bold" style="color: #0000FF">build_wrapper_table ( )</SPAN> |
</blockquote> |
531 |
<BR> |
<!-- =========== Summary =========== --> |
532 |
|
<p>Inherited From <span class="classname"><a href="../phpHtmlLib/Container.html">Container</a></span></p> |
533 |
<BR> |
<blockquote> |
534 |
<SPAN CLASS="font10bold">Description : </SPAN> |
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodContainer">Container::Container()</a></span><br> |
535 |
<!-- ========== Info from phpDoc block ========= --> |
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodadd">Container::add()</a></span><br> |
536 |
builds the wrapper table |
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodadd_reference">Container::add_reference()</a></span><br> |
537 |
<BR> |
<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 |
<DL> |
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodget_indent_flag">Container::get_indent_flag()</a></span><br> |
540 |
<DT class="font10bold">Function Parameters:</DT> |
<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 |
<DT class="font10bold">Function Info:</DT> |
<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 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - object.</DD> |
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodset_indent_flag">Container::set_indent_flag()</a></span><br> |
546 |
|
</blockquote> |
547 |
</DL> |
|
548 |
|
</div> |
549 |
</DIV> |
</div> |
550 |
<BR> |
|
551 |
|
|
552 |
<DIV CLASS="function"> |
<p class="notes" id="credit"> |
553 |
<A NAME='push'><!-- --></A> |
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 |
<SPAN CLASS="font12bold">push</SPAN> |
</p> |
555 |
<BR> |
</div></body> |
556 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
</html> |
|
<span class="font10bold" style="color: #FF0000">void</SPAN> |
|
|
<span class="font10bold" style="color: #0000FF">push ( $url, $text )</SPAN> |
|
|
<BR> |
|
|
|
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
add an entry to the footer nav. |
|
|
<BR> |
|
|
|
|
|
<DL> |
|
|
<DT class="font10bold">Function Parameters:</DT> |
|
|
|
|
|
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">string</SPAN> <span style="color: #0000FF;font-weight:bold">$url</SPAN></SPAN> - - url to go to</DD> |
|
|
|
|
|
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">text</SPAN> <span style="color: #0000FF;font-weight:bold">$text</SPAN></SPAN> - - url text to click on.</DD> |
|
|
|
|
|
|
|
|
<DT class="font10bold">Function Info:</DT> |
|
|
|
|
|
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Deprecated</b> - </DD> |
|
|
|
|
|
</DL> |
|
|
|
|
|
</DIV> |
|
|
<BR> |
|
|
|
|
|
<DIV CLASS="function"> |
|
|
<A NAME='render'><!-- --></A> |
|
|
<SPAN CLASS="font12bold">render</SPAN> |
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Useage : </SPAN> |
|
|
<span class="font10bold" style="color: #FF0000">string</SPAN> |
|
|
<span class="font10bold" style="color: #0000FF">render ( [$indent_level = 1], [$output_debug = 0] )</SPAN> |
|
|
<BR> |
|
|
|
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
render the code for this widget. |
|
|
<BR> |
|
|
|
|
|
<DL> |
|
|
<DT class="font10bold">Function Parameters:</DT> |
|
|
|
|
|
<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> |
|
|
|
|
|
<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> |
|
|
|
|
|
|
|
|
<DT class="font10bold">Function Info:</DT> |
|
|
|
|
|
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - the raw html output.</DD> |
|
|
|
|
|
</DL> |
|
|
|
|
|
</DIV> |
|
|
<BR> |
|
|
|
|
|
<DIV CLASS="function"> |
|
|
<A NAME='set_company_name'><!-- --></A> |
|
|
<SPAN CLASS="font12bold">set_company_name</SPAN> |
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Useage : </SPAN> |
|
|
<span class="font10bold" style="color: #FF0000">void</SPAN> |
|
|
<span class="font10bold" style="color: #0000FF">set_company_name ( $name )</SPAN> |
|
|
<BR> |
|
|
|
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
set the company name for the copyright |
|
|
statement. |
|
|
<BR> |
|
|
|
|
|
<DL> |
|
|
<DT class="font10bold">Function Parameters:</DT> |
|
|
|
|
|
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">string</SPAN> <span style="color: #0000FF;font-weight:bold">$name</SPAN></SPAN> -</DD> |
|
|
|
|
|
|
|
|
<DT class="font10bold">Function Info:</DT> |
|
|
|
|
|
</DL> |
|
|
|
|
|
</DIV> |
|
|
<BR> |
|
|
|
|
|
<DIV CLASS="function"> |
|
|
<A NAME='set_copyright_flag'><!-- --></A> |
|
|
<SPAN CLASS="font12bold">set_copyright_flag</SPAN> |
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Useage : </SPAN> |
|
|
<span class="font10bold" style="color: #FF0000">void</SPAN> |
|
|
<span class="font10bold" style="color: #0000FF">set_copyright_flag ( $flag )</SPAN> |
|
|
<BR> |
|
|
|
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
set/unset the flag to tell us to |
|
|
render the copyright string |
|
|
<BR> |
|
|
|
|
|
<DL> |
|
|
<DT class="font10bold">Function Parameters:</DT> |
|
|
|
|
|
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">boolean</SPAN> <span style="color: #0000FF;font-weight:bold">$flag</SPAN></SPAN> -</DD> |
|
|
|
|
|
|
|
|
<DT class="font10bold">Function Info:</DT> |
|
|
|
|
|
</DL> |
|
|
|
|
|
</DIV> |
|
|
<BR> |
|
|
|
|
|
<DIV CLASS="function"> |
|
|
<A NAME='set_date_string'><!-- --></A> |
|
|
<SPAN CLASS="font12bold">set_date_string</SPAN> |
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Useage : </SPAN> |
|
|
<span class="font10bold" style="color: #FF0000">void</SPAN> |
|
|
<span class="font10bold" style="color: #0000FF">set_date_string ( $date_str )</SPAN> |
|
|
<BR> |
|
|
|
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
set the date string for the copyright. |
|
|
<BR> |
|
|
in the form of "2001-1997", or |
|
|
"2001". |
|
|
<DL> |
|
|
<DT class="font10bold">Function Parameters:</DT> |
|
|
|
|
|
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">string</SPAN> <span style="color: #0000FF;font-weight:bold">$date_str</SPAN></SPAN> -</DD> |
|
|
|
|
|
|
|
|
<DT class="font10bold">Function Info:</DT> |
|
|
|
|
|
</DL> |
|
|
|
|
|
</DIV> |
|
|
<BR> |
|
|
|
|
|
<DIV CLASS="function"> |
|
|
<A NAME='set_legalnotice_url'><!-- --></A> |
|
|
<SPAN CLASS="font12bold">set_legalnotice_url</SPAN> |
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Useage : </SPAN> |
|
|
<span class="font10bold" style="color: #FF0000">void</SPAN> |
|
|
<span class="font10bold" style="color: #0000FF">set_legalnotice_url ( $url )</SPAN> |
|
|
<BR> |
|
|
|
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
set the legal notice url. |
|
|
<BR> |
|
|
if this is set we show the |
|
|
legal notice link that points to $url. |
|
|
<DL> |
|
|
<DT class="font10bold">Function Parameters:</DT> |
|
|
|
|
|
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">string</SPAN> <span style="color: #0000FF;font-weight:bold">$url</SPAN></SPAN> -</DD> |
|
|
|
|
|
|
|
|
<DT class="font10bold">Function Info:</DT> |
|
|
|
|
|
</DL> |
|
|
|
|
|
</DIV> |
|
|
<BR> |
|
|
|
|
|
<DIV CLASS="function"> |
|
|
<A NAME='set_privacypolicy_url'><!-- --></A> |
|
|
<SPAN CLASS="font12bold">set_privacypolicy_url</SPAN> |
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Useage : </SPAN> |
|
|
<span class="font10bold" style="color: #FF0000">void</SPAN> |
|
|
<span class="font10bold" style="color: #0000FF">set_privacypolicy_url ( $url )</SPAN> |
|
|
<BR> |
|
|
|
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
sets the Privacy policy url. |
|
|
<BR> |
|
|
if this is set we show the |
|
|
privacy policy link that points to $url |
|
|
<DL> |
|
|
<DT class="font10bold">Function Parameters:</DT> |
|
|
|
|
|
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">string</SPAN> <span style="color: #0000FF;font-weight:bold">$url</SPAN></SPAN> -</DD> |
|
|
|
|
|
|
|
|
<DT class="font10bold">Function Info:</DT> |
|
|
|
|
|
</DL> |
|
|
|
|
|
</DIV> |
|
|
<BR> |
|
|
|
|
|
<DIV CLASS="function"> |
|
|
<A NAME='set_webmaster_email'><!-- --></A> |
|
|
<SPAN CLASS="font12bold">set_webmaster_email</SPAN> |
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Useage : </SPAN> |
|
|
<span class="font10bold" style="color: #FF0000">void</SPAN> |
|
|
<span class="font10bold" style="color: #0000FF">set_webmaster_email ( $email )</SPAN> |
|
|
<BR> |
|
|
|
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
sets the Webmaster email address |
|
|
<BR> |
|
|
if this is set we show the |
|
|
mailto for this email |
|
|
<DL> |
|
|
<DT class="font10bold">Function Parameters:</DT> |
|
|
|
|
|
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">string</SPAN> <span style="color: #0000FF;font-weight:bold">$email</SPAN></SPAN> -</DD> |
|
|
|
|
|
|
|
|
<DT class="font10bold">Function Info:</DT> |
|
|
|
|
|
</DL> |
|
|
|
|
|
</DIV> |
|
|
<BR> |
|
|
|
|
|
|
|
|
<hr> |
|
|
</HTML> |
|