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