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

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

Parent Directory Parent Directory | Revision Log Revision Log

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