/[cvs]/nfo/php/libs/com.newsblob.phphtmllib/doc/phpHtmlLib/PageWidget.html
ViewVC logotype

Diff of /nfo/php/libs/com.newsblob.phphtmllib/doc/phpHtmlLib/PageWidget.html

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 1.1.1.1 by jonen, Thu Jan 30 03:29:22 2003 UTC revision 1.4 by jonen, Thu May 6 16:24:22 2004 UTC
# Line 1  Line 1 
1  <!DOCTYPE HTML PUBLIC '-//W3C//DTD HTML 4.0 Frameset//EN''http://www.w3.org/TR/REC-html40/frameset.dtd'>  <?xml version="1.0" encoding="iso-8859-1"?>
2  <!--NewPage-->  <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3  <HTML>    <html xmlns="http://www.w3.org/1999/xhtml">
4  <HEAD>                  <head>
5          <!-- Generated by PhpDoc date: 'Mon, 25 Nov 2002 09:21:33 -0800' -->                          <!-- template designed by Marco Von Ballmoos -->
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" href="../media/stylesheet.css" />
8  </HEAD>                          <meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
9  <BODY style="background-color: #eeeeee; font-family: arial; font-size: .9em;">                  </head>
10                        <body>
11                            <div class="page-body">                
12  <!-- Links -->  <h2 class="class-name">Class PageWidget</h2>
13  <a NAME="top"></A>  
14  <table WIDTH="100%" class="links">  <a name="sec-description"></a>
15   <TR>  <div class="info-box">
16     <TD class="font10">          <div class="info-box-title">Description</div>
17        Links:          <div class="nav-bar">
18        <A HREF="#children_summary" class="links" title="Classes extended from PageWidget">Child Classes</A>                                          <span class="disabled">Description</span> |
19        <A HREF="#var_summary" class="links" title="Class Variable Summary">Variables</A>                                                          <a href="#sec-descendents">Descendents</a>
20        <A HREF="#var_inherited_summary" class="links" title="Inherited Class Variable Summary">Inherited Variables</A>                          |                                                                                       <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
21        <A HREF="#functions_inherited" class="links" title="Inherited Method Summary">Inerited Methods</A>                                                  |                                                                                       <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</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>                                          </div>
24        <A HREF="#function_detail" class="links" title="Method Detail">Method Detail</A>          <div class="info-box-body">
25     </TD>                          <!-- ========== Info from phpDoc block ========= -->
26   </TR>  <p class="short-description">This class is used to build content  for an entire page.  It uses the  HTMLPageClass widget from phphtmllib  to render the final output.</p>
27  </TABLE>          <ul class="tags">
28  <BR>                                  <li><span class="field">author:</span> Walter A. Boring IV &lt;<a href="mailto:waboring@buildabetterweb.com">waboring@buildabetterweb.com</a>&gt;</li>
29                            </ul>
30  <!-- Start of Class Data -->                  <p class="notes">
31  <H2>                          Located in <a class="field" href="_widgets_PageWidget_inc.html">/widgets/PageWidget.inc</a> (line <span class="field">34</span>)
32          Class PageWidget                  </p>
33  </H2>                  
34                                    
35  <pre>                  <pre><a href="../phpHtmlLib/HTMLPageClass.html">HTMLPageClass</a>
 <pre><a href="../phpHtmlLib/HTMLPageClass.html">HTMLPageClass</a>  
