| 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 HTMLPageClass</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 HTMLPageClass</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">class the constructs and renders an entire HTML/XHTML document.</p> |
| 28 |
<ul class="tags"> |
| 29 |
<li><span class="field">author:</span> Walter A. Boring IV <<a href="mailto:waboring@buildabetterweb.com">waboring@buildabetterweb.com</a>></li> |
| 30 |
</ul> |
| 31 |
<p class="notes"> |
| 32 |
Located in <a class="field" href="_widgets_HTMLPageClass_inc.html">/widgets/HTMLPageClass.inc</a> (line <span class="field">26</span>) |
| 33 |
</p> |
| 34 |
|
| 35 |
|
| 36 |
<pre></pre> |
| 37 |
|
| 38 |
</div> |
| 39 |
</div> |
| 40 |
|
| 41 |
<a name="sec-descendents"></a> |
| 42 |
<div class="info-box"> |
| 43 |
<div class="info-box-title">Direct descendents</div> |
| 44 |
<div class="nav-bar"> |
| 45 |
<a href="#sec-description">Description</a> | |
| 46 |
<span class="disabled">Descendents</span> |
| 47 |
| <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) |
| 48 |
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
| 49 |
|
| 50 |
</div> |
| 51 |
<div class="info-box-body"> |
| 52 |
<table cellpadding="2" cellspacing="0" class="class-table"> |
| 53 |
<tr> |
| 54 |
<th class="class-table-header">Class</th> |
| 55 |
<th class="class-table-header">Description</th> |
| 56 |
</tr> |
| 57 |
<tr> |
| 58 |
<td style="padding-right: 2em"><a href="../phpHtmlLib/HTMLRedirectPage.html">HTMLRedirectPage</a></td> |
| 59 |
<td> |
| 60 |
This builds an entire HTML Page with the sole purpose of doing a redirect to another url. |
| 61 |
</td> |
| 62 |
</tr> |
| 63 |
<tr> |
| 64 |
<td style="padding-right: 2em"><a href="../phpHtmlLib/PageWidget.html">PageWidget</a></td> |
| 65 |
<td> |
| 66 |
This class is used to build content for an entire page. It uses the HTMLPageClass widget from phphtmllib to render the final output. |
| 67 |
</td> |
| 68 |
</tr> |
| 69 |
</table> |
| 70 |
</div> |
| 71 |
</div> |
| 72 |
|
| 73 |
|
| 74 |
<a name="sec-var-summary"></a> |
| 75 |
<div class="info-box"> |
| 76 |
<div class="info-box-title">Variable Summary</span></div> |
| 77 |
<div class="nav-bar"> |
| 78 |
<a href="#sec-description">Description</a> | |
| 79 |
<a href="#sec-descendents">Descendents</a> | |
| 80 |
<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>) |
| 81 |
| |
| 82 |
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
| 83 |
|
| 84 |
</div> |
| 85 |
<div class="info-box-body"> |
| 86 |
<div class="var-summary"> |
| 87 |
<div class="var-title"> |
| 88 |
<span class="var-type">array</span> |
| 89 |
<a href="#$_favicon" title="details" class="var-name">$_favicon</a> |
| 90 |
</div> |
| 91 |
<div class="var-title"> |
| 92 |
<span class="var-type">array</span> |
| 93 |
<a href="#$_html_attributes" title="details" class="var-name">$_html_attributes</a> |
| 94 |
</div> |
| 95 |
<div class="var-title"> |
| 96 |
<span class="var-type">string</span> |
| 97 |
<a href="#$_html_render_type" title="details" class="var-name">$_html_render_type</a> |
| 98 |
</div> |
| 99 |
<div class="var-title"> |
| 100 |
<span class="var-type">int</span> |
| 101 |
<a href="#$_indent_style" title="details" class="var-name">$_indent_style</a> |
| 102 |
</div> |
| 103 |
<div class="var-title"> |
| 104 |
<span class="var-type">array</span> |
| 105 |
<a href="#$_widget_css_auto" title="details" class="var-name">$_widget_css_auto</a> |
| 106 |
</div> |
| 107 |
<div class="var-title"> |
| 108 |
<span class="var-type">array</span> |
| 109 |
<a href="#$_widget_js_auto" title="details" class="var-name">$_widget_js_auto</a> |
| 110 |
</div> |
| 111 |
<div class="var-title"> |
| 112 |
<span class="var-type">mixed</span> |
| 113 |
<a href="#$_xml_encoding" title="details" class="var-name">$_xml_encoding</a> |
| 114 |
</div> |
| 115 |
</div> |
| 116 |
</div> |
| 117 |
</div> |
| 118 |
|
| 119 |
<a name="sec-method-summary"></a> |
| 120 |
<div class="info-box"> |
| 121 |
<div class="info-box-title">Method Summary</span></div> |
| 122 |
<div class="nav-bar"> |
| 123 |
<a href="#sec-description">Description</a> | |
| 124 |
<a href="#sec-descendents">Descendents</a> | |
| 125 |
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) |
| 126 |
|
| 127 |
| |
| 128 |
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>) |
| 129 |
</div> |
| 130 |
<div class="info-box-body"> |
| 131 |
<div class="method-summary"> |
| 132 |
|
| 133 |
<div class="method-definition"> |
| 134 |
<span class="method-result">HTMLPageClass</span> |
| 135 |
<a href="#HTMLPageClass" title="details" class="method-name">HTMLPageClass</a> |
| 136 |
([<span class="var-type">mixed</span> <span class="var-name">$title</span> = <span class="var-default">NULL</span>], [<span class="var-type">string</span> <span class="var-name">$html_type</span> = <span class="var-default">HTML</span>], [<span class="var-type">int</span> <span class="var-name">$indent_style</span> = <span class="var-default">INDENT_NICE</span>]) |
| 137 |
</div> |
| 138 |
|
| 139 |
<div class="method-definition"> |
| 140 |
<span class="method-result">void</span> |
| 141 |
<a href="#add" title="details" class="method-name">add</a> |
| 142 |
(<span class="var-type">mixed</span> <span class="var-name">0</span>) |
| 143 |
</div> |
| 144 |
|
| 145 |
<div class="method-definition"> |
| 146 |
<span class="method-result">void</span> |
| 147 |
<a href="#add_css_link" title="details" class="method-name">add_css_link</a> |
| 148 |
(<span class="var-type">mixed</span> <span class="var-name">$link</span>) |
| 149 |
</div> |
| 150 |
|
| 151 |
<div class="method-definition"> |
| 152 |
<span class="method-result">void</span> |
| 153 |
<a href="#add_head_content" title="details" class="method-name">add_head_content</a> |
| 154 |
(<span class="var-type">mixed</span> <span class="var-name">0</span>) |
| 155 |
</div> |
| 156 |
|
| 157 |
<div class="method-definition"> |
| 158 |
<span class="method-result">void</span> |
| 159 |
<a href="#add_head_css" title="details" class="method-name">add_head_css</a> |
| 160 |
(<span class="var-type">string</span> <span class="var-name">$css</span>) |
| 161 |
</div> |
| 162 |
|
| 163 |
<div class="method-definition"> |
| 164 |
<span class="method-result">void</span> |
| 165 |
<a href="#add_head_js" title="details" class="method-name">add_head_js</a> |
| 166 |
(<span class="var-type">mixed</span> <span class="var-name">$content</span>) |
| 167 |
</div> |
| 168 |
|
| 169 |
<div class="method-definition"> |
| 170 |
<span class="method-result">void</span> |
| 171 |
<a href="#add_js_link" title="details" class="method-name">add_js_link</a> |
| 172 |
(<span class="var-type">mixed</span> <span class="var-name">$link</span>) |
| 173 |
</div> |
| 174 |
|
| 175 |
<div class="method-definition"> |
| 176 |
<span class="method-result">void</span> |
| 177 |
<a href="#add_reference" title="details" class="method-name">add_reference</a> |
| 178 |
(<span class="var-type">mixed</span> <span class="var-name">&$content</span>) |
| 179 |
</div> |
| 180 |
|
| 181 |
<div class="method-definition"> |
| 182 |
<span class="method-result">void</span> |
| 183 |
<a href="#build_doctype" title="details" class="method-name">build_doctype</a> |
| 184 |
(<span class="var-type">string</span> <span class="var-name">$link1</span>, [<span class="var-type">string</span> <span class="var-name">$link2</span> = <span class="var-default">NULL</span>]) |
| 185 |
</div> |
| 186 |
|
| 187 |
<div class="method-definition"> |
| 188 |
<span class="method-result">array();</span> |
| 189 |
<a href="#get_html_attributes" title="details" class="method-name">get_html_attributes</a> |
| 190 |
() |
| 191 |
</div> |
| 192 |
|
| 193 |
<div class="method-definition"> |
| 194 |
<span class="method-result">void</span> |
| 195 |
<a href="#push" title="details" class="method-name">push</a> |
| 196 |
() |
| 197 |
</div> |
| 198 |
|
| 199 |
<div class="method-definition"> |
| 200 |
<span class="method-result">void</span> |
| 201 |
<a href="#push_css_link" title="details" class="method-name">push_css_link</a> |
| 202 |
(<span class="var-type">mixed</span> <span class="var-name">$link</span>) |
| 203 |
</div> |
| 204 |
|
| 205 |
<div class="method-definition"> |
| 206 |
<span class="method-result">void</span> |
| 207 |
<a href="#push_head_content" title="details" class="method-name">push_head_content</a> |
| 208 |
() |
| 209 |
</div> |
| 210 |
|
| 211 |
<div class="method-definition"> |
| 212 |
<span class="method-result">void</span> |
| 213 |
<a href="#push_head_js" title="details" class="method-name">push_head_js</a> |
| 214 |
(<span class="var-type">mixed</span> <span class="var-name">$content</span>) |
| 215 |
</div> |
| 216 |
|
| 217 |
<div class="method-definition"> |
| 218 |
<span class="method-result">void</span> |
| 219 |
<a href="#push_js_link" title="details" class="method-name">push_js_link</a> |
| 220 |
(<span class="var-type">mixed</span> <span class="var-name">$link</span>) |
| 221 |
</div> |
| 222 |
|
| 223 |
<div class="method-definition"> |
| 224 |
<span class="method-result">void</span> |
| 225 |
<a href="#push_reference" title="details" class="method-name">push_reference</a> |
| 226 |
(<span class="var-type">mixed</span> <span class="var-name">&$content</span>) |
| 227 |
</div> |
| 228 |
|
| 229 |
<div class="method-definition"> |
| 230 |
<span class="method-result">string</span> |
| 231 |
<a href="#render" title="details" class="method-name">render</a> |
| 232 |
() |
| 233 |
</div> |
| 234 |
|
| 235 |
<div class="method-definition"> |
| 236 |
<span class="method-result">void</span> |
| 237 |
<a href="#set_body_attributes" title="details" class="method-name">set_body_attributes</a> |
| 238 |
(<span class="var-type">array</span> <span class="var-name">$attributes</span>) |
| 239 |
</div> |
| 240 |
|
| 241 |
<div class="method-definition"> |
| 242 |
<span class="method-result">void</span> |
| 243 |
<a href="#set_charset" title="details" class="method-name">set_charset</a> |
| 244 |
(<span class="var-type">string</span> <span class="var-name">$charset</span>) |
| 245 |
</div> |
| 246 |
|
| 247 |
<div class="method-definition"> |
| 248 |
<span class="method-result">void</span> |
| 249 |
<a href="#set_encoding" title="details" class="method-name">set_encoding</a> |
| 250 |
(<span class="var-type">string</span> <span class="var-name">$encoding</span>) |
| 251 |
</div> |
| 252 |
|
| 253 |
<div class="method-definition"> |
| 254 |
<span class="method-result">void</span> |
| 255 |
<a href="#set_favicon" title="details" class="method-name">set_favicon</a> |
| 256 |
(<span class="var-type">string</span> <span class="var-name">$path</span>, [<span class="var-type">string</span> <span class="var-name">$type</span> = <span class="var-default">"image/x-ico"</span>]) |
| 257 |
</div> |
| 258 |
|
| 259 |
<div class="method-definition"> |
| 260 |
<span class="method-result">void</span> |
| 261 |
<a href="#set_favicon_flag" title="details" class="method-name">set_favicon_flag</a> |
| 262 |
([<span class="var-type">boolean</span> <span class="var-name">$flag</span> = <span class="var-default">TRUE</span>]) |
| 263 |
</div> |
| 264 |
|
| 265 |
<div class="method-definition"> |
| 266 |
<span class="method-result">void</span> |
| 267 |
<a href="#set_frameset" title="details" class="method-name">set_frameset</a> |
| 268 |
(<span class="var-type"><a href="../phpHtmlLib/FRAMESETtag.html">FRAMESETtag</a></span> <span class="var-name">$frameset</span>) |
| 269 |
</div> |
| 270 |
|
| 271 |
<div class="method-definition"> |
| 272 |
<span class="method-result">void</span> |
| 273 |
<a href="#set_html_attributes" title="details" class="method-name">set_html_attributes</a> |
| 274 |
(<span class="var-type">array</span> <span class="var-name">$attributes</span>) |
| 275 |
</div> |
| 276 |
|
| 277 |
<div class="method-definition"> |
| 278 |
<span class="method-result">void</span> |
| 279 |
<a href="#set_language" title="details" class="method-name">set_language</a> |
| 280 |
(<span class="var-type">string</span> <span class="var-name">$language</span>) |
| 281 |
</div> |
| 282 |
|
| 283 |
<div class="method-definition"> |
| 284 |
<span class="method-result">void</span> |
| 285 |
<a href="#set_refresh" title="details" class="method-name">set_refresh</a> |
| 286 |
(<span class="var-type">int</span> <span class="var-name">$time</span>, [<span class="var-type">string</span> <span class="var-name">$url</span> = <span class="var-default">NULL</span>]) |
| 287 |
</div> |
| 288 |
|
| 289 |
<div class="method-definition"> |
| 290 |
<span class="method-result">void</span> |
| 291 |
<a href="#set_text_debug" title="details" class="method-name">set_text_debug</a> |
| 292 |
(<span class="var-type">$flag</span> <span class="var-name">$flag</span>) |
| 293 |
</div> |
| 294 |
|
| 295 |
<div class="method-definition"> |
| 296 |
<span class="method-result">void</span> |
| 297 |
<a href="#set_title" title="details" class="method-name">set_title</a> |
| 298 |
(<span class="var-type">mixed</span> <span class="var-name">$title</span>) |
| 299 |
</div> |
| 300 |
|
| 301 |
<div class="method-definition"> |
| 302 |
<span class="method-result">void</span> |
| 303 |
<a href="#_build_content_type_tag" title="details" class="method-name">_build_content_type_tag</a> |
| 304 |
() |
| 305 |
</div> |
| 306 |
|
| 307 |
<div class="method-definition"> |
| 308 |
<span class="method-result">void</span> |
| 309 |
<a href="#_build_head" title="details" class="method-name">_build_head</a> |
| 310 |
() |
| 311 |
</div> |
| 312 |
|
| 313 |
<div class="method-definition"> |
| 314 |
<span class="method-result">void</span> |
| 315 |
<a href="#_create_body" title="details" class="method-name">_create_body</a> |
| 316 |
() |
| 317 |
</div> |
| 318 |
|
| 319 |
<div class="method-definition"> |
| 320 |
<span class="method-result"><a href="../phpHtmlLib/NOFRAMEStag.html">NOFRAMEStag</a></span> |
| 321 |
<a href="#_frameset_wrap_body" title="details" class="method-name">_frameset_wrap_body</a> |
| 322 |
() |
| 323 |
</div> |
| 324 |
</div> |
| 325 |
</div> |
| 326 |
</div> |
| 327 |
|
| 328 |
<a name="sec-vars"></a> |
| 329 |
<div class="info-box"> |
| 330 |
<div class="info-box-title">Variables</div> |
| 331 |
<div class="nav-bar"> |
| 332 |
<a href="#sec-description">Description</a> | |
| 333 |
<a href="#sec-descendents">Descendents</a> | |
| 334 |
<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>) |
| 335 |
|
| 336 |
|
| 337 |
| |
| 338 |
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
| 339 |
|
| 340 |
</div> |
| 341 |
<div class="info-box-body"> |
| 342 |
<a name="var$_favicon" id="$_favicon"><!-- --></A> |
| 343 |
<div class="oddrow"> |
| 344 |
|
| 345 |
<div class="var-header"> |
| 346 |
<span class="var-title"> |
| 347 |
<span class="var-type">array</span> |
| 348 |
<span class="var-name">$_favicon</span> |
| 349 |
= <span class="var-default">array("href" => "/favicon.ico",<br /> "type" => "images/x-ico",<br /> "enabled" => FALSE)</span> (line <span class="line-number">189</span>) |
| 350 |
</span> |
| 351 |
</div> |
| 352 |
|
| 353 |
<!-- ========== Info from phpDoc block ========= --> |
| 354 |
<p class="short-description">The favicon params</p> |
| 355 |
|
| 356 |
|
| 357 |
|
| 358 |
|
| 359 |
|
| 360 |
</div> |
| 361 |
<a name="var$_html_attributes" id="$_html_attributes"><!-- --></A> |
| 362 |
<div class="evenrow"> |
| 363 |
|
| 364 |
<div class="var-header"> |
| 365 |
<span class="var-title"> |
| 366 |
<span class="var-type">array</span> |
| 367 |
<span class="var-name">$_html_attributes</span> |
| 368 |
= <span class="var-default">array()</span> (line <span class="line-number">149</span>) |
| 369 |
</span> |
| 370 |
</div> |
| 371 |
|
| 372 |
<!-- ========== Info from phpDoc block ========= --> |
| 373 |
<p class="short-description">This holds the attributes for the <html> tag.</p> |
| 374 |
|
| 375 |
|
| 376 |
|
| 377 |
|
| 378 |
|
| 379 |
</div> |
| 380 |
<a name="var$_html_render_type" id="$_html_render_type"><!-- --></A> |
| 381 |
<div class="oddrow"> |
| 382 |
|
| 383 |
<div class="var-header"> |
| 384 |
<span class="var-title"> |
| 385 |
<span class="var-type">string</span> |
| 386 |
<span class="var-name">$_html_render_type</span> |
| 387 |
= <span class="var-default"> HTML</span> (line <span class="line-number">183</span>) |
| 388 |
</span> |
| 389 |
</div> |
| 390 |
|
| 391 |
<!-- ========== Info from phpDoc block ========= --> |
| 392 |
<p class="short-description">keeps track of the html render type.</p> |
| 393 |
|
| 394 |
|
| 395 |
|
| 396 |
|
| 397 |
|
| 398 |
</div> |
| 399 |
<a name="var$_indent_style" id="$_indent_style"><!-- --></A> |
| 400 |
<div class="evenrow"> |
| 401 |
|
| 402 |
<div class="var-header"> |
| 403 |
<span class="var-title"> |
| 404 |
<span class="var-type">int</span> |
| 405 |
<span class="var-name">$_indent_style</span> |
| 406 |
= <span class="var-default"> 0</span> (line <span class="line-number">175</span>) |
| 407 |
</span> |
| 408 |
</div> |
| 409 |
|
| 410 |
<!-- ========== Info from phpDoc block ========= --> |
| 411 |
<p class="short-description">Holds the value of the indent style the user wants to render the page w/</p> |
| 412 |
|
| 413 |
|
| 414 |
|
| 415 |
|
| 416 |
|
| 417 |
</div> |
| 418 |
<a name="var$_widget_css_auto" id="$_widget_css_auto"><!-- --></A> |
| 419 |
<div class="oddrow"> |
| 420 |
|
| 421 |
<div class="var-header"> |
| 422 |
<span class="var-title"> |
| 423 |
<span class="var-type">array</span> |
| 424 |
<span class="var-name">$_widget_css_auto</span> |
| 425 |
= <span class="var-default">array()</span> (line <span class="line-number">157</span>) |
| 426 |
</span> |
| 427 |
</div> |
| 428 |
|
| 429 |
<!-- ========== Info from phpDoc block ========= --> |
| 430 |
<p class="short-description">keeps track of which widgets we have automatically pulled in css for</p> |
| 431 |
|
| 432 |
|
| 433 |
|
| 434 |
|
| 435 |
|
| 436 |
</div> |
| 437 |
<a name="var$_widget_js_auto" id="$_widget_js_auto"><!-- --></A> |
| 438 |
<div class="evenrow"> |
| 439 |
|
| 440 |
<div class="var-header"> |
| 441 |
<span class="var-title"> |
| 442 |
<span class="var-type">array</span> |
| 443 |
<span class="var-name">$_widget_js_auto</span> |
| 444 |
= <span class="var-default">array()</span> (line <span class="line-number">165</span>) |
| 445 |
</span> |
| 446 |
</div> |
| 447 |
|
| 448 |
<!-- ========== Info from phpDoc block ========= --> |
| 449 |
<p class="short-description">keeps track of which widgets we have automatically pulled in js for</p> |
| 450 |
|
| 451 |
|
| 452 |
|
| 453 |
|
| 454 |
|
| 455 |
</div> |
| 456 |
<a name="var$_xml_encoding" id="$_xml_encoding"><!-- --></A> |
| 457 |
<div class="oddrow"> |
| 458 |
|
| 459 |
<div class="var-header"> |
| 460 |
<span class="var-title"> |
| 461 |
<span class="var-type">mixed</span> |
| 462 |
<span class="var-name">$_xml_encoding</span> |
| 463 |
= <span class="var-default"> "UTF-8"</span> (line <span class="line-number">93</span>) |
| 464 |
</span> |
| 465 |
</div> |
| 466 |
|
| 467 |
<!-- ========== Info from phpDoc block ========= --> |
| 468 |
<p class="short-description">The encoding of the XHTML</p> |
| 469 |
<p class="description"><p>XML tag</p></p> |
| 470 |
|
| 471 |
|
| 472 |
|
| 473 |
|
| 474 |
|
| 475 |
</div> |
| 476 |
|
| 477 |
|
| 478 |
</div> |
| 479 |
</div> |
| 480 |
|
| 481 |
<a name="sec-methods"></a> |
| 482 |
<div class="info-box"> |
| 483 |
<div class="info-box-title">Methods</div> |
| 484 |
<div class="nav-bar"> |
| 485 |
<a href="#sec-description">Description</a> | |
| 486 |
<a href="#sec-descendents">Descendents</a> | |
| 487 |
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) |
| 488 |
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>) |
| 489 |
|
| 490 |
</div> |
| 491 |
<div class="info-box-body"> |
| 492 |
<A NAME='method_detail'></A> |
| 493 |
<a name="methodHTMLPageClass" id="HTMLPageClass"><!-- --></a> |
| 494 |
<div class="evenrow"> |
| 495 |
|
| 496 |
<div class="method-header"> |
| 497 |
<span class="method-title">Constructor HTMLPageClass</span> (line <span class="line-number">219</span>) |
| 498 |
</div> |
| 499 |
|
| 500 |
<!-- ========== Info from phpDoc block ========= --> |
| 501 |
<p class="short-description">Class Constructor</p> |
| 502 |
<ul class="tags"> |
| 503 |
<li><span class="field">access:</span> public</li> |
| 504 |
</ul> |
| 505 |
|
| 506 |
<div class="method-signature"> |
| 507 |
<span class="method-result">HTMLPageClass</span> |
| 508 |
<span class="method-name"> |
| 509 |
HTMLPageClass |
| 510 |
</span> |
| 511 |
([<span class="var-type">mixed</span> <span class="var-name">$title</span> = <span class="var-default">NULL</span>], [<span class="var-type">string</span> <span class="var-name">$html_type</span> = <span class="var-default">HTML</span>], [<span class="var-type">int</span> <span class="var-name">$indent_style</span> = <span class="var-default">INDENT_NICE</span>]) |
| 512 |
</div> |
| 513 |
|
| 514 |
<ul class="parameters"> |
| 515 |
<li> |
| 516 |
<span class="var-type">mixed</span> |
| 517 |
<span class="var-name">$title</span><span class="var-description">: - $title Title string or TITLEtag object for the page.</span> </li> |
| 518 |
<li> |
| 519 |
<span class="var-type">string</span> |
| 520 |
<span class="var-name">$html_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 <IMG> tag. If xhtml is selected, the the IMGtag object and all utility functions will not render "border=0" as a default attribute, since this is not proper xhtml. "html" - HTML 4.0 (default) "xhtml_transitional" - render xhtml instead of html <ul><li>doctype is XHTML transitional.</li></ul> "xhtml_strict" - render xhtml instead of html 4.0. <ul><li>doctype is XHTML strict.</li></ul></span> </li> |
| 521 |
<li> |
| 522 |
<span class="var-type">int</span> |
| 523 |
<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> |
| 524 |
</ul> |
| 525 |
|
| 526 |
|
| 527 |
</div> |
| 528 |
<a name="methodadd" id="add"><!-- --></a> |
| 529 |
<div class="oddrow"> |
| 530 |
|
| 531 |
<div class="method-header"> |
| 532 |
<span class="method-title">add</span> (line <span class="line-number">523</span>) |
| 533 |
</div> |
| 534 |
|
| 535 |
<!-- ========== Info from phpDoc block ========= --> |
| 536 |
<p class="short-description">This function adds content to the <body> area of the page.</p> |
| 537 |
|
| 538 |
<div class="method-signature"> |
| 539 |
<span class="method-result">void</span> |
| 540 |
<span class="method-name"> |
| 541 |
add |
| 542 |
</span> |
| 543 |
(<span class="var-type">mixed</span> <span class="var-name">0</span>) |
| 544 |
</div> |
| 545 |
|
| 546 |
<ul class="parameters"> |
| 547 |
<li> |
| 548 |
<span class="var-type">mixed</span> |
| 549 |
<span class="var-name">0</span><span class="var-description">: - any # of parameters</span> </li> |
| 550 |
</ul> |
| 551 |
|
| 552 |
|
| 553 |
</div> |
| 554 |
<a name="methodadd_css_link" id="add_css_link"><!-- --></a> |
| 555 |
<div class="evenrow"> |
| 556 |
|
| 557 |
<div class="method-header"> |
| 558 |
<span class="method-title">add_css_link</span> (line <span class="line-number">350</span>) |
| 559 |
</div> |
| 560 |
|
| 561 |
<!-- ========== Info from phpDoc block ========= --> |
| 562 |
<p class="short-description">pushes a css external reference to the head area</p> |
| 563 |
|
| 564 |
<div class="method-signature"> |
| 565 |
<span class="method-result">void</span> |
| 566 |
<span class="method-name"> |
| 567 |
add_css_link |
| 568 |
</span> |
| 569 |
(<span class="var-type">mixed</span> <span class="var-name">$link</span>) |
| 570 |
</div> |
| 571 |
|
| 572 |
<ul class="parameters"> |
| 573 |
<li> |
| 574 |
<span class="var-type">mixed</span> |
| 575 |
<span class="var-name">$link</span><span class="var-description">: - link tag object or $url for a css.</span> </li> |
| 576 |
</ul> |
| 577 |
|
| 578 |
|
| 579 |
</div> |
| 580 |
<a name="methodadd_head_content" id="add_head_content"><!-- --></a> |
| 581 |
<div class="oddrow"> |
| 582 |
|
| 583 |
<div class="method-header"> |
| 584 |
<span class="method-title">add_head_content</span> (line <span class="line-number">279</span>) |
| 585 |
</div> |
| 586 |
|
| 587 |
<!-- ========== Info from phpDoc block ========= --> |
| 588 |
<p class="short-description">this adds content to the head tag of the page</p> |
| 589 |
|
| 590 |
<div class="method-signature"> |
| 591 |
<span class="method-result">void</span> |
| 592 |
<span class="method-name"> |
| 593 |
add_head_content |
| 594 |
</span> |
| 595 |
(<span class="var-type">mixed</span> <span class="var-name">0</span>) |
| 596 |
</div> |
| 597 |
|
| 598 |
<ul class="parameters"> |
| 599 |
<li> |
| 600 |
<span class="var-type">mixed</span> |
| 601 |
<span class="var-name">0</span><span class="var-description">: - any content to add</span> </li> |
| 602 |
</ul> |
| 603 |
|
| 604 |
|
| 605 |
</div> |
| 606 |
<a name="methodadd_head_css" id="add_head_css"><!-- --></a> |
| 607 |
<div class="evenrow"> |
| 608 |
|
| 609 |
<div class="method-header"> |
| 610 |
<span class="method-title">add_head_css</span> (line <span class="line-number">323</span>) |
| 611 |
</div> |
| 612 |
|
| 613 |
<!-- ========== Info from phpDoc block ========= --> |
| 614 |
<p class="short-description">this function adds raw css to the <head> tag. It will automatically be wrapped in a <style type="text/css"></p> |
| 615 |
|
| 616 |
<div class="method-signature"> |
| 617 |
<span class="method-result">void</span> |
| 618 |
<span class="method-name"> |
| 619 |
add_head_css |
| 620 |
</span> |
| 621 |
(<span class="var-type">string</span> <span class="var-name">$css</span>) |
| 622 |
</div> |
| 623 |
|
| 624 |
<ul class="parameters"> |
| 625 |
<li> |
| 626 |
<span class="var-type">string</span> |
| 627 |
<span class="var-name">$css</span><span class="var-description">: - the raw css</span> </li> |
| 628 |
</ul> |
| 629 |
|
| 630 |
|
| 631 |
</div> |
| 632 |
<a name="methodadd_head_js" id="add_head_js"><!-- --></a> |
| 633 |
<div class="oddrow"> |
| 634 |
|
| 635 |
<div class="method-header"> |
| 636 |
<span class="method-title">add_head_js</span> (line <span class="line-number">303</span>) |
| 637 |
</div> |
| 638 |
|
| 639 |
<!-- ========== Info from phpDoc block ========= --> |
| 640 |
<p class="short-description">adds raw javascript to the head which will automatically get wrapped in a <script language="JavaScript"> tag.</p> |
| 641 |
|
| 642 |
<div class="method-signature"> |
| 643 |
<span class="method-result">void</span> |
| 644 |
<span class="method-name"> |
| 645 |
add_head_js |
| 646 |
</span> |
| 647 |
(<span class="var-type">mixed</span> <span class="var-name">$content</span>) |
| 648 |
</div> |
| 649 |
|
| 650 |
<ul class="parameters"> |
| 651 |
<li> |
| 652 |
<span class="var-type">mixed</span> |
| 653 |
<span class="var-name">$content</span><span class="var-description">: - raw javascript code to add to the head</span> </li> |
| 654 |
</ul> |
| 655 |
|
| 656 |
|
| 657 |
</div> |
| 658 |
<a name="methodadd_js_link" id="add_js_link"><!-- --></a> |
| 659 |
<div class="evenrow"> |
| 660 |
|
| 661 |
<div class="method-header"> |
| 662 |
<span class="method-title">add_js_link</span> (line <span class="line-number">375</span>) |
| 663 |
</div> |
| 664 |
|
| 665 |
<!-- ========== Info from phpDoc block ========= --> |
| 666 |
<p class="short-description">This adds a link to an external Javascript file, which will get rendered in the head.</p> |
| 667 |
|
| 668 |
<div class="method-signature"> |
| 669 |
<span class="method-result">void</span> |
| 670 |
<span class="method-name"> |
| 671 |
add_js_link |
| 672 |
</span> |
| 673 |
(<span class="var-type">mixed</span> <span class="var-name">$link</span>) |
| 674 |
</div> |
| 675 |
|
| 676 |
<ul class="parameters"> |
| 677 |
<li> |
| 678 |
<span class="var-type">mixed</span> |
| 679 |
<span class="var-name">$link</span><span class="var-description">: - script tag object or $url of .js file.</span> </li> |
| 680 |
</ul> |
| 681 |
|
| 682 |
|
| 683 |
</div> |
| 684 |
<a name="methodadd_reference" id="add_reference"><!-- --></a> |
| 685 |
<div class="oddrow"> |
| 686 |
|
| 687 |
<div class="method-header"> |
| 688 |
<span class="method-title">add_reference</span> (line <span class="line-number">560</span>) |
| 689 |
</div> |
| 690 |
|
| 691 |
<!-- ========== Info from phpDoc block ========= --> |
| 692 |
<p class="short-description">Adds the content reference to the <body> tag for later use.</p> |
| 693 |
|
| 694 |
<div class="method-signature"> |
| 695 |
<span class="method-result">void</span> |
| 696 |
<span class="method-name"> |
| 697 |
add_reference |
| 698 |
</span> |
| 699 |
(<span class="var-type">mixed</span> <span class="var-name">&$content</span>) |
| 700 |
</div> |
| 701 |
|
| 702 |
<ul class="parameters"> |
| 703 |
<li> |
| 704 |
<span class="var-type">mixed</span> |
| 705 |
<span class="var-name">$content</span><span class="var-description">: - content to add</span> </li> |
| 706 |
</ul> |
| 707 |
|
| 708 |
|
| 709 |
</div> |
| 710 |
<a name="methodbuild_doctype" id="build_doctype"><!-- --></a> |
| 711 |
<div class="evenrow"> |
| 712 |
|
| 713 |
<div class="method-header"> |
| 714 |
<span class="method-title">build_doctype</span> (line <span class="line-number">609</span>) |
| 715 |
</div> |
| 716 |
|
| 717 |
<!-- ========== Info from phpDoc block ========= --> |
| 718 |
<p class="short-description">This function is used to build the DOCTYPE</p> |
| 719 |
<p class="description"><p>tag for the page. It will automatically create a DOCTYPE with a document_element of "html" and a source of "PUBLIC"</p></p> |
| 720 |
|
| 721 |
<div class="method-signature"> |
| 722 |
<span class="method-result">void</span> |
| 723 |
<span class="method-name"> |
| 724 |
build_doctype |
| 725 |
</span> |
| 726 |
(<span class="var-type">string</span> <span class="var-name">$link1</span>, [<span class="var-type">string</span> <span class="var-name">$link2</span> = <span class="var-default">NULL</span>]) |
| 727 |
</div> |
| 728 |
|
| 729 |
<ul class="parameters"> |
| 730 |
<li> |
| 731 |
<span class="var-type">string</span> |
| 732 |
<span class="var-name">$link1</span><span class="var-description">: - link1</span> </li> |
| 733 |
<li> |
| 734 |
<span class="var-type">string</span> |
| 735 |
<span class="var-name">$link2</span><span class="var-description">: - link2</span> </li> |
| 736 |
</ul> |
| 737 |
|
| 738 |
|
| 739 |
</div> |
| 740 |
<a name="methodget_html_attributes" id="get_html_attributes"><!-- --></a> |
| 741 |
<div class="oddrow"> |
| 742 |
|
| 743 |
<div class="method-header"> |
| 744 |
<span class="method-title">get_html_attributes</span> (line <span class="line-number">459</span>) |
| 745 |
</div> |
| 746 |
|
| 747 |
<!-- ========== Info from phpDoc block ========= --> |
| 748 |
<p class="short-description">This function returns the attributes to be used for the <html> tag.</p> |
| 749 |
|
| 750 |
<div class="method-signature"> |
| 751 |
<span class="method-result">array();</span> |
| 752 |
<span class="method-name"> |
| 753 |
get_html_attributes |
| 754 |
</span> |
| 755 |
() |
| 756 |
</div> |
| 757 |
|
| 758 |
|
| 759 |
|
| 760 |
</div> |
| 761 |
<a name="methodpush" id="push"><!-- --></a> |
| 762 |
<div class="evenrow"> |
| 763 |
|
| 764 |
<div class="method-header"> |
| 765 |
<span class="method-title">push</span> (line <span class="line-number">549</span>) |
| 766 |
</div> |
| 767 |
|
| 768 |
<!-- ========== Info from phpDoc block ========= --> |
| 769 |
<p class="short-description">Same as add()</p> |
| 770 |
<ul class="tags"> |
| 771 |
<li><span class="field">deprecated:</span> - use add()</li> |
| 772 |
</ul> |
| 773 |
|
| 774 |
<div class="method-signature"> |
| 775 |
<span class="method-result">void</span> |
| 776 |
<span class="method-name"> |
| 777 |
push |
| 778 |
</span> |
| 779 |
() |
| 780 |
</div> |
| 781 |
|
| 782 |
|
| 783 |
|
| 784 |
</div> |
| 785 |
<a name="methodpush_css_link" id="push_css_link"><!-- --></a> |
| 786 |
<div class="oddrow"> |
| 787 |
|
| 788 |
<div class="method-header"> |
| 789 |
<span class="method-title">push_css_link</span> (line <span class="line-number">364</span>) |
| 790 |
</div> |
| 791 |
|
| 792 |
<!-- ========== Info from phpDoc block ========= --> |
| 793 |
<p class="short-description">Same ass add_css_link()</p> |
| 794 |
<ul class="tags"> |
| 795 |
<li><span class="field">deprecated:</span> - use add_css_link();</li> |
| 796 |
</ul> |
| 797 |
|
| 798 |
<div class="method-signature"> |
| 799 |
<span class="method-result">void</span> |
| 800 |
<span class="method-name"> |
| 801 |
push_css_link |
| 802 |
</span> |
| 803 |
(<span class="var-type">mixed</span> <span class="var-name">$link</span>) |
| 804 |
</div> |
| 805 |
|
| 806 |
|
| 807 |
|
| 808 |
</div> |
| 809 |
<a name="methodpush_head_content" id="push_head_content"><!-- --></a> |
| 810 |
<div class="evenrow"> |
| 811 |
|
| 812 |
<div class="method-header"> |
| 813 |
<span class="method-title">push_head_content</span> (line <span class="line-number">291</span>) |
| 814 |
</div> |
| 815 |
|
| 816 |
<!-- ========== Info from phpDoc block ========= --> |
| 817 |
<p class="short-description">Same ass add_head_content()</p> |
| 818 |
<ul class="tags"> |
| 819 |
<li><span class="field">deprecated:</span> - use add_head_content();</li> |
| 820 |
</ul> |
| 821 |
|
| 822 |
<div class="method-signature"> |
| 823 |
<span class="method-result">void</span> |
| 824 |
<span class="method-name"> |
| 825 |
push_head_content |
| 826 |
</span> |
| 827 |
() |
| 828 |
</div> |
| 829 |
|
| 830 |
|
| 831 |
|
| 832 |
</div> |
| 833 |
<a name="methodpush_head_js" id="push_head_js"><!-- --></a> |
| 834 |
<div class="oddrow"> |
| 835 |
|
| 836 |
<div class="method-header"> |
| 837 |
<span class="method-title">push_head_js</span> (line <span class="line-number">312</span>) |
| 838 |
</div> |
| 839 |
|
| 840 |
<!-- ========== Info from phpDoc block ========= --> |
| 841 |
<p class="short-description">Same ass add_head_js()</p> |
| 842 |
<ul class="tags"> |
| 843 |
<li><span class="field">deprecated:</span> - use add_head_js();</li> |
| 844 |
</ul> |
| 845 |
|
| 846 |
<div class="method-signature"> |
| 847 |
<span class="method-result">void</span> |
| 848 |
<span class="method-name"> |
| 849 |
push_head_js |
| 850 |
</span> |
| 851 |
(<span class="var-type">mixed</span> <span class="var-name">$content</span>) |
| 852 |
</div> |
| 853 |
|
| 854 |
|
| 855 |
|
| 856 |
</div> |
| 857 |
<a name="methodpush_js_link" id="push_js_link"><!-- --></a> |
| 858 |
<div class="evenrow"> |
| 859 |
|
| 860 |
<div class="method-header"> |
| 861 |
<span class="method-title">push_js_link</span> (line <span class="line-number">389</span>) |
| 862 |
</div> |
| 863 |
|
| 864 |
<!-- ========== Info from phpDoc block ========= --> |
| 865 |
<p class="short-description">same as add_js_link()</p> |
| 866 |
<ul class="tags"> |
| 867 |
<li><span class="field">deprecated:</span> </li> |
| 868 |
</ul> |
| 869 |
|
| 870 |
<div class="method-signature"> |
| 871 |
<span class="method-result">void</span> |
| 872 |
<span class="method-name"> |
| 873 |
push_js_link |
| 874 |
</span> |
| 875 |
(<span class="var-type">mixed</span> <span class="var-name">$link</span>) |
| 876 |
</div> |
| 877 |
|
| 878 |
|
| 879 |
|
| 880 |
</div> |
| 881 |
<a name="methodpush_reference" id="push_reference"><!-- --></a> |
| 882 |
<div class="oddrow"> |
| 883 |
|
| 884 |
<div class="method-header"> |
| 885 |
<span class="method-title">push_reference</span> (line <span class="line-number">570</span>) |
| 886 |
</div> |
| 887 |
|
| 888 |
<!-- ========== Info from phpDoc block ========= --> |
| 889 |
<p class="short-description">Same as add()</p> |
| 890 |
<ul class="tags"> |
| 891 |
<li><span class="field">deprecated:</span> - use add()</li> |
| 892 |
</ul> |
| 893 |
|
| 894 |
<div class="method-signature"> |
| 895 |
<span class="method-result">void</span> |
| 896 |
<span class="method-name"> |
| 897 |
push_reference |
| 898 |
</span> |
| 899 |
(<span class="var-type">mixed</span> <span class="var-name">&$content</span>) |
| 900 |
</div> |
| 901 |
|
| 902 |
|
| 903 |
|
| 904 |
</div> |
| 905 |
<a name="methodrender" id="render"><!-- --></a> |
| 906 |
<div class="evenrow"> |
| 907 |
|
| 908 |
<div class="method-header"> |
| 909 |
<span class="method-title">render</span> (line <span class="line-number">688</span>) |
| 910 |
</div> |
| 911 |
|
| 912 |
<!-- ========== Info from phpDoc block ========= --> |
| 913 |
<p class="short-description">render the page.</p> |
| 914 |
<ul class="tags"> |
| 915 |
<li><span class="field">return:</span> the raw html output.</li> |
| 916 |
</ul> |
| 917 |
|
| 918 |
<div class="method-signature"> |
| 919 |
<span class="method-result">string</span> |
| 920 |
<span class="method-name"> |
| 921 |
render |
| 922 |
</span> |
| 923 |
() |
| 924 |
</div> |
| 925 |
|
| 926 |
|
| 927 |
|
| 928 |
<hr class="separator" /> |
| 929 |
<div class="notes">Redefined in descendants as:</div> |
| 930 |
<ul class="redefinitions"> |
| 931 |
<li> |
| 932 |
<a href="../phpHtmlLib/PageWidget.html#methodrender">PageWidget::render()</a> |
| 933 |
: This is the function that renders the HTML for this widget. |
| 934 |
</li> |
| 935 |
</ul> |
| 936 |
</div> |
| 937 |
<a name="methodset_body_attributes" id="set_body_attributes"><!-- --></a> |
| 938 |
<div class="oddrow"> |
| 939 |
|
| 940 |
<div class="method-header"> |
| 941 |
<span class="method-title">set_body_attributes</span> (line <span class="line-number">593</span>) |
| 942 |
</div> |
| 943 |
|
| 944 |
<!-- ========== Info from phpDoc block ========= --> |
| 945 |
<p class="short-description">set attributes of body tag</p> |
| 946 |
|
| 947 |
<div class="method-signature"> |
| 948 |
<span class="method-result">void</span> |
| 949 |
<span class="method-name"> |
| 950 |
set_body_attributes |
| 951 |
</span> |
| 952 |
(<span class="var-type">array</span> <span class="var-name">$attributes</span>) |
| 953 |
</div> |
| 954 |
|
| 955 |
<ul class="parameters"> |
| 956 |
<li> |
| 957 |
<span class="var-type">array</span> |
| 958 |
<span class="var-name">$attributes</span><span class="var-description">: the name=>value pairs</span> </li> |
| 959 |
</ul> |
| 960 |
|
| 961 |
|
| 962 |
</div> |
| 963 |
<a name="methodset_charset" id="set_charset"><!-- --></a> |
| 964 |
<div class="evenrow"> |
| 965 |
|
| 966 |
<div class="method-header"> |
| 967 |
<span class="method-title">set_charset</span> (line <span class="line-number">410</span>) |
| 968 |
</div> |
| 969 |
|
| 970 |
<!-- ========== Info from phpDoc block ========= --> |
| 971 |
<p class="short-description">set the character set</p> |
| 972 |
|
| 973 |
<div class="method-signature"> |
| 974 |
<span class="method-result">void</span> |
| 975 |
<span class="method-name"> |
| 976 |
set_charset |
| 977 |
</span> |
| 978 |
(<span class="var-type">string</span> <span class="var-name">$charset</span>) |
| 979 |
</div> |
| 980 |
|
| 981 |
<ul class="parameters"> |
| 982 |
<li> |
| 983 |
<span class="var-type">string</span> |
| 984 |
<span class="var-name">$charset</span><span class="var-description">: - the charset for the meta tag</span> </li> |
| 985 |
</ul> |
| 986 |
|
| 987 |
|
| 988 |
</div> |
| 989 |
<a name="methodset_encoding" id="set_encoding"><!-- --></a> |
| 990 |
<div class="oddrow"> |
| 991 |
|
| 992 |
<div class="method-header"> |
| 993 |
<span class="method-title">set_encoding</span> (line <span class="line-number">420</span>) |
| 994 |
</div> |
| 995 |
|
| 996 |
<!-- ========== Info from phpDoc block ========= --> |
| 997 |
<p class="short-description">This sets the encoding type for XHTML documents</p> |
| 998 |
|
| 999 |
<div class="method-signature"> |
| 1000 |
<span class="method-result">void</span> |
| 1001 |
<span class="method-name"> |
| 1002 |
set_encoding |
| 1003 |
</span> |
| 1004 |
(<span class="var-type">string</span> <span class="var-name">$encoding</span>) |
| 1005 |
</div> |
| 1006 |
|
| 1007 |
<ul class="parameters"> |
| 1008 |
<li> |
| 1009 |
<span class="var-type">string</span> |
| 1010 |
<span class="var-name">$encoding</span><span class="var-description">: - the encoding parameter</span> </li> |
| 1011 |
</ul> |
| 1012 |
|
| 1013 |
|
| 1014 |
</div> |
| 1015 |
<a name="methodset_favicon" id="set_favicon"><!-- --></a> |
| 1016 |
<div class="evenrow"> |
| 1017 |
|
| 1018 |
<div class="method-header"> |
| 1019 |
<span class="method-title">set_favicon</span> (line <span class="line-number">506</span>) |
| 1020 |
</div> |
| 1021 |
|
| 1022 |
<!-- ========== Info from phpDoc block ========= --> |
| 1023 |
<p class="short-description">This allows you to change the default url/path for where the favicon.ico lives.</p> |
| 1024 |
<p class="description"><p>NOTE: calling this method automatically enables the link in the head to be created.</p></p> |
| 1025 |
|
| 1026 |
<div class="method-signature"> |
| 1027 |
<span class="method-result">void</span> |
| 1028 |
<span class="method-name"> |
| 1029 |
set_favicon |
| 1030 |
</span> |
| 1031 |
(<span class="var-type">string</span> <span class="var-name">$path</span>, [<span class="var-type">string</span> <span class="var-name">$type</span> = <span class="var-default">"image/x-ico"</span>]) |
| 1032 |
</div> |
| 1033 |
|
| 1034 |
<ul class="parameters"> |
| 1035 |
<li> |
| 1036 |
<span class="var-type">string</span> |
| 1037 |
<span class="var-name">$path</span><span class="var-description">: the url to the favicon.ico file</span> </li> |
| 1038 |
<li> |
| 1039 |
<span class="var-type">string</span> |
| 1040 |
<span class="var-name">$type</span><span class="var-description">: the type of the image. NOTE: Default is image/x-ico</span> </li> |
| 1041 |
</ul> |
| 1042 |
|
| 1043 |
|
| 1044 |
</div> |
| 1045 |
<a name="methodset_favicon_flag" id="set_favicon_flag"><!-- --></a> |
| 1046 |
<div class="oddrow"> |
| 1047 |
|
| 1048 |
<div class="method-header"> |
| 1049 |
<span class="method-title">set_favicon_flag</span> (line <span class="line-number">492</span>) |
| 1050 |
</div> |
| 1051 |
|
| 1052 |
<!-- ========== Info from phpDoc block ========= --> |
| 1053 |
<p class="short-description">This is used to enable the ability to add the favicon link in the head of the document.</p> |
| 1054 |
<p class="description"><p>By default it is off.</p></p> |
| 1055 |
|
| 1056 |
<div class="method-signature"> |
| 1057 |
<span class="method-result">void</span> |
| 1058 |
<span class="method-name"> |
| 1059 |
set_favicon_flag |
| 1060 |
</span> |
| 1061 |
([<span class="var-type">boolean</span> <span class="var-name">$flag</span> = <span class="var-default">TRUE</span>]) |
| 1062 |
</div> |
| 1063 |
|
| 1064 |
<ul class="parameters"> |
| 1065 |
<li> |
| 1066 |
<span class="var-type">boolean</span> |
| 1067 |
<span class="var-name">$flag</span><span class="var-description">: TRUE = enable</span> </li> |
| 1068 |
</ul> |
| 1069 |
|
| 1070 |
|
| 1071 |
</div> |
| 1072 |
<a name="methodset_frameset" id="set_frameset"><!-- --></a> |
| 1073 |
<div class="evenrow"> |
| 1074 |
|
| 1075 |
<div class="method-header"> |
| 1076 |
<span class="method-title">set_frameset</span> (line <span class="line-number">443</span>) |
| 1077 |
</div> |
| 1078 |
|
| 1079 |
<!-- ========== Info from phpDoc block ========= --> |
| 1080 |
<p class="short-description">This function is used to set the FRAMSETtag object for this page. This automatically sets the output for this page object to be a frameset.</p> |
| 1081 |
|
| 1082 |
<div class="method-signature"> |
| 1083 |
<span class="method-result">void</span> |
| 1084 |
<span class="method-name"> |
| 1085 |
set_frameset |
| 1086 |
</span> |
| 1087 |
(<span class="var-type"><a href="../phpHtmlLib/FRAMESETtag.html">FRAMESETtag</a></span> <span class="var-name">$frameset</span>) |
| 1088 |
</div> |
| 1089 |
|
| 1090 |
<ul class="parameters"> |
| 1091 |
<li> |
| 1092 |
<span class="var-type"><a href="../phpHtmlLib/FRAMESETtag.html">FRAMESETtag</a></span> |
| 1093 |
<span class="var-name">$frameset</span><span class="var-description">: object - $frameset</span> </li> |
| 1094 |
</ul> |
| 1095 |
|
| 1096 |
|
| 1097 |
</div> |
| 1098 |
<a name="methodset_html_attributes" id="set_html_attributes"><!-- --></a> |
| 1099 |
<div class="oddrow"> |
| 1100 |
|
| 1101 |
<div class="method-header"> |
| 1102 |
<span class="method-title">set_html_attributes</span> (line <span class="line-number">471</span>) |
| 1103 |
</div> |
| 1104 |
|
| 1105 |
<!-- ========== Info from phpDoc block ========= --> |
| 1106 |
<p class="short-description">This function sets the attributes for the <html> tag</p> |
| 1107 |
|
| 1108 |
<div class="method-signature"> |
| 1109 |
<span class="method-result">void</span> |
| 1110 |
<span class="method-name"> |
| 1111 |
set_html_attributes |
| 1112 |
</span> |
| 1113 |
(<span class="var-type">array</span> <span class="var-name">$attributes</span>) |
| 1114 |
</div> |
| 1115 |
|
| 1116 |
<ul class="parameters"> |
| 1117 |
<li> |
| 1118 |
<span class="var-type">array</span> |
| 1119 |
<span class="var-name">$attributes</span><span class="var-description">: - the name=>value pair for the attributes</span> </li> |
| 1120 |
</ul> |
| 1121 |
|
| 1122 |
|
| 1123 |
</div> |
| 1124 |
<a name="methodset_language" id="set_language"><!-- --></a> |
| 1125 |
<div class="evenrow"> |
| 1126 |
|
| 1127 |
<div class="method-header"> |
| 1128 |
<span class="method-title">set_language</span> (line <span class="line-number">430</span>) |
| 1129 |
</div> |
| 1130 |
|
| 1131 |
<!-- ========== Info from phpDoc block ========= --> |
| 1132 |
<p class="short-description">This method sets the lang, and xml:lang setting in the HTML tag.</p> |
| 1133 |
|
| 1134 |
<div class="method-signature"> |
| 1135 |
<span class="method-result">void</span> |
| 1136 |
<span class="method-name"> |
| 1137 |
set_language |
| 1138 |
</span> |
| 1139 |
(<span class="var-type">string</span> <span class="var-name">$language</span>) |
| 1140 |
</div> |
| 1141 |
|
| 1142 |
<ul class="parameters"> |
| 1143 |
<li> |
| 1144 |
<span class="var-type">string</span> |
| 1145 |
<span class="var-name">$language</span><span class="var-description">: - the language</span> </li> |
| 1146 |
</ul> |
| 1147 |
|
| 1148 |
|
| 1149 |
</div> |
| 1150 |
<a name="methodset_refresh" id="set_refresh"><!-- --></a> |
| 1151 |
<div class="oddrow"> |
| 1152 |
|
| 1153 |
<div class="method-header"> |
| 1154 |
<span class="method-title">set_refresh</span> (line <span class="line-number">398</span>) |
| 1155 |
</div> |
| 1156 |
|
| 1157 |
<!-- ========== Info from phpDoc block ========= --> |
| 1158 |
<p class="short-description">Automatically set a page meta tag refresh</p> |
| 1159 |
|
| 1160 |
<div class="method-signature"> |
| 1161 |
<span class="method-result">void</span> |
| 1162 |
<span class="method-name"> |
| 1163 |
set_refresh |
| 1164 |
</span> |
| 1165 |
(<span class="var-type">int</span> <span class="var-name">$time</span>, [<span class="var-type">string</span> <span class="var-name">$url</span> = <span class="var-default">NULL</span>]) |
| 1166 |
</div> |
| 1167 |
|
| 1168 |
<ul class="parameters"> |
| 1169 |
<li> |
| 1170 |
<span class="var-type">int</span> |
| 1171 |
<span class="var-name">$time</span><span class="var-description">: - time in seconds to refresh</span> </li> |
| 1172 |
<li> |
| 1173 |
<span class="var-type">string</span> |
| 1174 |
<span class="var-name">$url</span><span class="var-description">: - the url to go to.</span> </li> |
| 1175 |
</ul> |
| 1176 |
|
| 1177 |
|
| 1178 |
</div> |
| 1179 |
<a name="methodset_text_debug" id="set_text_debug"><!-- --></a> |
| 1180 |
<div class="evenrow"> |
| 1181 |
|
| 1182 |
<div class="method-header"> |
| 1183 |
<span class="method-title">set_text_debug</span> (line <span class="line-number">621</span>) |
| 1184 |
</div> |
| 1185 |
|
| 1186 |
<!-- ========== Info from phpDoc block ========= --> |
| 1187 |
<p class="short-description">set the $_text_debug flag</p> |
| 1188 |
|
| 1189 |
<div class="method-signature"> |
| 1190 |
<span class="method-result">void</span> |
| 1191 |
<span class="method-name"> |
| 1192 |
set_text_debug |
| 1193 |
</span> |
| 1194 |
(<span class="var-type">$flag</span> <span class="var-name">$flag</span>) |
| 1195 |
</div> |
| 1196 |
|
| 1197 |
<ul class="parameters"> |
| 1198 |
<li> |
| 1199 |
<span class="var-type">$flag</span> |
| 1200 |
<span class="var-name">$flag</span><span class="var-description">: - boolean.</span> </li> |
| 1201 |
</ul> |
| 1202 |
|
| 1203 |
|
| 1204 |
</div> |
| 1205 |
<a name="methodset_title" id="set_title"><!-- --></a> |
| 1206 |
<div class="oddrow"> |
| 1207 |
|
| 1208 |
<div class="method-header"> |
| 1209 |
<span class="method-title">set_title</span> (line <span class="line-number">333</span>) |
| 1210 |
</div> |
| 1211 |
|
| 1212 |
<!-- ========== Info from phpDoc block ========= --> |
| 1213 |
<p class="short-description">set the title of the page output.</p> |
| 1214 |
|
| 1215 |
<div class="method-signature"> |
| 1216 |
<span class="method-result">void</span> |
| 1217 |
<span class="method-name"> |
| 1218 |
set_title |
| 1219 |
</span> |
| 1220 |
(<span class="var-type">mixed</span> <span class="var-name">$title</span>) |
| 1221 |
</div> |
| 1222 |
|
| 1223 |
<ul class="parameters"> |
| 1224 |
<li> |
| 1225 |
<span class="var-type">mixed</span> |
| 1226 |
<span class="var-name">$title</span><span class="var-description">: - the title of the html page can be TITLEtag object.</span> </li> |
| 1227 |
</ul> |
| 1228 |
|
| 1229 |
|
| 1230 |
</div> |
| 1231 |
<a name="method_build_content_type_tag" id="_build_content_type_tag"><!-- --></a> |
| 1232 |
<div class="evenrow"> |
| 1233 |
|
| 1234 |
<div class="method-header"> |
| 1235 |
<span class="method-title">_build_content_type_tag</span> (line <span class="line-number">480</span>) |
| 1236 |
</div> |
| 1237 |
|
| 1238 |
<!-- ========== Info from phpDoc block ========= --> |
| 1239 |
<p class="short-description">this builds the content type meta tag.</p> |
| 1240 |
|
| 1241 |
<div class="method-signature"> |
| 1242 |
<span class="method-result">void</span> |
| 1243 |
<span class="method-name"> |
| 1244 |
_build_content_type_tag |
| 1245 |
</span> |
| 1246 |
() |
| 1247 |
</div> |
| 1248 |
|
| 1249 |
|
| 1250 |
|
| 1251 |
</div> |
| 1252 |
<a name="method_build_head" id="_build_head"><!-- --></a> |
| 1253 |
<div class="oddrow"> |
| 1254 |
|
| 1255 |
<div class="method-header"> |
| 1256 |
<span class="method-title">_build_head</span> (line <span class="line-number">634</span>) |
| 1257 |
</div> |
| 1258 |
|
| 1259 |
<!-- ========== Info from phpDoc block ========= --> |
| 1260 |
<p class="short-description">builds the head object and its content.</p> |
| 1261 |
|
| 1262 |
<div class="method-signature"> |
| 1263 |
<span class="method-result">void</span> |
| 1264 |
<span class="method-name"> |
| 1265 |
_build_head |
| 1266 |
</span> |
| 1267 |
() |
| 1268 |
</div> |
| 1269 |
|
| 1270 |
|
| 1271 |
|
| 1272 |
</div> |
| 1273 |
<a name="method_create_body" id="_create_body"><!-- --></a> |
| 1274 |
<div class="evenrow"> |
| 1275 |
|
| 1276 |
<div class="method-header"> |
| 1277 |
<span class="method-title">_create_body</span> (line <span class="line-number">581</span>) |
| 1278 |
</div> |
| 1279 |
|
| 1280 |
<!-- ========== Info from phpDoc block ========= --> |
| 1281 |
<p class="short-description">This is responsible for creating the BODYtag object. We only will create a new $this->_body if it doesn't already exist.</p> |
| 1282 |
|
| 1283 |
<div class="method-signature"> |
| 1284 |
<span class="method-result">void</span> |
| 1285 |
<span class="method-name"> |
| 1286 |
_create_body |
| 1287 |
</span> |
| 1288 |
() |
| 1289 |
</div> |
| 1290 |
|
| 1291 |
|
| 1292 |
|
| 1293 |
</div> |
| 1294 |
<a name="method_frameset_wrap_body" id="_frameset_wrap_body"><!-- --></a> |
| 1295 |
<div class="oddrow"> |
| 1296 |
|
| 1297 |
<div class="method-header"> |
| 1298 |
<span class="method-title">_frameset_wrap_body</span> (line <span class="line-number">674</span>) |
| 1299 |
</div> |
| 1300 |
|
| 1301 |
<!-- ========== Info from phpDoc block ========= --> |
| 1302 |
<p class="short-description">This builds a frameset body tag wrapped in a <noframes> tag.</p> |
| 1303 |
<ul class="tags"> |
| 1304 |
<li><span class="field">return:</span> object.</li> |
| 1305 |
</ul> |
| 1306 |
|
| 1307 |
<div class="method-signature"> |
| 1308 |
<span class="method-result"><a href="../phpHtmlLib/NOFRAMEStag.html">NOFRAMEStag</a></span> |
| 1309 |
<span class="method-name"> |
| 1310 |
_frameset_wrap_body |
| 1311 |
</span> |
| 1312 |
() |
| 1313 |
</div> |
| 1314 |
|
| 1315 |
|
| 1316 |
|
| 1317 |
</div> |
| 1318 |
|
| 1319 |
</div> |
| 1320 |
</div> |
| 1321 |
|
| 1322 |
|
| 1323 |
<p class="notes" id="credit"> |
| 1324 |
Documentation generated on Thu, 1 Apr 2004 09:38:57 -0800 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0RC2</a> |
| 1325 |
</p> |
| 1326 |
</div></body> |
| 1327 |
</html> |
Parent Directory
| 
Revision Log
