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