36     |     |
37     --PageWidget</pre>     --PageWidget</pre>
38  </pre>          
39                            </div>
40  <A NAME="children_summary"</A>  </div>
41  <H3>  
42          Classes extended from PageWidget: <A HREF="#top" CLASS="links">^TOP</A>          <a name="sec-descendents"></a>
43  </H3>          <div class="info-box">
44  <a href="../phpHtmlLib/examples/MyLayoutPage.html">MyLayoutPage</a>                  <div class="info-box-title">Direct descendents</div>
45  <p>                  <div class="nav-bar">
46          <b><i>Located in File: Program_Root/widgets/PageWidget.inc</i></b><br>                          <a href="#sec-description">Description</a> |
47  </p>                          <span class="disabled">Descendents</span>
48  <hr>                          |                                                                                               <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
49  <!-- ========== Info from phpDoc block ========= -->                                                                  |                                                                                                                       <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
50  This class is used to build content                                                          
51  for an entire page.                                                                  </div>
52  <BR>                  <div class="info-box-body">
53  It uses the                          <table cellpadding="2" cellspacing="0" class="class-table">
54  HTMLPageClass widget from phphtmllib                                  <tr>
55  to render the final output.                                          <th class="class-table-header">Class</th>
56                                            <th class="class-table-header">Description</th>
57  <UL>                                  </tr>
58                                                                            <tr>
59          <LI><b>Package</b> - <CODE>phpHtmlLib</CODE></LI>                                          <td style="padding-right: 2em"></td>
60                                                    <td>
61          <LI><b>Author</b> - <CODE>Walter A. Boring IV &lt;<a href="mailto:waboring@buildabetterweb.com">waboring@buildabetterweb.com</a>&gt;</CODE></LI>                                                                                          This class is used to build content  for an entire page.  It uses the  HTMLPageClass widget from phphtmllib  to render the final output.
62                                                                                            </td>
63  </UL>                                  </tr>
64                                                                    <tr>
65  <hr>                                          <td style="padding-right: 2em"><a href="../phpHtmlLib/widget-examples/PermissionsCheckTestPage.html">PermissionsCheckTestPage</a></td>
66  <!-- =========== VAR SUMMARY =========== -->                                          <td>
67  <A NAME='var_summary'><!-- --></A>                                                                                          This class is used to build content  for an entire page.  It uses the  HTMLPageClass widget from phphtmllib  to render the final output.
68  <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">                                                                                  </td>
69          <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>                                  </tr>
70                  <TD>                                                                  <tr>
71                          <span CLASS="font12bold">Class Variable Summary</span>                                          <td style="padding-right: 2em"><a href="../phpHtmlLib/widget-examples/WidgetListPage.html">WidgetListPage</a></td>
72              <A HREF="#top" CLASS="links">^TOP</A>                                          <td>
73                  </TD>                                                                                          This class is used to build content  for an entire page.  It uses the  HTMLPageClass widget from phphtmllib  to render the final output.
74          </TR>                                                                                  </td>
75                                    </tr>
76                                                                    </table>
77          <!-- =========== Summary =========== -->                  </div>
78          <TR BGCOLOR='white' CLASS='TableRowColor'>          </div>
79                  <TD>  
80                          <CODE><B><A HREF='PageWidget.html#$_enable_debug'>$_enable_debug</A></B></CODE>  
81                          <BR>          <a name="sec-var-summary"></a>
82                          <blockquote> This enables the ability to view the          <div class="info-box">
83  source of a page bu setting debug=1                  <div class="info-box-title">Variable Summary</span></div>
84  in the query string. </blockquote>                  <div class="nav-bar">
85                          <blockquote> Default Value: <CODE>->FALSE<-</CODE> </blockquote>                          <a href="#sec-description">Description</a> |
86                  </TD>                                                          <a href="#sec-descendents">Descendents</a> |
87          </TR>                                                  <span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
88                                                                    |
89          <!-- =========== Summary =========== -->                                                                          <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
90          <TR BGCOLOR='white' CLASS='TableRowColor'>                                                          
91                  <TD>                                                                  </div>
92                          <CODE><B><A HREF='PageWidget.html#$_title_text'>$_title_text</A></B></CODE>                  <div class="info-box-body">
93                          <BR>                          <div class="var-summary">
94                          <blockquote> holds the page title text for                                                                  <div class="var-title">
95  a page </blockquote>                                          <span class="var-type">mixed</span>
96                          <blockquote> Default Value: <CODE>->NULL<-</CODE> </blockquote>                                          <a href="#$_allow_permissions_checks" title="details" class="var-name">$_allow_permissions_checks</a>
97                  </TD>                                  </div>
98          </TR>                                                                  <div class="var-title">
99                                                    <span class="var-type">mixed</span>
100  </TABLE>                                          <a href="#$_enable_debug" title="details" class="var-name">$_enable_debug</a>
101                                    </div>
102  <hr>                                                                  <div class="var-title">
103  <!-- =========== VAR INHERITED SUMMARY =========== -->                                          <span class="var-type">mixed</span>
104  <A NAME='var_inherited_summary'><!-- --></A>                                          <a href="#$_permissions_error_width" title="details" class="var-name">$_permissions_error_width</a>
105  <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">                                  </div>
106          <TR CLASS='TableHeadingColor'>                                                                  <div class="var-title">
107                  <TD>                                          <span class="var-type">mixed</span>
108                          <span CLASS="font12bold">Inherited Class Variable Summary</span>                                          <a href="#$_permission_box" title="details" class="var-name">$_permission_box</a>
109              <A HREF="#top" CLASS="links">^TOP</A>                                  </div>
110                  </TD>                                                                  <div class="var-title">
111          </TR>                                          <span class="var-type">mixed</span>
112                                            <a href="#$_perm_options" title="details" class="var-name">$_perm_options</a>
113                                            </div>
114          <!-- =========== Summary =========== -->                                                                  <div class="var-title">
115          <TR BGCOLOR='white'>                                          <span class="var-type">mixed</span>
116                  <TD>                                          <a href="#$_title_text" title="details" class="var-name">$_title_text</a>
117                          <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/HTMLPageClass.html">HTMLPageClass</a></span>                                  </div>
118              <table CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">                                                          </div>
119                          <tr CLASS="tableheadingcolor">                  </div>
120                                  <th>Variable</th>          </div>
121                                  <th>Default Value</th>  
122                                  <th>Description</th>          <a name="sec-method-summary"></a>
123                          </tr>          <div class="info-box">
124                                                    <div class="info-box-title">Method Summary</span></div>
125                          <tr>                  <div class="nav-bar">
126                                  <td CLASS="font10bold"><A HREF='../phpHtmlLib/HTMLPageClass.html#$_html_attributes'>$_html_attributes</A></td>                          <a href="#sec-description">Description</a> |
127                                  <td CLASS="font10" STYLE="white-space: nowrap">->array()<-</td>                                                          <a href="#sec-descendents">Descendents</a> |
128                                  <td CLASS="font10">This holds the attributes for the                                                                                                                                                  <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
129  &lt;html&gt; tag.</td>                                  
130                          </tr>                                  |
131                                                                                    <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
132                          <tr>                  </div>
133                                  <td CLASS="font10bold"><A HREF='../phpHtmlLib/HTMLPageClass.html#$_indent_style'>$_indent_style</A></td>                  <div class="info-box-body">                    
134                                  <td CLASS="font10" STYLE="white-space: nowrap">->0<-</td>                          <div class="method-summary">
135                                  <td CLASS="font10">Holds the value of the indent</td>                                                                  
136                          </tr>                                  <div class="method-definition">
137                                                                                                                            <span class="method-result">PageWidget</span>
138                          <tr>                                                                                  <a href="#PageWidget" title="details" class="method-name">PageWidget</a>
139                                  <td CLASS="font10bold"><A HREF='../phpHtmlLib/HTMLPageClass.html#$_widget_css_auto'>$_widget_css_auto</A></td>                                                                                          (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$title</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$render_type</span> = <span class="var-default">HTML</span>], [<span class="var-type">int</span>&nbsp;<span class="var-name">$indent_style</span> = <span class="var-default">INDENT_NICE</span>])
140                                  <td CLASS="font10" STYLE="white-space: nowrap">->array()<-</td>                                                                          </div>
141                                  <td CLASS="font10">keeps track of which widgets we have                                                                  
142  automatically pulled in css for</td>                                  <div class="method-definition">
143                          </tr>                                                                                          <span class="method-result">void</span>
144                                                                                                                    <a href="#allow_permissions_checks" title="details" class="method-name">allow_permissions_checks</a>
145                          <tr>                                                                                          ([<span class="var-type">boolean</span>&nbsp;<span class="var-name">$flag</span> = <span class="var-default">true</span>])
146                                  <td CLASS="font10bold"><A HREF='../phpHtmlLib/HTMLPageClass.html#$_widget_js_auto'>$_widget_js_auto</A></td>                                                                          </div>
147                                  <td CLASS="font10" STYLE="white-space: nowrap">->array()<-</td>                                                                  
148                                  <td CLASS="font10">keeps track of which widgets we have                                  <div class="method-definition">
149  automatically pulled in js for</td>                                                                                          <span class="method-result">mixed.</span>
150                          </tr>                                                                                  <a href="#body_content" title="details" class="method-name">body_content</a>
151                                                                                                                    ()
152                          </table>                                                                          </div>
153              <BR>                                                                  
154          </TD>                                  <div class="method-definition">
155          </TR>                                                                                          <span class="method-result">void</span>
156                                                                                            <a href="#enable_debug" title="details" class="method-name">enable_debug</a>
157  </TABLE>                                                                                          ([<span class="var-type">boolean</span>&nbsp;<span class="var-name">$flag</span> = <span class="var-default">TRUE</span>])
158                                                                            </div>
159  <hr>                                                                  
160  <!-- =========== INHERITED METHOD SUMMARY =========== -->                                  <div class="method-definition">
161  <A NAME='functions_inherited'><!-- --></A>                                                                                          <span class="method-result">void</span>
162  <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">                                                                                  <a href="#frameset" title="details" class="method-name">frameset</a>
163          <TR CLASS='TableHeadingColor'>                                                                                  ()
164                  <TD>                                                                          </div>
165                          <span CLASS="font12bold">Inherited Method Summary</span>                                                                  
166              <A HREF="#top" CLASS="links">^TOP</A>                                  <div class="method-definition">
167                  </TD>                                                                                          <span class="method-result">string</span>
168          </TR>                                                                                  <a href="#get_title" title="details" class="method-name">get_title</a>
169                                                                                    ()
170                                                                                    </div>
171          <!-- =========== Summary =========== -->                                                                  
172          <TR BGCOLOR='white' CLASS='TableRowColor'>                                  <div class="method-definition">
173                  <TD>                                                                                          <span class="method-result">mixed.</span>
174                          <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/HTMLPageClass.html">HTMLPageClass</a></span>                                                                                  <a href="#head_content" title="details" class="method-name">head_content</a>
175              <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">                                                                                  ()
176                                  <tr CLASS="tableheadingcolor">                                                                          </div>
177                                          <th>Function</th>                                                                  
178                                          <th>Description</th>                                  <div class="method-definition">
179                                  </tr>                                                                                          <span class="method-result">string</span>
180                                                                                                                    <a href="#head_javascript" title="details" class="method-name">head_javascript</a>
181                                  <tr>                                                                                  ()
182                                          <td CLASS="font10bold"><A HREF='../phpHtmlLib/HTMLPageClass.html#constructor HTMLPageClass'>constructor HTMLPageClass ( [$title = NULL], [$html_type = HTML], [$indent_style = INDENT_NICE] )</A></td>                                                                          </div>
183                                          <td CLASS="font10">Class Constructor</td>                                                                  
184                                                                    <div class="method-definition">
185                                  <tr>                                                                                          <span class="method-result">boolean</span>
186                                          <td CLASS="font10bold"><A HREF='../phpHtmlLib/HTMLPageClass.html#add'>add (  )</A></td>                                                                                  <a href="#permission" title="details" class="method-name">permission</a>
187                                          <td CLASS="font10">This function adds content to the &lt;body&gt;                                                                                  ()
188  area of the page.</td>                                                                          </div>
189                                                                                                    
190                                  <tr>                                  <div class="method-definition">
191                                          <td CLASS="font10bold"><A HREF='../phpHtmlLib/HTMLPageClass.html#add_css_link'>add_css_link ( $link )</A></td>                                                                                          <span class="method-result">string</span>
192                                          <td CLASS="font10">pushes a css external reference to the head area</td>                                                                                  <a href="#render" title="details" class="method-name">render</a>
193                                                                                                                    ()
194                                  <tr>                                                                          </div>
195                                          <td CLASS="font10bold"><A HREF='../phpHtmlLib/HTMLPageClass.html#add_head_content'>add_head_content (  )</A></td>                                                                  
196                                          <td CLASS="font10">this adds content to the head tag                                  <div class="method-definition">
197  of the page</td>                                                                                          <span class="method-result">void</span>
198                                                                                                                    <a href="#set_permissions_message" title="details" class="method-name">set_permissions_message</a>
199                                  <tr>                                                                                          ([<span class="var-type">string</span>&nbsp;<span class="var-name">$message</span> = <span class="var-default">NULL</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$url</span> = <span class="var-default">NULL</span>])
200                                          <td CLASS="font10bold"><A HREF='../phpHtmlLib/HTMLPageClass.html#add_head_css'>add_head_css ( $css )</A></td>                                                                          </div>
201                                          <td CLASS="font10">this function adds raw css to the                                                                  
202  &lt;head&gt; tag.</td>                                  <div class="method-definition">
203                                                                                                                            <span class="method-result">none</span>
204                                  <tr>                                                                                  <a href="#_build_permission_box" title="details" class="method-name">_build_permission_box</a>
205                                          <td CLASS="font10bold"><A HREF='../phpHtmlLib/HTMLPageClass.html#add_head_js'>add_head_js ( $content )</A></td>                                                                                  ()
206                                          <td CLASS="font10">adds raw javascript to the head which                                                                          </div>
207  will automatically get wrapped in a                                                                  
208  &lt;script language=&quot;JavaScript&quot;&gt; tag.</td>                                  <div class="method-definition">
209                                                                                                                            <span class="method-result">void</span>
210                                  <tr>                                                                                  <a href="#_check_permissions" title="details" class="method-name">_check_permissions</a>
211                                          <td CLASS="font10bold"><A HREF='../phpHtmlLib/HTMLPageClass.html#add_reference'>add_reference ( &$content )</A></td>                                                                                  ()
212                                          <td CLASS="font10">Adds the content reference to the &lt;body&gt;                                                                          </div>
213  tag for later use.</td>                                                                  
214                                                                    <div class="method-definition">
215                                  <tr>                                                                                          <span class="method-result">boolean</span>
216                                          <td CLASS="font10bold"><A HREF='../phpHtmlLib/HTMLPageClass.html#build_doctype'>build_doctype ( $link1, [$link2 = NULL] )</A></td>                                                                                  <a href="#_has_permission" title="details" class="method-name">_has_permission</a>
217                                          <td CLASS="font10">This function is used to build the DOCTYPE                                                                                  ()
218  tag for the page.</td>                                                                          </div>
219                                                                                                    
220                                  <tr>                                  <div class="method-definition">
221                                          <td CLASS="font10bold"><A HREF='../phpHtmlLib/HTMLPageClass.html#get_html_attributes'>get_html_attributes (  )</A></td>                                                                                          <span class="method-result">void</span>
222                                          <td CLASS="font10">This function returns the                                                                                  <a href="#_set_perms" title="details" class="method-name">_set_perms</a>
223  attributes to be used for the                                                                                          (<span class="var-type">boolean</span>&nbsp;<span class="var-name">$flag</span>)
224  &lt;html&gt; tag.</td>                                                                          </div>
225                                                                                            </div>
226                                  <tr>                  </div>
227                                          <td CLASS="font10bold"><A HREF='../phpHtmlLib/HTMLPageClass.html#push'>push (  )</A></td>          </div>          
228                                          <td CLASS="font10">Same as add()</td>  
229                                            <a name="sec-vars"></a>
230                                  <tr>          <div class="info-box">
231                                          <td CLASS="font10bold"><A HREF='../phpHtmlLib/HTMLPageClass.html#push_css_link'>push_css_link ( $link )</A></td>                  <div class="info-box-title">Variables</div>
232                                          <td CLASS="font10">Same ass add_css_link()</td>                  <div class="nav-bar">
233                                                            <a href="#sec-description">Description</a> |
234                                  <tr>                                                          <a href="#sec-descendents">Descendents</a> |
235                                          <td CLASS="font10bold"><A HREF='../phpHtmlLib/HTMLPageClass.html#push_head_content'>push_head_content (  )</A></td>                                                                                  <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
236                                          <td CLASS="font10">Same ass add_head_content()</td>                                                  
237                                                            
238                                  <tr>                                                                                  |
239                                          <td CLASS="font10bold"><A HREF='../phpHtmlLib/HTMLPageClass.html#push_head_js'>push_head_js ( $content )</A></td>                                                                          <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
240                                          <td CLASS="font10">Same ass add_head_js()</td>                                                          
241                                                                            </div>
242                                  <tr>                  <div class="info-box-body">
243                                          <td CLASS="font10bold"><A HREF='../phpHtmlLib/HTMLPageClass.html#push_js_link'>push_js_link ( $link )</A></td>                          <a name="var$_allow_permissions_checks" id="$_allow_permissions_checks"><!-- --></A>
244                                          <td CLASS="font10">pushes an link to an externally referenced javascript  <div class="evenrow">
245   file, which will get rendered in the head.</td>  
246                                            <div class="var-header">
247                                  <tr>                  <span class="var-title">
248                                          <td CLASS="font10bold"><A HREF='../phpHtmlLib/HTMLPageClass.html#push_reference'>push_reference ( &$content )</A></td>                          <span class="var-type">mixed</span>
249                                          <td CLASS="font10">Same as add()</td>                          <span class="var-name">$_allow_permissions_checks</span>
250                                                             = <span class="var-default"> FALSE</span>                      (line <span class="line-number">73</span>)
251                                  <tr>                  </span>
252                                          <td CLASS="font10bold"><A HREF='../phpHtmlLib/HTMLPageClass.html#render'>render (  )</A></td>          </div>
253                                          <td CLASS="font10">render the page.</td>  
254                                            <!-- ========== Info from phpDoc block ========= -->
255                                  <tr>  <p class="short-description">This is to enable/disable the  permissions checking.</p>
256                                          <td CLASS="font10bold"><A HREF='../phpHtmlLib/HTMLPageClass.html#set_body_attributes'>set_body_attributes ( $attributes )</A></td>  <p class="description"><p>By default it is off.</p></p>
257                                          <td CLASS="font10">set attributes of body tag</td>          
258                                            
259                                  <tr>                  
260                                          <td CLASS="font10bold"><A HREF='../phpHtmlLib/HTMLPageClass.html#set_charset'>set_charset ( $charset )</A></td>                  
261                                          <td CLASS="font10">set the character set</td>  
262                                    </div>
263                                  <tr>  <a name="var$_enable_debug" id="$_enable_debug"><!-- --></A>
264                                          <td CLASS="font10bold"><A HREF='../phpHtmlLib/HTMLPageClass.html#set_frameset'>set_frameset ( $frameset )</A></td>  <div class="oddrow">
265                                          <td CLASS="font10">This function is used to set the FRAMSETtag  
266  object for this page.</td>          <div class="var-header">
267                                                    <span class="var-title">
268                                  <tr>                          <span class="var-type">mixed</span>
269                                          <td CLASS="font10bold"><A HREF='../phpHtmlLib/HTMLPageClass.html#set_html_attributes'>set_html_attributes ( $attributes )</A></td>                          <span class="var-name">$_enable_debug</span>
270                                          <td CLASS="font10">This function sets the attributes                           = <span class="var-default"> FALSE</span>                      (line <span class="line-number">44</span>)
271  for the &lt;html&gt; tag</td>                  </span>
272                                            </div>
273                                  <tr>  
274                                          <td CLASS="font10bold"><A HREF='../phpHtmlLib/HTMLPageClass.html#set_refresh'>set_refresh ( $time, [$url = NULL] )</A></td>          <!-- ========== Info from phpDoc block ========= -->
275                                          <td CLASS="font10">Automatically set a page meta tag refresh</td>  <p class="short-description">This enables the ability to view the  source of a page bu setting debug=1  in the query string.</p>
276                                            
277                                  <tr>          
278                                          <td CLASS="font10bold"><A HREF='../phpHtmlLib/HTMLPageClass.html#set_text_debug'>set_text_debug ( $flag )</A></td>                  
279                                          <td CLASS="font10">set the $_text_debug flag</td>                  
280                                    
281                                  <tr>  </div>
282                                          <td CLASS="font10bold"><A HREF='../phpHtmlLib/HTMLPageClass.html#set_title'>set_title ( $title )</A></td>  <a name="var$_permissions_error_width" id="$_permissions_error_width"><!-- --></A>
283                                          <td CLASS="font10">set the title of the page output.</td>  <div class="evenrow">
284                                    
285                                  <tr>          <div class="var-header">
286                                          <td CLASS="font10bold"><A HREF='../phpHtmlLib/HTMLPageClass.html#_build_content_type_tag'>_build_content_type_tag (  )</A></td>                  <span class="var-title">
287                                          <td CLASS="font10">this builds the content type meta tag.</td>                          <span class="var-type">mixed</span>
288                                                            <span class="var-name">$_permissions_error_width</span>
289                                  <tr>                           = <span class="var-default"> &quot;50%&quot;</span>                    (line <span class="line-number">80</span>)
290                                          <td CLASS="font10bold"><A HREF='../phpHtmlLib/HTMLPageClass.html#_build_head'>_build_head (  )</A></td>                  </span>
291                                          <td CLASS="font10">builds the head object and its content.</td>          </div>
292                                    
293                                  <tr>          <!-- ========== Info from phpDoc block ========= -->
294                                          <td CLASS="font10bold"><A HREF='../phpHtmlLib/HTMLPageClass.html#_create_body'>_create_body (  )</A></td>  <p class="short-description">The width of the permissions dialog  table.</p>
295                                          <td CLASS="font10">This is responsible for creating the</td>          
296                                            
297                                  <tr>                  
298                                          <td CLASS="font10bold"><A HREF='../phpHtmlLib/HTMLPageClass.html#_frameset_wrap_body'>_frameset_wrap_body (  )</A></td>                  
299                                          <td CLASS="font10">This builds a frameset body tag  
300  wrapped in a &lt;noframes&gt; tag.</td>  </div>
301                                    <a name="var$_permission_box" id="$_permission_box"><!-- --></A>
302                          </table>  <div class="oddrow">
303              <br>                          
304                  </TD>          <div class="var-header">
305          </TR>                  <span class="var-title">
306                                    <span class="var-type">mixed</span>
307  </TABLE>                          <span class="var-name">$_permission_box</span>
308                             = <span class="var-default"> NULL</span>                       (line <span class="line-number">66</span>)
309  <hr>                  </span>
310  <!-- should have constructor at some point -->          </div>
311  <!-- =========== Method SUMMARY =========== -->  
312  <A NAME='Method_summary'><!-- --></A>          <!-- ========== Info from phpDoc block ========= -->
313  <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' Class="border">  <p class="short-description">the message box for displaying</p>
314          <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>  <p class="description"><p>permissions errors</p></p>
315                  <TD>          
316                          <span class="font12bold">Method Summary</span>          
317              <A HREF="#top" CLASS="links">^TOP</A>                  
318                  </TD>                  
319          </TR>  
320    </div>
321            <a name="var$_perm_options" id="$_perm_options"><!-- --></A>
322          <!-- =========== Summary =========== -->  <div class="evenrow">
323          <TR BGCOLOR='white' CLASS='TableRowColor'>  
324                  <TD>          <div class="var-header">
325                          <CODE><B><A HREF='PageWidget.html#constructor PageWidget'>void constructor PageWidget ( $title, [$render_type = HTML], [$indent_style = INDENT_NICE] )</A></B></CODE>                  <span class="var-title">
326                          <BR>                          <span class="var-type">mixed</span>
327                          <blockquote> Constructor: </blockquote>                          <span class="var-name">$_perm_options</span>
328                  </TD>                           = <span class="var-default">array(&quot;allowed&quot; =&gt; TRUE,<br />                               &quot;message&quot; =&gt; &quot;You are not allowed to view this page.&quot;,<br />                               &quot;url&quot; =&gt; NULL)</span>                     (line <span class="line-number">58</span>)
329          </TR>                  </span>
330                    </div>
331          <!-- =========== Summary =========== -->  
332          <TR BGCOLOR='white' CLASS='TableRowColor'>          <!-- ========== Info from phpDoc block ========= -->
333                  <TD>  <p class="short-description">Does the user have permission</p>
334                          <CODE><B><A HREF='PageWidget.html#body_content'>mixed. body_content (  )</A></B></CODE>  <p class="description"><p>to build and view the content?</p></p>
335                          <BR>          
336                          <blockquote> This function is meant to be overridden          
337  by the child class. </blockquote>                  
338                  </TD>                  
339          </TR>  
340            </div>
341          <!-- =========== Summary =========== -->  <a name="var$_title_text" id="$_title_text"><!-- --></A>
342          <TR BGCOLOR='white' CLASS='TableRowColor'>  <div class="oddrow">
343                  <TD>  
344                          <CODE><B><A HREF='PageWidget.html#enable_debug'>void enable_debug ( [$flag = TRUE] )</A></B></CODE>          <div class="var-header">
345                          <BR>                  <span class="var-title">
346                          <blockquote> This sets the debug option for                          <span class="var-type">mixed</span>
347  the HTMLPageClass </blockquote>                          <span class="var-name">$_title_text</span>
348                  </TD>                           = <span class="var-default"> NULL</span>                       (line <span class="line-number">52</span>)
349          </TR>                  </span>
350                    </div>
351          <!-- =========== Summary =========== -->  
352          <TR BGCOLOR='white' CLASS='TableRowColor'>          <!-- ========== Info from phpDoc block ========= -->
353                  <TD>  <p class="short-description">holds the page title text for</p>
354                          <CODE><B><A HREF='PageWidget.html#frameset'>void frameset (  )</A></B></CODE>  <p class="description"><p>a page</p></p>
355                          <BR>          
356                          <blockquote> This function is used to save          
357  a frameset to the page. </blockquote>                  
358                  </TD>                  
359          </TR>  
360            </div>
361          <!-- =========== Summary =========== -->                                                          <h4>Inherited Variables</h4>
362          <TR BGCOLOR='white' CLASS='TableRowColor'>                                  <A NAME='inherited_vars'><!-- --></A>
363                  <TD>                                                                          <p>Inherited from <span class="classname"><a href="../phpHtmlLib/HTMLPageClass.html">HTMLPageClass</a></span></p>
364                          <CODE><B><A HREF='PageWidget.html#get_title'>string get_title (  )</A></B></CODE>                                          <blockquote>
365                          <BR>                                                                                                          <span class="var-title">
366                          <blockquote> gets the current title of the page. </blockquote>                                                                  <span class="var-name"><a href="../phpHtmlLib/HTMLPageClass.html#var$_favicon">HTMLPageClass::$_favicon</a></span><br>
367                  </TD>                                                          </span>
368          </TR>                                                                                                          <span class="var-title">
369                                                                            <span class="var-name"><a href="../phpHtmlLib/HTMLPageClass.html#var$_html_attributes">HTMLPageClass::$_html_attributes</a></span><br>
370          <!-- =========== Summary =========== -->                                                          </span>
371          <TR BGCOLOR='white' CLASS='TableRowColor'>                                                                                                          <span class="var-title">
372                  <TD>                                                                  <span class="var-name"><a href="../phpHtmlLib/HTMLPageClass.html#var$_html_render_type">HTMLPageClass::$_html_render_type</a></span><br>
373                          <CODE><B><A HREF='PageWidget.html#head_content'>mixed. head_content (  )</A></B></CODE>                                                          </span>
374                          <BR>                                                                                                          <span class="var-title">
375                          <blockquote> This function is used to build </blockquote>                                                                  <span class="var-name"><a href="../phpHtmlLib/HTMLPageClass.html#var$_indent_style">HTMLPageClass::$_indent_style</a></span><br>
376                  </TD>                                                          </span>
377          </TR>                                                                                                          <span class="var-title">
378                                                                            <span class="var-name"><a href="../phpHtmlLib/HTMLPageClass.html#var$_widget_css_auto">HTMLPageClass::$_widget_css_auto</a></span><br>
379          <!-- =========== Summary =========== -->                                                          </span>
380          <TR BGCOLOR='white' CLASS='TableRowColor'>                                                                                                          <span class="var-title">
381                  <TD>                                                                  <span class="var-name"><a href="../phpHtmlLib/HTMLPageClass.html#var$_widget_js_auto">HTMLPageClass::$_widget_js_auto</a></span><br>
382                          <CODE><B><A HREF='PageWidget.html#head_javascript'>string head_javascript (  )</A></B></CODE>                                                          </span>
383                          <BR>                                                                                                          <span class="var-title">
384                          <blockquote> This function is called to build                                                                  <span class="var-name"><a href="../phpHtmlLib/HTMLPageClass.html#var$_xml_encoding">HTMLPageClass::$_xml_encoding</a></span><br>
385  any JavaScript that is needed in the                                                          </span>
386  &lt;HEAD&gt; portion of a document. </blockquote>                                                                                          </blockquote>
387                  </TD>                                                                                  
388          </TR>                  </div>
389                    </div>
390          <!-- =========== Summary =========== -->          
391          <TR BGCOLOR='white' CLASS='TableRowColor'>          <a name="sec-methods"></a>
392                  <TD>          <div class="info-box">
393                          <CODE><B><A HREF='PageWidget.html#render'>string render (  )</A></B></CODE>                  <div class="info-box-title">Methods</div>
394                          <BR>                  <div class="nav-bar">
395                          <blockquote> This is the function that renders the HTML                          <a href="#sec-description">Description</a> |
396  for this widget. </blockquote>                                                          <a href="#sec-descendents">Descendents</a> |
397                  </TD>                                                                                                                          <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
398          </TR>                                                                                                                                          <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
399                                                            
400  </TABLE>                  </div>
401                    <div class="info-box-body">
402  <hr>                          <A NAME='method_detail'></A>
403  <!-- ============ VARIABLE DETAIL =========== -->  <a name="methodPageWidget" id="PageWidget"><!-- --></a>
404    <div class="evenrow">
405  <A NAME='variable_detail'></A>          
406  <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">          <div class="method-header">
407          <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>                  <span class="method-title">Constructor PageWidget</span> (line <span class="line-number">107</span>)
408                  <TD>          </div>
409                          <span CLASS="font12bold">Variable Detail</span>          
410              <A HREF="#top" CLASS="links">^TOP</A>          <!-- ========== Info from phpDoc block ========= -->
411                  </TD>  <p class="short-description">Constructor:</p>
412          </TR>          
413  </TABLE>          <div class="method-signature">
414                    <span class="method-result">PageWidget</span>
415                    <span class="method-name">
416  <A NAME='$_enable_debug'><!-- --></A><H3>$_enable_debug</H3>                          PageWidget
417  <b>Data type:</b> mixed<br>                  </span>
418  <!-- ========== Info from phpDoc block ========= -->                                          (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$title</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$render_type</span> = <span class="var-default">HTML</span>], [<span class="var-type">int</span>&nbsp;<span class="var-name">$indent_style</span> = <span class="var-default">INDENT_NICE</span>])
419  This enables the ability to view the                          </div>
420  source of a page bu setting debug=1          
421  in the query string.                          <ul class="parameters">
422  <BR>                                          <li>
423                                    <span class="var-type">mixed</span>
424                                    <span class="var-name">$title</span><span class="var-description">: - $title Title string or TITLEtag object for the page.</span>                       </li>
425  <UL>                                          <li>
426                                            <span class="var-type">string</span>
427  </UL>                                  <span class="var-name">$render_type</span><span class="var-description">: - 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 &lt;IMG&gt;                    tag.  If xhtml is selected, the the IMGtag object and all                    utility functions will not render &quot;border=0&quot; as a default                    attribute, since this is not proper xhtml.                    &quot;html&quot; - HTML 4.0 (default)                    &quot;xhtml_transitional&quot; - render xhtml instead of html <ul><li>doctype is XHTML transitional.</li></ul>                   &quot;xhtml_strict&quot; - render xhtml instead of html 4.0. <ul><li>doctype is XHTML strict.</li></ul></span>                      </li>
428                                            <li>
429  <HR>                                  <span class="var-type">int</span>
430                                    <span class="var-name">$indent_style</span><span class="var-description">: - 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</span>                       </li>
431  <A NAME='$_title_text'><!-- --></A><H3>$_title_text</H3>                                  </ul>
432  <b>Data type:</b> mixed<br>                  
433  <!-- ========== Info from phpDoc block ========= -->                  
434  holds the page title text for          </div>
435  a page  <a name="methodallow_permissions_checks" id="allow_permissions_checks"><!-- --></a>
436  <BR>  <div class="oddrow">
437            
438            <div class="method-header">
439  <UL>                  <span class="method-title">allow_permissions_checks</span> (line <span class="line-number">283</span>)
440                    </div>
441  </UL>          
442            <!-- ========== Info from phpDoc block ========= -->
443  <HR>  <p class="short-description">This method is used to enable or disable the  built in permissions checking mechanism.</p>
444            
445            <div class="method-signature">
446  <hr>                  <span class="method-result">void</span>
447  <!-- ============ FUNCTION DETAIL =========== -->                  <span class="method-name">
448                            allow_permissions_checks
449  <A NAME='function_detail'></A>                  </span>
450  <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">                                          ([<span class="var-type">boolean</span>&nbsp;<span class="var-name">$flag</span> = <span class="var-default">true</span>])
451          <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>                          </div>
452                  <TD>          
453                          <span class="font12bold">Method Detail</span>                          <ul class="parameters">
454              <A HREF="#top" CLASS="links">^TOP</A>                                          <li>
455                  </TD>                                  <span class="var-type">boolean</span>
456          </TR>                                  <span class="var-name">$flag</span><span class="var-description">: TRUE = enable permissions checks</span>                      </li>
457  </TABLE>                                  </ul>
458  <BR>                  
459                    
460  <DIV CLASS="function">          </div>
461  <A NAME='constructor PageWidget'><!-- --></A>  <a name="methodbody_content" id="body_content"><!-- --></a>
462  <SPAN CLASS="font12bold">constructor PageWidget</SPAN>  <div class="evenrow">
463  <BR>          
464  <SPAN CLASS="font10bold">Useage : </SPAN>          <div class="method-header">
465  <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;                  <span class="method-title">body_content</span> (line <span class="line-number">179</span>)
466  <span class="font10bold" style="color: #0000FF">constructor PageWidget ( $title, [$render_type = HTML], [$indent_style = INDENT_NICE] )</SPAN>          </div>
467  <BR>          
468            <!-- ========== Info from phpDoc block ========= -->
469  <BR>  <p class="short-description">This function is meant to be overridden  by the child class.</p>
470  <SPAN CLASS="font10bold">Description : </SPAN>  <p class="description"><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-&gt;add();           and then return NULL;</p></p>
471  <!-- ========== Info from phpDoc block ========= -->          
472  Constructor:          <div class="method-signature">
473  <BR>                  <span class="method-result">mixed.</span>
474                    <span class="method-name">
475  <DL>                          body_content
476    <DT class="font10bold">Function Parameters:</DT>                  </span>
477                                      ()
478    <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                          </div>
479                     make the object declare the gobal define which tells          
480                     all of the tag objects what type of html tags to render.                  
481                     some tags support special features.  such as the &lt;IMG&gt;                  
482                     tag.  If xhtml is selected, the the IMGtag object and all                          <hr class="separator" />
483                     utility functions will not render &quot;border=0&quot; as a default                  <div class="notes">Redefined in descendants as:</div>
484                     attribute, since this is not proper xhtml.                  <ul class="redefinitions">
485                     &quot;html&quot; - HTML 4.0 (default)                                          <li>
486                     &quot;xhtml_transitional&quot; - render xhtml instead of html                                  <a href="../phpHtmlLib/examples/MyLayoutPage.html#methodbody_content">MyLayoutPage::body_content()</a>
487                                          - doctype is XHTML transitional.                                                                  : This builds the main content for the  page.
488                     &quot;xhtml_strict&quot; - render xhtml instead of html 4.0.                                                          </li>
489                                    - doctype is XHTML strict.</DD>                                          <li>
490                                      <a href="../phpHtmlLib/widget-examples/PermissionsCheckTestPage.html#methodbody_content">PermissionsCheckTestPage::body_content()</a>
491    <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 will only get called if we have permissions to  build and render the content for this page object.
492                    This tells the page how to render the indenting of the                                                          </li>
493                    output.  By default it is set to INDENT_NICE, which nicely                                          <li>
494                    indents each nested tag.  You can have all tags rendered                                  <a href="../phpHtmlLib/widget-examples/WidgetListPage.html#methodbody_content">WidgetListPage::body_content()</a>
495                    left justified (smaller size in output) by using                                                                  : This will only get called if we have permissions to  build and render the content for this page object.
496                    INDENT_LEFT_JUSTIFY</DD>                                                          </li>
497                                      </ul>
498            </div>
499    <DT class="font10bold">Function Info:</DT>  <a name="methodenable_debug" id="enable_debug"><!-- --></a>
500      <div class="oddrow">
501  </DL>          
502            <div class="method-header">
503  </DIV>                  <span class="method-title">enable_debug</span> (line <span class="line-number">213</span>)
504  <BR>          </div>
505            
506  <DIV CLASS="function">          <!-- ========== Info from phpDoc block ========= -->
507  <A NAME='body_content'><!-- --></A>  <p class="short-description">This sets the debug option for  the HTMLPageClass</p>
508  <SPAN CLASS="font12bold">body_content</SPAN>          
509  <BR>          <div class="method-signature">
510  <SPAN CLASS="font10bold">Useage : </SPAN>                  <span class="method-result">void</span>
511  <span class="font10bold" style="color: #FF0000">mixed.</SPAN>&nbsp;                  <span class="method-name">
512  <span class="font10bold" style="color: #0000FF">body_content (  )</SPAN>                          enable_debug
513  <BR>                  </span>
514  Overridden in child class(es) as: <a href="../phpHtmlLib/examples/MyLayoutPage.html#body_content">MyLayoutPage::body_content()</a><br>                                          ([<span class="var-type">boolean</span>&nbsp;<span class="var-name">$flag</span> = <span class="var-default">TRUE</span>])
515  <BR>                          </div>
516  <SPAN CLASS="font10bold">Description : </SPAN>          
517  <!-- ========== Info from phpDoc block ========= -->                          <ul class="parameters">
518  This function is meant to be overridden                                          <li>
519  by the child class.                                  <span class="var-type">boolean</span>
520  <BR>                                  <span class="var-name">$flag</span><span class="var-description">: TRUE for on, FALSE for off</span>                    </li>
521  This provides all of the content                                  </ul>
522  for the page.                  
523  NOTE: You add the content to the                  
524        body in 1 of 2 ways.          </div>
525        1) return the content from this  <a name="methodframeset" id="frameset"><!-- --></a>
526           call.  <div class="evenrow">
527        2) inside the call, you can          
528           just call $this-&gt;add();          <div class="method-header">
529           and then return NULL;                  <span class="method-title">frameset</span> (line <span class="line-number">190</span>)
530  <DL>          </div>
531    <DT class="font10bold">Function Parameters:</DT>          
532              <!-- ========== Info from phpDoc block ========= -->
533    <p class="short-description">This function is used to save</p>
534    <DT class="font10bold">Function Info:</DT>  <p class="description"><p>a frameset to the page.  This will  automatically output a properly  formatted</p></p>
535              
536  </DL>          <div class="method-signature">
537                    <span class="method-result">void</span>
538  </DIV>                  <span class="method-name">
539  <BR>                          frameset
540                    </span>
541  <DIV CLASS="function">                                  ()
542  <A NAME='enable_debug'><!-- --></A>                          </div>
543  <SPAN CLASS="font12bold">enable_debug</SPAN>          
544  <BR>                  
545  <SPAN CLASS="font10bold">Useage : </SPAN>                  
546  <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;          </div>
547  <span class="font10bold" style="color: #0000FF">enable_debug ( [$flag = TRUE] )</SPAN>  <a name="methodget_title" id="get_title"><!-- --></a>
548  <BR>  <div class="oddrow">
549            
550  <BR>          <div class="method-header">
551  <SPAN CLASS="font10bold">Description : </SPAN>                  <span class="method-title">get_title</span> (line <span class="line-number">138</span>)
552  <!-- ========== Info from phpDoc block ========= -->          </div>
553  This sets the debug option for          
554  the HTMLPageClass          <!-- ========== Info from phpDoc block ========= -->
555  <BR>  <p class="short-description">gets the current title of the page.</p>
556            
557  <DL>          <div class="method-signature">
558    <DT class="font10bold">Function Parameters:</DT>                  <span class="method-result">string</span>
559                      <span class="method-name">
560    <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>                          get_title
561                      </span>
562                                    ()
563    <DT class="font10bold">Function Info:</DT>                          </div>
564              
565  </DL>                  
566                    
567  </DIV>          </div>
568  <BR>  <a name="methodhead_content" id="head_content"><!-- --></a>
569    <div class="evenrow">
570  <DIV CLASS="function">          
571  <A NAME='frameset'><!-- --></A>          <div class="method-header">
572  <SPAN CLASS="font12bold">frameset</SPAN>                  <span class="method-title">head_content</span> (line <span class="line-number">159</span>)
573  <BR>          </div>
574  <SPAN CLASS="font10bold">Useage : </SPAN>          
575  <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;          <!-- ========== Info from phpDoc block ========= -->
576  <span class="font10bold" style="color: #0000FF">frameset (  )</SPAN>  <p class="short-description">This function is used to build  addition head content that isn't  built by the HTMLPageClass parent  class by default.</p>
577  <BR>  <p class="description"><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-&gt;add_head_content()           from within the head_content()           call.</p></p>
578            
579  <BR>          <div class="method-signature">
580  <SPAN CLASS="font10bold">Description : </SPAN>                  <span class="method-result">mixed.</span>
581  <!-- ========== Info from phpDoc block ========= -->                  <span class="method-name">
582  This function is used to save                          head_content
583  a frameset to the page.                  </span>
584  <BR>                                  ()
585  This will                          </div>
586  automatically output a properly          
587  formatted                  
588  <DL>                  
589    <DT class="font10bold">Function Parameters:</DT>          </div>
590      <a name="methodhead_javascript" id="head_javascript"><!-- --></a>
591    <div class="oddrow">
592    <DT class="font10bold">Function Info:</DT>          
593              <div class="method-header">
594  </DL>                  <span class="method-title">head_javascript</span> (line <span class="line-number">202</span>)
595            </div>
596  </DIV>          
597  <BR>          <!-- ========== Info from phpDoc block ========= -->
598    <p class="short-description">This function is called to build  any JavaScript that is needed in the  &lt;HEAD&gt; portion of a document.</p>
599  <DIV CLASS="function">          <ul class="tags">
600  <A NAME='get_title'><!-- --></A>                                  <li><span class="field">return:</span> - the raw JS code to be                   put inside the &lt;head&gt;</li>
601  <SPAN CLASS="font12bold">get_title</SPAN>                          </ul>
602  <BR>          
603  <SPAN CLASS="font10bold">Useage : </SPAN>          <div class="method-signature">
604  <span class="font10bold" style="color: #FF0000">string</SPAN>&nbsp;                  <span class="method-result">string</span>
605  <span class="font10bold" style="color: #0000FF">get_title (  )</SPAN>                  <span class="method-name">
606  <BR>                          head_javascript
607                    </span>
608  <BR>                                  ()
609  <SPAN CLASS="font10bold">Description : </SPAN>                          </div>
610  <!-- ========== Info from phpDoc block ========= -->          
611  gets the current title of the page.                  
612  <BR>                  
613            </div>
614  <DL>  <a name="methodpermission" id="permission"><!-- --></a>
615    <DT class="font10bold">Function Parameters:</DT>  <div class="evenrow">
616              
617            <div class="method-header">
618    <DT class="font10bold">Function Info:</DT>                  <span class="method-title">permission</span> (line <span class="line-number">315</span>)
619              </div>
620  </DL>          
621            <!-- ========== Info from phpDoc block ========= -->
622  </DIV>  <p class="short-description">This is meant to be extended by the child class  to do any generic permissions checking for access  to the content that the child builds</p>
623  <BR>          <ul class="tags">
624                                    <li><span class="field">return:</span> - TRUE = has permissions to build                           and view content.</li>
625  <DIV CLASS="function">                          </ul>
626  <A NAME='head_content'><!-- --></A>          
627  <SPAN CLASS="font12bold">head_content</SPAN>          <div class="method-signature">
628  <BR>                  <span class="method-result">boolean</span>
629  <SPAN CLASS="font10bold">Useage : </SPAN>                  <span class="method-name">
630  <span class="font10bold" style="color: #FF0000">mixed.</SPAN>&nbsp;                          permission
631  <span class="font10bold" style="color: #0000FF">head_content (  )</SPAN>                  </span>
632  <BR>                                  ()
633                            </div>
634  <BR>          
635  <SPAN CLASS="font10bold">Description : </SPAN>                  
636  <!-- ========== Info from phpDoc block ========= -->                  
637  This function is used to build                          <hr class="separator" />
638  <BR>                  <div class="notes">Redefined in descendants as:</div>
639  addition head content that isn't                  <ul class="redefinitions">
640  built by the HTMLPageClass parent                                          <li>
641  class by default.                                  <a href="../phpHtmlLib/widget-examples/PermissionsCheckTestPage.html#methodpermission">PermissionsCheckTestPage::permission()</a>
642  NOTE: you can add addition content                                                                  : This method is called during constructor time to check  to make sure the page is allowed to build and render  any content.
643        to the head in 1 of 2 ways.                                                          </li>
644        1) inside the call return the                                  </ul>
645           addition content in the          </div>
646           return $foo;  <a name="methodrender" id="render"><!-- --></a>
647        2) or use the HTMLPageClass'  <div class="oddrow">
648           $this-&gt;add_head_content()          
649           from within the head_content()          <div class="method-header">
650           call.                  <span class="method-title">render</span> (line <span class="line-number">224</span>)
651  <DL>          </div>
652    <DT class="font10bold">Function Parameters:</DT>          
653              <!-- ========== Info from phpDoc block ========= -->
654    <p class="short-description">This is the function that renders the HTML  for this widget.</p>
655    <DT class="font10bold">Function Info:</DT>          <ul class="tags">
656                                      <li><span class="field">return:</span> - the HTML</li>
657  </DL>                          </ul>
658            
659  </DIV>          <div class="method-signature">
660  <BR>                  <span class="method-result">string</span>
661                    <span class="method-name">
662  <DIV CLASS="function">                          render
663  <A NAME='head_javascript'><!-- --></A>                  </span>
664  <SPAN CLASS="font12bold">head_javascript</SPAN>                                  ()
665  <BR>                          </div>
666  <SPAN CLASS="font10bold">Useage : </SPAN>          
667  <span class="font10bold" style="color: #FF0000">string</SPAN>&nbsp;                  
668  <span class="font10bold" style="color: #0000FF">head_javascript (  )</SPAN>                          <hr class="separator" />
669  <BR>                  <div class="notes">Redefinition of:</div>
670                    <dl>
671  <BR>                          <dt><a href="../phpHtmlLib/HTMLPageClass.html#methodrender">HTMLPageClass::render()</a></dt>
672  <SPAN CLASS="font10bold">Description : </SPAN>                                                  <dd>render the page.</dd>
673  <!-- ========== Info from phpDoc block ========= -->                                          </dl>
674  This function is called to build                  
675  any JavaScript that is needed in the          </div>
676  &lt;HEAD&gt; portion of a document.  <a name="methodset_permissions_message" id="set_permissions_message"><!-- --></a>
677  <BR>  <div class="evenrow">
678            
679  <DL>          <div class="method-header">
680    <DT class="font10bold">Function Parameters:</DT>                  <span class="method-title">set_permissions_message</span> (line <span class="line-number">355</span>)
681              </div>
682            
683    <DT class="font10bold">Function Info:</DT>          <!-- ========== Info from phpDoc block ========= -->
684      <p class="short-description">This is used to set the various options for displaying  the failed permissions box.  This should be called  prior to returning false in the permissions() method</p>
685    <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - - the raw JS code to be          
686                    put inside the &lt;head&gt;</DD>          <div class="method-signature">
687                      <span class="method-result">void</span>
688  </DL>                  <span class="method-name">
689                            set_permissions_message
690  </DIV>                  </span>
691  <BR>                                          ([<span class="var-type">string</span>&nbsp;<span class="var-name">$message</span> = <span class="var-default">NULL</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$url</span> = <span class="var-default">NULL</span>])
692                            </div>
693  <DIV CLASS="function">          
694  <A NAME='render'><!-- --></A>                          <ul class="parameters">
695  <SPAN CLASS="font12bold">render</SPAN>                                          <li>
696  <BR>                                  <span class="var-type">string</span>
697  <SPAN CLASS="font10bold">Useage : </SPAN>                                  <span class="var-name">$message</span><span class="var-description">: - the permissions message                  NOTE: NULL message means use the default.</span>                       </li>
698  <span class="font10bold" style="color: #FF0000">string</SPAN>&nbsp;                                          <li>
699  <span class="font10bold" style="color: #0000FF">render (  )</SPAN>                                  <span class="var-type">string</span>
700  <BR>                                  <span class="var-name">$url</span><span class="var-description">: - the url where to go to.                  NOTE: if NULL, then there will be no                        button shown</span>                    </li>
701  <span class="font10bold" style="padding-left: 10px;">Overrides :</span> <a href="../phpHtmlLib/HTMLPageClass.html#render">HTMLPageClass::render()</a>                                  </ul>
702  <BR>                  
703  <SPAN CLASS="font10bold">Description : </SPAN>                  
704  <!-- ========== Info from phpDoc block ========= -->          </div>
705  This is the function that renders the HTML  <a name="method_build_permission_box" id="_build_permission_box"><!-- --></a>
706  for this widget.  <div class="oddrow">
707  <BR>          
708            <div class="method-header">
709  <DL>                  <span class="method-title">_build_permission_box</span> (line <span class="line-number">372</span>)
710    <DT class="font10bold">Function Parameters:</DT>          </div>
711              
712            <!-- ========== Info from phpDoc block ========= -->
713    <DT class="font10bold">Function Info:</DT>  <p class="short-description">This is the method used to build the  object to display the permissions error.</p>
714      <p class="description"><p>By default it uses either the MessageBoxWidget  or the MessageBoxOK widget which both rely on  having the InfoTable object's css included in the page.</p></p>
715    <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - - the HTML</DD>          
716              <div class="method-signature">
717  </DL>                  <span class="method-result">none</span>
718                    <span class="method-name">
719  </DIV>                          _build_permission_box
720  <BR>                  </span>
721                                    ()
722                            </div>
723  <hr>          
724  </HTML>                  
725                    
726            </div>
727    <a name="method_check_permissions" id="_check_permissions"><!-- --></a>
728    <div class="evenrow">
729            
730            <div class="method-header">
731                    <span class="method-title">_check_permissions</span> (line <span class="line-number">296</span>)
732            </div>
733            
734            <!-- ========== Info from phpDoc block ========= -->
735    <p class="short-description">This method allows all PageWidget children to  do any kind of permissions checking before  any content methods are called.</p>
736    <p class="description"><p>This allows for a very secure method of building  and rendering the page content.</p></p>
737            
738            <div class="method-signature">
739                    <span class="method-result">void</span>
740                    <span class="method-name">
741                            _check_permissions
742                    </span>
743                                    ()
744                            </div>
745            
746                    
747                    
748            </div>
749    <a name="method_has_permission" id="_has_permission"><!-- --></a>
750    <div class="oddrow">
751            
752            <div class="method-header">
753                    <span class="method-title">_has_permission</span> (line <span class="line-number">334</span>)
754            </div>
755            
756            <!-- ========== Info from phpDoc block ========= -->
757    <p class="short-description">do we have permissions to build/view the content?</p>
758            
759            <div class="method-signature">
760                    <span class="method-result">boolean</span>
761                    <span class="method-name">
762                            _has_permission
763                    </span>
764                                    ()
765                            </div>
766            
767                    
768                    
769            </div>
770    <a name="method_set_perms" id="_set_perms"><!-- --></a>
771    <div class="evenrow">
772            
773            <div class="method-header">
774                    <span class="method-title">_set_perms</span> (line <span class="line-number">325</span>)
775            </div>
776            
777            <!-- ========== Info from phpDoc block ========= -->
778    <p class="short-description">set the value of the permissions</p>
779            
780            <div class="method-signature">
781                    <span class="method-result">void</span>
782                    <span class="method-name">
783                            _set_perms
784                    </span>
785                                            (<span class="var-type">boolean</span>&nbsp;<span class="var-name">$flag</span>)
786                            </div>
787            
788                            <ul class="parameters">
789                                            <li>
790                                    <span class="var-type">boolean</span>
791                                    <span class="var-name">$flag</span><span class="var-description">: - TRUE = has permission</span>                       </li>
792                                    </ul>
793                    
794                    
795            </div>
796                                                            <h4>Inherited Methods</h4>
797                                    <a name='inherited_methods'><!-- --></a>        
798                                                                            <!-- =========== Summary =========== -->
799                                            <p>Inherited From <span class="classname"><a href="../phpHtmlLib/HTMLPageClass.html">HTMLPageClass</a></span></p>
800                                            <blockquote>
801                                                                                                            <span class="method-name"><a href="../phpHtmlLib/HTMLPageClass.html#methodHTMLPageClass">HTMLPageClass::HTMLPageClass()</a></span><br>
802                                                                                                            <span class="method-name"><a href="../phpHtmlLib/HTMLPageClass.html#methodadd">HTMLPageClass::add()</a></span><br>
803                                                                                                            <span class="method-name"><a href="../phpHtmlLib/HTMLPageClass.html#methodadd_css_link">HTMLPageClass::add_css_link()</a></span><br>
804                                                                                                            <span class="method-name"><a href="../phpHtmlLib/HTMLPageClass.html#methodadd_head_content">HTMLPageClass::add_head_content()</a></span><br>
805                                                                                                            <span class="method-name"><a href="../phpHtmlLib/HTMLPageClass.html#methodadd_head_css">HTMLPageClass::add_head_css()</a></span><br>
806                                                                                                            <span class="method-name"><a href="../phpHtmlLib/HTMLPageClass.html#methodadd_head_js">HTMLPageClass::add_head_js()</a></span><br>
807                                                                                                            <span class="method-name"><a href="../phpHtmlLib/HTMLPageClass.html#methodadd_js_link">HTMLPageClass::add_js_link()</a></span><br>
808                                                                                                            <span class="method-name"><a href="../phpHtmlLib/HTMLPageClass.html#methodadd_reference">HTMLPageClass::add_reference()</a></span><br>
809                                                                                                            <span class="method-name"><a href="../phpHtmlLib/HTMLPageClass.html#methodbuild_doctype">HTMLPageClass::build_doctype()</a></span><br>
810                                                                                                            <span class="method-name"><a href="../phpHtmlLib/HTMLPageClass.html#methodget_html_attributes">HTMLPageClass::get_html_attributes()</a></span><br>
811                                                                                                            <span class="method-name"><a href="../phpHtmlLib/HTMLPageClass.html#methodpush">HTMLPageClass::push()</a></span><br>
812                                                                                                            <span class="method-name"><a href="../phpHtmlLib/HTMLPageClass.html#methodpush_css_link">HTMLPageClass::push_css_link()</a></span><br>
813                                                                                                            <span class="method-name"><a href="../phpHtmlLib/HTMLPageClass.html#methodpush_head_content">HTMLPageClass::push_head_content()</a></span><br>
814                                                                                                            <span class="method-name"><a href="../phpHtmlLib/HTMLPageClass.html#methodpush_head_js">HTMLPageClass::push_head_js()</a></span><br>
815                                                                                                            <span class="method-name"><a href="../phpHtmlLib/HTMLPageClass.html#methodpush_js_link">HTMLPageClass::push_js_link()</a></span><br>
816                                                                                                            <span class="method-name"><a href="../phpHtmlLib/HTMLPageClass.html#methodpush_reference">HTMLPageClass::push_reference()</a></span><br>
817                                                                                                            <span class="method-name"><a href="../phpHtmlLib/HTMLPageClass.html#methodrender">HTMLPageClass::render()</a></span><br>
818                                                                                                            <span class="method-name"><a href="../phpHtmlLib/HTMLPageClass.html#methodset_body_attributes">HTMLPageClass::set_body_attributes()</a></span><br>
819                                                                                                            <span class="method-name"><a href="../phpHtmlLib/HTMLPageClass.html#methodset_charset">HTMLPageClass::set_charset()</a></span><br>
820                                                                                                            <span class="method-name"><a href="../phpHtmlLib/HTMLPageClass.html#methodset_encoding">HTMLPageClass::set_encoding()</a></span><br>
821                                                                                                            <span class="method-name"><a href="../phpHtmlLib/HTMLPageClass.html#methodset_favicon">HTMLPageClass::set_favicon()</a></span><br>
822                                                                                                            <span class="method-name"><a href="../phpHtmlLib/HTMLPageClass.html#methodset_favicon_flag">HTMLPageClass::set_favicon_flag()</a></span><br>
823                                                                                                            <span class="method-name"><a href="../phpHtmlLib/HTMLPageClass.html#methodset_frameset">HTMLPageClass::set_frameset()</a></span><br>
824                                                                                                            <span class="method-name"><a href="../phpHtmlLib/HTMLPageClass.html#methodset_html_attributes">HTMLPageClass::set_html_attributes()</a></span><br>
825                                                                                                            <span class="method-name"><a href="../phpHtmlLib/HTMLPageClass.html#methodset_language">HTMLPageClass::set_language()</a></span><br>
826                                                                                                            <span class="method-name"><a href="../phpHtmlLib/HTMLPageClass.html#methodset_refresh">HTMLPageClass::set_refresh()</a></span><br>
827                                                                                                            <span class="method-name"><a href="../phpHtmlLib/HTMLPageClass.html#methodset_text_debug">HTMLPageClass::set_text_debug()</a></span><br>
828                                                                                                            <span class="method-name"><a href="../phpHtmlLib/HTMLPageClass.html#methodset_title">HTMLPageClass::set_title()</a></span><br>
829                                                                                                            <span class="method-name"><a href="../phpHtmlLib/HTMLPageClass.html#method_build_content_type_tag">HTMLPageClass::_build_content_type_tag()</a></span><br>
830                                                                                                            <span class="method-name"><a href="../phpHtmlLib/HTMLPageClass.html#method_build_head">HTMLPageClass::_build_head()</a></span><br>
831                                                                                                            <span class="method-name"><a href="../phpHtmlLib/HTMLPageClass.html#method_create_body">HTMLPageClass::_create_body()</a></span><br>
832                                                                                                            <span class="method-name"><a href="../phpHtmlLib/HTMLPageClass.html#method_frameset_wrap_body">HTMLPageClass::_frameset_wrap_body()</a></span><br>
833                                                                                            </blockquote>
834                                                                                    
835                    </div>
836            </div>
837    
838    
839            <p class="notes" id="credit">
840                    Documentation generated on Thu,  1 Apr 2004 09:39:08 -0800 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0RC2</a>
841            </p>
842            </div></body>
843    </html>
Legend:
Removed from v.1.1.1.1  
changed lines
  Added in v.1.4
MailToCvsAdmin">MailToCvsAdmin
 ViewVC Help
Powered by ViewVC 1.1.26 RSS 2.0 feed