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 MyLayoutPage</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 MyLayoutPage">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 MyLayoutPage |
33 |
</H2> |
34 |
|
35 |
<pre> |
36 |
<pre><a href="../../phpHtmlLib/HTMLPageClass.html">HTMLPageClass</a> |
37 |
| |
38 |
--<a href="../../phpHtmlLib/PageWidget.html">PageWidget</a> |
39 |
| |
40 |
--MyLayoutPage</pre> |
41 |
</pre> |
42 |
|
43 |
<A NAME="children_summary"</A> |
44 |
<H3> |
45 |
Classes extended from MyLayoutPage: <A HREF="#top" CLASS="links">^TOP</A> |
46 |
</H3> |
47 |
|
48 |
<p> |
49 |
<b><i>Located in File: Program_Root/examples/example3.php</i></b><br> |
50 |
</p> |
51 |
<hr> |
52 |
<!-- ========== Info from phpDoc block ========= --> |
53 |
|
54 |
<BR> |
55 |
|
56 |
|
57 |
<UL> |
58 |
|
59 |
<LI><b>Package</b> - <CODE>phpHtmlLib</CODE></LI> |
60 |
|
61 |
<LI><b>Sub-Package</b> - <CODE>examples</CODE></LI> |
62 |
|
63 |
</UL> |
64 |
|
65 |
<hr> |
66 |
<!-- =========== VAR SUMMARY =========== --> |
67 |
<A NAME='var_summary'><!-- --></A> |
68 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
69 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
70 |
<TD> |
71 |
<span CLASS="font12bold">Class Variable Summary</span> |
72 |
<A HREF="#top" CLASS="links">^TOP</A> |
73 |
</TD> |
74 |
</TR> |
75 |
|
76 |
|
77 |
</TABLE> |
78 |
|
79 |
<hr> |
80 |
<!-- =========== VAR INHERITED SUMMARY =========== --> |
81 |
<A NAME='var_inherited_summary'><!-- --></A> |
82 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
83 |
<TR CLASS='TableHeadingColor'> |
84 |
<TD> |
85 |
<span CLASS="font12bold">Inherited Class Variable Summary</span> |
86 |
<A HREF="#top" CLASS="links">^TOP</A> |
87 |
</TD> |
88 |
</TR> |
89 |
|
90 |
|
91 |
<!-- =========== Summary =========== --> |
92 |
<TR BGCOLOR='white'> |
93 |
<TD> |
94 |
<span CLASS="font10bold">Inherited From Class <a href="../../phpHtmlLib/PageWidget.html">PageWidget</a></span> |
95 |
<table CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center"> |
96 |
<tr CLASS="tableheadingcolor"> |
97 |
<th>Variable</th> |
98 |
<th>Default Value</th> |
99 |
<th>Description</th> |
100 |
</tr> |
101 |
|
102 |
<tr> |
103 |
<td CLASS="font10bold"><A HREF='../../phpHtmlLib/PageWidget.html#$_enable_debug'>$_enable_debug</A></td> |
104 |
<td CLASS="font10" STYLE="white-space: nowrap">->FALSE<-</td> |
105 |
<td CLASS="font10">This enables the ability to view the |
106 |
source of a page bu setting debug=1 |
107 |
in the query string.</td> |
108 |
</tr> |
109 |
|
110 |
<tr> |
111 |
<td CLASS="font10bold"><A HREF='../../phpHtmlLib/PageWidget.html#$_title_text'>$_title_text</A></td> |
112 |
<td CLASS="font10" STYLE="white-space: nowrap">->NULL<-</td> |
113 |
<td CLASS="font10">holds the page title text for |
114 |
a page</td> |
115 |
</tr> |
116 |
|
117 |
</table> |
118 |
<BR> |
119 |
</TD> |
120 |
</TR> |
121 |
|
122 |
<!-- =========== Summary =========== --> |
123 |
<TR BGCOLOR='white'> |
124 |
<TD> |
125 |
<span CLASS="font10bold">Inherited From Class <a href="../../phpHtmlLib/HTMLPageClass.html">HTMLPageClass</a></span> |
126 |
<table CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center"> |
127 |
<tr CLASS="tableheadingcolor"> |
128 |
<th>Variable</th> |
129 |
<th>Default Value</th> |
130 |
<th>Description</th> |
131 |
</tr> |
132 |
|
133 |
<tr> |
134 |
<td CLASS="font10bold"><A HREF='../../phpHtmlLib/HTMLPageClass.html#$_html_attributes'>$_html_attributes</A></td> |
135 |
<td CLASS="font10" STYLE="white-space: nowrap">->array()<-</td> |
136 |
<td CLASS="font10">This holds the attributes for the |
137 |
<html> tag.</td> |
138 |
</tr> |
139 |
|
140 |
<tr> |
141 |
<td CLASS="font10bold"><A HREF='../../phpHtmlLib/HTMLPageClass.html#$_indent_style'>$_indent_style</A></td> |
142 |
<td CLASS="font10" STYLE="white-space: nowrap">->0<-</td> |
143 |
<td CLASS="font10">Holds the value of the indent</td> |
144 |
</tr> |
145 |
|
146 |
<tr> |
147 |
<td CLASS="font10bold"><A HREF='../../phpHtmlLib/HTMLPageClass.html#$_widget_css_auto'>$_widget_css_auto</A></td> |
148 |
<td CLASS="font10" STYLE="white-space: nowrap">->array()<-</td> |
149 |
<td CLASS="font10">keeps track of which widgets we have |
150 |
automatically pulled in css for</td> |
151 |
</tr> |
152 |
|
153 |
<tr> |
154 |
<td CLASS="font10bold"><A HREF='../../phpHtmlLib/HTMLPageClass.html#$_widget_js_auto'>$_widget_js_auto</A></td> |
155 |
<td CLASS="font10" STYLE="white-space: nowrap">->array()<-</td> |
156 |
<td CLASS="font10">keeps track of which widgets we have |
157 |
automatically pulled in js for</td> |
158 |
</tr> |
159 |
|
160 |
</table> |
161 |
<BR> |
162 |
</TD> |
163 |
</TR> |
164 |
|
165 |
</TABLE> |
166 |
|
167 |
<hr> |
168 |
<!-- =========== INHERITED METHOD SUMMARY =========== --> |
169 |
<A NAME='functions_inherited'><!-- --></A> |
170 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
171 |
<TR CLASS='TableHeadingColor'> |
172 |
<TD> |
173 |
<span CLASS="font12bold">Inherited Method Summary</span> |
174 |
<A HREF="#top" CLASS="links">^TOP</A> |
175 |
</TD> |
176 |
</TR> |
177 |
|
178 |
|
179 |
<!-- =========== Summary =========== --> |
180 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
181 |
<TD> |
182 |
<span CLASS="font10bold">Inherited From Class <a href="../../phpHtmlLib/PageWidget.html">PageWidget</a></span> |
183 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center"> |
184 |
<tr CLASS="tableheadingcolor"> |
185 |
<th>Function</th> |
186 |
<th>Description</th> |
187 |
</tr> |
188 |
|
189 |
<tr> |
190 |
<td CLASS="font10bold"><A HREF='../../phpHtmlLib/PageWidget.html#constructor PageWidget'>constructor PageWidget ( [$title = ], [$render_type = HTML], [$indent_style = INDENT_NICE] )</A></td> |
191 |
<td CLASS="font10">Constructor:</td> |
192 |
|
193 |
<tr> |
194 |
<td CLASS="font10bold"><A HREF='../../phpHtmlLib/PageWidget.html#body_content'>body_content ( )</A></td> |
195 |
<td CLASS="font10">This function is meant to be overridden |
196 |
by the child class.</td> |
197 |
|
198 |
<tr> |
199 |
<td CLASS="font10bold"><A HREF='../../phpHtmlLib/PageWidget.html#enable_debug'>enable_debug ( [$flag = TRUE] )</A></td> |
200 |
<td CLASS="font10">This sets the debug option for |
201 |
the HTMLPageClass</td> |
202 |
|
203 |
<tr> |
204 |
<td CLASS="font10bold"><A HREF='../../phpHtmlLib/PageWidget.html#frameset'>frameset ( )</A></td> |
205 |
<td CLASS="font10">This function is used to save |
206 |
a frameset to the page.</td> |
207 |
|
208 |
<tr> |
209 |
<td CLASS="font10bold"><A HREF='../../phpHtmlLib/PageWidget.html#get_title'>get_title ( )</A></td> |
210 |
<td CLASS="font10">gets the current title of the page.</td> |
211 |
|
212 |
<tr> |
213 |
<td CLASS="font10bold"><A HREF='../../phpHtmlLib/PageWidget.html#head_content'>head_content ( )</A></td> |
214 |
<td CLASS="font10">This function is used to build</td> |
215 |
|
216 |
<tr> |
217 |
<td CLASS="font10bold"><A HREF='../../phpHtmlLib/PageWidget.html#head_javascript'>head_javascript ( )</A></td> |
218 |
<td CLASS="font10">This function is called to build |
219 |
any JavaScript that is needed in the |
220 |
<HEAD> portion of a document.</td> |
221 |
|
222 |
<tr> |
223 |
<td CLASS="font10bold"><A HREF='../../phpHtmlLib/PageWidget.html#render'>render ( )</A></td> |
224 |
<td CLASS="font10">This is the function that renders the HTML |
225 |
for this widget.</td> |
226 |
|
227 |
</table> |
228 |
<br> |
229 |
</TD> |
230 |
</TR> |
231 |
|
232 |
<!-- =========== Summary =========== --> |
233 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
234 |
<TD> |
235 |
<span CLASS="font10bold">Inherited From Class <a href="../../phpHtmlLib/HTMLPageClass.html">HTMLPageClass</a></span> |
236 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center"> |
237 |
<tr CLASS="tableheadingcolor"> |
238 |
<th>Function</th> |
239 |
<th>Description</th> |
240 |
</tr> |
241 |
|
242 |
<tr> |
243 |
<td CLASS="font10bold"><A HREF='../../phpHtmlLib/HTMLPageClass.html#constructor HTMLPageClass'>constructor HTMLPageClass ( [$title = NULL], [$html_type = HTML], [$indent_style = INDENT_NICE] )</A></td> |
244 |
<td CLASS="font10">Class Constructor</td> |
245 |
|
246 |
<tr> |
247 |
<td CLASS="font10bold"><A HREF='../../phpHtmlLib/HTMLPageClass.html#add'>add ( )</A></td> |
248 |
<td CLASS="font10">This function adds content to the <body> |
249 |
area of the page.</td> |
250 |
|
251 |
<tr> |
252 |
<td CLASS="font10bold"><A HREF='../../phpHtmlLib/HTMLPageClass.html#add_css_link'>add_css_link ( $link )</A></td> |
253 |
<td CLASS="font10">pushes a css external reference to the head area</td> |
254 |
|
255 |
<tr> |
256 |
<td CLASS="font10bold"><A HREF='../../phpHtmlLib/HTMLPageClass.html#add_head_content'>add_head_content ( )</A></td> |
257 |
<td CLASS="font10">this adds content to the head tag |
258 |
of the page</td> |
259 |
|
260 |
<tr> |
261 |
<td CLASS="font10bold"><A HREF='../../phpHtmlLib/HTMLPageClass.html#add_head_css'>add_head_css ( $css )</A></td> |
262 |
<td CLASS="font10">this function adds raw css to the |
263 |
<head> tag.</td> |
264 |
|
265 |
<tr> |
266 |
<td CLASS="font10bold"><A HREF='../../phpHtmlLib/HTMLPageClass.html#add_head_js'>add_head_js ( $content )</A></td> |
267 |
<td CLASS="font10">adds raw javascript to the head which |
268 |
will automatically get wrapped in a |
269 |
<script language="JavaScript"> tag.</td> |
270 |
|
271 |
<tr> |
272 |
<td CLASS="font10bold"><A HREF='../../phpHtmlLib/HTMLPageClass.html#add_reference'>add_reference ( &$content )</A></td> |
273 |
<td CLASS="font10">Adds the content reference to the <body> |
274 |
tag for later use.</td> |
275 |
|
276 |
<tr> |
277 |
<td CLASS="font10bold"><A HREF='../../phpHtmlLib/HTMLPageClass.html#build_doctype'>build_doctype ( $link1, [$link2 = NULL] )</A></td> |
278 |
<td CLASS="font10">This function is used to build the DOCTYPE |
279 |
tag for the page.</td> |
280 |
|
281 |
<tr> |
282 |
<td CLASS="font10bold"><A HREF='../../phpHtmlLib/HTMLPageClass.html#get_html_attributes'>get_html_attributes ( )</A></td> |
283 |
<td CLASS="font10">This function returns the |
284 |
attributes to be used for the |
285 |
<html> tag.</td> |
286 |
|
287 |
<tr> |
288 |
<td CLASS="font10bold"><A HREF='../../phpHtmlLib/HTMLPageClass.html#push'>push ( )</A></td> |
289 |
<td CLASS="font10">Same as add()</td> |
290 |
|
291 |
<tr> |
292 |
<td CLASS="font10bold"><A HREF='../../phpHtmlLib/HTMLPageClass.html#push_css_link'>push_css_link ( $link )</A></td> |
293 |
<td CLASS="font10">Same ass add_css_link()</td> |
294 |
|
295 |
<tr> |
296 |
<td CLASS="font10bold"><A HREF='../../phpHtmlLib/HTMLPageClass.html#push_head_content'>push_head_content ( )</A></td> |
297 |
<td CLASS="font10">Same ass add_head_content()</td> |
298 |
|
299 |
<tr> |
300 |
<td CLASS="font10bold"><A HREF='../../phpHtmlLib/HTMLPageClass.html#push_head_js'>push_head_js ( $content )</A></td> |
301 |
<td CLASS="font10">Same ass add_head_js()</td> |
302 |
|
303 |
<tr> |
304 |
<td CLASS="font10bold"><A HREF='../../phpHtmlLib/HTMLPageClass.html#push_js_link'>push_js_link ( $link )</A></td> |
305 |
<td CLASS="font10">pushes an link to an externally referenced javascript |
306 |
file, which will get rendered in the head.</td> |
307 |
|
308 |
<tr> |
309 |
<td CLASS="font10bold"><A HREF='../../phpHtmlLib/HTMLPageClass.html#push_reference'>push_reference ( &$content )</A></td> |
310 |
<td CLASS="font10">Same as add()</td> |
311 |
|
312 |
<tr> |
313 |
<td CLASS="font10bold"><A HREF='../../phpHtmlLib/HTMLPageClass.html#render'>render ( )</A></td> |
314 |
<td CLASS="font10">render the page.</td> |
315 |
|
316 |
<tr> |
317 |
<td CLASS="font10bold"><A HREF='../../phpHtmlLib/HTMLPageClass.html#set_body_attributes'>set_body_attributes ( $attributes )</A></td> |
318 |
<td CLASS="font10">set attributes of body tag</td> |
319 |
|
320 |
<tr> |
321 |
<td CLASS="font10bold"><A HREF='../../phpHtmlLib/HTMLPageClass.html#set_charset'>set_charset ( $charset )</A></td> |
322 |
<td CLASS="font10">set the character set</td> |
323 |
|
324 |
<tr> |
325 |
<td CLASS="font10bold"><A HREF='../../phpHtmlLib/HTMLPageClass.html#set_frameset'>set_frameset ( $frameset )</A></td> |
326 |
<td CLASS="font10">This function is used to set the FRAMSETtag |
327 |
object for this page.</td> |
328 |
|
329 |
<tr> |
330 |
<td CLASS="font10bold"><A HREF='../../phpHtmlLib/HTMLPageClass.html#set_html_attributes'>set_html_attributes ( $attributes )</A></td> |
331 |
<td CLASS="font10">This function sets the attributes |
332 |
for the <html> tag</td> |
333 |
|
334 |
<tr> |
335 |
<td CLASS="font10bold"><A HREF='../../phpHtmlLib/HTMLPageClass.html#set_refresh'>set_refresh ( $time, [$url = NULL] )</A></td> |
336 |
<td CLASS="font10">Automatically set a page meta tag refresh</td> |
337 |
|
338 |
<tr> |
339 |
<td CLASS="font10bold"><A HREF='../../phpHtmlLib/HTMLPageClass.html#set_text_debug'>set_text_debug ( $flag )</A></td> |
340 |
<td CLASS="font10">set the $_text_debug flag</td> |
341 |
|
342 |
<tr> |
343 |
<td CLASS="font10bold"><A HREF='../../phpHtmlLib/HTMLPageClass.html#set_title'>set_title ( $title )</A></td> |
344 |
<td CLASS="font10">set the title of the page output.</td> |
345 |
|
346 |
<tr> |
347 |
<td CLASS="font10bold"><A HREF='../../phpHtmlLib/HTMLPageClass.html#_build_content_type_tag'>_build_content_type_tag ( )</A></td> |
348 |
<td CLASS="font10">this builds the content type meta tag.</td> |
349 |
|
350 |
<tr> |
351 |
<td CLASS="font10bold"><A HREF='../../phpHtmlLib/HTMLPageClass.html#_build_head'>_build_head ( )</A></td> |
352 |
<td CLASS="font10">builds the head object and its content.</td> |
353 |
|
354 |
<tr> |
355 |
<td CLASS="font10bold"><A HREF='../../phpHtmlLib/HTMLPageClass.html#_create_body'>_create_body ( )</A></td> |
356 |
<td CLASS="font10">This is responsible for creating the</td> |
357 |
|
358 |
<tr> |
359 |
<td CLASS="font10bold"><A HREF='../../phpHtmlLib/HTMLPageClass.html#_frameset_wrap_body'>_frameset_wrap_body ( )</A></td> |
360 |
<td CLASS="font10">This builds a frameset body tag |
361 |
wrapped in a <noframes> tag.</td> |
362 |
|
363 |
</table> |
364 |
<br> |
365 |
</TD> |
366 |
</TR> |
367 |
|
368 |
</TABLE> |
369 |
|
370 |
<hr> |
371 |
<!-- should have constructor at some point --> |
372 |
<!-- =========== Method SUMMARY =========== --> |
373 |
<A NAME='Method_summary'><!-- --></A> |
374 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' Class="border"> |
375 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
376 |
<TD> |
377 |
<span class="font12bold">Method Summary</span> |
378 |
<A HREF="#top" CLASS="links">^TOP</A> |
379 |
</TD> |
380 |
</TR> |
381 |
|
382 |
|
383 |
<!-- =========== Summary =========== --> |
384 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
385 |
<TD> |
386 |
<CODE><B><A HREF='MyLayoutPage.html#constructor MyLayoutPage'>void constructor MyLayoutPage ( $title, [$render_type = HTML] )</A></B></CODE> |
387 |
<BR> |
388 |
<blockquote> This is the constructor. </blockquote> |
389 |
</TD> |
390 |
</TR> |
391 |
|
392 |
<!-- =========== Summary =========== --> |
393 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
394 |
<TD> |
395 |
<CODE><B><A HREF='MyLayoutPage.html#body_content'>void body_content ( )</A></B></CODE> |
396 |
<BR> |
397 |
<blockquote> This builds the main content for the |
398 |
page. </blockquote> |
399 |
</TD> |
400 |
</TR> |
401 |
|
402 |
<!-- =========== Summary =========== --> |
403 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
404 |
<TD> |
405 |
<CODE><B><A HREF='MyLayoutPage.html#content_block'>HTMLTag content_block ( )</A></B></CODE> |
406 |
<BR> |
407 |
<blockquote> this function returns the contents |
408 |
of the right block. </blockquote> |
409 |
</TD> |
410 |
</TR> |
411 |
|
412 |
<!-- =========== Summary =========== --> |
413 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
414 |
<TD> |
415 |
<CODE><B><A HREF='MyLayoutPage.html#footer_block'><a href="../../phpHtmlLib/HTMLtag.html">HTMLtag</a> footer_block ( )</A></B></CODE> |
416 |
<BR> |
417 |
<blockquote> This function is responsible for building |
418 |
the footer block for every page. </blockquote> |
419 |
</TD> |
420 |
</TR> |
421 |
|
422 |
<!-- =========== Summary =========== --> |
423 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
424 |
<TD> |
425 |
<CODE><B><A HREF='MyLayoutPage.html#header_block'><a href="../../phpHtmlLib/HTMLtag.html">HTMLtag</a> header_block ( )</A></B></CODE> |
426 |
<BR> |
427 |
<blockquote> This function is responsible for building |
428 |
the header block that lives at the top |
429 |
of every page. </blockquote> |
430 |
</TD> |
431 |
</TR> |
432 |
|
433 |
<!-- =========== Summary =========== --> |
434 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
435 |
<TD> |
436 |
<CODE><B><A HREF='MyLayoutPage.html#left_block'>HTMLTag left_block ( )</A></B></CODE> |
437 |
<BR> |
438 |
<blockquote> this function returns the contents |
439 |
of the left block. </blockquote> |
440 |
</TD> |
441 |
</TR> |
442 |
|
443 |
<!-- =========== Summary =========== --> |
444 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
445 |
<TD> |
446 |
<CODE><B><A HREF='MyLayoutPage.html#main_block'>void main_block ( )</A></B></CODE> |
447 |
<BR> |
448 |
<blockquote> We override this method to automatically </blockquote> |
449 |
</TD> |
450 |
</TR> |
451 |
|
452 |
</TABLE> |
453 |
|
454 |
<hr> |
455 |
<!-- ============ VARIABLE DETAIL =========== --> |
456 |
|
457 |
<A NAME='variable_detail'></A> |
458 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
459 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
460 |
<TD> |
461 |
<span CLASS="font12bold">Variable Detail</span> |
462 |
<A HREF="#top" CLASS="links">^TOP</A> |
463 |
</TD> |
464 |
</TR> |
465 |
</TABLE> |
466 |
|
467 |
|
468 |
|
469 |
<hr> |
470 |
<!-- ============ FUNCTION DETAIL =========== --> |
471 |
|
472 |
<A NAME='function_detail'></A> |
473 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
474 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
475 |
<TD> |
476 |
<span class="font12bold">Method Detail</span> |
477 |
<A HREF="#top" CLASS="links">^TOP</A> |
478 |
</TD> |
479 |
</TR> |
480 |
</TABLE> |
481 |
<BR> |
482 |
|
483 |
<DIV CLASS="function"> |
484 |
<A NAME='constructor MyLayoutPage'><!-- --></A> |
485 |
<SPAN CLASS="font12bold">constructor MyLayoutPage</SPAN> |
486 |
<BR> |
487 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
488 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
489 |
<span class="font10bold" style="color: #0000FF">constructor MyLayoutPage ( $title, [$render_type = HTML] )</SPAN> |
490 |
<BR> |
491 |
|
492 |
<BR> |
493 |
<SPAN CLASS="font10bold">Description : </SPAN> |
494 |
<!-- ========== Info from phpDoc block ========= --> |
495 |
This is the constructor. |
496 |
<BR> |
497 |
|
498 |
<DL> |
499 |
<DT class="font10bold">Function Parameters:</DT> |
500 |
|
501 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">-</SPAN> <span style="color: #0000FF;font-weight:bold">$title</SPAN></SPAN> string - The render type (HTML, XHTML, etc. )</DD> |
502 |
|
503 |
|
504 |
<DT class="font10bold">Function Info:</DT> |
505 |
|
506 |
</DL> |
507 |
|
508 |
</DIV> |
509 |
<BR> |
510 |
|
511 |
<DIV CLASS="function"> |
512 |
<A NAME='body_content'><!-- --></A> |
513 |
<SPAN CLASS="font12bold">body_content</SPAN> |
514 |
<BR> |
515 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
516 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
517 |
<span class="font10bold" style="color: #0000FF">body_content ( )</SPAN> |
518 |
<BR> |
519 |
<span class="font10bold" style="padding-left: 10px;">Overrides :</span> <a href="../../phpHtmlLib/PageWidget.html#body_content">PageWidget::body_content()</a> |
520 |
<BR> |
521 |
<SPAN CLASS="font10bold">Description : </SPAN> |
522 |
<!-- ========== Info from phpDoc block ========= --> |
523 |
This builds the main content for the |
524 |
page. |
525 |
<BR> |
526 |
|
527 |
<DL> |
528 |
<DT class="font10bold">Function Parameters:</DT> |
529 |
|
530 |
|
531 |
<DT class="font10bold">Function Info:</DT> |
532 |
|
533 |
</DL> |
534 |
|
535 |
</DIV> |
536 |
<BR> |
537 |
|
538 |
<DIV CLASS="function"> |
539 |
<A NAME='content_block'><!-- --></A> |
540 |
<SPAN CLASS="font12bold">content_block</SPAN> |
541 |
<BR> |
542 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
543 |
<span class="font10bold" style="color: #FF0000">HTMLTag</SPAN> |
544 |
<span class="font10bold" style="color: #0000FF">content_block ( )</SPAN> |
545 |
<BR> |
546 |
|
547 |
<BR> |
548 |
<SPAN CLASS="font10bold">Description : </SPAN> |
549 |
<!-- ========== Info from phpDoc block ========= --> |
550 |
this function returns the contents |
551 |
of the right block. |
552 |
<BR> |
553 |
It is already wrapped |
554 |
in a TD |
555 |
<DL> |
556 |
<DT class="font10bold">Function Parameters:</DT> |
557 |
|
558 |
|
559 |
<DT class="font10bold">Function Info:</DT> |
560 |
|
561 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - object</DD> |
562 |
|
563 |
</DL> |
564 |
|
565 |
</DIV> |
566 |
<BR> |
567 |
|
568 |
<DIV CLASS="function"> |
569 |
<A NAME='footer_block'><!-- --></A> |
570 |
<SPAN CLASS="font12bold">footer_block</SPAN> |
571 |
<BR> |
572 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
573 |
<span class="font10bold" style="color: #FF0000"><a href="../../phpHtmlLib/HTMLtag.html">HTMLtag</a></SPAN> |
574 |
<span class="font10bold" style="color: #0000FF">footer_block ( )</SPAN> |
575 |
<BR> |
576 |
|
577 |
<BR> |
578 |
<SPAN CLASS="font10bold">Description : </SPAN> |
579 |
<!-- ========== Info from phpDoc block ========= --> |
580 |
This function is responsible for building |
581 |
the footer block for every page. |
582 |
<BR> |
583 |
|
584 |
<DL> |
585 |
<DT class="font10bold">Function Parameters:</DT> |
586 |
|
587 |
|
588 |
<DT class="font10bold">Function Info:</DT> |
589 |
|
590 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - object.</DD> |
591 |
|
592 |
</DL> |
593 |
|
594 |
</DIV> |
595 |
<BR> |
596 |
|
597 |
<DIV CLASS="function"> |
598 |
<A NAME='header_block'><!-- --></A> |
599 |
<SPAN CLASS="font12bold">header_block</SPAN> |
600 |
<BR> |
601 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
602 |
<span class="font10bold" style="color: #FF0000"><a href="../../phpHtmlLib/HTMLtag.html">HTMLtag</a></SPAN> |
603 |
<span class="font10bold" style="color: #0000FF">header_block ( )</SPAN> |
604 |
<BR> |
605 |
|
606 |
<BR> |
607 |
<SPAN CLASS="font10bold">Description : </SPAN> |
608 |
<!-- ========== Info from phpDoc block ========= --> |
609 |
This function is responsible for building |
610 |
the header block that lives at the top |
611 |
of every page. |
612 |
<BR> |
613 |
|
614 |
<DL> |
615 |
<DT class="font10bold">Function Parameters:</DT> |
616 |
|
617 |
|
618 |
<DT class="font10bold">Function Info:</DT> |
619 |
|
620 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - object.</DD> |
621 |
|
622 |
</DL> |
623 |
|
624 |
</DIV> |
625 |
<BR> |
626 |
|
627 |
<DIV CLASS="function"> |
628 |
<A NAME='left_block'><!-- --></A> |
629 |
<SPAN CLASS="font12bold">left_block</SPAN> |
630 |
<BR> |
631 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
632 |
<span class="font10bold" style="color: #FF0000">HTMLTag</SPAN> |
633 |
<span class="font10bold" style="color: #0000FF">left_block ( )</SPAN> |
634 |
<BR> |
635 |
|
636 |
<BR> |
637 |
<SPAN CLASS="font10bold">Description : </SPAN> |
638 |
<!-- ========== Info from phpDoc block ========= --> |
639 |
this function returns the contents |
640 |
of the left block. |
641 |
<BR> |
642 |
It is already wrapped |
643 |
in a TD |
644 |
<DL> |
645 |
<DT class="font10bold">Function Parameters:</DT> |
646 |
|
647 |
|
648 |
<DT class="font10bold">Function Info:</DT> |
649 |
|
650 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - object</DD> |
651 |
|
652 |
</DL> |
653 |
|
654 |
</DIV> |
655 |
<BR> |
656 |
|
657 |
<DIV CLASS="function"> |
658 |
<A NAME='main_block'><!-- --></A> |
659 |
<SPAN CLASS="font12bold">main_block</SPAN> |
660 |
<BR> |
661 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
662 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
663 |
<span class="font10bold" style="color: #0000FF">main_block ( )</SPAN> |
664 |
<BR> |
665 |
|
666 |
<BR> |
667 |
<SPAN CLASS="font10bold">Description : </SPAN> |
668 |
<!-- ========== Info from phpDoc block ========= --> |
669 |
We override this method to automatically |
670 |
<BR> |
671 |
break up the main block into a |
672 |
left block and a right block |
673 |
<DL> |
674 |
<DT class="font10bold">Function Parameters:</DT> |
675 |
|
676 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;"><a href="../../phpHtmlLib/TABLEtag.html">TABLEtag</a></SPAN> <span style="color: #0000FF;font-weight:bold">0</SPAN></SPAN> object.</DD> |
677 |
|
678 |
|
679 |
<DT class="font10bold">Function Info:</DT> |
680 |
|
681 |
</DL> |
682 |
|
683 |
</DIV> |
684 |
<BR> |
685 |
|
686 |
|
687 |
<hr> |
688 |
</HTML> |