1 |
<!DOCTYPE HTML PUBLIC '-//W3C//DTD HTML 4.0 Frameset//EN''http://www.w3.org/TR/REC-html40/frameset.dtd'> |
<!DOCTYPE HTML PUBLIC '-//W3C//DTD HTML 4.0 Transitional//EN' 'http://www.w3.org/TR/REC-html40/loose.dtd'> |
2 |
<!--NewPage--> |
<!--NewPage--> |
3 |
<HTML> |
<HTML> |
4 |
<HEAD> |
<HEAD> |
5 |
<!-- Generated by PhpDoc date: 'Mon, 25 Nov 2002 09:21:33 -0800' --> |
<!-- Generated by PhpDoc date: 'Thu, 20 Feb 2003 16:23:06 -0800' --> |
6 |
<TITLE>Docs For Class PageWidget</TITLE> |
<TITLE>Docs For Class PageWidget</TITLE> |
7 |
<LINK REL ='stylesheet' TYPE='text/css' HREF='stylesheet.css' TITLE='Style'> |
<LINK REL ='stylesheet' TYPE='text/css' HREF='../media/stylesheet.css' TITLE='Style'> |
8 |
</HEAD> |
</HEAD> |
9 |
<BODY style="background-color: #eeeeee; font-family: arial; font-size: .9em;"> |
<BODY style="background-color: #eeeeee; font-family: arial; font-size: .9em;"> |
|
|
|
|
|
|
10 |
<!-- Links --> |
<!-- Links --> |
11 |
<a NAME="top"></A> |
<a NAME="top"></A> |
12 |
<table WIDTH="100%" class="links"> |
<table WIDTH="100%" class="links"> |
16 |
<A HREF="#children_summary" class="links" title="Classes extended from PageWidget">Child Classes</A> |
<A HREF="#children_summary" class="links" title="Classes extended from PageWidget">Child Classes</A> |
17 |
<A HREF="#var_summary" class="links" title="Class Variable Summary">Variables</A> |
<A HREF="#var_summary" class="links" title="Class Variable Summary">Variables</A> |
18 |
<A HREF="#var_inherited_summary" class="links" title="Inherited Class Variable Summary">Inherited Variables</A> |
<A HREF="#var_inherited_summary" class="links" title="Inherited Class Variable Summary">Inherited Variables</A> |
19 |
<A HREF="#functions_inherited" class="links" title="Inherited Method Summary">Inerited Methods</A> |
<A HREF="#functions_inherited" class="links" title="Inherited Method Summary">Inherited Methods</A> |
20 |
<A HREF="#functions_summary" class="links" title="Method Summary">Methods</A> |
<A HREF="#method_summary" class="links" title="Method Summary">Methods</A> |
21 |
<A HREF="#variable_detail" class="links" title="Variable Detail">Variable Detail</A> |
<A HREF="#variable_detail" class="links" title="Variable Detail">Variable Detail</A> |
22 |
<A HREF="#function_detail" class="links" title="Method Detail">Method Detail</A> |
<A HREF="#method_detail" class="links" title="Method Detail">Method Detail</A> |
23 |
</TD> |
</TD> |
24 |
</TR> |
</TR> |
25 |
</TABLE> |
</TABLE> |
26 |
<BR> |
<BR> |
|
|
|
27 |
<!-- Start of Class Data --> |
<!-- Start of Class Data --> |
28 |
<H2> |
<H2> |
29 |
Class PageWidget |
Class PageWidget |
30 |
</H2> |
</H2> (line <span class="linenumber">25</span>) |
|
|
|
31 |
<pre> |
<pre> |
32 |
<pre><a href="../phpHtmlLib/HTMLPageClass.html">HTMLPageClass</a> |
<a href="../phpHtmlLib/HTMLPageClass.html">HTMLPageClass</a> |
33 |
| |
| |
34 |
--PageWidget</pre> |
--PageWidget</pre> |
35 |
</pre> |
<SPAN class="type">Classes extended from PageWidget:</SPAN> |
36 |
|
<dl> |
37 |
<A NAME="children_summary"</A> |
<dt><a href="../phpHtmlLib/examples/MyLayoutPage.html">MyLayoutPage</a></dt> |
38 |
<H3> |
<dd>This is an example Child of the PageWidget</dd> |
39 |
Classes extended from PageWidget: <A HREF="#top" CLASS="links">^TOP</A> |
</dl> |
40 |
</H3> |
</p> |
|
<a href="../phpHtmlLib/examples/MyLayoutPage.html">MyLayoutPage</a> |
|
41 |
<p> |
<p> |
42 |
<b><i>Located in File: Program_Root/widgets/PageWidget.inc</i></b><br> |
<b><i>Located in File: Program_Root/widgets/PageWidget.inc</i></b><br> |
43 |
</p> |
</p> |
44 |
<hr> |
<hr> |
45 |
<!-- ========== Info from phpDoc block ========= --> |
This class is used to build content for an entire page. It uses the HTMLPageClass widget from phphtmllib to render the final output. |
46 |
This class is used to build content |
<br /> |
|
for an entire page. |
|
|
<BR> |
|
|
It uses the |
|
|
HTMLPageClass widget from phphtmllib |
|
|
to render the final output. |
|
47 |
|
|
48 |
<UL> |
<UL> |
49 |
|
<LI><b>author</b> - <CODE>Walter A. Boring IV <<a href="mailto:waboring@buildabetterweb.com">mailto:waboring@buildabetterweb.com</a>></CODE></LI> |
50 |
<LI><b>Package</b> - <CODE>phpHtmlLib</CODE></LI> |
</UL> |
|
|
|
|
<LI><b>Author</b> - <CODE>Walter A. Boring IV <<a href="mailto:waboring@buildabetterweb.com">waboring@buildabetterweb.com</a>></CODE></LI> |
|
|
|
|
|
</UL> |
|
|
|
|
51 |
<hr> |
<hr> |
52 |
<!-- =========== VAR SUMMARY =========== --> |
<!-- =========== VAR SUMMARY =========== --> |
53 |
<A NAME='var_summary'><!-- --></A> |
<A NAME='var_summary'><!-- --></A> |
59 |
</TD> |
</TD> |
60 |
</TR> |
</TR> |
61 |
|
|
62 |
|
<!-- =========== Summary =========== --> |
|
<!-- =========== Summary =========== --> |
|
63 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
64 |
<TD> |
<TD> |
65 |
<CODE><B><A HREF='PageWidget.html#$_enable_debug'>$_enable_debug</A></B></CODE> |
<CODE><B><A HREF="../phpHtmlLib/PageWidget.html#var$_enable_debug">$_enable_debug</A></B></CODE> |
66 |
<BR> |
<BR> |
67 |
<blockquote> This enables the ability to view the |
<blockquote> This enables the ability to view the source of a page bu setting debug=1 in the query string. </blockquote> |
68 |
source of a page bu setting debug=1 |
<blockquote> Default Value: <CODE>-> FALSE<-</CODE> </blockquote> |
|
in the query string. </blockquote> |
|
|
<blockquote> Default Value: <CODE>->FALSE<-</CODE> </blockquote> |
|
69 |
</TD> |
</TD> |
70 |
</TR> |
</TR> |
71 |
|
<!-- =========== Summary =========== --> |
|
<!-- =========== Summary =========== --> |
|
72 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
73 |
<TD> |
<TD> |
74 |
<CODE><B><A HREF='PageWidget.html#$_title_text'>$_title_text</A></B></CODE> |
<CODE><B><A HREF="../phpHtmlLib/PageWidget.html#var$_title_text">$_title_text</A></B></CODE> |
75 |
<BR> |
<BR> |
76 |
<blockquote> holds the page title text for |
<blockquote> holds the page title text for </blockquote> |
77 |
a page </blockquote> |
<blockquote> Default Value: <CODE>-> NULL<-</CODE> </blockquote> |
|
<blockquote> Default Value: <CODE>->NULL<-</CODE> </blockquote> |
|
78 |
</TD> |
</TD> |
79 |
</TR> |
</TR> |
80 |
|
</TABLE> |
|
</TABLE> |
|
|
|
|
81 |
<hr> |
<hr> |
82 |
<!-- =========== VAR INHERITED SUMMARY =========== --> |
<!-- =========== VAR INHERITED SUMMARY =========== --> |
83 |
<A NAME='var_inherited_summary'><!-- --></A> |
<A NAME='var_inherited_summary'><!-- --></A> |
84 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
85 |
<TR CLASS='TableHeadingColor'> |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
86 |
<TD> |
<TD> |
87 |
<span CLASS="font12bold">Inherited Class Variable Summary</span> |
<span CLASS="font12bold">Inherited Class Variable Summary</span> |
88 |
<A HREF="#top" CLASS="links">^TOP</A> |
<A HREF="#top" CLASS="links">^TOP</A> |
89 |
</TD> |
</TD> |
90 |
</TR> |
</TR> |
91 |
|
|
92 |
|
<!-- =========== Summary =========== --> |
|
<!-- =========== Summary =========== --> |
|
93 |
<TR BGCOLOR='white'> |
<TR BGCOLOR='white'> |
94 |
<TD> |
<TD> |
95 |
<span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/HTMLPageClass.html">HTMLPageClass</a></span> |
<span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/HTMLPageClass.html">HTMLPageClass</a></span> |
99 |
<th>Default Value</th> |
<th>Default Value</th> |
100 |
<th>Description</th> |
<th>Description</th> |
101 |
</tr> |
</tr> |
102 |
|
<tr> |
103 |
<tr> |
<td CLASS="font10bold"><a href="../phpHtmlLib/HTMLPageClass.html#var$_html_attributes">HTMLPageClass::$_html_attributes</a></td> |
|
<td CLASS="font10bold"><A HREF='../phpHtmlLib/HTMLPageClass.html#$_html_attributes'>$_html_attributes</A></td> |
|
104 |
<td CLASS="font10" STYLE="white-space: nowrap">->array()<-</td> |
<td CLASS="font10" STYLE="white-space: nowrap">->array()<-</td> |
105 |
<td CLASS="font10">This holds the attributes for the |
<td CLASS="font10">This holds the attributes for the <html> tag.</td> |
|
<html> tag.</td> |
|
106 |
</tr> |
</tr> |
107 |
|
<tr> |
108 |
<tr> |
<td CLASS="font10bold"><a href="../phpHtmlLib/HTMLPageClass.html#var$_indent_style">HTMLPageClass::$_indent_style</a></td> |
109 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/HTMLPageClass.html#$_indent_style'>$_indent_style</A></td> |
<td CLASS="font10" STYLE="white-space: nowrap">-> 0<-</td> |
110 |
<td CLASS="font10" STYLE="white-space: nowrap">->0<-</td> |
<td CLASS="font10">Holds the value of the indent style the user wants to render the page w/</td> |
|
<td CLASS="font10">Holds the value of the indent</td> |
|
111 |
</tr> |
</tr> |
112 |
|
<tr> |
113 |
<tr> |
<td CLASS="font10bold"><a href="../phpHtmlLib/HTMLPageClass.html#var$_widget_css_auto">HTMLPageClass::$_widget_css_auto</a></td> |
|
<td CLASS="font10bold"><A HREF='../phpHtmlLib/HTMLPageClass.html#$_widget_css_auto'>$_widget_css_auto</A></td> |
|
114 |
<td CLASS="font10" STYLE="white-space: nowrap">->array()<-</td> |
<td CLASS="font10" STYLE="white-space: nowrap">->array()<-</td> |
115 |
<td CLASS="font10">keeps track of which widgets we have |
<td CLASS="font10">keeps track of which widgets we have automatically pulled in css for</td> |
|
automatically pulled in css for</td> |
|
116 |
</tr> |
</tr> |
117 |
|
<tr> |
118 |
<tr> |
<td CLASS="font10bold"><a href="../phpHtmlLib/HTMLPageClass.html#var$_widget_js_auto">HTMLPageClass::$_widget_js_auto</a></td> |
|
<td CLASS="font10bold"><A HREF='../phpHtmlLib/HTMLPageClass.html#$_widget_js_auto'>$_widget_js_auto</A></td> |
|
119 |
<td CLASS="font10" STYLE="white-space: nowrap">->array()<-</td> |
<td CLASS="font10" STYLE="white-space: nowrap">->array()<-</td> |
120 |
<td CLASS="font10">keeps track of which widgets we have |
<td CLASS="font10">keeps track of which widgets we have automatically pulled in js for</td> |
|
automatically pulled in js for</td> |
|
121 |
</tr> |
</tr> |
122 |
|
</table> |
|
</table> |
|
123 |
<BR> |
<BR> |
124 |
</TD> |
</TD> |
125 |
</TR> |
</TR> |
126 |
|
</TABLE> |
|
</TABLE> |
|
127 |
|
|
128 |
<hr> |
<hr> |
129 |
<!-- =========== INHERITED METHOD SUMMARY =========== --> |
<!-- =========== METHOD SUMMARY =========== --> |
130 |
<A NAME='functions_inherited'><!-- --></A> |
<A NAME='method_summary'><!-- --></A> |
|
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
|
|
<TR CLASS='TableHeadingColor'> |
|
|
<TD> |
|
|
<span CLASS="font12bold">Inherited Method Summary</span> |
|
|
<A HREF="#top" CLASS="links">^TOP</A> |
|
|
</TD> |
|
|
</TR> |
|
|
|
|
|
|
|
|
<!-- =========== Summary =========== --> |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
|
<TD> |
|
|
<span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/HTMLPageClass.html">HTMLPageClass</a></span> |
|
|
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center"> |
|
|
<tr CLASS="tableheadingcolor"> |
|
|
<th>Function</th> |
|
|
<th>Description</th> |
|
|
</tr> |
|
|
|
|
|
<tr> |
|
|
<td CLASS="font10bold"><A HREF='../phpHtmlLib/HTMLPageClass.html#constructor HTMLPageClass'>constructor HTMLPageClass ( [$title = NULL], [$html_type = HTML], [$indent_style = INDENT_NICE] )</A></td> |
|
|
<td CLASS="font10">Class Constructor</td> |
|
|
|
|
|
<tr> |
|
|
<td CLASS="font10bold"><A HREF='../phpHtmlLib/HTMLPageClass.html#add'>add ( )</A></td> |
|
|
<td CLASS="font10">This function adds content to the <body> |
|
|
area of the page.</td> |
|
|
|
|
|
<tr> |
|
|
<td CLASS="font10bold"><A HREF='../phpHtmlLib/HTMLPageClass.html#add_css_link'>add_css_link ( $link )</A></td> |
|
|
<td CLASS="font10">pushes a css external reference to the head area</td> |
|
|
|
|
|
<tr> |
|
|
<td CLASS="font10bold"><A HREF='../phpHtmlLib/HTMLPageClass.html#add_head_content'>add_head_content ( )</A></td> |
|
|
<td CLASS="font10">this adds content to the head tag |
|
|
of the page</td> |
|
|
|
|
|
<tr> |
|
|
<td CLASS="font10bold"><A HREF='../phpHtmlLib/HTMLPageClass.html#add_head_css'>add_head_css ( $css )</A></td> |
|
|
<td CLASS="font10">this function adds raw css to the |
|
|
<head> tag.</td> |
|
|
|
|
|
<tr> |
|
|
<td CLASS="font10bold"><A HREF='../phpHtmlLib/HTMLPageClass.html#add_head_js'>add_head_js ( $content )</A></td> |
|
|
<td CLASS="font10">adds raw javascript to the head which |
|
|
will automatically get wrapped in a |
|
|
<script language="JavaScript"> tag.</td> |
|
|
|
|
|
<tr> |
|
|
<td CLASS="font10bold"><A HREF='../phpHtmlLib/HTMLPageClass.html#add_reference'>add_reference ( &$content )</A></td> |
|
|
<td CLASS="font10">Adds the content reference to the <body> |
|
|
tag for later use.</td> |
|
|
|
|
|
<tr> |
|
|
<td CLASS="font10bold"><A HREF='../phpHtmlLib/HTMLPageClass.html#build_doctype'>build_doctype ( $link1, [$link2 = NULL] )</A></td> |
|
|
<td CLASS="font10">This function is used to build the DOCTYPE |
|
|
tag for the page.</td> |
|
|
|
|
|
<tr> |
|
|
<td CLASS="font10bold"><A HREF='../phpHtmlLib/HTMLPageClass.html#get_html_attributes'>get_html_attributes ( )</A></td> |
|
|
<td CLASS="font10">This function returns the |
|
|
attributes to be used for the |
|
|
<html> tag.</td> |
|
|
|
|
|
<tr> |
|
|
<td CLASS="font10bold"><A HREF='../phpHtmlLib/HTMLPageClass.html#push'>push ( )</A></td> |
|
|
<td CLASS="font10">Same as add()</td> |
|
|
|
|
|
<tr> |
|
|
<td CLASS="font10bold"><A HREF='../phpHtmlLib/HTMLPageClass.html#push_css_link'>push_css_link ( $link )</A></td> |
|
|
<td CLASS="font10">Same ass add_css_link()</td> |
|
|
|
|
|
<tr> |
|
|
<td CLASS="font10bold"><A HREF='../phpHtmlLib/HTMLPageClass.html#push_head_content'>push_head_content ( )</A></td> |
|
|
<td CLASS="font10">Same ass add_head_content()</td> |
|
|
|
|
|
<tr> |
|
|
<td CLASS="font10bold"><A HREF='../phpHtmlLib/HTMLPageClass.html#push_head_js'>push_head_js ( $content )</A></td> |
|
|
<td CLASS="font10">Same ass add_head_js()</td> |
|
|
|
|
|
<tr> |
|
|
<td CLASS="font10bold"><A HREF='../phpHtmlLib/HTMLPageClass.html#push_js_link'>push_js_link ( $link )</A></td> |
|
|
<td CLASS="font10">pushes an link to an externally referenced javascript |
|
|
file, which will get rendered in the head.</td> |
|
|
|
|
|
<tr> |
|
|
<td CLASS="font10bold"><A HREF='../phpHtmlLib/HTMLPageClass.html#push_reference'>push_reference ( &$content )</A></td> |
|
|
<td CLASS="font10">Same as add()</td> |
|
|
|
|
|
<tr> |
|
|
<td CLASS="font10bold"><A HREF='../phpHtmlLib/HTMLPageClass.html#render'>render ( )</A></td> |
|
|
<td CLASS="font10">render the page.</td> |
|
|
|
|
|
<tr> |
|
|
<td CLASS="font10bold"><A HREF='../phpHtmlLib/HTMLPageClass.html#set_body_attributes'>set_body_attributes ( $attributes )</A></td> |
|
|
<td CLASS="font10">set attributes of body tag</td> |
|
|
|
|
|
<tr> |
|
|
<td CLASS="font10bold"><A HREF='../phpHtmlLib/HTMLPageClass.html#set_charset'>set_charset ( $charset )</A></td> |
|
|
<td CLASS="font10">set the character set</td> |
|
|
|
|
|
<tr> |
|
|
<td CLASS="font10bold"><A HREF='../phpHtmlLib/HTMLPageClass.html#set_frameset'>set_frameset ( $frameset )</A></td> |
|
|
<td CLASS="font10">This function is used to set the FRAMSETtag |
|
|
object for this page.</td> |
|
|
|
|
|
<tr> |
|
|
<td CLASS="font10bold"><A HREF='../phpHtmlLib/HTMLPageClass.html#set_html_attributes'>set_html_attributes ( $attributes )</A></td> |
|
|
<td CLASS="font10">This function sets the attributes |
|
|
for the <html> tag</td> |
|
|
|
|
|
<tr> |
|
|
<td CLASS="font10bold"><A HREF='../phpHtmlLib/HTMLPageClass.html#set_refresh'>set_refresh ( $time, [$url = NULL] )</A></td> |
|
|
<td CLASS="font10">Automatically set a page meta tag refresh</td> |
|
|
|
|
|
<tr> |
|
|
<td CLASS="font10bold"><A HREF='../phpHtmlLib/HTMLPageClass.html#set_text_debug'>set_text_debug ( $flag )</A></td> |
|
|
<td CLASS="font10">set the $_text_debug flag</td> |
|
|
|
|
|
<tr> |
|
|
<td CLASS="font10bold"><A HREF='../phpHtmlLib/HTMLPageClass.html#set_title'>set_title ( $title )</A></td> |
|
|
<td CLASS="font10">set the title of the page output.</td> |
|
|
|
|
|
<tr> |
|
|
<td CLASS="font10bold"><A HREF='../phpHtmlLib/HTMLPageClass.html#_build_content_type_tag'>_build_content_type_tag ( )</A></td> |
|
|
<td CLASS="font10">this builds the content type meta tag.</td> |
|
|
|
|
|
<tr> |
|
|
<td CLASS="font10bold"><A HREF='../phpHtmlLib/HTMLPageClass.html#_build_head'>_build_head ( )</A></td> |
|
|
<td CLASS="font10">builds the head object and its content.</td> |
|
|
|
|
|
<tr> |
|
|
<td CLASS="font10bold"><A HREF='../phpHtmlLib/HTMLPageClass.html#_create_body'>_create_body ( )</A></td> |
|
|
<td CLASS="font10">This is responsible for creating the</td> |
|
|
|
|
|
<tr> |
|
|
<td CLASS="font10bold"><A HREF='../phpHtmlLib/HTMLPageClass.html#_frameset_wrap_body'>_frameset_wrap_body ( )</A></td> |
|
|
<td CLASS="font10">This builds a frameset body tag |
|
|
wrapped in a <noframes> tag.</td> |
|
|
|
|
|
</table> |
|
|
<br> |
|
|
</TD> |
|
|
</TR> |
|
|
|
|
|
</TABLE> |
|
|
|
|
|
<hr> |
|
|
<!-- should have constructor at some point --> |
|
|
<!-- =========== Method SUMMARY =========== --> |
|
|
<A NAME='Method_summary'><!-- --></A> |
|
131 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' Class="border"> |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' Class="border"> |
132 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
133 |
<TD> |
<TD> |
136 |
</TD> |
</TD> |
137 |
</TR> |
</TR> |
138 |
|
|
139 |
|
<!-- =========== Summary =========== --> |
|
<!-- =========== Summary =========== --> |
|
140 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
141 |
<TD> |
<TD> |
142 |
<CODE><B><A HREF='PageWidget.html#constructor PageWidget'>void constructor PageWidget ( $title, [$render_type = HTML], [$indent_style = INDENT_NICE] )</A></B></CODE> |
<CODE><B><A HREF='../phpHtmlLib/PageWidget.html#methodPageWidget'>void constructor PageWidget ( $title, [$render_type = HTML], [$indent_style = INDENT_NICE] )</A></B></CODE> |
143 |
<BR> |
<BR> |
144 |
<blockquote> Constructor: </blockquote> |
<blockquote> Constructor: </blockquote> |
145 |
</TD> |
</TD> |
146 |
</TR> |
</TR> |
147 |
|
<!-- =========== Summary =========== --> |
|
<!-- =========== Summary =========== --> |
|
148 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
149 |
<TD> |
<TD> |
150 |
<CODE><B><A HREF='PageWidget.html#body_content'>mixed. body_content ( )</A></B></CODE> |
<CODE><B><A HREF='../phpHtmlLib/PageWidget.html#methodbody_content'>mixed. body_content ( )</A></B></CODE> |
151 |
<BR> |
<BR> |
152 |
<blockquote> This function is meant to be overridden |
<blockquote> This function is meant to be overridden by the child class. </blockquote> |
|
by the child class. </blockquote> |
|
153 |
</TD> |
</TD> |
154 |
</TR> |
</TR> |
155 |
|
<!-- =========== Summary =========== --> |
|
<!-- =========== Summary =========== --> |
|
156 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
157 |
<TD> |
<TD> |
158 |
<CODE><B><A HREF='PageWidget.html#enable_debug'>void enable_debug ( [$flag = TRUE] )</A></B></CODE> |
<CODE><B><A HREF='../phpHtmlLib/PageWidget.html#methodenable_debug'>void enable_debug ( [$flag = TRUE] )</A></B></CODE> |
159 |
<BR> |
<BR> |
160 |
<blockquote> This sets the debug option for |
<blockquote> This sets the debug option for the HTMLPageClass </blockquote> |
|
the HTMLPageClass </blockquote> |
|
161 |
</TD> |
</TD> |
162 |
</TR> |
</TR> |
163 |
|
<!-- =========== Summary =========== --> |
|
<!-- =========== Summary =========== --> |
|
164 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
165 |
<TD> |
<TD> |
166 |
<CODE><B><A HREF='PageWidget.html#frameset'>void frameset ( )</A></B></CODE> |
<CODE><B><A HREF='../phpHtmlLib/PageWidget.html#methodframeset'>void frameset ( )</A></B></CODE> |
167 |
<BR> |
<BR> |
168 |
<blockquote> This function is used to save |
<blockquote> This function is used to save </blockquote> |
|
a frameset to the page. </blockquote> |
|
169 |
</TD> |
</TD> |
170 |
</TR> |
</TR> |
171 |
|
<!-- =========== Summary =========== --> |
|
<!-- =========== Summary =========== --> |
|
172 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
173 |
<TD> |
<TD> |
174 |
<CODE><B><A HREF='PageWidget.html#get_title'>string get_title ( )</A></B></CODE> |
<CODE><B><A HREF='../phpHtmlLib/PageWidget.html#methodget_title'>string get_title ( )</A></B></CODE> |
175 |
<BR> |
<BR> |
176 |
<blockquote> gets the current title of the page. </blockquote> |
<blockquote> gets the current title of the page. </blockquote> |
177 |
</TD> |
</TD> |
178 |
</TR> |
</TR> |
179 |
|
<!-- =========== Summary =========== --> |
|
<!-- =========== Summary =========== --> |
|
180 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
181 |
<TD> |
<TD> |
182 |
<CODE><B><A HREF='PageWidget.html#head_content'>mixed. head_content ( )</A></B></CODE> |
<CODE><B><A HREF='../phpHtmlLib/PageWidget.html#methodhead_content'>mixed. head_content ( )</A></B></CODE> |
183 |
<BR> |
<BR> |
184 |
<blockquote> This function is used to build </blockquote> |
<blockquote> This function is used to build addition head content that isn't built by the HTMLPageClass parent class by default. </blockquote> |
185 |
</TD> |
</TD> |
186 |
</TR> |
</TR> |
187 |
|
<!-- =========== Summary =========== --> |
|
<!-- =========== Summary =========== --> |
|
188 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
189 |
<TD> |
<TD> |
190 |
<CODE><B><A HREF='PageWidget.html#head_javascript'>string head_javascript ( )</A></B></CODE> |
<CODE><B><A HREF='../phpHtmlLib/PageWidget.html#methodhead_javascript'>string head_javascript ( )</A></B></CODE> |
191 |
<BR> |
<BR> |
192 |
<blockquote> This function is called to build |
<blockquote> This function is called to build any JavaScript that is needed in the <HEAD> portion of a document. </blockquote> |
|
any JavaScript that is needed in the |
|
|
<HEAD> portion of a document. </blockquote> |
|
193 |
</TD> |
</TD> |
194 |
</TR> |
</TR> |
195 |
|
<!-- =========== Summary =========== --> |
|
<!-- =========== Summary =========== --> |
|
196 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
197 |
<TD> |
<TD> |
198 |
<CODE><B><A HREF='PageWidget.html#render'>string render ( )</A></B></CODE> |
<CODE><B><A HREF='../phpHtmlLib/PageWidget.html#methodrender'>string render ( )</A></B></CODE> |
199 |
<BR> |
<BR> |
200 |
<blockquote> This is the function that renders the HTML |
<blockquote> This is the function that renders the HTML for this widget. </blockquote> |
201 |
for this widget. </blockquote> |
</TD> |
202 |
|
</TR> |
203 |
|
</TABLE> |
204 |
|
<!-- =========== INHERITED METHOD SUMMARY =========== --> |
205 |
|
<A NAME='functions_inherited'><!-- --></A> |
206 |
|
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
207 |
|
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
208 |
|
<TD> |
209 |
|
<span CLASS="font12bold">Inherited Method Summary</span> |
210 |
|
<A HREF="#top" CLASS="links">^TOP</A> |
211 |
</TD> |
</TD> |
212 |
</TR> |
</TR> |
|
|
|
|
</TABLE> |
|
213 |
|
|
214 |
|
<!-- =========== Summary =========== --> |
215 |
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
216 |
|
<TD> |
217 |
|
<span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/HTMLPageClass.html">HTMLPageClass</a></span> |
218 |
|
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center"> |
219 |
|
<tr CLASS="tableheadingcolor"> |
220 |
|
<th>Function</th> |
221 |
|
<th>Description</th> |
222 |
|
</tr> |
223 |
|
<tr> |
224 |
|
<td CLASS="font10bold"><a href="../phpHtmlLib/HTMLPageClass.html#methodHTMLPageClass">HTMLPageClass::HTMLPageClass()</a></td> |
225 |
|
<td CLASS="font10">Class Constructor</td> |
226 |
|
<tr> |
227 |
|
<td CLASS="font10bold"><a href="../phpHtmlLib/HTMLPageClass.html#methodadd">HTMLPageClass::add()</a></td> |
228 |
|
<td CLASS="font10">This function adds content to the <body> area of the page.</td> |
229 |
|
<tr> |
230 |
|
<td CLASS="font10bold"><a href="../phpHtmlLib/HTMLPageClass.html#methodadd_css_link">HTMLPageClass::add_css_link()</a></td> |
231 |
|
<td CLASS="font10">pushes a css external reference to the head area</td> |
232 |
|
<tr> |
233 |
|
<td CLASS="font10bold"><a href="../phpHtmlLib/HTMLPageClass.html#methodadd_head_content">HTMLPageClass::add_head_content()</a></td> |
234 |
|
<td CLASS="font10">this adds content to the head tag of the page</td> |
235 |
|
<tr> |
236 |
|
<td CLASS="font10bold"><a href="../phpHtmlLib/HTMLPageClass.html#methodadd_head_css">HTMLPageClass::add_head_css()</a></td> |
237 |
|
<td CLASS="font10">this function adds raw css to the <head> tag. It will automatically be wrapped in a <style type="text/css"></td> |
238 |
|
<tr> |
239 |
|
<td CLASS="font10bold"><a href="../phpHtmlLib/HTMLPageClass.html#methodadd_head_js">HTMLPageClass::add_head_js()</a></td> |
240 |
|
<td CLASS="font10">adds raw javascript to the head which will automatically get wrapped in a <script language="JavaScript"> tag.</td> |
241 |
|
<tr> |
242 |
|
<td CLASS="font10bold"><a href="../phpHtmlLib/HTMLPageClass.html#methodadd_reference">HTMLPageClass::add_reference()</a></td> |
243 |
|
<td CLASS="font10">Adds the content reference to the <body> tag for later use.</td> |
244 |
|
<tr> |
245 |
|
<td CLASS="font10bold"><a href="../phpHtmlLib/HTMLPageClass.html#methodbuild_doctype">HTMLPageClass::build_doctype()</a></td> |
246 |
|
<td CLASS="font10">This function is used to build the DOCTYPE</td> |
247 |
|
<tr> |
248 |
|
<td CLASS="font10bold"><a href="../phpHtmlLib/HTMLPageClass.html#methodget_html_attributes">HTMLPageClass::get_html_attributes()</a></td> |
249 |
|
<td CLASS="font10">This function returns the attributes to be used for the <html> tag.</td> |
250 |
|
<tr> |
251 |
|
<td CLASS="font10bold"><a href="../phpHtmlLib/HTMLPageClass.html#methodpush">HTMLPageClass::push()</a></td> |
252 |
|
<td CLASS="font10">Same as add()</td> |
253 |
|
<tr> |
254 |
|
<td CLASS="font10bold"><a href="../phpHtmlLib/HTMLPageClass.html#methodpush_css_link">HTMLPageClass::push_css_link()</a></td> |
255 |
|
<td CLASS="font10">Same ass add_css_link()</td> |
256 |
|
<tr> |
257 |
|
<td CLASS="font10bold"><a href="../phpHtmlLib/HTMLPageClass.html#methodpush_head_content">HTMLPageClass::push_head_content()</a></td> |
258 |
|
<td CLASS="font10">Same ass add_head_content()</td> |
259 |
|
<tr> |
260 |
|
<td CLASS="font10bold"><a href="../phpHtmlLib/HTMLPageClass.html#methodpush_head_js">HTMLPageClass::push_head_js()</a></td> |
261 |
|
<td CLASS="font10">Same ass add_head_js()</td> |
262 |
|
<tr> |
263 |
|
<td CLASS="font10bold"><a href="../phpHtmlLib/HTMLPageClass.html#methodpush_js_link">HTMLPageClass::push_js_link()</a></td> |
264 |
|
<td CLASS="font10">pushes an link to an externally referenced javascript file, which will get rendered in the head.</td> |
265 |
|
<tr> |
266 |
|
<td CLASS="font10bold"><a href="../phpHtmlLib/HTMLPageClass.html#methodpush_reference">HTMLPageClass::push_reference()</a></td> |
267 |
|
<td CLASS="font10">Same as add()</td> |
268 |
|
<tr> |
269 |
|
<td CLASS="font10bold"><a href="../phpHtmlLib/HTMLPageClass.html#methodrender">HTMLPageClass::render()</a></td> |
270 |
|
<td CLASS="font10">render the page.</td> |
271 |
|
<tr> |
272 |
|
<td CLASS="font10bold"><a href="../phpHtmlLib/HTMLPageClass.html#methodset_body_attributes">HTMLPageClass::set_body_attributes()</a></td> |
273 |
|
<td CLASS="font10">set attributes of body tag</td> |
274 |
|
<tr> |
275 |
|
<td CLASS="font10bold"><a href="../phpHtmlLib/HTMLPageClass.html#methodset_charset">HTMLPageClass::set_charset()</a></td> |
276 |
|
<td CLASS="font10">set the character set</td> |
277 |
|
<tr> |
278 |
|
<td CLASS="font10bold"><a href="../phpHtmlLib/HTMLPageClass.html#methodset_frameset">HTMLPageClass::set_frameset()</a></td> |
279 |
|
<td CLASS="font10">This function is used to set the FRAMSETtag object for this page. This automatically sets the output for this page object to be a frameset.</td> |
280 |
|
<tr> |
281 |
|
<td CLASS="font10bold"><a href="../phpHtmlLib/HTMLPageClass.html#methodset_html_attributes">HTMLPageClass::set_html_attributes()</a></td> |
282 |
|
<td CLASS="font10">This function sets the attributes for the <html> tag</td> |
283 |
|
<tr> |
284 |
|
<td CLASS="font10bold"><a href="../phpHtmlLib/HTMLPageClass.html#methodset_refresh">HTMLPageClass::set_refresh()</a></td> |
285 |
|
<td CLASS="font10">Automatically set a page meta tag refresh</td> |
286 |
|
<tr> |
287 |
|
<td CLASS="font10bold"><a href="../phpHtmlLib/HTMLPageClass.html#methodset_text_debug">HTMLPageClass::set_text_debug()</a></td> |
288 |
|
<td CLASS="font10">set the $_text_debug flag</td> |
289 |
|
<tr> |
290 |
|
<td CLASS="font10bold"><a href="../phpHtmlLib/HTMLPageClass.html#methodset_title">HTMLPageClass::set_title()</a></td> |
291 |
|
<td CLASS="font10">set the title of the page output.</td> |
292 |
|
<tr> |
293 |
|
<td CLASS="font10bold"><a href="../phpHtmlLib/HTMLPageClass.html#method_build_content_type_tag">HTMLPageClass::_build_content_type_tag()</a></td> |
294 |
|
<td CLASS="font10">this builds the content type meta tag.</td> |
295 |
|
<tr> |
296 |
|
<td CLASS="font10bold"><a href="../phpHtmlLib/HTMLPageClass.html#method_build_head">HTMLPageClass::_build_head()</a></td> |
297 |
|
<td CLASS="font10">builds the head object and its content.</td> |
298 |
|
<tr> |
299 |
|
<td CLASS="font10bold"><a href="../phpHtmlLib/HTMLPageClass.html#method_create_body">HTMLPageClass::_create_body()</a></td> |
300 |
|
<td CLASS="font10">This is responsible for creating the BODYtag object. We only will create a new $this->_body if it doesn't already exist.</td> |
301 |
|
<tr> |
302 |
|
<td CLASS="font10bold"><a href="../phpHtmlLib/HTMLPageClass.html#method_frameset_wrap_body">HTMLPageClass::_frameset_wrap_body()</a></td> |
303 |
|
<td CLASS="font10">This builds a frameset body tag wrapped in a <noframes> tag.</td> |
304 |
|
</table> |
305 |
|
<br> |
306 |
|
</TD> |
307 |
|
</TR> |
308 |
|
</TABLE> |
309 |
<hr> |
<hr> |
310 |
<!-- ============ VARIABLE DETAIL =========== --> |
<!-- ============ VARIABLE DETAIL =========== --> |
311 |
|
|
319 |
</TR> |
</TR> |
320 |
</TABLE> |
</TABLE> |
321 |
|
|
322 |
|
<A NAME='var$_enable_debug'><!-- --></A><H3>$_enable_debug</H3> (line <span class="linenumber">35</span>)<br /> |
323 |
<A NAME='$_enable_debug'><!-- --></A><H3>$_enable_debug</H3> |
<b>Data type:</b> mixed<br>This enables the ability to view the source of a page bu setting debug=1 in the query string. |
324 |
<b>Data type:</b> mixed<br> |
<br /> |
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
This enables the ability to view the |
|
|
source of a page bu setting debug=1 |
|
|
in the query string. |
|
|
<BR> |
|
|
|
|
325 |
|
|
326 |
<UL> |
<UL> |
327 |
|
</UL> |
|
</UL> |
|
|
|
|
328 |
<HR> |
<HR> |
329 |
|
<A NAME='var$_title_text'><!-- --></A><H3>$_title_text</H3> (line <span class="linenumber">43</span>)<br /> |
330 |
<A NAME='$_title_text'><!-- --></A><H3>$_title_text</H3> |
<b>Data type:</b> mixed<br>holds the page title text for |
331 |
<b>Data type:</b> mixed<br> |
<br /> |
332 |
<!-- ========== Info from phpDoc block ========= --> |
<p>a page</p> |
|
holds the page title text for |
|
|
a page |
|
|
<BR> |
|
|
|
|
|
|
|
333 |
<UL> |
<UL> |
334 |
|
</UL> |
|
</UL> |
|
|
|
|
335 |
<HR> |
<HR> |
|
|
|
|
|
|
336 |
<hr> |
<hr> |
337 |
<!-- ============ FUNCTION DETAIL =========== --> |
<!-- ============ METHOD DETAIL =========== --> |
338 |
|
|
339 |
<A NAME='function_detail'></A> |
<A NAME='method_detail'></A> |
340 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
341 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
342 |
<TD> |
<TD> |
346 |
</TR> |
</TR> |
347 |
</TABLE> |
</TABLE> |
348 |
<BR> |
<BR> |
|
|
|
349 |
<DIV CLASS="function"> |
<DIV CLASS="function"> |
350 |
<A NAME='constructor PageWidget'><!-- --></A> |
<A NAME='methodPageWidget'><!-- --></A> |
351 |
<SPAN CLASS="font12bold">constructor PageWidget</SPAN> |
<SPAN CLASS="font12bold">Constructor PageWidget</SPAN> (line <span class="linenumber">70</span>) |
352 |
<BR> |
<BR> |
353 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
<SPAN CLASS="font10bold">Usage : </SPAN> |
354 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
355 |
<span class="font10bold" style="color: #0000FF">constructor PageWidget ( $title, [$render_type = HTML], [$indent_style = INDENT_NICE] )</SPAN> |
<span class="font10bold" style="color: #0000FF">PageWidget( |
356 |
|
mixed |
357 |
|
$title, [string |
358 |
|
$render_type = HTML], [int |
359 |
|
$indent_style = INDENT_NICE])</SPAN> |
360 |
<BR> |
<BR> |
361 |
|
|
362 |
<BR> |
<BR> |
363 |
<SPAN CLASS="font10bold">Description : </SPAN> |
<SPAN CLASS="font10bold">Description : </SPAN> |
|
<!-- ========== Info from phpDoc block ========= --> |
|
364 |
Constructor: |
Constructor: |
365 |
<BR> |
<br /> |
366 |
|
|
367 |
<DL> |
<DL> |
368 |
<DT class="font10bold">Function Parameters:</DT> |
<DT class="font10bold">Function Parameters:</DT> |
369 |
|
<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> - $title Title string or TITLEtag object for the page.</DD> |
370 |
<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 |
<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">$render_type</SPAN></SPAN> - one of 3 types of html to render. Setting this will make the object declare the gobal define which tells all of the tag objects what type of html tags to render. some tags support special features. such as the <IMG> tag. If xhtml is selected, the the IMGtag object and all utility functions will not render "border=0" as a default attribute, since this is not proper xhtml. "html" - HTML 4.0 (default) "xhtml_transitional" - render xhtml instead of html - doctype is XHTML transitional. "xhtml_strict" - render xhtml instead of html 4.0. - doctype is XHTML strict.</DD> |
371 |
make the object declare the gobal define which tells |
<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_style</SPAN></SPAN> - one of 2 types. INDENT_NICE or INDENT_LEFT_JUSTIFY This tells the page how to render the indenting of the output. By default it is set to INDENT_NICE, which nicely indents each nested tag. You can have all tags rendered left justified (smaller size in output) by using INDENT_LEFT_JUSTIFY</DD> |
372 |
all of the tag objects what type of html tags to render. |
|
373 |
some tags support special features. such as the <IMG> |
<DT class="font10bold">Function Info:</DT> |
374 |
tag. If xhtml is selected, the the IMGtag object and all |
</DL> |
|
utility functions will not render "border=0" as a default |
|
|
attribute, since this is not proper xhtml. |
|
|
"html" - HTML 4.0 (default) |
|
|
"xhtml_transitional" - render xhtml instead of html |
|
|
- doctype is XHTML transitional. |
|
|
"xhtml_strict" - render xhtml instead of html 4.0. |
|
|
- doctype is XHTML strict.</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">$render_type</SPAN></SPAN> - one of 2 types. INDENT_NICE or INDENT_LEFT_JUSTIFY |
|
|
This tells the page how to render the indenting of the |
|
|
output. By default it is set to INDENT_NICE, which nicely |
|
|
indents each nested tag. You can have all tags rendered |
|
|
left justified (smaller size in output) by using |
|
|
INDENT_LEFT_JUSTIFY</DD> |
|
|
|
|
|
|
|
|
<DT class="font10bold">Function Info:</DT> |
|
|
|
|
|
</DL> |
|
|
|
|
375 |
</DIV> |
</DIV> |
376 |
<BR> |
<BR> |
|
|
|
377 |
<DIV CLASS="function"> |
<DIV CLASS="function"> |
378 |
<A NAME='body_content'><!-- --></A> |
<A NAME='methodbody_content'><!-- --></A> |
379 |
<SPAN CLASS="font12bold">body_content</SPAN> |
<SPAN CLASS="font12bold">body_content</SPAN> (line <span class="linenumber">130</span>) |
380 |
<BR> |
<BR> |
381 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
<SPAN CLASS="font10bold">Usage : </SPAN> |
382 |
<span class="font10bold" style="color: #FF0000">mixed.</SPAN> |
<span class="font10bold" style="color: #FF0000">mixed.</SPAN> |
383 |
<span class="font10bold" style="color: #0000FF">body_content ( )</SPAN> |
<span class="font10bold" style="color: #0000FF">body_content( |
384 |
|
)</SPAN> |
385 |
<BR> |
<BR> |
386 |
Overridden in child class(es) as: <a href="../phpHtmlLib/examples/MyLayoutPage.html#body_content">MyLayoutPage::body_content()</a><br> |
<p>Overridden in child classes as:<br /> |
387 |
|
<dl> |
388 |
|
<dt><a href="../phpHtmlLib/examples/MyLayoutPage.html#methodbody_content">MyLayoutPage::body_content()</a></dt> |
389 |
|
<dd>This builds the main content for the page.</dd> |
390 |
|
</dl> |
391 |
|
</p> |
392 |
|
|
393 |
<BR> |
<BR> |
394 |
<SPAN CLASS="font10bold">Description : </SPAN> |
<SPAN CLASS="font10bold">Description : </SPAN> |
395 |
<!-- ========== Info from phpDoc block ========= --> |
This function is meant to be overridden by the child class. |
396 |
This function is meant to be overridden |
<br /> |
397 |
by the child class. |
<p>This provides all of the content for the page. NOTE: You add the content to the body in 1 of 2 ways. 1) return the content from this call. 2) inside the call, you can just call $this->add(); and then return NULL;</p> |
|
<BR> |
|
|
This provides all of the content |
|
|
for the page. |
|
|
NOTE: You add the content to the |
|
|
body in 1 of 2 ways. |
|
|
1) return the content from this |
|
|
call. |
|
|
2) inside the call, you can |
|
|
just call $this->add(); |
|
|
and then return NULL; |
|
398 |
<DL> |
<DL> |
|
<DT class="font10bold">Function Parameters:</DT> |
|
|
|
|
|
|
|
|
<DT class="font10bold">Function Info:</DT> |
|
|
|
|
|
</DL> |
|
399 |
|
|
400 |
|
<DT class="font10bold">Function Info:</DT> |
401 |
|
</DL> |
402 |
</DIV> |
</DIV> |
403 |
<BR> |
<BR> |
|
|
|
404 |
<DIV CLASS="function"> |
<DIV CLASS="function"> |
405 |
<A NAME='enable_debug'><!-- --></A> |
<A NAME='methodenable_debug'><!-- --></A> |
406 |
<SPAN CLASS="font12bold">enable_debug</SPAN> |
<SPAN CLASS="font12bold">enable_debug</SPAN> (line <span class="linenumber">164</span>) |
407 |
<BR> |
<BR> |
408 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
<SPAN CLASS="font10bold">Usage : </SPAN> |
409 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
410 |
<span class="font10bold" style="color: #0000FF">enable_debug ( [$flag = TRUE] )</SPAN> |
<span class="font10bold" style="color: #0000FF">enable_debug( |
411 |
|
[boolean |
412 |
|
$flag = TRUE])</SPAN> |
413 |
<BR> |
<BR> |
414 |
|
|
415 |
<BR> |
<BR> |
416 |
<SPAN CLASS="font10bold">Description : </SPAN> |
<SPAN CLASS="font10bold">Description : </SPAN> |
417 |
<!-- ========== Info from phpDoc block ========= --> |
This sets the debug option for the HTMLPageClass |
418 |
This sets the debug option for |
<br /> |
|
the HTMLPageClass |
|
|
<BR> |
|
419 |
|
|
420 |
<DL> |
<DL> |
421 |
<DT class="font10bold">Function Parameters:</DT> |
<DT class="font10bold">Function Parameters:</DT> |
422 |
|
<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> TRUE for on, FALSE for off</DD> |
423 |
<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> TRUE for on, FALSE for off</DD> |
|
424 |
|
<DT class="font10bold">Function Info:</DT> |
425 |
|
</DL> |
|
<DT class="font10bold">Function Info:</DT> |
|
|
|
|
|
</DL> |
|
|
|
|
426 |
</DIV> |
</DIV> |
427 |
<BR> |
<BR> |
|
|
|
428 |
<DIV CLASS="function"> |
<DIV CLASS="function"> |
429 |
<A NAME='frameset'><!-- --></A> |
<A NAME='methodframeset'><!-- --></A> |
430 |
<SPAN CLASS="font12bold">frameset</SPAN> |
<SPAN CLASS="font12bold">frameset</SPAN> (line <span class="linenumber">141</span>) |
431 |
<BR> |
<BR> |
432 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
<SPAN CLASS="font10bold">Usage : </SPAN> |
433 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
434 |
<span class="font10bold" style="color: #0000FF">frameset ( )</SPAN> |
<span class="font10bold" style="color: #0000FF">frameset( |
435 |
|
)</SPAN> |
436 |
<BR> |
<BR> |
437 |
|
|
438 |
<BR> |
<BR> |
439 |
<SPAN CLASS="font10bold">Description : </SPAN> |
<SPAN CLASS="font10bold">Description : </SPAN> |
|
<!-- ========== Info from phpDoc block ========= --> |
|
440 |
This function is used to save |
This function is used to save |
441 |
a frameset to the page. |
<br /> |
442 |
<BR> |
<p>a frameset to the page. This will automatically output a properly formatted</p> |
|
This will |
|
|
automatically output a properly |
|
|
formatted |
|
443 |
<DL> |
<DL> |
|
<DT class="font10bold">Function Parameters:</DT> |
|
|
|
|
|
|
|
|
<DT class="font10bold">Function Info:</DT> |
|
|
|
|
|
</DL> |
|
444 |
|
|
445 |
|
<DT class="font10bold">Function Info:</DT> |
446 |
|
</DL> |
447 |
</DIV> |
</DIV> |
448 |
<BR> |
<BR> |
|
|
|
449 |
<DIV CLASS="function"> |
<DIV CLASS="function"> |
450 |
<A NAME='get_title'><!-- --></A> |
<A NAME='methodget_title'><!-- --></A> |
451 |
<SPAN CLASS="font12bold">get_title</SPAN> |
<SPAN CLASS="font12bold">get_title</SPAN> (line <span class="linenumber">89</span>) |
452 |
<BR> |
<BR> |
453 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
<SPAN CLASS="font10bold">Usage : </SPAN> |
454 |
<span class="font10bold" style="color: #FF0000">string</SPAN> |
<span class="font10bold" style="color: #FF0000">string</SPAN> |
455 |
<span class="font10bold" style="color: #0000FF">get_title ( )</SPAN> |
<span class="font10bold" style="color: #0000FF">get_title( |
456 |
|
)</SPAN> |
457 |
<BR> |
<BR> |
458 |
|
|
459 |
<BR> |
<BR> |
460 |
<SPAN CLASS="font10bold">Description : </SPAN> |
<SPAN CLASS="font10bold">Description : </SPAN> |
|
<!-- ========== Info from phpDoc block ========= --> |
|
461 |
gets the current title of the page. |
gets the current title of the page. |
462 |
<BR> |
<br /> |
463 |
|
|
464 |
<DL> |
<DL> |
|
<DT class="font10bold">Function Parameters:</DT> |
|
|
|
|
|
|
|
|
<DT class="font10bold">Function Info:</DT> |
|
|
|
|
|
</DL> |
|
465 |
|
|
466 |
|
<DT class="font10bold">Function Info:</DT> |
467 |
|
</DL> |
468 |
</DIV> |
</DIV> |
469 |
<BR> |
<BR> |
|
|
|
470 |
<DIV CLASS="function"> |
<DIV CLASS="function"> |
471 |
<A NAME='head_content'><!-- --></A> |
<A NAME='methodhead_content'><!-- --></A> |
472 |
<SPAN CLASS="font12bold">head_content</SPAN> |
<SPAN CLASS="font12bold">head_content</SPAN> (line <span class="linenumber">110</span>) |
473 |
<BR> |
<BR> |
474 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
<SPAN CLASS="font10bold">Usage : </SPAN> |
475 |
<span class="font10bold" style="color: #FF0000">mixed.</SPAN> |
<span class="font10bold" style="color: #FF0000">mixed.</SPAN> |
476 |
<span class="font10bold" style="color: #0000FF">head_content ( )</SPAN> |
<span class="font10bold" style="color: #0000FF">head_content( |
477 |
|
)</SPAN> |
478 |
<BR> |
<BR> |
479 |
|
|
480 |
<BR> |
<BR> |
481 |
<SPAN CLASS="font10bold">Description : </SPAN> |
<SPAN CLASS="font10bold">Description : </SPAN> |
482 |
<!-- ========== Info from phpDoc block ========= --> |
This function is used to build addition head content that isn't built by the HTMLPageClass parent class by default. |
483 |
This function is used to build |
<br /> |
484 |
<BR> |
<p>NOTE: you can add addition content to the head in 1 of 2 ways. 1) inside the call return the addition content in the return $foo; 2) or use the HTMLPageClass' $this->add_head_content() from within the head_content() call.</p> |
|
addition head content that isn't |
|
|
built by the HTMLPageClass parent |
|
|
class by default. |
|
|
NOTE: you can add addition content |
|
|
to the head in 1 of 2 ways. |
|
|
1) inside the call return the |
|
|
addition content in the |
|
|
return $foo; |
|
|
2) or use the HTMLPageClass' |
|
|
$this->add_head_content() |
|
|
from within the head_content() |
|
|
call. |
|
485 |
<DL> |
<DL> |
|
<DT class="font10bold">Function Parameters:</DT> |
|
|
|
|
|
|
|
|
<DT class="font10bold">Function Info:</DT> |
|
|
|
|
|
</DL> |
|
486 |
|
|
487 |
|
<DT class="font10bold">Function Info:</DT> |
488 |
|
</DL> |
489 |
</DIV> |
</DIV> |
490 |
<BR> |
<BR> |
|
|
|
491 |
<DIV CLASS="function"> |
<DIV CLASS="function"> |
492 |
<A NAME='head_javascript'><!-- --></A> |
<A NAME='methodhead_javascript'><!-- --></A> |
493 |
<SPAN CLASS="font12bold">head_javascript</SPAN> |
<SPAN CLASS="font12bold">head_javascript</SPAN> (line <span class="linenumber">153</span>) |
494 |
<BR> |
<BR> |
495 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
<SPAN CLASS="font10bold">Usage : </SPAN> |
496 |
<span class="font10bold" style="color: #FF0000">string</SPAN> |
<span class="font10bold" style="color: #FF0000">string</SPAN> |
497 |
<span class="font10bold" style="color: #0000FF">head_javascript ( )</SPAN> |
<span class="font10bold" style="color: #0000FF">head_javascript( |
498 |
|
)</SPAN> |
499 |
<BR> |
<BR> |
500 |
|
|
501 |
<BR> |
<BR> |
502 |
<SPAN CLASS="font10bold">Description : </SPAN> |
<SPAN CLASS="font10bold">Description : </SPAN> |
503 |
<!-- ========== Info from phpDoc block ========= --> |
This function is called to build any JavaScript that is needed in the <HEAD> portion of a document. |
504 |
This function is called to build |
<br /> |
|
any JavaScript that is needed in the |
|
|
<HEAD> portion of a document. |
|
|
<BR> |
|
505 |
|
|
506 |
<DL> |
<DL> |
|
<DT class="font10bold">Function Parameters:</DT> |
|
|
|
|
|
|
|
|
<DT class="font10bold">Function Info:</DT> |
|
|
|
|
|
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - - the raw JS code to be |
|
|
put inside the <head></DD> |
|
|
|
|
|
</DL> |
|
507 |
|
|
508 |
|
<DT class="font10bold">Function Info:</DT> |
509 |
|
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>return</b> - - the raw JS code to be put inside the <head></DD> |
510 |
|
</DL> |
511 |
</DIV> |
</DIV> |
512 |
<BR> |
<BR> |
|
|
|
513 |
<DIV CLASS="function"> |
<DIV CLASS="function"> |
514 |
<A NAME='render'><!-- --></A> |
<A NAME='methodrender'><!-- --></A> |
515 |
<SPAN CLASS="font12bold">render</SPAN> |
<SPAN CLASS="font12bold">render</SPAN> (line <span class="linenumber">175</span>) |
516 |
<BR> |
<BR> |
517 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
<SPAN CLASS="font10bold">Usage : </SPAN> |
518 |
<span class="font10bold" style="color: #FF0000">string</SPAN> |
<span class="font10bold" style="color: #FF0000">string</SPAN> |
519 |
<span class="font10bold" style="color: #0000FF">render ( )</SPAN> |
<span class="font10bold" style="color: #0000FF">render( |
520 |
|
)</SPAN> |
521 |
<BR> |
<BR> |
522 |
<span class="font10bold" style="padding-left: 10px;">Overrides :</span> <a href="../phpHtmlLib/HTMLPageClass.html#render">HTMLPageClass::render()</a> |
|
523 |
|
<span class="font10bold" style="padding-left: 10px;">Overrides :</span> <a href="../phpHtmlLib/HTMLPageClass.html#methodrender">HTMLPageClass::render()</a> render the page. |
524 |
<BR> |
<BR> |
525 |
<SPAN CLASS="font10bold">Description : </SPAN> |
<SPAN CLASS="font10bold">Description : </SPAN> |
526 |
<!-- ========== Info from phpDoc block ========= --> |
This is the function that renders the HTML for this widget. |
527 |
This is the function that renders the HTML |
<br /> |
|
for this widget. |
|
|
<BR> |
|
528 |
|
|
529 |
<DL> |
<DL> |
|
<DT class="font10bold">Function Parameters:</DT> |
|
|
|
|
|
|
|
|
<DT class="font10bold">Function Info:</DT> |
|
|
|
|
|
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - - the HTML</DD> |
|
|
|
|
|
</DL> |
|
530 |
|
|
531 |
|
<DT class="font10bold">Function Info:</DT> |
532 |
|
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>return</b> - - the HTML</DD> |
533 |
|
</DL> |
534 |
</DIV> |
</DIV> |
535 |
<BR> |
<BR> |
536 |
|
<div id="credit"> |
537 |
|
<hr> |
538 |
<hr> |
Documention generated on Thu, 20 Feb 2003 16:23:06 -0800 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.0rc1</a> |
539 |
</HTML> |
</div> |
540 |
|
</body> |
541 |
|
</html> |