/[cvs]/nfo/php/libs/com.newsblob.phphtmllib/doc/phpHtmlLib/HTMLPageClass.html
ViewVC logotype

Annotation of /nfo/php/libs/com.newsblob.phphtmllib/doc/phpHtmlLib/HTMLPageClass.html

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.4 - (hide annotations)
Thu May 6 16:24:21 2004 UTC (20 years, 3 months ago) by jonen
Branch: MAIN
CVS Tags: HEAD
Changes since 1.3: +1325 -1208 lines
File MIME type: text/html
 updated all to v2.4.1 - Apr 01, 2004

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

MailToCvsAdmin">MailToCvsAdmin
ViewVC Help
Powered by ViewVC 1.1.26 RSS 2.0 feed