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 HTMLRedirectPage</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 |
<h2 class="class-name">Class HTMLRedirectPage</h2> |
13 |
|
14 |
<a name="sec-description"></a> |
15 |
<div class="info-box"> |
16 |
<div class="info-box-title">Description</div> |
17 |
<div class="nav-bar"> |
18 |
<span class="disabled">Description</span> | |
19 |
<a href="#sec-vars">Vars</a> |
20 |
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
21 |
|
22 |
</div> |
23 |
<div class="info-box-body"> |
24 |
<!-- ========== Info from phpDoc block ========= --> |
25 |
<p class="short-description">This builds an entire HTML Page with the sole purpose of doing a redirect to another url.</p> |
26 |
<ul class="tags"> |
27 |
<li><span class="field">author:</span> <p>Walter A. Boring IV <<a href="mailto:waboring@buildabetterweb.com">mailto:waboring@buildabetterweb.com</a>></p></li> |
28 |
</ul> |
29 |
<p class="notes"> |
30 |
Located in <a class="field" href="_widgets_HTMLRedirectPage_inc.html">Program_Root/widgets/HTMLRedirectPage.inc</a> (line <span class="field">19</span>) |
31 |
</p> |
32 |
|
33 |
|
34 |
<pre><a href="../phpHtmlLib/HTMLPageClass.html">HTMLPageClass</a> |
35 |
| |
36 |
--HTMLRedirectPage</pre> |
37 |
|
38 |
</div> |
39 |
</div> |
40 |
|
41 |
|
42 |
|
43 |
<a name="sec-method-summary"></a> |
44 |
<div class="info-box"> |
45 |
<div class="info-box-title">Method Summary</span></div> |
46 |
<div class="nav-bar"> |
47 |
<a href="#sec-description">Description</a> | |
48 |
<a href="#sec-vars">Vars</a> |
49 |
|
50 |
| |
51 |
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>) |
52 |
</div> |
53 |
<div class="info-box-body"> |
54 |
<div class="method-summary"> |
55 |
|
56 |
<div class="method-definition"> |
57 |
<span class="method-result">void</span> |
58 |
<a href="#HTMLRedirectPage" title="details" class="method-name">HTMLRedirectPage</a> |
59 |
(<span class="var-type">string</span> <span class="var-name">$title</span>, <span class="var-type">string</span> <span class="var-name">$url</span>, [<span class="var-type">boolean</span> <span class="var-name">$showMessage</span> = <span class="var-default">false</span>], [<span class="var-type">boolean</span> <span class="var-name">$destroy_frameset</span> = <span class="var-default">FALSE</span>], [<span class="var-type">boolean</span> <span class="var-name">$usejs</span> = <span class="var-default">TRUE</span>]) |
60 |
</div> |
61 |
</div> |
62 |
</div> |
63 |
</div> |
64 |
|
65 |
<a name="sec-vars"></a> |
66 |
<div class="info-box"> |
67 |
<div class="info-box-title">Variables</div> |
68 |
<div class="nav-bar"> |
69 |
<a href="#sec-description">Description</a> | |
70 |
<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>) |
71 |
|
72 |
|
73 |
| |
74 |
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
75 |
|
76 |
</div> |
77 |
<div class="info-box-body"> |
78 |
<h4>Inherited Variables</h4> |
79 |
<A NAME='inherited_vars'><!-- --></A> |
80 |
<p>Inherited from <span class="classname"><a href="../phpHtmlLib/HTMLPageClass.html">HTMLPageClass</a></span></p> |
81 |
<blockquote> |
82 |
<span class="var-title"> |
83 |
<span class="var-name"><a href="../phpHtmlLib/HTMLPageClass.html#var$_html_attributes">HTMLPageClass::$_html_attributes</a></span><br> |
84 |
</span> |
85 |
<span class="var-title"> |
86 |
<span class="var-name"><a href="../phpHtmlLib/HTMLPageClass.html#var$_indent_style">HTMLPageClass::$_indent_style</a></span><br> |
87 |
</span> |
88 |
<span class="var-title"> |
89 |
<span class="var-name"><a href="../phpHtmlLib/HTMLPageClass.html#var$_widget_css_auto">HTMLPageClass::$_widget_css_auto</a></span><br> |
90 |
</span> |
91 |
<span class="var-title"> |
92 |
<span class="var-name"><a href="../phpHtmlLib/HTMLPageClass.html#var$_widget_js_auto">HTMLPageClass::$_widget_js_auto</a></span><br> |
93 |
</span> |
94 |
<span class="var-title"> |
95 |
<span class="var-name"><a href="../phpHtmlLib/HTMLPageClass.html#var$_xml_encoding">HTMLPageClass::$_xml_encoding</a></span><br> |
96 |
</span> |
97 |
</blockquote> |
98 |
|
99 |
</div> |
100 |
</div> |
101 |
|
102 |
<a name="sec-methods"></a> |
103 |
<div class="info-box"> |
104 |
<div class="info-box-title">Methods</div> |
105 |
<div class="nav-bar"> |
106 |
<a href="#sec-description">Description</a> | |
107 |
<a href="#sec-vars">Vars</a> |
108 |
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>) |
109 |
|
110 |
</div> |
111 |
<div class="info-box-body"> |
112 |
<A NAME='method_detail'></A> |
113 |
<a name="methodHTMLRedirectPage" id="HTMLRedirectPage"><!-- --></a> |
114 |
<div class="evenrow"> |
115 |
|
116 |
<div class="method-header"> |
117 |
<span class="method-title">Constructor HTMLRedirectPage</span> (line <span class="line-number">32</span>) |
118 |
</div> |
119 |
|
120 |
<!-- ========== Info from phpDoc block ========= --> |
121 |
<p class="short-description">The constructor</p> |
122 |
|
123 |
<div class="method-signature"> |
124 |
<span class="method-result">void</span> |
125 |
<span class="method-name"> |
126 |
HTMLRedirectPage |
127 |
</span> |
128 |
(<span class="var-type">string</span> <span class="var-name">$title</span>, <span class="var-type">string</span> <span class="var-name">$url</span>, [<span class="var-type">boolean</span> <span class="var-name">$showMessage</span> = <span class="var-default">false</span>], [<span class="var-type">boolean</span> <span class="var-name">$destroy_frameset</span> = <span class="var-default">FALSE</span>], [<span class="var-type">boolean</span> <span class="var-name">$usejs</span> = <span class="var-default">TRUE</span>]) |
129 |
</div> |
130 |
|
131 |
<ul class="parameters"> |
132 |
<li> |
133 |
<span class="var-type">string</span> |
134 |
<span class="var-name">$title</span><span class="var-description">: <p>- the title of the page</p></span> </li> |
135 |
<li> |
136 |
<span class="var-type">string</span> |
137 |
<span class="var-name">$url</span><span class="var-description">: <p>- the url to redirect to</p></span> </li> |
138 |
<li> |
139 |
<span class="var-type">boolean</span> |
140 |
<span class="var-name">$showMessage</span><span class="var-description">: <p>- do we show the fallback message?</p></span> </li> |
141 |
<li> |
142 |
<span class="var-type">boolean</span> |
143 |
<span class="var-name">$destroy_frameset</span><span class="var-description">: <p>- do we want to destroy a frameset with the redirect?</p></span> </li> |
144 |
<li> |
145 |
<span class="var-type">boolean</span> |
146 |
<span class="var-name">$usejs</span><span class="var-description">: <p>- do we want to use a Javascript window.location call?</p></span> </li> |
147 |
</ul> |
148 |
|
149 |
|
150 |
</div> |
151 |
<h4>Inherited Methods</h4> |
152 |
<a name='inherited_methods'><!-- --></a> |
153 |
<!-- =========== Summary =========== --> |
154 |
<p>Inherited From <span class="classname"><a href="../phpHtmlLib/HTMLPageClass.html">HTMLPageClass</a></span></p> |
155 |
<blockquote> |
156 |
<span class="method-name"><a href="../phpHtmlLib/HTMLPageClass.html#methodHTMLPageClass">HTMLPageClass::HTMLPageClass()</a></span><br> |
157 |
<span class="method-name"><a href="../phpHtmlLib/HTMLPageClass.html#methodadd">HTMLPageClass::add()</a></span><br> |
158 |
<span class="method-name"><a href="../phpHtmlLib/HTMLPageClass.html#methodadd_css_link">HTMLPageClass::add_css_link()</a></span><br> |
159 |
<span class="method-name"><a href="../phpHtmlLib/HTMLPageClass.html#methodadd_head_content">HTMLPageClass::add_head_content()</a></span><br> |
160 |
<span class="method-name"><a href="../phpHtmlLib/HTMLPageClass.html#methodadd_head_css">HTMLPageClass::add_head_css()</a></span><br> |
161 |
<span class="method-name"><a href="../phpHtmlLib/HTMLPageClass.html#methodadd_head_js">HTMLPageClass::add_head_js()</a></span><br> |
162 |
<span class="method-name"><a href="../phpHtmlLib/HTMLPageClass.html#methodadd_js_link">HTMLPageClass::add_js_link()</a></span><br> |
163 |
<span class="method-name"><a href="../phpHtmlLib/HTMLPageClass.html#methodadd_reference">HTMLPageClass::add_reference()</a></span><br> |
164 |
<span class="method-name"><a href="../phpHtmlLib/HTMLPageClass.html#methodbuild_doctype">HTMLPageClass::build_doctype()</a></span><br> |
165 |
<span class="method-name"><a href="../phpHtmlLib/HTMLPageClass.html#methodget_html_attributes">HTMLPageClass::get_html_attributes()</a></span><br> |
166 |
<span class="method-name"><a href="../phpHtmlLib/HTMLPageClass.html#methodpush">HTMLPageClass::push()</a></span><br> |
167 |
<span class="method-name"><a href="../phpHtmlLib/HTMLPageClass.html#methodpush_css_link">HTMLPageClass::push_css_link()</a></span><br> |
168 |
<span class="method-name"><a href="../phpHtmlLib/HTMLPageClass.html#methodpush_head_content">HTMLPageClass::push_head_content()</a></span><br> |
169 |
<span class="method-name"><a href="../phpHtmlLib/HTMLPageClass.html#methodpush_head_js">HTMLPageClass::push_head_js()</a></span><br> |
170 |
<span class="method-name"><a href="../phpHtmlLib/HTMLPageClass.html#methodpush_js_link">HTMLPageClass::push_js_link()</a></span><br> |
171 |
<span class="method-name"><a href="../phpHtmlLib/HTMLPageClass.html#methodpush_reference">HTMLPageClass::push_reference()</a></span><br> |
172 |
<span class="method-name"><a href="../phpHtmlLib/HTMLPageClass.html#methodrender">HTMLPageClass::render()</a></span><br> |
173 |
<span class="method-name"><a href="../phpHtmlLib/HTMLPageClass.html#methodset_body_attributes">HTMLPageClass::set_body_attributes()</a></span><br> |
174 |
<span class="method-name"><a href="../phpHtmlLib/HTMLPageClass.html#methodset_charset">HTMLPageClass::set_charset()</a></span><br> |
175 |
<span class="method-name"><a href="../phpHtmlLib/HTMLPageClass.html#methodset_encoding">HTMLPageClass::set_encoding()</a></span><br> |
176 |
<span class="method-name"><a href="../phpHtmlLib/HTMLPageClass.html#methodset_frameset">HTMLPageClass::set_frameset()</a></span><br> |
177 |
<span class="method-name"><a href="../phpHtmlLib/HTMLPageClass.html#methodset_html_attributes">HTMLPageClass::set_html_attributes()</a></span><br> |
178 |
<span class="method-name"><a href="../phpHtmlLib/HTMLPageClass.html#methodset_language">HTMLPageClass::set_language()</a></span><br> |
179 |
<span class="method-name"><a href="../phpHtmlLib/HTMLPageClass.html#methodset_refresh">HTMLPageClass::set_refresh()</a></span><br> |
180 |
<span class="method-name"><a href="../phpHtmlLib/HTMLPageClass.html#methodset_text_debug">HTMLPageClass::set_text_debug()</a></span><br> |
181 |
<span class="method-name"><a href="../phpHtmlLib/HTMLPageClass.html#methodset_title">HTMLPageClass::set_title()</a></span><br> |
182 |
<span class="method-name"><a href="../phpHtmlLib/HTMLPageClass.html#method_build_content_type_tag">HTMLPageClass::_build_content_type_tag()</a></span><br> |
183 |
<span class="method-name"><a href="../phpHtmlLib/HTMLPageClass.html#method_build_head">HTMLPageClass::_build_head()</a></span><br> |
184 |
<span class="method-name"><a href="../phpHtmlLib/HTMLPageClass.html#method_create_body">HTMLPageClass::_create_body()</a></span><br> |
185 |
<span class="method-name"><a href="../phpHtmlLib/HTMLPageClass.html#method_frameset_wrap_body">HTMLPageClass::_frameset_wrap_body()</a></span><br> |
186 |
</blockquote> |
187 |
|
188 |
</div> |
189 |
</div> |
190 |
|
191 |
<p class="notes" id="credit"> |
192 |
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> |
193 |
</p> |
194 |
</div></body> |
195 |
</html> |