1 |
jonen |
1.1 |
<!DOCTYPE HTML PUBLIC '-//W3C//DTD HTML 4.0 Frameset//EN''http://www.w3.org/TR/REC-html40/frameset.dtd'> |
2 |
|
|
<!--NewPage--> |
3 |
|
|
<HTML> |
4 |
|
|
<HEAD> |
5 |
|
|
<!-- Generated by PhpDoc date: 'Mon, 25 Nov 2002 09:21:31 -0800' --> |
6 |
|
|
<TITLE>Docs For Class HTMLPageClass</TITLE> |
7 |
|
|
<LINK REL ='stylesheet' TYPE='text/css' HREF='stylesheet.css' TITLE='Style'> |
8 |
|
|
</HEAD> |
9 |
|
|
<BODY style="background-color: #eeeeee; font-family: arial; font-size: .9em;"> |
10 |
|
|
|
11 |
|
|
|
12 |
|
|
<!-- Links --> |
13 |
|
|
<a NAME="top"></A> |
14 |
|
|
<table WIDTH="100%" class="links"> |
15 |
|
|
<TR> |
16 |
|
|
<TD class="font10"> |
17 |
|
|
Links: |
18 |
|
|
<A HREF="#children_summary" class="links" title="Classes extended from HTMLPageClass">Child Classes</A> |
19 |
|
|
<A HREF="#var_summary" class="links" title="Class Variable Summary">Variables</A> |
20 |
|
|
<A HREF="#var_inherited_summary" class="links" title="Inherited Class Variable Summary">Inherited Variables</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> |
23 |
|
|
<A HREF="#variable_detail" class="links" title="Variable Detail">Variable Detail</A> |
24 |
|
|
<A HREF="#function_detail" class="links" title="Method Detail">Method Detail</A> |
25 |
|
|
</TD> |
26 |
|
|
</TR> |
27 |
|
|
</TABLE> |
28 |
|
|
<BR> |
29 |
|
|
|
30 |
|
|
<!-- Start of Class Data --> |
31 |
|
|
<H2> |
32 |
|
|
Class HTMLPageClass |
33 |
|
|
</H2> |
34 |
|
|
|
35 |
|
|
<pre> |
36 |
|
|
HTMLPageClass |
37 |
|
|
</pre> |
38 |
|
|
|
39 |
|
|
<A NAME="children_summary"</A> |
40 |
|
|
<H3> |
41 |
|
|
Classes extended from HTMLPageClass: <A HREF="#top" CLASS="links">^TOP</A> |
42 |
|
|
</H3> |
43 |
|
|
<a href="../phpHtmlLib/PageWidget.html">PageWidget</a> |
44 |
|
|
<p> |
45 |
|
|
<b><i>Located in File: Program_Root/widgets/HTMLPageClass.inc</i></b><br> |
46 |
|
|
</p> |
47 |
|
|
<hr> |
48 |
|
|
<!-- ========== Info from phpDoc block ========= --> |
49 |
|
|
class the constructs and renders an entire |
50 |
|
|
HTML/XHTML document. |
51 |
|
|
<BR> |
52 |
|
|
|
53 |
|
|
|
54 |
|
|
<UL> |
55 |
|
|
|
56 |
|
|
<LI><b>Package</b> - <CODE>phpHtmlLib</CODE></LI> |
57 |
|
|
|
58 |
|
|
<LI><b>Author</b> - <CODE>Walter A. Boring IV <<a href="mailto:waboring@buildabetterweb.com">waboring@buildabetterweb.com</a>></CODE></LI> |
59 |
|
|
|
60 |
|
|
</UL> |
61 |
|
|
|
62 |
|
|
<hr> |
63 |
|
|
<!-- =========== VAR SUMMARY =========== --> |
64 |
|
|
<A NAME='var_summary'><!-- --></A> |
65 |
|
|
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
66 |
|
|
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
67 |
|
|
<TD> |
68 |
|
|
<span CLASS="font12bold">Class Variable Summary</span> |
69 |
|
|
<A HREF="#top" CLASS="links">^TOP</A> |
70 |
|
|
</TD> |
71 |
|
|
</TR> |
72 |
|
|
|
73 |
|
|
|
74 |
|
|
<!-- =========== Summary =========== --> |
75 |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
76 |
|
|
<TD> |
77 |
|
|
<CODE><B><A HREF='HTMLPageClass.html#$_html_attributes'>$_html_attributes</A></B></CODE> |
78 |
|
|
<BR> |
79 |
|
|
<blockquote> This holds the attributes for the |
80 |
|
|
<html> tag. </blockquote> |
81 |
|
|
<blockquote> Default Value: <CODE>->array()<-</CODE> </blockquote> |
82 |
|
|
</TD> |
83 |
|
|
</TR> |
84 |
|
|
|
85 |
|
|
<!-- =========== Summary =========== --> |
86 |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
87 |
|
|
<TD> |
88 |
|
|
<CODE><B><A HREF='HTMLPageClass.html#$_indent_style'>$_indent_style</A></B></CODE> |
89 |
|
|
<BR> |
90 |
|
|
<blockquote> Holds the value of the indent </blockquote> |
91 |
|
|
<blockquote> Default Value: <CODE>->0<-</CODE> </blockquote> |
92 |
|
|
</TD> |
93 |
|
|
</TR> |
94 |
|
|
|
95 |
|
|
<!-- =========== Summary =========== --> |
96 |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
97 |
|
|
<TD> |
98 |
|
|
<CODE><B><A HREF='HTMLPageClass.html#$_widget_css_auto'>$_widget_css_auto</A></B></CODE> |
99 |
|
|
<BR> |
100 |
|
|
<blockquote> keeps track of which widgets we have |
101 |
|
|
automatically pulled in css for </blockquote> |
102 |
|
|
<blockquote> Default Value: <CODE>->array()<-</CODE> </blockquote> |
103 |
|
|
</TD> |
104 |
|
|
</TR> |
105 |
|
|
|
106 |
|
|
<!-- =========== Summary =========== --> |
107 |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
108 |
|
|
<TD> |
109 |
|
|
<CODE><B><A HREF='HTMLPageClass.html#$_widget_js_auto'>$_widget_js_auto</A></B></CODE> |
110 |
|
|
<BR> |
111 |
|
|
<blockquote> keeps track of which widgets we have |
112 |
|
|
automatically pulled in js for </blockquote> |
113 |
|
|
<blockquote> Default Value: <CODE>->array()<-</CODE> </blockquote> |
114 |
|
|
</TD> |
115 |
|
|
</TR> |
116 |
|
|
|
117 |
|
|
</TABLE> |
118 |
|
|
|
119 |
|
|
<hr> |
120 |
|
|
<!-- =========== VAR INHERITED SUMMARY =========== --> |
121 |
|
|
<A NAME='var_inherited_summary'><!-- --></A> |
122 |
|
|
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
123 |
|
|
<TR CLASS='TableHeadingColor'> |
124 |
|
|
<TD> |
125 |
|
|
<span CLASS="font12bold">Inherited Class Variable Summary</span> |
126 |
|
|
<A HREF="#top" CLASS="links">^TOP</A> |
127 |
|
|
</TD> |
128 |
|
|
</TR> |
129 |
|
|
|
130 |
|
|
|
131 |
|
|
</TABLE> |
132 |
|
|
|
133 |
|
|
<hr> |
134 |
|
|
<!-- =========== INHERITED METHOD SUMMARY =========== --> |
135 |
|
|
<A NAME='functions_inherited'><!-- --></A> |
136 |
|
|
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
137 |
|
|
<TR CLASS='TableHeadingColor'> |
138 |
|
|
<TD> |
139 |
|
|
<span CLASS="font12bold">Inherited Method Summary</span> |
140 |
|
|
<A HREF="#top" CLASS="links">^TOP</A> |
141 |
|
|
</TD> |
142 |
|
|
</TR> |
143 |
|
|
|
144 |
|
|
|
145 |
|
|
</TABLE> |
146 |
|
|
|
147 |
|
|
<hr> |
148 |
|
|
<!-- should have constructor at some point --> |
149 |
|
|
<!-- =========== Method SUMMARY =========== --> |
150 |
|
|
<A NAME='Method_summary'><!-- --></A> |
151 |
|
|
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' Class="border"> |
152 |
|
|
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
153 |
|
|
<TD> |
154 |
|
|
<span class="font12bold">Method Summary</span> |
155 |
|
|
<A HREF="#top" CLASS="links">^TOP</A> |
156 |
|
|
</TD> |
157 |
|
|
</TR> |
158 |
|
|
|
159 |
|
|
|
160 |
|
|
<!-- =========== Summary =========== --> |
161 |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
162 |
|
|
<TD> |
163 |
|
|
<CODE><B><A HREF='HTMLPageClass.html#constructor HTMLPageClass'>void constructor HTMLPageClass ( [$title = NULL], [$html_type = HTML], [$indent_style = INDENT_NICE] )</A></B></CODE> |
164 |
|
|
<BR> |
165 |
|
|
<blockquote> Class Constructor </blockquote> |
166 |
|
|
</TD> |
167 |
|
|
</TR> |
168 |
|
|
|
169 |
|
|
<!-- =========== Summary =========== --> |
170 |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
171 |
|
|
<TD> |
172 |
|
|
<CODE><B><A HREF='HTMLPageClass.html#add'>void add ( )</A></B></CODE> |
173 |
|
|
<BR> |
174 |
|
|
<blockquote> This function adds content to the <body> |
175 |
|
|
area of the page. </blockquote> |
176 |
|
|
</TD> |
177 |
|
|
</TR> |
178 |
|
|
|
179 |
|
|
<!-- =========== Summary =========== --> |
180 |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
181 |
|
|
<TD> |
182 |
|
|
<CODE><B><A HREF='HTMLPageClass.html#add_css_link'>void add_css_link ( $link )</A></B></CODE> |
183 |
|
|
<BR> |
184 |
|
|
<blockquote> pushes a css external reference to the head area </blockquote> |
185 |
|
|
</TD> |
186 |
|
|
</TR> |
187 |
|
|
|
188 |
|
|
<!-- =========== Summary =========== --> |
189 |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
190 |
|
|
<TD> |
191 |
|
|
<CODE><B><A HREF='HTMLPageClass.html#add_head_content'>void add_head_content ( )</A></B></CODE> |
192 |
|
|
<BR> |
193 |
|
|
<blockquote> this adds content to the head tag |
194 |
|
|
of the page </blockquote> |
195 |
|
|
</TD> |
196 |
|
|
</TR> |
197 |
|
|
|
198 |
|
|
<!-- =========== Summary =========== --> |
199 |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
200 |
|
|
<TD> |
201 |
|
|
<CODE><B><A HREF='HTMLPageClass.html#add_head_css'>void add_head_css ( $css )</A></B></CODE> |
202 |
|
|
<BR> |
203 |
|
|
<blockquote> this function adds raw css to the |
204 |
|
|
<head> tag. </blockquote> |
205 |
|
|
</TD> |
206 |
|
|
</TR> |
207 |
|
|
|
208 |
|
|
<!-- =========== Summary =========== --> |
209 |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
210 |
|
|
<TD> |
211 |
|
|
<CODE><B><A HREF='HTMLPageClass.html#add_head_js'>void add_head_js ( $content )</A></B></CODE> |
212 |
|
|
<BR> |
213 |
|
|
<blockquote> adds raw javascript to the head which |
214 |
|
|
will automatically get wrapped in a |
215 |
|
|
<script language="JavaScript"> tag. </blockquote> |
216 |
|
|
</TD> |
217 |
|
|
</TR> |
218 |
|
|
|
219 |
|
|
<!-- =========== Summary =========== --> |
220 |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
221 |
|
|
<TD> |
222 |
|
|
<CODE><B><A HREF='HTMLPageClass.html#add_reference'>void add_reference ( &$content )</A></B></CODE> |
223 |
|
|
<BR> |
224 |
|
|
<blockquote> Adds the content reference to the <body> |
225 |
|
|
tag for later use. </blockquote> |
226 |
|
|
</TD> |
227 |
|
|
</TR> |
228 |
|
|
|
229 |
|
|
<!-- =========== Summary =========== --> |
230 |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
231 |
|
|
<TD> |
232 |
|
|
<CODE><B><A HREF='HTMLPageClass.html#build_doctype'>void build_doctype ( $link1, [$link2 = NULL] )</A></B></CODE> |
233 |
|
|
<BR> |
234 |
|
|
<blockquote> This function is used to build the DOCTYPE |
235 |
|
|
tag for the page. </blockquote> |
236 |
|
|
</TD> |
237 |
|
|
</TR> |
238 |
|
|
|
239 |
|
|
<!-- =========== Summary =========== --> |
240 |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
241 |
|
|
<TD> |
242 |
|
|
<CODE><B><A HREF='HTMLPageClass.html#get_html_attributes'>array(); get_html_attributes ( )</A></B></CODE> |
243 |
|
|
<BR> |
244 |
|
|
<blockquote> This function returns the |
245 |
|
|
attributes to be used for the |
246 |
|
|
<html> tag. </blockquote> |
247 |
|
|
</TD> |
248 |
|
|
</TR> |
249 |
|
|
|
250 |
|
|
<!-- =========== Summary =========== --> |
251 |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
252 |
|
|
<TD> |
253 |
|
|
<CODE><B><A HREF='HTMLPageClass.html#push'>void push ( )</A></B></CODE> |
254 |
|
|
<BR> |
255 |
|
|
<blockquote> Same as add() </blockquote> |
256 |
|
|
</TD> |
257 |
|
|
</TR> |
258 |
|
|
|
259 |
|
|
<!-- =========== Summary =========== --> |
260 |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
261 |
|
|
<TD> |
262 |
|
|
<CODE><B><A HREF='HTMLPageClass.html#push_css_link'>void push_css_link ( $link )</A></B></CODE> |
263 |
|
|
<BR> |
264 |
|
|
<blockquote> Same ass add_css_link() </blockquote> |
265 |
|
|
</TD> |
266 |
|
|
</TR> |
267 |
|
|
|
268 |
|
|
<!-- =========== Summary =========== --> |
269 |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
270 |
|
|
<TD> |
271 |
|
|
<CODE><B><A HREF='HTMLPageClass.html#push_head_content'>void push_head_content ( )</A></B></CODE> |
272 |
|
|
<BR> |
273 |
|
|
<blockquote> Same ass add_head_content() </blockquote> |
274 |
|
|
</TD> |
275 |
|
|
</TR> |
276 |
|
|
|
277 |
|
|
<!-- =========== Summary =========== --> |
278 |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
279 |
|
|
<TD> |
280 |
|
|
<CODE><B><A HREF='HTMLPageClass.html#push_head_js'>void push_head_js ( $content )</A></B></CODE> |
281 |
|
|
<BR> |
282 |
|
|
<blockquote> Same ass add_head_js() </blockquote> |
283 |
|
|
</TD> |
284 |
|
|
</TR> |
285 |
|
|
|
286 |
|
|
<!-- =========== Summary =========== --> |
287 |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
288 |
|
|
<TD> |
289 |
|
|
<CODE><B><A HREF='HTMLPageClass.html#push_js_link'>void push_js_link ( $link )</A></B></CODE> |
290 |
|
|
<BR> |
291 |
|
|
<blockquote> pushes an link to an externally referenced javascript |
292 |
|
|
file, which will get rendered in the head. </blockquote> |
293 |
|
|
</TD> |
294 |
|
|
</TR> |
295 |
|
|
|
296 |
|
|
<!-- =========== Summary =========== --> |
297 |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
298 |
|
|
<TD> |
299 |
|
|
<CODE><B><A HREF='HTMLPageClass.html#push_reference'>void push_reference ( &$content )</A></B></CODE> |
300 |
|
|
<BR> |
301 |
|
|
<blockquote> Same as add() </blockquote> |
302 |
|
|
</TD> |
303 |
|
|
</TR> |
304 |
|
|
|
305 |
|
|
<!-- =========== Summary =========== --> |
306 |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
307 |
|
|
<TD> |
308 |
|
|
<CODE><B><A HREF='HTMLPageClass.html#render'>string render ( )</A></B></CODE> |
309 |
|
|
<BR> |
310 |
|
|
<blockquote> render the page. </blockquote> |
311 |
|
|
</TD> |
312 |
|
|
</TR> |
313 |
|
|
|
314 |
|
|
<!-- =========== Summary =========== --> |
315 |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
316 |
|
|
<TD> |
317 |
|
|
<CODE><B><A HREF='HTMLPageClass.html#set_body_attributes'>void set_body_attributes ( $attributes )</A></B></CODE> |
318 |
|
|
<BR> |
319 |
|
|
<blockquote> set attributes of body tag </blockquote> |
320 |
|
|
</TD> |
321 |
|
|
</TR> |
322 |
|
|
|
323 |
|
|
<!-- =========== Summary =========== --> |
324 |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
325 |
|
|
<TD> |
326 |
|
|
<CODE><B><A HREF='HTMLPageClass.html#set_charset'>void set_charset ( $charset )</A></B></CODE> |
327 |
|
|
<BR> |
328 |
|
|
<blockquote> set the character set </blockquote> |
329 |
|
|
</TD> |
330 |
|
|
</TR> |
331 |
|
|
|
332 |
|
|
<!-- =========== Summary =========== --> |
333 |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
334 |
|
|
<TD> |
335 |
|
|
<CODE><B><A HREF='HTMLPageClass.html#set_frameset'>void set_frameset ( $frameset )</A></B></CODE> |
336 |
|
|
<BR> |
337 |
|
|
<blockquote> This function is used to set the FRAMSETtag |
338 |
|
|
object for this page. </blockquote> |
339 |
|
|
</TD> |
340 |
|
|
</TR> |
341 |
|
|
|
342 |
|
|
<!-- =========== Summary =========== --> |
343 |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
344 |
|
|
<TD> |
345 |
|
|
<CODE><B><A HREF='HTMLPageClass.html#set_html_attributes'>void set_html_attributes ( $attributes )</A></B></CODE> |
346 |
|
|
<BR> |
347 |
|
|
<blockquote> This function sets the attributes |
348 |
|
|
for the <html> tag </blockquote> |
349 |
|
|
</TD> |
350 |
|
|
</TR> |
351 |
|
|
|
352 |
|
|
<!-- =========== Summary =========== --> |
353 |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
354 |
|
|
<TD> |
355 |
|
|
<CODE><B><A HREF='HTMLPageClass.html#set_refresh'>void set_refresh ( $time, [$url = NULL] )</A></B></CODE> |
356 |
|
|
<BR> |
357 |
|
|
<blockquote> Automatically set a page meta tag refresh </blockquote> |
358 |
|
|
</TD> |
359 |
|
|
</TR> |
360 |
|
|
|
361 |
|
|
<!-- =========== Summary =========== --> |
362 |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
363 |
|
|
<TD> |
364 |
|
|
<CODE><B><A HREF='HTMLPageClass.html#set_text_debug'>void set_text_debug ( $flag )</A></B></CODE> |
365 |
|
|
<BR> |
366 |
|
|
<blockquote> set the $_text_debug flag </blockquote> |
367 |
|
|
</TD> |
368 |
|
|
</TR> |
369 |
|
|
|
370 |
|
|
<!-- =========== Summary =========== --> |
371 |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
372 |
|
|
<TD> |
373 |
|
|
<CODE><B><A HREF='HTMLPageClass.html#set_title'>void set_title ( $title )</A></B></CODE> |
374 |
|
|
<BR> |
375 |
|
|
<blockquote> set the title of the page output. </blockquote> |
376 |
|
|
</TD> |
377 |
|
|
</TR> |
378 |
|
|
|
379 |
|
|
<!-- =========== Summary =========== --> |
380 |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
381 |
|
|
<TD> |
382 |
|
|
<CODE><B><A HREF='HTMLPageClass.html#_build_content_type_tag'>void _build_content_type_tag ( )</A></B></CODE> |
383 |
|
|
<BR> |
384 |
|
|
<blockquote> this builds the content type meta tag. </blockquote> |
385 |
|
|
</TD> |
386 |
|
|
</TR> |
387 |
|
|
|
388 |
|
|
<!-- =========== Summary =========== --> |
389 |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
390 |
|
|
<TD> |
391 |
|
|
<CODE><B><A HREF='HTMLPageClass.html#_build_head'>void _build_head ( )</A></B></CODE> |
392 |
|
|
<BR> |
393 |
|
|
<blockquote> builds the head object and its content. </blockquote> |
394 |
|
|
</TD> |
395 |
|
|
</TR> |
396 |
|
|
|
397 |
|
|
<!-- =========== Summary =========== --> |
398 |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
399 |
|
|
<TD> |
400 |
|
|
<CODE><B><A HREF='HTMLPageClass.html#_create_body'>void _create_body ( )</A></B></CODE> |
401 |
|
|
<BR> |
402 |
|
|
<blockquote> This is responsible for creating the </blockquote> |
403 |
|
|
</TD> |
404 |
|
|
</TR> |
405 |
|
|
|
406 |
|
|
<!-- =========== Summary =========== --> |
407 |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
408 |
|
|
<TD> |
409 |
|
|
<CODE><B><A HREF='HTMLPageClass.html#_frameset_wrap_body'><a href="../phpHtmlLib/NOFRAMEStag.html">NOFRAMEStag</a> _frameset_wrap_body ( )</A></B></CODE> |
410 |
|
|
<BR> |
411 |
|
|
<blockquote> This builds a frameset body tag |
412 |
|
|
wrapped in a <noframes> tag. </blockquote> |
413 |
|
|
</TD> |
414 |
|
|
</TR> |
415 |
|
|
|
416 |
|
|
</TABLE> |
417 |
|
|
|
418 |
|
|
<hr> |
419 |
|
|
<!-- ============ VARIABLE DETAIL =========== --> |
420 |
|
|
|
421 |
|
|
<A NAME='variable_detail'></A> |
422 |
|
|
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
423 |
|
|
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
424 |
|
|
<TD> |
425 |
|
|
<span CLASS="font12bold">Variable Detail</span> |
426 |
|
|
<A HREF="#top" CLASS="links">^TOP</A> |
427 |
|
|
</TD> |
428 |
|
|
</TR> |
429 |
|
|
</TABLE> |
430 |
|
|
|
431 |
|
|
|
432 |
|
|
<A NAME='$_html_attributes'><!-- --></A><H3>$_html_attributes</H3> |
433 |
|
|
<b>Data type:</b> array<br> |
434 |
|
|
<!-- ========== Info from phpDoc block ========= --> |
435 |
|
|
This holds the attributes for the |
436 |
|
|
<html> tag. |
437 |
|
|
<BR> |
438 |
|
|
|
439 |
|
|
|
440 |
|
|
<UL> |
441 |
|
|
|
442 |
|
|
</UL> |
443 |
|
|
|
444 |
|
|
<HR> |
445 |
|
|
|
446 |
|
|
<A NAME='$_indent_style'><!-- --></A><H3>$_indent_style</H3> |
447 |
|
|
<b>Data type:</b> int<br> |
448 |
|
|
<!-- ========== Info from phpDoc block ========= --> |
449 |
|
|
Holds the value of the indent |
450 |
|
|
<BR> |
451 |
|
|
style the user wants to render |
452 |
|
|
the page w/ |
453 |
|
|
|
454 |
|
|
<UL> |
455 |
|
|
|
456 |
|
|
</UL> |
457 |
|
|
|
458 |
|
|
<HR> |
459 |
|
|
|
460 |
|
|
<A NAME='$_widget_css_auto'><!-- --></A><H3>$_widget_css_auto</H3> |
461 |
|
|
<b>Data type:</b> array<br> |
462 |
|
|
<!-- ========== Info from phpDoc block ========= --> |
463 |
|
|
keeps track of which widgets we have |
464 |
|
|
automatically pulled in css for |
465 |
|
|
<BR> |
466 |
|
|
|
467 |
|
|
|
468 |
|
|
<UL> |
469 |
|
|
|
470 |
|
|
</UL> |
471 |
|
|
|
472 |
|
|
<HR> |
473 |
|
|
|
474 |
|
|
<A NAME='$_widget_js_auto'><!-- --></A><H3>$_widget_js_auto</H3> |
475 |
|
|
<b>Data type:</b> array<br> |
476 |
|
|
<!-- ========== Info from phpDoc block ========= --> |
477 |
|
|
keeps track of which widgets we have |
478 |
|
|
automatically pulled in js for |
479 |
|
|
<BR> |
480 |
|
|
|
481 |
|
|
|
482 |
|
|
<UL> |
483 |
|
|
|
484 |
|
|
</UL> |
485 |
|
|
|
486 |
|
|
<HR> |
487 |
|
|
|
488 |
|
|
|
489 |
|
|
<hr> |
490 |
|
|
<!-- ============ FUNCTION DETAIL =========== --> |
491 |
|
|
|
492 |
|
|
<A NAME='function_detail'></A> |
493 |
|
|
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
494 |
|
|
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
495 |
|
|
<TD> |
496 |
|
|
<span class="font12bold">Method Detail</span> |
497 |
|
|
<A HREF="#top" CLASS="links">^TOP</A> |
498 |
|
|
</TD> |
499 |
|
|
</TR> |
500 |
|
|
</TABLE> |
501 |
|
|
<BR> |
502 |
|
|
|
503 |
|
|
<DIV CLASS="function"> |
504 |
|
|
<A NAME='constructor HTMLPageClass'><!-- --></A> |
505 |
|
|
<SPAN CLASS="font12bold">constructor HTMLPageClass</SPAN> |
506 |
|
|
<BR> |
507 |
|
|
<SPAN CLASS="font10bold">Useage : </SPAN> |
508 |
|
|
<span class="font10bold" style="color: #FF0000">void</SPAN> |
509 |
|
|
<span class="font10bold" style="color: #0000FF">constructor HTMLPageClass ( [$title = NULL], [$html_type = HTML], [$indent_style = INDENT_NICE] )</SPAN> |
510 |
|
|
<BR> |
511 |
|
|
|
512 |
|
|
<BR> |
513 |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
514 |
|
|
<!-- ========== Info from phpDoc block ========= --> |
515 |
|
|
Class Constructor |
516 |
|
|
<BR> |
517 |
|
|
|
518 |
|
|
<DL> |
519 |
|
|
<DT class="font10bold">Function Parameters:</DT> |
520 |
|
|
|
521 |
|
|
<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">$title</SPAN></SPAN> - one of 3 types of html to render. Setting this will |
522 |
|
|
make the object declare the gobal define which tells |
523 |
|
|
all of the tag objects what type of html tags to render. |
524 |
|
|
some tags support special features. such as the <IMG> |
525 |
|
|
tag. If xhtml is selected, the the IMGtag object and all |
526 |
|
|
utility functions will not render "border=0" as a default |
527 |
|
|
attribute, since this is not proper xhtml. |
528 |
|
|
"html" - HTML 4.0 (default) |
529 |
|
|
"xhtml_transitional" - render xhtml instead of html |
530 |
|
|
- doctype is XHTML transitional. |
531 |
|
|
"xhtml_strict" - render xhtml instead of html 4.0. |
532 |
|
|
- doctype is XHTML strict.</DD> |
533 |
|
|
|
534 |
|
|
<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">$html_type</SPAN></SPAN> - one of 2 types. INDENT_NICE or INDENT_LEFT_JUSTIFY |
535 |
|
|
This tells the page how to render the indenting of the |
536 |
|
|
output. By default it is set to INDENT_NICE, which nicely |
537 |
|
|
indents each nested tag. You can have all tags rendered |
538 |
|
|
left justified (smaller size in output) by using |
539 |
|
|
INDENT_LEFT_JUSTIFY</DD> |
540 |
|
|
|
541 |
|
|
|
542 |
|
|
<DT class="font10bold">Function Info:</DT> |
543 |
|
|
|
544 |
|
|
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Access</b> - public</DD> |
545 |
|
|
|
546 |
|
|
</DL> |
547 |
|
|
|
548 |
|
|
</DIV> |
549 |
|
|
<BR> |
550 |
|
|
|
551 |
|
|
<DIV CLASS="function"> |
552 |
|
|
<A NAME='add'><!-- --></A> |
553 |
|
|
<SPAN CLASS="font12bold">add</SPAN> |
554 |
|
|
<BR> |
555 |
|
|
<SPAN CLASS="font10bold">Useage : </SPAN> |
556 |
|
|
<span class="font10bold" style="color: #FF0000">void</SPAN> |
557 |
|
|
<span class="font10bold" style="color: #0000FF">add ( )</SPAN> |
558 |
|
|
<BR> |
559 |
|
|
|
560 |
|
|
<BR> |
561 |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
562 |
|
|
<!-- ========== Info from phpDoc block ========= --> |
563 |
|
|
This function adds content to the <body> |
564 |
|
|
area of the page. |
565 |
|
|
<BR> |
566 |
|
|
|
567 |
|
|
<DL> |
568 |
|
|
<DT class="font10bold">Function Parameters:</DT> |
569 |
|
|
|
570 |
|
|
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">mixed</SPAN> <span style="color: #0000FF;font-weight:bold">0</SPAN></SPAN> - any # of parameters</DD> |
571 |
|
|
|
572 |
|
|
|
573 |
|
|
<DT class="font10bold">Function Info:</DT> |
574 |
|
|
|
575 |
|
|
</DL> |
576 |
|
|
|
577 |
|
|
</DIV> |
578 |
|
|
<BR> |
579 |
|
|
|
580 |
|
|
<DIV CLASS="function"> |
581 |
|
|
<A NAME='add_css_link'><!-- --></A> |
582 |
|
|
<SPAN CLASS="font12bold">add_css_link</SPAN> |
583 |
|
|
<BR> |
584 |
|
|
<SPAN CLASS="font10bold">Useage : </SPAN> |
585 |
|
|
<span class="font10bold" style="color: #FF0000">void</SPAN> |
586 |
|
|
<span class="font10bold" style="color: #0000FF">add_css_link ( $link )</SPAN> |
587 |
|
|
<BR> |
588 |
|
|
|
589 |
|
|
<BR> |
590 |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
591 |
|
|
<!-- ========== Info from phpDoc block ========= --> |
592 |
|
|
pushes a css external reference to the head area |
593 |
|
|
<BR> |
594 |
|
|
|
595 |
|
|
<DL> |
596 |
|
|
<DT class="font10bold">Function Parameters:</DT> |
597 |
|
|
|
598 |
|
|
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">mixed</SPAN> <span style="color: #0000FF;font-weight:bold">$link</SPAN></SPAN> - link tag object or $url for a css.</DD> |
599 |
|
|
|
600 |
|
|
|
601 |
|
|
<DT class="font10bold">Function Info:</DT> |
602 |
|
|
|
603 |
|
|
</DL> |
604 |
|
|
|
605 |
|
|
</DIV> |
606 |
|
|
<BR> |
607 |
|
|
|
608 |
|
|
<DIV CLASS="function"> |
609 |
|
|
<A NAME='add_head_content'><!-- --></A> |
610 |
|
|
<SPAN CLASS="font12bold">add_head_content</SPAN> |
611 |
|
|
<BR> |
612 |
|
|
<SPAN CLASS="font10bold">Useage : </SPAN> |
613 |
|
|
<span class="font10bold" style="color: #FF0000">void</SPAN> |
614 |
|
|
<span class="font10bold" style="color: #0000FF">add_head_content ( )</SPAN> |
615 |
|
|
<BR> |
616 |
|
|
|
617 |
|
|
<BR> |
618 |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
619 |
|
|
<!-- ========== Info from phpDoc block ========= --> |
620 |
|
|
this adds content to the head tag |
621 |
|
|
of the page |
622 |
|
|
<BR> |
623 |
|
|
|
624 |
|
|
<DL> |
625 |
|
|
<DT class="font10bold">Function Parameters:</DT> |
626 |
|
|
|
627 |
|
|
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">mixed</SPAN> <span style="color: #0000FF;font-weight:bold">0</SPAN></SPAN> - any content to add</DD> |
628 |
|
|
|
629 |
|
|
|
630 |
|
|
<DT class="font10bold">Function Info:</DT> |
631 |
|
|
|
632 |
|
|
</DL> |
633 |
|
|
|
634 |
|
|
</DIV> |
635 |
|
|
<BR> |
636 |
|
|
|
637 |
|
|
<DIV CLASS="function"> |
638 |
|
|
<A NAME='add_head_css'><!-- --></A> |
639 |
|
|
<SPAN CLASS="font12bold">add_head_css</SPAN> |
640 |
|
|
<BR> |
641 |
|
|
<SPAN CLASS="font10bold">Useage : </SPAN> |
642 |
|
|
<span class="font10bold" style="color: #FF0000">void</SPAN> |
643 |
|
|
<span class="font10bold" style="color: #0000FF">add_head_css ( $css )</SPAN> |
644 |
|
|
<BR> |
645 |
|
|
|
646 |
|
|
<BR> |
647 |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
648 |
|
|
<!-- ========== Info from phpDoc block ========= --> |
649 |
|
|
this function adds raw css to the |
650 |
|
|
<head> tag. |
651 |
|
|
<BR> |
652 |
|
|
It will automatically |
653 |
|
|
be wrapped in a <style type="text/css"> |
654 |
|
|
<DL> |
655 |
|
|
<DT class="font10bold">Function Parameters:</DT> |
656 |
|
|
|
657 |
|
|
<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">$css</SPAN></SPAN> - the raw css</DD> |
658 |
|
|
|
659 |
|
|
|
660 |
|
|
<DT class="font10bold">Function Info:</DT> |
661 |
|
|
|
662 |
|
|
</DL> |
663 |
|
|
|
664 |
|
|
</DIV> |
665 |
|
|
<BR> |
666 |
|
|
|
667 |
|
|
<DIV CLASS="function"> |
668 |
|
|
<A NAME='add_head_js'><!-- --></A> |
669 |
|
|
<SPAN CLASS="font12bold">add_head_js</SPAN> |
670 |
|
|
<BR> |
671 |
|
|
<SPAN CLASS="font10bold">Useage : </SPAN> |
672 |
|
|
<span class="font10bold" style="color: #FF0000">void</SPAN> |
673 |
|
|
<span class="font10bold" style="color: #0000FF">add_head_js ( $content )</SPAN> |
674 |
|
|
<BR> |
675 |
|
|
|
676 |
|
|
<BR> |
677 |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
678 |
|
|
<!-- ========== Info from phpDoc block ========= --> |
679 |
|
|
adds raw javascript to the head which |
680 |
|
|
will automatically get wrapped in a |
681 |
|
|
<script language="JavaScript"> tag. |
682 |
|
|
<BR> |
683 |
|
|
|
684 |
|
|
<DL> |
685 |
|
|
<DT class="font10bold">Function Parameters:</DT> |
686 |
|
|
|
687 |
|
|
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">mixed</SPAN> <span style="color: #0000FF;font-weight:bold">$content</SPAN></SPAN> - raw javascript code to add to the head</DD> |
688 |
|
|
|
689 |
|
|
|
690 |
|
|
<DT class="font10bold">Function Info:</DT> |
691 |
|
|
|
692 |
|
|
</DL> |
693 |
|
|
|
694 |
|
|
</DIV> |
695 |
|
|
<BR> |
696 |
|
|
|
697 |
|
|
<DIV CLASS="function"> |
698 |
|
|
<A NAME='add_reference'><!-- --></A> |
699 |
|
|
<SPAN CLASS="font12bold">add_reference</SPAN> |
700 |
|
|
<BR> |
701 |
|
|
<SPAN CLASS="font10bold">Useage : </SPAN> |
702 |
|
|
<span class="font10bold" style="color: #FF0000">void</SPAN> |
703 |
|
|
<span class="font10bold" style="color: #0000FF">add_reference ( &$content )</SPAN> |
704 |
|
|
<BR> |
705 |
|
|
|
706 |
|
|
<BR> |
707 |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
708 |
|
|
<!-- ========== Info from phpDoc block ========= --> |
709 |
|
|
Adds the content reference to the <body> |
710 |
|
|
tag for later use. |
711 |
|
|
<BR> |
712 |
|
|
|
713 |
|
|
<DL> |
714 |
|
|
<DT class="font10bold">Function Parameters:</DT> |
715 |
|
|
|
716 |
|
|
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">mixed</SPAN> <span style="color: #0000FF;font-weight:bold">$content</SPAN></SPAN> - content to add</DD> |
717 |
|
|
|
718 |
|
|
|
719 |
|
|
<DT class="font10bold">Function Info:</DT> |
720 |
|
|
|
721 |
|
|
</DL> |
722 |
|
|
|
723 |
|
|
</DIV> |
724 |
|
|
<BR> |
725 |
|
|
|
726 |
|
|
<DIV CLASS="function"> |
727 |
|
|
<A NAME='build_doctype'><!-- --></A> |
728 |
|
|
<SPAN CLASS="font12bold">build_doctype</SPAN> |
729 |
|
|
<BR> |
730 |
|
|
<SPAN CLASS="font10bold">Useage : </SPAN> |
731 |
|
|
<span class="font10bold" style="color: #FF0000">void</SPAN> |
732 |
|
|
<span class="font10bold" style="color: #0000FF">build_doctype ( $link1, [$link2 = NULL] )</SPAN> |
733 |
|
|
<BR> |
734 |
|
|
|
735 |
|
|
<BR> |
736 |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
737 |
|
|
<!-- ========== Info from phpDoc block ========= --> |
738 |
|
|
This function is used to build the DOCTYPE |
739 |
|
|
tag for the page. |
740 |
|
|
<BR> |
741 |
|
|
It will automatically |
742 |
|
|
create a DOCTYPE with a document_element of "html" |
743 |
|
|
and a source of "PUBLIC" |
744 |
|
|
<DL> |
745 |
|
|
<DT class="font10bold">Function Parameters:</DT> |
746 |
|
|
|
747 |
|
|
<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">$link1</SPAN></SPAN> - link1</DD> |
748 |
|
|
|
749 |
|
|
<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">$link2</SPAN></SPAN> - link2</DD> |
750 |
|
|
|
751 |
|
|
|
752 |
|
|
<DT class="font10bold">Function Info:</DT> |
753 |
|
|
|
754 |
|
|
</DL> |
755 |
|
|
|
756 |
|
|
</DIV> |
757 |
|
|
<BR> |
758 |
|
|
|
759 |
|
|
<DIV CLASS="function"> |
760 |
|
|
<A NAME='get_html_attributes'><!-- --></A> |
761 |
|
|
<SPAN CLASS="font12bold">get_html_attributes</SPAN> |
762 |
|
|
<BR> |
763 |
|
|
<SPAN CLASS="font10bold">Useage : </SPAN> |
764 |
|
|
<span class="font10bold" style="color: #FF0000">array();</SPAN> |
765 |
|
|
<span class="font10bold" style="color: #0000FF">get_html_attributes ( )</SPAN> |
766 |
|
|
<BR> |
767 |
|
|
|
768 |
|
|
<BR> |
769 |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
770 |
|
|
<!-- ========== Info from phpDoc block ========= --> |
771 |
|
|
This function returns the |
772 |
|
|
attributes to be used for the |
773 |
|
|
<html> tag. |
774 |
|
|
<BR> |
775 |
|
|
|
776 |
|
|
<DL> |
777 |
|
|
<DT class="font10bold">Function Parameters:</DT> |
778 |
|
|
|
779 |
|
|
|
780 |
|
|
<DT class="font10bold">Function Info:</DT> |
781 |
|
|
|
782 |
|
|
</DL> |
783 |
|
|
|
784 |
|
|
</DIV> |
785 |
|
|
<BR> |
786 |
|
|
|
787 |
|
|
<DIV CLASS="function"> |
788 |
|
|
<A NAME='push'><!-- --></A> |
789 |
|
|
<SPAN CLASS="font12bold">push</SPAN> |
790 |
|
|
<BR> |
791 |
|
|
<SPAN CLASS="font10bold">Useage : </SPAN> |
792 |
|
|
<span class="font10bold" style="color: #FF0000">void</SPAN> |
793 |
|
|
<span class="font10bold" style="color: #0000FF">push ( )</SPAN> |
794 |
|
|
<BR> |
795 |
|
|
|
796 |
|
|
<BR> |
797 |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
798 |
|
|
<!-- ========== Info from phpDoc block ========= --> |
799 |
|
|
Same as add() |
800 |
|
|
<BR> |
801 |
|
|
|
802 |
|
|
<DL> |
803 |
|
|
<DT class="font10bold">Function Parameters:</DT> |
804 |
|
|
|
805 |
|
|
|
806 |
|
|
<DT class="font10bold">Function Info:</DT> |
807 |
|
|
|
808 |
|
|
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Deprecated</b> - - use add()</DD> |
809 |
|
|
|
810 |
|
|
</DL> |
811 |
|
|
|
812 |
|
|
</DIV> |
813 |
|
|
<BR> |
814 |
|
|
|
815 |
|
|
<DIV CLASS="function"> |
816 |
|
|
<A NAME='push_css_link'><!-- --></A> |
817 |
|
|
<SPAN CLASS="font12bold">push_css_link</SPAN> |
818 |
|
|
<BR> |
819 |
|
|
<SPAN CLASS="font10bold">Useage : </SPAN> |
820 |
|
|
<span class="font10bold" style="color: #FF0000">void</SPAN> |
821 |
|
|
<span class="font10bold" style="color: #0000FF">push_css_link ( $link )</SPAN> |
822 |
|
|
<BR> |
823 |
|
|
|
824 |
|
|
<BR> |
825 |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
826 |
|
|
<!-- ========== Info from phpDoc block ========= --> |
827 |
|
|
Same ass add_css_link() |
828 |
|
|
<BR> |
829 |
|
|
|
830 |
|
|
<DL> |
831 |
|
|
<DT class="font10bold">Function Parameters:</DT> |
832 |
|
|
|
833 |
|
|
|
834 |
|
|
<DT class="font10bold">Function Info:</DT> |
835 |
|
|
|
836 |
|
|
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Deprecated</b> - - use add_css_link();</DD> |
837 |
|
|
|
838 |
|
|
</DL> |
839 |
|
|
|
840 |
|
|
</DIV> |
841 |
|
|
<BR> |
842 |
|
|
|
843 |
|
|
<DIV CLASS="function"> |
844 |
|
|
<A NAME='push_head_content'><!-- --></A> |
845 |
|
|
<SPAN CLASS="font12bold">push_head_content</SPAN> |
846 |
|
|
<BR> |
847 |
|
|
<SPAN CLASS="font10bold">Useage : </SPAN> |
848 |
|
|
<span class="font10bold" style="color: #FF0000">void</SPAN> |
849 |
|
|
<span class="font10bold" style="color: #0000FF">push_head_content ( )</SPAN> |
850 |
|
|
<BR> |
851 |
|
|
|
852 |
|
|
<BR> |
853 |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
854 |
|
|
<!-- ========== Info from phpDoc block ========= --> |
855 |
|
|
Same ass add_head_content() |
856 |
|
|
<BR> |
857 |
|
|
|
858 |
|
|
<DL> |
859 |
|
|
<DT class="font10bold">Function Parameters:</DT> |
860 |
|
|
|
861 |
|
|
|
862 |
|
|
<DT class="font10bold">Function Info:</DT> |
863 |
|
|
|
864 |
|
|
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Deprecated</b> - - use add_head_content();</DD> |
865 |
|
|
|
866 |
|
|
</DL> |
867 |
|
|
|
868 |
|
|
</DIV> |
869 |
|
|
<BR> |
870 |
|
|
|
871 |
|
|
<DIV CLASS="function"> |
872 |
|
|
<A NAME='push_head_js'><!-- --></A> |
873 |
|
|
<SPAN CLASS="font12bold">push_head_js</SPAN> |
874 |
|
|
<BR> |
875 |
|
|
<SPAN CLASS="font10bold">Useage : </SPAN> |
876 |
|
|
<span class="font10bold" style="color: #FF0000">void</SPAN> |
877 |
|
|
<span class="font10bold" style="color: #0000FF">push_head_js ( $content )</SPAN> |
878 |
|
|
<BR> |
879 |
|
|
|
880 |
|
|
<BR> |
881 |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
882 |
|
|
<!-- ========== Info from phpDoc block ========= --> |
883 |
|
|
Same ass add_head_js() |
884 |
|
|
<BR> |
885 |
|
|
|
886 |
|
|
<DL> |
887 |
|
|
<DT class="font10bold">Function Parameters:</DT> |
888 |
|
|
|
889 |
|
|
|
890 |
|
|
<DT class="font10bold">Function Info:</DT> |
891 |
|
|
|
892 |
|
|
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Deprecated</b> - - use add_head_js();</DD> |
893 |
|
|
|
894 |
|
|
</DL> |
895 |
|
|
|
896 |
|
|
</DIV> |
897 |
|
|
<BR> |
898 |
|
|
|
899 |
|
|
<DIV CLASS="function"> |
900 |
|
|
<A NAME='push_js_link'><!-- --></A> |
901 |
|
|
<SPAN CLASS="font12bold">push_js_link</SPAN> |
902 |
|
|
<BR> |
903 |
|
|
<SPAN CLASS="font10bold">Useage : </SPAN> |
904 |
|
|
<span class="font10bold" style="color: #FF0000">void</SPAN> |
905 |
|
|
<span class="font10bold" style="color: #0000FF">push_js_link ( $link )</SPAN> |
906 |
|
|
<BR> |
907 |
|
|
|
908 |
|
|
<BR> |
909 |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
910 |
|
|
<!-- ========== Info from phpDoc block ========= --> |
911 |
|
|
pushes an link to an externally referenced javascript |
912 |
|
|
file, which will get rendered in the head. |
913 |
|
|
<BR> |
914 |
|
|
|
915 |
|
|
<DL> |
916 |
|
|
<DT class="font10bold">Function Parameters:</DT> |
917 |
|
|
|
918 |
|
|
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">mixed</SPAN> <span style="color: #0000FF;font-weight:bold">$link</SPAN></SPAN> - script tag object or $url of .js file.</DD> |
919 |
|
|
|
920 |
|
|
|
921 |
|
|
<DT class="font10bold">Function Info:</DT> |
922 |
|
|
|
923 |
|
|
</DL> |
924 |
|
|
|
925 |
|
|
</DIV> |
926 |
|
|
<BR> |
927 |
|
|
|
928 |
|
|
<DIV CLASS="function"> |
929 |
|
|
<A NAME='push_reference'><!-- --></A> |
930 |
|
|
<SPAN CLASS="font12bold">push_reference</SPAN> |
931 |
|
|
<BR> |
932 |
|
|
<SPAN CLASS="font10bold">Useage : </SPAN> |
933 |
|
|
<span class="font10bold" style="color: #FF0000">void</SPAN> |
934 |
|
|
<span class="font10bold" style="color: #0000FF">push_reference ( &$content )</SPAN> |
935 |
|
|
<BR> |
936 |
|
|
|
937 |
|
|
<BR> |
938 |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
939 |
|
|
<!-- ========== Info from phpDoc block ========= --> |
940 |
|
|
Same as add() |
941 |
|
|
<BR> |
942 |
|
|
|
943 |
|
|
<DL> |
944 |
|
|
<DT class="font10bold">Function Parameters:</DT> |
945 |
|
|
|
946 |
|
|
|
947 |
|
|
<DT class="font10bold">Function Info:</DT> |
948 |
|
|
|
949 |
|
|
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Deprecated</b> - - use add()</DD> |
950 |
|
|
|
951 |
|
|
</DL> |
952 |
|
|
|
953 |
|
|
</DIV> |
954 |
|
|
<BR> |
955 |
|
|
|
956 |
|
|
<DIV CLASS="function"> |
957 |
|
|
<A NAME='render'><!-- --></A> |
958 |
|
|
<SPAN CLASS="font12bold">render</SPAN> |
959 |
|
|
<BR> |
960 |
|
|
<SPAN CLASS="font10bold">Useage : </SPAN> |
961 |
|
|
<span class="font10bold" style="color: #FF0000">string</SPAN> |
962 |
|
|
<span class="font10bold" style="color: #0000FF">render ( )</SPAN> |
963 |
|
|
<BR> |
964 |
|
|
Overridden in child class(es) as: <a href="../phpHtmlLib/PageWidget.html#render">PageWidget::render()</a><br> |
965 |
|
|
<BR> |
966 |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
967 |
|
|
<!-- ========== Info from phpDoc block ========= --> |
968 |
|
|
render the page. |
969 |
|
|
<BR> |
970 |
|
|
|
971 |
|
|
<DL> |
972 |
|
|
<DT class="font10bold">Function Parameters:</DT> |
973 |
|
|
|
974 |
|
|
|
975 |
|
|
<DT class="font10bold">Function Info:</DT> |
976 |
|
|
|
977 |
|
|
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - the raw html output.</DD> |
978 |
|
|
|
979 |
|
|
</DL> |
980 |
|
|
|
981 |
|
|
</DIV> |
982 |
|
|
<BR> |
983 |
|
|
|
984 |
|
|
<DIV CLASS="function"> |
985 |
|
|
<A NAME='set_body_attributes'><!-- --></A> |
986 |
|
|
<SPAN CLASS="font12bold">set_body_attributes</SPAN> |
987 |
|
|
<BR> |
988 |
|
|
<SPAN CLASS="font10bold">Useage : </SPAN> |
989 |
|
|
<span class="font10bold" style="color: #FF0000">void</SPAN> |
990 |
|
|
<span class="font10bold" style="color: #0000FF">set_body_attributes ( $attributes )</SPAN> |
991 |
|
|
<BR> |
992 |
|
|
|
993 |
|
|
<BR> |
994 |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
995 |
|
|
<!-- ========== Info from phpDoc block ========= --> |
996 |
|
|
set attributes of body tag |
997 |
|
|
<BR> |
998 |
|
|
|
999 |
|
|
<DL> |
1000 |
|
|
<DT class="font10bold">Function Parameters:</DT> |
1001 |
|
|
|
1002 |
|
|
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">array</SPAN> <span style="color: #0000FF;font-weight:bold">$attributes</SPAN></SPAN> the name=>value pairs</DD> |
1003 |
|
|
|
1004 |
|
|
|
1005 |
|
|
<DT class="font10bold">Function Info:</DT> |
1006 |
|
|
|
1007 |
|
|
</DL> |
1008 |
|
|
|
1009 |
|
|
</DIV> |
1010 |
|
|
<BR> |
1011 |
|
|
|
1012 |
|
|
<DIV CLASS="function"> |
1013 |
|
|
<A NAME='set_charset'><!-- --></A> |
1014 |
|
|
<SPAN CLASS="font12bold">set_charset</SPAN> |
1015 |
|
|
<BR> |
1016 |
|
|
<SPAN CLASS="font10bold">Useage : </SPAN> |
1017 |
|
|
<span class="font10bold" style="color: #FF0000">void</SPAN> |
1018 |
|
|
<span class="font10bold" style="color: #0000FF">set_charset ( $charset )</SPAN> |
1019 |
|
|
<BR> |
1020 |
|
|
|
1021 |
|
|
<BR> |
1022 |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
1023 |
|
|
<!-- ========== Info from phpDoc block ========= --> |
1024 |
|
|
set the character set |
1025 |
|
|
<BR> |
1026 |
|
|
|
1027 |
|
|
<DL> |
1028 |
|
|
<DT class="font10bold">Function Parameters:</DT> |
1029 |
|
|
|
1030 |
|
|
<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">$charset</SPAN></SPAN> - the charset for the meta tag</DD> |
1031 |
|
|
|
1032 |
|
|
|
1033 |
|
|
<DT class="font10bold">Function Info:</DT> |
1034 |
|
|
|
1035 |
|
|
</DL> |
1036 |
|
|
|
1037 |
|
|
</DIV> |
1038 |
|
|
<BR> |
1039 |
|
|
|
1040 |
|
|
<DIV CLASS="function"> |
1041 |
|
|
<A NAME='set_frameset'><!-- --></A> |
1042 |
|
|
<SPAN CLASS="font12bold">set_frameset</SPAN> |
1043 |
|
|
<BR> |
1044 |
|
|
<SPAN CLASS="font10bold">Useage : </SPAN> |
1045 |
|
|
<span class="font10bold" style="color: #FF0000">void</SPAN> |
1046 |
|
|
<span class="font10bold" style="color: #0000FF">set_frameset ( $frameset )</SPAN> |
1047 |
|
|
<BR> |
1048 |
|
|
|
1049 |
|
|
<BR> |
1050 |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
1051 |
|
|
<!-- ========== Info from phpDoc block ========= --> |
1052 |
|
|
This function is used to set the FRAMSETtag |
1053 |
|
|
object for this page. |
1054 |
|
|
<BR> |
1055 |
|
|
This automatically |
1056 |
|
|
sets the output for this page object to |
1057 |
|
|
be a frameset. |
1058 |
|
|
<DL> |
1059 |
|
|
<DT class="font10bold">Function Parameters:</DT> |
1060 |
|
|
|
1061 |
|
|
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;"><a href="../phpHtmlLib/FRAMESETtag.html">FRAMESETtag</a></SPAN> <span style="color: #0000FF;font-weight:bold">$frameset</SPAN></SPAN> object -</DD> |
1062 |
|
|
|
1063 |
|
|
|
1064 |
|
|
<DT class="font10bold">Function Info:</DT> |
1065 |
|
|
|
1066 |
|
|
</DL> |
1067 |
|
|
|
1068 |
|
|
</DIV> |
1069 |
|
|
<BR> |
1070 |
|
|
|
1071 |
|
|
<DIV CLASS="function"> |
1072 |
|
|
<A NAME='set_html_attributes'><!-- --></A> |
1073 |
|
|
<SPAN CLASS="font12bold">set_html_attributes</SPAN> |
1074 |
|
|
<BR> |
1075 |
|
|
<SPAN CLASS="font10bold">Useage : </SPAN> |
1076 |
|
|
<span class="font10bold" style="color: #FF0000">void</SPAN> |
1077 |
|
|
<span class="font10bold" style="color: #0000FF">set_html_attributes ( $attributes )</SPAN> |
1078 |
|
|
<BR> |
1079 |
|
|
|
1080 |
|
|
<BR> |
1081 |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
1082 |
|
|
<!-- ========== Info from phpDoc block ========= --> |
1083 |
|
|
This function sets the attributes |
1084 |
|
|
for the <html> tag |
1085 |
|
|
<BR> |
1086 |
|
|
|
1087 |
|
|
<DL> |
1088 |
|
|
<DT class="font10bold">Function Parameters:</DT> |
1089 |
|
|
|
1090 |
|
|
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">array</SPAN> <span style="color: #0000FF;font-weight:bold">$attributes</SPAN></SPAN> - the name=>value |
1091 |
|
|
pair for the |
1092 |
|
|
attributes</DD> |
1093 |
|
|
|
1094 |
|
|
|
1095 |
|
|
<DT class="font10bold">Function Info:</DT> |
1096 |
|
|
|
1097 |
|
|
</DL> |
1098 |
|
|
|
1099 |
|
|
</DIV> |
1100 |
|
|
<BR> |
1101 |
|
|
|
1102 |
|
|
<DIV CLASS="function"> |
1103 |
|
|
<A NAME='set_refresh'><!-- --></A> |
1104 |
|
|
<SPAN CLASS="font12bold">set_refresh</SPAN> |
1105 |
|
|
<BR> |
1106 |
|
|
<SPAN CLASS="font10bold">Useage : </SPAN> |
1107 |
|
|
<span class="font10bold" style="color: #FF0000">void</SPAN> |
1108 |
|
|
<span class="font10bold" style="color: #0000FF">set_refresh ( $time, [$url = NULL] )</SPAN> |
1109 |
|
|
<BR> |
1110 |
|
|
|
1111 |
|
|
<BR> |
1112 |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
1113 |
|
|
<!-- ========== Info from phpDoc block ========= --> |
1114 |
|
|
Automatically set a page meta tag refresh |
1115 |
|
|
<BR> |
1116 |
|
|
|
1117 |
|
|
<DL> |
1118 |
|
|
<DT class="font10bold">Function Parameters:</DT> |
1119 |
|
|
|
1120 |
|
|
<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">$time</SPAN></SPAN> - time in seconds to refresh</DD> |
1121 |
|
|
|
1122 |
|
|
<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> - the url to go to.</DD> |
1123 |
|
|
|
1124 |
|
|
|
1125 |
|
|
<DT class="font10bold">Function Info:</DT> |
1126 |
|
|
|
1127 |
|
|
</DL> |
1128 |
|
|
|
1129 |
|
|
</DIV> |
1130 |
|
|
<BR> |
1131 |
|
|
|
1132 |
|
|
<DIV CLASS="function"> |
1133 |
|
|
<A NAME='set_text_debug'><!-- --></A> |
1134 |
|
|
<SPAN CLASS="font12bold">set_text_debug</SPAN> |
1135 |
|
|
<BR> |
1136 |
|
|
<SPAN CLASS="font10bold">Useage : </SPAN> |
1137 |
|
|
<span class="font10bold" style="color: #FF0000">void</SPAN> |
1138 |
|
|
<span class="font10bold" style="color: #0000FF">set_text_debug ( $flag )</SPAN> |
1139 |
|
|
<BR> |
1140 |
|
|
|
1141 |
|
|
<BR> |
1142 |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
1143 |
|
|
<!-- ========== Info from phpDoc block ========= --> |
1144 |
|
|
set the $_text_debug flag |
1145 |
|
|
<BR> |
1146 |
|
|
|
1147 |
|
|
<DL> |
1148 |
|
|
<DT class="font10bold">Function Parameters:</DT> |
1149 |
|
|
|
1150 |
|
|
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">$flag</SPAN> <span style="color: #0000FF;font-weight:bold">$flag</SPAN></SPAN> - boolean.</DD> |
1151 |
|
|
|
1152 |
|
|
|
1153 |
|
|
<DT class="font10bold">Function Info:</DT> |
1154 |
|
|
|
1155 |
|
|
</DL> |
1156 |
|
|
|
1157 |
|
|
</DIV> |
1158 |
|
|
<BR> |
1159 |
|
|
|
1160 |
|
|
<DIV CLASS="function"> |
1161 |
|
|
<A NAME='set_title'><!-- --></A> |
1162 |
|
|
<SPAN CLASS="font12bold">set_title</SPAN> |
1163 |
|
|
<BR> |
1164 |
|
|
<SPAN CLASS="font10bold">Useage : </SPAN> |
1165 |
|
|
<span class="font10bold" style="color: #FF0000">void</SPAN> |
1166 |
|
|
<span class="font10bold" style="color: #0000FF">set_title ( $title )</SPAN> |
1167 |
|
|
<BR> |
1168 |
|
|
|
1169 |
|
|
<BR> |
1170 |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
1171 |
|
|
<!-- ========== Info from phpDoc block ========= --> |
1172 |
|
|
set the title of the page output. |
1173 |
|
|
<BR> |
1174 |
|
|
|
1175 |
|
|
<DL> |
1176 |
|
|
<DT class="font10bold">Function Parameters:</DT> |
1177 |
|
|
|
1178 |
|
|
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">mixed</SPAN> <span style="color: #0000FF;font-weight:bold">$title</SPAN></SPAN> - the title of the html page |
1179 |
|
|
can be TITLEtag object.</DD> |
1180 |
|
|
|
1181 |
|
|
|
1182 |
|
|
<DT class="font10bold">Function Info:</DT> |
1183 |
|
|
|
1184 |
|
|
</DL> |
1185 |
|
|
|
1186 |
|
|
</DIV> |
1187 |
|
|
<BR> |
1188 |
|
|
|
1189 |
|
|
<DIV CLASS="function"> |
1190 |
|
|
<A NAME='_build_content_type_tag'><!-- --></A> |
1191 |
|
|
<SPAN CLASS="font12bold">_build_content_type_tag</SPAN> |
1192 |
|
|
<BR> |
1193 |
|
|
<SPAN CLASS="font10bold">Useage : </SPAN> |
1194 |
|
|
<span class="font10bold" style="color: #FF0000">void</SPAN> |
1195 |
|
|
<span class="font10bold" style="color: #0000FF">_build_content_type_tag ( )</SPAN> |
1196 |
|
|
<BR> |
1197 |
|
|
|
1198 |
|
|
<BR> |
1199 |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
1200 |
|
|
<!-- ========== Info from phpDoc block ========= --> |
1201 |
|
|
this builds the content type meta tag. |
1202 |
|
|
<BR> |
1203 |
|
|
|
1204 |
|
|
<DL> |
1205 |
|
|
<DT class="font10bold">Function Parameters:</DT> |
1206 |
|
|
|
1207 |
|
|
|
1208 |
|
|
<DT class="font10bold">Function Info:</DT> |
1209 |
|
|
|
1210 |
|
|
</DL> |
1211 |
|
|
|
1212 |
|
|
</DIV> |
1213 |
|
|
<BR> |
1214 |
|
|
|
1215 |
|
|
<DIV CLASS="function"> |
1216 |
|
|
<A NAME='_build_head'><!-- --></A> |
1217 |
|
|
<SPAN CLASS="font12bold">_build_head</SPAN> |
1218 |
|
|
<BR> |
1219 |
|
|
<SPAN CLASS="font10bold">Useage : </SPAN> |
1220 |
|
|
<span class="font10bold" style="color: #FF0000">void</SPAN> |
1221 |
|
|
<span class="font10bold" style="color: #0000FF">_build_head ( )</SPAN> |
1222 |
|
|
<BR> |
1223 |
|
|
|
1224 |
|
|
<BR> |
1225 |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
1226 |
|
|
<!-- ========== Info from phpDoc block ========= --> |
1227 |
|
|
builds the head object and its content. |
1228 |
|
|
<BR> |
1229 |
|
|
|
1230 |
|
|
<DL> |
1231 |
|
|
<DT class="font10bold">Function Parameters:</DT> |
1232 |
|
|
|
1233 |
|
|
|
1234 |
|
|
<DT class="font10bold">Function Info:</DT> |
1235 |
|
|
|
1236 |
|
|
</DL> |
1237 |
|
|
|
1238 |
|
|
</DIV> |
1239 |
|
|
<BR> |
1240 |
|
|
|
1241 |
|
|
<DIV CLASS="function"> |
1242 |
|
|
<A NAME='_create_body'><!-- --></A> |
1243 |
|
|
<SPAN CLASS="font12bold">_create_body</SPAN> |
1244 |
|
|
<BR> |
1245 |
|
|
<SPAN CLASS="font10bold">Useage : </SPAN> |
1246 |
|
|
<span class="font10bold" style="color: #FF0000">void</SPAN> |
1247 |
|
|
<span class="font10bold" style="color: #0000FF">_create_body ( )</SPAN> |
1248 |
|
|
<BR> |
1249 |
|
|
|
1250 |
|
|
<BR> |
1251 |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
1252 |
|
|
<!-- ========== Info from phpDoc block ========= --> |
1253 |
|
|
This is responsible for creating the |
1254 |
|
|
<BR> |
1255 |
|
|
BODYtag object. We only will |
1256 |
|
|
create a new $this->_body if it doesn't |
1257 |
|
|
already exist. |
1258 |
|
|
<DL> |
1259 |
|
|
<DT class="font10bold">Function Parameters:</DT> |
1260 |
|
|
|
1261 |
|
|
|
1262 |
|
|
<DT class="font10bold">Function Info:</DT> |
1263 |
|
|
|
1264 |
|
|
</DL> |
1265 |
|
|
|
1266 |
|
|
</DIV> |
1267 |
|
|
<BR> |
1268 |
|
|
|
1269 |
|
|
<DIV CLASS="function"> |
1270 |
|
|
<A NAME='_frameset_wrap_body'><!-- --></A> |
1271 |
|
|
<SPAN CLASS="font12bold">_frameset_wrap_body</SPAN> |
1272 |
|
|
<BR> |
1273 |
|
|
<SPAN CLASS="font10bold">Useage : </SPAN> |
1274 |
|
|
<span class="font10bold" style="color: #FF0000"><a href="../phpHtmlLib/NOFRAMEStag.html">NOFRAMEStag</a></SPAN> |
1275 |
|
|
<span class="font10bold" style="color: #0000FF">_frameset_wrap_body ( )</SPAN> |
1276 |
|
|
<BR> |
1277 |
|
|
|
1278 |
|
|
<BR> |
1279 |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
1280 |
|
|
<!-- ========== Info from phpDoc block ========= --> |
1281 |
|
|
This builds a frameset body tag |
1282 |
|
|
wrapped in a <noframes> tag. |
1283 |
|
|
<BR> |
1284 |
|
|
|
1285 |
|
|
<DL> |
1286 |
|
|
<DT class="font10bold">Function Parameters:</DT> |
1287 |
|
|
|
1288 |
|
|
|
1289 |
|
|
<DT class="font10bold">Function Info:</DT> |
1290 |
|
|
|
1291 |
|
|
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - object.</DD> |
1292 |
|
|
|
1293 |
|
|
</DL> |
1294 |
|
|
|
1295 |
|
|
</DIV> |
1296 |
|
|
<BR> |
1297 |
|
|
|
1298 |
|
|
|
1299 |
|
|
<hr> |
1300 |
|
|
</HTML> |