| 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 PermissionsCheckTestPage</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 PermissionsCheckTestPage</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-vars">Vars</a> |
| 21 |
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
| 22 |
|
| 23 |
</div> |
| 24 |
<div class="info-box-body"> |
| 25 |
<!-- ========== Info from phpDoc block ========= --> |
| 26 |
<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 |
<ul class="tags"> |
| 28 |
<li><span class="field">author:</span> Walter A. Boring IV <<a href="mailto:waboring@buildabetterweb.com">waboring@buildabetterweb.com</a>></li> |
| 29 |
</ul> |
| 30 |
<p class="notes"> |
| 31 |
Located in <a class="field" href="_examples_widget13_php.html">/examples/widget13.php</a> (line <span class="field">24</span>) |
| 32 |
</p> |
| 33 |
|
| 34 |
|
| 35 |
<pre><a href="../../phpHtmlLib/HTMLPageClass.html">HTMLPageClass</a> |
| 36 |
| |
| 37 |
--<a href="../../phpHtmlLib/PageWidget.html">PageWidget</a> |
| 38 |
| |
| 39 |
--PermissionsCheckTestPage</pre> |
| 40 |
|
| 41 |
</div> |
| 42 |
</div> |
| 43 |
|
| 44 |
|
| 45 |
|
| 46 |
|
| 47 |
<a name="sec-method-summary"></a> |
| 48 |
<div class="info-box"> |
| 49 |
<div class="info-box-title">Method Summary</span></div> |
| 50 |
<div class="nav-bar"> |
| 51 |
<a href="#sec-description">Description</a> | |
| 52 |
<a href="#sec-vars">Vars</a> |
| 53 |
|
| 54 |
| |
| 55 |
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>) |
| 56 |
</div> |
| 57 |
<div class="info-box-body"> |
| 58 |
<div class="method-summary"> |
| 59 |
|
| 60 |
<div class="method-definition"> |
| 61 |
<span class="method-result">PermissionsCheckTestPage</span> |
| 62 |
<a href="#PermissionsCheckTestPage" title="details" class="method-name">PermissionsCheckTestPage</a> |
| 63 |
(<span class="var-type">mixed</span> <span class="var-name">$title</span>) |
| 64 |
</div> |
| 65 |
|
| 66 |
<div class="method-definition"> |
| 67 |
<span class="method-result">object</span> |
| 68 |
<a href="#body_content" title="details" class="method-name">body_content</a> |
| 69 |
() |
| 70 |
</div> |
| 71 |
|
| 72 |
<div class="method-definition"> |
| 73 |
<span class="method-result">boolean</span> |
| 74 |
<a href="#permission" title="details" class="method-name">permission</a> |
| 75 |
() |
| 76 |
</div> |
| 77 |
</div> |
| 78 |
</div> |
| 79 |
</div> |
| 80 |
|
| 81 |
<a name="sec-vars"></a> |
| 82 |
<div class="info-box"> |
| 83 |
<div class="info-box-title">Variables</div> |
| 84 |
<div class="nav-bar"> |
| 85 |
<a href="#sec-description">Description</a> | |
| 86 |
<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>) |
| 87 |
|
| 88 |
|
| 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 |
|
| 95 |
<h4>Inherited Variables</h4> |
| 96 |
<A NAME='inherited_vars'><!-- --></A> |
| 97 |
<p>Inherited from <span class="classname"><a href="../../phpHtmlLib/PageWidget.html">PageWidget</a></span></p> |
| 98 |
<blockquote> |
| 99 |
<span class="var-title"> |
| 100 |
<span class="var-name"><a href="../../phpHtmlLib/PageWidget.html#var$_allow_permissions_checks">PageWidget::$_allow_permissions_checks</a></span><br> |
| 101 |
</span> |
| 102 |
<span class="var-title"> |
| 103 |
<span class="var-name"><a href="../../phpHtmlLib/PageWidget.html#var$_enable_debug">PageWidget::$_enable_debug</a></span><br> |
| 104 |
</span> |
| 105 |
<span class="var-title"> |
| 106 |
<span class="var-name"><a href="../../phpHtmlLib/PageWidget.html#var$_permissions_error_width">PageWidget::$_permissions_error_width</a></span><br> |
| 107 |
</span> |
| 108 |
<span class="var-title"> |
| 109 |
<span class="var-name"><a href="../../phpHtmlLib/PageWidget.html#var$_permission_box">PageWidget::$_permission_box</a></span><br> |
| 110 |
</span> |
| 111 |
<span class="var-title"> |
| 112 |
<span class="var-name"><a href="../../phpHtmlLib/PageWidget.html#var$_perm_options">PageWidget::$_perm_options</a></span><br> |
| 113 |
</span> |
| 114 |
<span class="var-title"> |
| 115 |
<span class="var-name"><a href="../../phpHtmlLib/PageWidget.html#var$_title_text">PageWidget::$_title_text</a></span><br> |
| 116 |
</span> |
| 117 |
</blockquote> |
| 118 |
<p>Inherited from <span class="classname"><a href="../../phpHtmlLib/HTMLPageClass.html">HTMLPageClass</a></span></p> |
| 119 |
<blockquote> |
| 120 |
<span class="var-title"> |
| 121 |
<span class="var-name"><a href="../../phpHtmlLib/HTMLPageClass.html#var$_favicon">HTMLPageClass::$_favicon</a></span><br> |
| 122 |
</span> |
| 123 |
<span class="var-title"> |
| 124 |
<span class="var-name"><a href="../../phpHtmlLib/HTMLPageClass.html#var$_html_attributes">HTMLPageClass::$_html_attributes</a></span><br> |
| 125 |
</span> |
| 126 |
<span class="var-title"> |
| 127 |
<span class="var-name"><a href="../../phpHtmlLib/HTMLPageClass.html#var$_html_render_type">HTMLPageClass::$_html_render_type</a></span><br> |
| 128 |
</span> |
| 129 |
<span class="var-title"> |
| 130 |
<span class="var-name"><a href="../../phpHtmlLib/HTMLPageClass.html#var$_indent_style">HTMLPageClass::$_indent_style</a></span><br> |
| 131 |
</span> |
| 132 |
<span class="var-title"> |
| 133 |
<span class="var-name"><a href="../../phpHtmlLib/HTMLPageClass.html#var$_widget_css_auto">HTMLPageClass::$_widget_css_auto</a></span><br> |
| 134 |
</span> |
| 135 |
<span class="var-title"> |
| 136 |
<span class="var-name"><a href="../../phpHtmlLib/HTMLPageClass.html#var$_widget_js_auto">HTMLPageClass::$_widget_js_auto</a></span><br> |
| 137 |
</span> |
| 138 |
<span class="var-title"> |
| 139 |
<span class="var-name"><a href="../../phpHtmlLib/HTMLPageClass.html#var$_xml_encoding">HTMLPageClass::$_xml_encoding</a></span><br> |
| 140 |
</span> |
| 141 |
</blockquote> |
| 142 |
|
| 143 |
</div> |
| 144 |
</div> |
| 145 |
|
| 146 |
<a name="sec-methods"></a> |
| 147 |
<div class="info-box"> |
| 148 |
<div class="info-box-title">Methods</div> |
| 149 |
<div class="nav-bar"> |
| 150 |
<a href="#sec-description">Description</a> | |
| 151 |
<a href="#sec-vars">Vars</a> |
| 152 |
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>) |
| 153 |
|
| 154 |
</div> |
| 155 |
<div class="info-box-body"> |
| 156 |
<A NAME='method_detail'></A> |
| 157 |
<a name="methodPermissionsCheckTestPage" id="PermissionsCheckTestPage"><!-- --></a> |
| 158 |
<div class="oddrow"> |
| 159 |
|
| 160 |
<div class="method-header"> |
| 161 |
<span class="method-title">Constructor PermissionsCheckTestPage</span> (line <span class="line-number">27</span>) |
| 162 |
</div> |
| 163 |
|
| 164 |
<!-- ========== Info from phpDoc block ========= --> |
| 165 |
|
| 166 |
<div class="method-signature"> |
| 167 |
<span class="method-result">PermissionsCheckTestPage</span> |
| 168 |
<span class="method-name"> |
| 169 |
PermissionsCheckTestPage |
| 170 |
</span> |
| 171 |
(<span class="var-type">mixed</span> <span class="var-name">$title</span>) |
| 172 |
</div> |
| 173 |
|
| 174 |
|
| 175 |
|
| 176 |
</div> |
| 177 |
<a name="methodbody_content" id="body_content"><!-- --></a> |
| 178 |
<div class="evenrow"> |
| 179 |
|
| 180 |
<div class="method-header"> |
| 181 |
<span class="method-title">body_content</span> (line <span class="line-number">67</span>) |
| 182 |
</div> |
| 183 |
|
| 184 |
<!-- ========== Info from phpDoc block ========= --> |
| 185 |
<p class="short-description">This will only get called if we have permissions to build and render the content for this page object.</p> |
| 186 |
|
| 187 |
<div class="method-signature"> |
| 188 |
<span class="method-result">object</span> |
| 189 |
<span class="method-name"> |
| 190 |
body_content |
| 191 |
</span> |
| 192 |
() |
| 193 |
</div> |
| 194 |
|
| 195 |
|
| 196 |
<hr class="separator" /> |
| 197 |
<div class="notes">Redefinition of:</div> |
| 198 |
<dl> |
| 199 |
<dt><a href="../../phpHtmlLib/PageWidget.html#methodbody_content">PageWidget::body_content()</a></dt> |
| 200 |
<dd>This function is meant to be overridden by the child class.</dd> |
| 201 |
</dl> |
| 202 |
|
| 203 |
</div> |
| 204 |
<a name="methodpermission" id="permission"><!-- --></a> |
| 205 |
<div class="oddrow"> |
| 206 |
|
| 207 |
<div class="method-header"> |
| 208 |
<span class="method-title">permission</span> (line <span class="line-number">45</span>) |
| 209 |
</div> |
| 210 |
|
| 211 |
<!-- ========== Info from phpDoc block ========= --> |
| 212 |
<p class="short-description">This method is called during constructor time to check to make sure the page is allowed to build and render any content.</p> |
| 213 |
<ul class="tags"> |
| 214 |
<li><span class="field">return:</span> FALSE = not allowed.</li> |
| 215 |
</ul> |
| 216 |
|
| 217 |
<div class="method-signature"> |
| 218 |
<span class="method-result">boolean</span> |
| 219 |
<span class="method-name"> |
| 220 |
permission |
| 221 |
</span> |
| 222 |
() |
| 223 |
</div> |
| 224 |
|
| 225 |
|
| 226 |
<hr class="separator" /> |
| 227 |
<div class="notes">Redefinition of:</div> |
| 228 |
<dl> |
| 229 |
<dt><a href="../../phpHtmlLib/PageWidget.html#methodpermission">PageWidget::permission()</a></dt> |
| 230 |
<dd>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</dd> |
| 231 |
</dl> |
| 232 |
|
| 233 |
</div> |
| 234 |
<h4>Inherited Methods</h4> |
| 235 |
<a name='inherited_methods'><!-- --></a> |
| 236 |
<!-- =========== Summary =========== --> |
| 237 |
<p>Inherited From <span class="classname"><a href="../../phpHtmlLib/PageWidget.html">PageWidget</a></span></p> |
| 238 |
<blockquote> |
| 239 |
<span class="method-name"><a href="../../phpHtmlLib/PageWidget.html#methodPageWidget">PageWidget::PageWidget()</a></span><br> |
| 240 |
<span class="method-name"><a href="../../phpHtmlLib/PageWidget.html#methodallow_permissions_checks">PageWidget::allow_permissions_checks()</a></span><br> |
| 241 |
<span class="method-name"><a href="../../phpHtmlLib/PageWidget.html#methodbody_content">PageWidget::body_content()</a></span><br> |
| 242 |
<span class="method-name"><a href="../../phpHtmlLib/PageWidget.html#methodenable_debug">PageWidget::enable_debug()</a></span><br> |
| 243 |
<span class="method-name"><a href="../../phpHtmlLib/PageWidget.html#methodframeset">PageWidget::frameset()</a></span><br> |
| 244 |
<span class="method-name"><a href="../../phpHtmlLib/PageWidget.html#methodget_title">PageWidget::get_title()</a></span><br> |
| 245 |
<span class="method-name"><a href="../../phpHtmlLib/PageWidget.html#methodhead_content">PageWidget::head_content()</a></span><br> |
| 246 |
<span class="method-name"><a href="../../phpHtmlLib/PageWidget.html#methodhead_javascript">PageWidget::head_javascript()</a></span><br> |
| 247 |
<span class="method-name"><a href="../../phpHtmlLib/PageWidget.html#methodpermission">PageWidget::permission()</a></span><br> |
| 248 |
<span class="method-name"><a href="../../phpHtmlLib/PageWidget.html#methodrender">PageWidget::render()</a></span><br> |
| 249 |
<span class="method-name"><a href="../../phpHtmlLib/PageWidget.html#methodset_permissions_message">PageWidget::set_permissions_message()</a></span><br> |
| 250 |
<span class="method-name"><a href="../../phpHtmlLib/PageWidget.html#method_build_permission_box">PageWidget::_build_permission_box()</a></span><br> |
| 251 |
<span class="method-name"><a href="../../phpHtmlLib/PageWidget.html#method_check_permissions">PageWidget::_check_permissions()</a></span><br> |
| 252 |
<span class="method-name"><a href="../../phpHtmlLib/PageWidget.html#method_has_permission">PageWidget::_has_permission()</a></span><br> |
| 253 |
<span class="method-name"><a href="../../phpHtmlLib/PageWidget.html#method_set_perms">PageWidget::_set_perms()</a></span><br> |
| 254 |
</blockquote> |
| 255 |
<!-- =========== Summary =========== --> |
| 256 |
<p>Inherited From <span class="classname"><a href="../../phpHtmlLib/HTMLPageClass.html">HTMLPageClass</a></span></p> |
| 257 |
<blockquote> |
| 258 |
<span class="method-name"><a href="../../phpHtmlLib/HTMLPageClass.html#methodHTMLPageClass">HTMLPageClass::HTMLPageClass()</a></span><br> |
| 259 |
<span class="method-name"><a href="../../phpHtmlLib/HTMLPageClass.html#methodadd">HTMLPageClass::add()</a></span><br> |
| 260 |
<span class="method-name"><a href="../../phpHtmlLib/HTMLPageClass.html#methodadd_css_link">HTMLPageClass::add_css_link()</a></span><br> |
| 261 |
<span class="method-name"><a href="../../phpHtmlLib/HTMLPageClass.html#methodadd_head_content">HTMLPageClass::add_head_content()</a></span><br> |
| 262 |
<span class="method-name"><a href="../../phpHtmlLib/HTMLPageClass.html#methodadd_head_css">HTMLPageClass::add_head_css()</a></span><br> |
| 263 |
<span class="method-name"><a href="../../phpHtmlLib/HTMLPageClass.html#methodadd_head_js">HTMLPageClass::add_head_js()</a></span><br> |
| 264 |
<span class="method-name"><a href="../../phpHtmlLib/HTMLPageClass.html#methodadd_js_link">HTMLPageClass::add_js_link()</a></span><br> |
| 265 |
<span class="method-name"><a href="../../phpHtmlLib/HTMLPageClass.html#methodadd_reference">HTMLPageClass::add_reference()</a></span><br> |
| 266 |
<span class="method-name"><a href="../../phpHtmlLib/HTMLPageClass.html#methodbuild_doctype">HTMLPageClass::build_doctype()</a></span><br> |
| 267 |
<span class="method-name"><a href="../../phpHtmlLib/HTMLPageClass.html#methodget_html_attributes">HTMLPageClass::get_html_attributes()</a></span><br> |
| 268 |
<span class="method-name"><a href="../../phpHtmlLib/HTMLPageClass.html#methodpush">HTMLPageClass::push()</a></span><br> |
| 269 |
<span class="method-name"><a href="../../phpHtmlLib/HTMLPageClass.html#methodpush_css_link">HTMLPageClass::push_css_link()</a></span><br> |
| 270 |
<span class="method-name"><a href="../../phpHtmlLib/HTMLPageClass.html#methodpush_head_content">HTMLPageClass::push_head_content()</a></span><br> |
| 271 |
<span class="method-name"><a href="../../phpHtmlLib/HTMLPageClass.html#methodpush_head_js">HTMLPageClass::push_head_js()</a></span><br> |
| 272 |
<span class="method-name"><a href="../../phpHtmlLib/HTMLPageClass.html#methodpush_js_link">HTMLPageClass::push_js_link()</a></span><br> |
| 273 |
<span class="method-name"><a href="../../phpHtmlLib/HTMLPageClass.html#methodpush_reference">HTMLPageClass::push_reference()</a></span><br> |
| 274 |
<span class="method-name"><a href="../../phpHtmlLib/HTMLPageClass.html#methodrender">HTMLPageClass::render()</a></span><br> |
| 275 |
<span class="method-name"><a href="../../phpHtmlLib/HTMLPageClass.html#methodset_body_attributes">HTMLPageClass::set_body_attributes()</a></span><br> |
| 276 |
<span class="method-name"><a href="../../phpHtmlLib/HTMLPageClass.html#methodset_charset">HTMLPageClass::set_charset()</a></span><br> |
| 277 |
<span class="method-name"><a href="../../phpHtmlLib/HTMLPageClass.html#methodset_encoding">HTMLPageClass::set_encoding()</a></span><br> |
| 278 |
<span class="method-name"><a href="../../phpHtmlLib/HTMLPageClass.html#methodset_favicon">HTMLPageClass::set_favicon()</a></span><br> |
| 279 |
<span class="method-name"><a href="../../phpHtmlLib/HTMLPageClass.html#methodset_favicon_flag">HTMLPageClass::set_favicon_flag()</a></span><br> |
| 280 |
<span class="method-name"><a href="../../phpHtmlLib/HTMLPageClass.html#methodset_frameset">HTMLPageClass::set_frameset()</a></span><br> |
| 281 |
<span class="method-name"><a href="../../phpHtmlLib/HTMLPageClass.html#methodset_html_attributes">HTMLPageClass::set_html_attributes()</a></span><br> |
| 282 |
<span class="method-name"><a href="../../phpHtmlLib/HTMLPageClass.html#methodset_language">HTMLPageClass::set_language()</a></span><br> |
| 283 |
<span class="method-name"><a href="../../phpHtmlLib/HTMLPageClass.html#methodset_refresh">HTMLPageClass::set_refresh()</a></span><br> |
| 284 |
<span class="method-name"><a href="../../phpHtmlLib/HTMLPageClass.html#methodset_text_debug">HTMLPageClass::set_text_debug()</a></span><br> |
| 285 |
<span class="method-name"><a href="../../phpHtmlLib/HTMLPageClass.html#methodset_title">HTMLPageClass::set_title()</a></span><br> |
| 286 |
<span class="method-name"><a href="../../phpHtmlLib/HTMLPageClass.html#method_build_content_type_tag">HTMLPageClass::_build_content_type_tag()</a></span><br> |
| 287 |
<span class="method-name"><a href="../../phpHtmlLib/HTMLPageClass.html#method_build_head">HTMLPageClass::_build_head()</a></span><br> |
| 288 |
<span class="method-name"><a href="../../phpHtmlLib/HTMLPageClass.html#method_create_body">HTMLPageClass::_create_body()</a></span><br> |
| 289 |
<span class="method-name"><a href="../../phpHtmlLib/HTMLPageClass.html#method_frameset_wrap_body">HTMLPageClass::_frameset_wrap_body()</a></span><br> |
| 290 |
</blockquote> |
| 291 |
|
| 292 |
</div> |
| 293 |
</div> |
| 294 |
|
| 295 |
|
| 296 |
<p class="notes" id="credit"> |
| 297 |
Documentation generated on Thu, 1 Apr 2004 09:40:14 -0800 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0RC2</a> |
| 298 |
</p> |
| 299 |
</div></body> |
| 300 |
</html> |