1 |
jonen |
1.2 |
<!DOCTYPE HTML PUBLIC '-//W3C//DTD HTML 4.0 Transitional//EN' 'http://www.w3.org/TR/REC-html40/loose.dtd'> |
2 |
jonen |
1.1 |
<!--NewPage--> |
3 |
|
|
<HTML> |
4 |
|
|
<HEAD> |
5 |
jonen |
1.2 |
<!-- Generated by PhpDoc date: 'Thu, 20 Feb 2003 16:23:05 -0800' --> |
6 |
jonen |
1.1 |
<TITLE>Docs for page misc_utils.inc</TITLE> |
7 |
jonen |
1.2 |
<LINK REL ='stylesheet' TYPE='text/css' HREF='../media/stylesheet.css' TITLE='Style'> |
8 |
jonen |
1.1 |
</HEAD> |
9 |
|
|
<BODY style="background-color: #eeeeee; font-family: arial; font-size: .9em;"> |
10 |
|
|
<!-- Links --> |
11 |
|
|
<a NAME="top"></A> |
12 |
|
|
<table WIDTH="100%" class="links"> |
13 |
|
|
<TR> |
14 |
|
|
<TD class="font10"> |
15 |
|
|
Links: |
16 |
|
|
<A HREF="#classes_summary" class="links" title="Classes created in this file">Classes</A> |
17 |
|
|
<A HREF="#includes_summary" class="links" title="Include Statements Summary">Includes</A> |
18 |
jonen |
1.2 |
<A HREF="#global_summary" class="links" title="Global Variable Summary">Globals</A> |
19 |
jonen |
1.1 |
<A HREF="#constant_summary" class="links" title="Constant Summary">Constants</A> |
20 |
jonen |
1.2 |
<A HREF="#function_summary" class="links" title="Function Summary">Functions</A> |
21 |
jonen |
1.1 |
<A HREF="#includes_detail" class="links" title="Include Statements Detail">Includes Detail</A> |
22 |
|
|
<A HREF="#global_detail" class="links" title="Global Variable Detail">Globals Detail</A> |
23 |
|
|
<A HREF="#constant_detail" class="links" title="Constant Detail">Constants Detail</A> |
24 |
|
|
<A HREF="#function_detail" class="links" title="Function Detail">Functions Detail</A> |
25 |
|
|
</TD> |
26 |
|
|
</TR> |
27 |
|
|
</TABLE> |
28 |
|
|
<BR> |
29 |
|
|
<h2>File: Program_Root/tag_utils/misc_utils.inc</h2> |
30 |
jonen |
1.2 |
This file contains miscellaneous functions used by the phpHtmllibs that don't seem to fit in the other files. |
31 |
|
|
<br /> |
32 |
|
|
<p>$Id: _tag_utils_misc_utils_inc.html,v 1.22 2003/02/21 00:44:00 hemna Exp $</p> |
33 |
jonen |
1.1 |
<UL> |
34 |
jonen |
1.2 |
<LI><b>author</b> - <CODE>Walter A. Boring IV <<a href="mailto:waboring@buildabetterweb.com">mailto:waboring@buildabetterweb.com</a>></CODE></LI> |
35 |
|
|
</UL> |
36 |
jonen |
1.1 |
<!-- =========== Used Classes =========== --> |
37 |
|
|
<A NAME='classes_summary'><!-- --></A> |
38 |
jonen |
1.2 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' Class="bordernobottom"> |
39 |
|
|
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
40 |
jonen |
1.1 |
<TD> |
41 |
|
|
<span class="font12bold">Classes defined in this file</span> |
42 |
|
|
<A HREF="#top" CLASS="links">^TOP</A> |
43 |
|
|
</TD> |
44 |
|
|
</TR> |
45 |
|
|
</TABLE> |
46 |
|
|
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
47 |
|
|
<THEAD> |
48 |
|
|
<TR><TD STYLE="width:20%"><h4>CLASS NAME</h4></TD><TD STYLE="width: 80%"><h4>DESCRIPTION</h4></TD></TR> |
49 |
|
|
</THEAD> |
50 |
|
|
<TBODY> |
51 |
jonen |
1.2 |
</TBODY> |
52 |
jonen |
1.1 |
</TABLE> |
53 |
|
|
<br> |
54 |
|
|
<!-- =========== Includes SUMMARY =========== --> |
55 |
|
|
<A NAME='includes_summary'><!-- --></A> |
56 |
|
|
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="bordernobottom"> |
57 |
|
|
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
58 |
|
|
<TD> |
59 |
|
|
<span CLASS="font12bold">Include Statements Summary</span> |
60 |
|
|
<A HREF="#top" CLASS="links">^TOP</A> |
61 |
|
|
</TD> |
62 |
|
|
</TR> |
63 |
|
|
</TABLE> |
64 |
|
|
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
65 |
|
|
<THEAD> |
66 |
|
|
<TR><TH>INCLUDE TYPE</TH><TH>INCLUDED FILENAME</TH><TH>DESCRIPTION</TH></TR> |
67 |
|
|
</THEAD> |
68 |
|
|
<TBODY> |
69 |
jonen |
1.2 |
</TBODY> |
70 |
jonen |
1.1 |
</TABLE> |
71 |
|
|
<br> |
72 |
|
|
<br> |
73 |
jonen |
1.2 |
<!-- =========== GLOBAL VARIABLE SUMMARY =========== --> |
74 |
jonen |
1.1 |
<A NAME='global_summary'><!-- --></A> |
75 |
|
|
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="bordernobottom"> |
76 |
|
|
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
77 |
|
|
<TD> |
78 |
jonen |
1.2 |
<span CLASS="font12bold">Global Variable Summary</span> |
79 |
jonen |
1.1 |
<A HREF="#top" CLASS="links">^TOP</A> |
80 |
|
|
</TD> |
81 |
|
|
</TR> |
82 |
|
|
</TABLE> |
83 |
|
|
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
84 |
|
|
<THEAD> |
85 |
|
|
<TR><TH>VARIABLE NAME</TH><TH>VARIABLE VALUE</TH><TH>DESCRIPTION</TH></TR> |
86 |
|
|
</THEAD> |
87 |
|
|
<TBODY> |
88 |
jonen |
1.2 |
</TBODY> |
89 |
jonen |
1.1 |
</TABLE> |
90 |
|
|
<br> |
91 |
|
|
<br> |
92 |
|
|
<!-- =========== CONSTANT SUMMARY =========== --> |
93 |
|
|
<A NAME='constant_summary'><!-- --></A> |
94 |
jonen |
1.2 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' Class="bordernobottom"> |
95 |
|
|
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
96 |
jonen |
1.1 |
<TD> |
97 |
jonen |
1.2 |
<span class="font12bold">Constant Summary</span> |
98 |
jonen |
1.1 |
<A HREF="#top" CLASS="links">^TOP</A> |
99 |
|
|
</TD> |
100 |
|
|
</TR> |
101 |
|
|
</TABLE> |
102 |
|
|
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
103 |
|
|
<THEAD> |
104 |
|
|
<TR><TH>CONSTANT NAME</TH><TH>CONSTANT VALUE</TH><TH>DESCRIPTION</TH></TR> |
105 |
|
|
</THEAD> |
106 |
|
|
<TBODY> |
107 |
jonen |
1.2 |
</TBODY> |
108 |
jonen |
1.1 |
</TABLE> |
109 |
|
|
<br> |
110 |
|
|
<br> |
111 |
jonen |
1.2 |
<!-- =========== FUNCTION SUMMARY =========== --> |
112 |
|
|
<A NAME='function_summary'><!-- --></A> |
113 |
|
|
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' Class="bordernobottom"> |
114 |
jonen |
1.1 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
115 |
|
|
<TD> |
116 |
|
|
<span class="font12bold">Function Summary</span> |
117 |
|
|
<A HREF="#top" CLASS="links">^TOP</A> |
118 |
|
|
</TD> |
119 |
|
|
</TR> |
120 |
|
|
|
121 |
jonen |
1.2 |
<!-- =========== Summary =========== --> |
122 |
jonen |
1.1 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
123 |
|
|
<TD> |
124 |
jonen |
1.2 |
<CODE><B><A HREF="../phpHtmlLib/_tag_utils_misc_utils_inc.html#functionbuild_spacergif_imgtag"><a href="../phpHtmlLib/IMGtag.html">IMGtag</a> build_spacergif_imgtag ( [$width = 1], [$height = 1], [$img_path = "/images"] )</A></B></CODE> |
125 |
jonen |
1.1 |
<BR> |
126 |
jonen |
1.2 |
<blockquote> This builds an IMG tag object that is used to show a spacer image. </blockquote> |
127 |
jonen |
1.1 |
</TD> |
128 |
|
|
</TR> |
129 |
jonen |
1.2 |
<!-- =========== Summary =========== --> |
130 |
jonen |
1.1 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
131 |
|
|
<TD> |
132 |
jonen |
1.2 |
<CODE><B><A HREF="../phpHtmlLib/_tag_utils_misc_utils_inc.html#functioncdata_wrapper">void cdata_wrapper ( $content )</A></B></CODE> |
133 |
jonen |
1.1 |
<BR> |
134 |
|
|
<blockquote> This function is used to wrap </blockquote> |
135 |
|
|
</TD> |
136 |
|
|
</TR> |
137 |
jonen |
1.2 |
<!-- =========== Summary =========== --> |
138 |
jonen |
1.1 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
139 |
|
|
<TD> |
140 |
jonen |
1.2 |
<CODE><B><A HREF="../phpHtmlLib/_tag_utils_misc_utils_inc.html#functioncontainer"><a href="../phpHtmlLib/ContainerWidget.html">ContainerWidget</a> container ( [0 = - variable # of args] )</A></B></CODE> |
141 |
jonen |
1.1 |
<BR> |
142 |
jonen |
1.2 |
<blockquote> This function creates a new container widget and stuffs all the args into it. </blockquote> |
143 |
jonen |
1.1 |
</TD> |
144 |
|
|
</TR> |
145 |
jonen |
1.2 |
<!-- =========== Summary =========== --> |
146 |
jonen |
1.1 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
147 |
|
|
<TD> |
148 |
jonen |
1.2 |
<CODE><B><A HREF="../phpHtmlLib/_tag_utils_misc_utils_inc.html#functionpush_args"><a href="../phpHtmlLib/HTMLTagClass.html">HTMLTagClass</a> push_args ( $tag_object, $args )</A></B></CODE> |
149 |
jonen |
1.1 |
<BR> |
150 |
jonen |
1.2 |
<blockquote> This function pushes an array of keys into an HTMLTagObject </blockquote> |
151 |
jonen |
1.1 |
</TD> |
152 |
|
|
</TR> |
153 |
jonen |
1.2 |
</TABLE> |
154 |
jonen |
1.1 |
<br> |
155 |
|
|
<!-- ============ Includes DETAIL =========== --> |
156 |
|
|
|
157 |
|
|
<A NAME='includes_detail'></A> |
158 |
|
|
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
159 |
|
|
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
160 |
|
|
<TD> |
161 |
|
|
<span CLASS="font12bold">Include Statements Detail</span> |
162 |
|
|
<A HREF="#top" CLASS="links">^TOP</A> |
163 |
|
|
</TD> |
164 |
|
|
</TR> |
165 |
|
|
</TABLE> |
166 |
|
|
|
167 |
|
|
<br> |
168 |
|
|
<!-- ============ GLOBALS DETAIL =========== --> |
169 |
|
|
|
170 |
|
|
<A NAME='global_detail'></A> |
171 |
jonen |
1.2 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="bordernobottom"> |
172 |
jonen |
1.1 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
173 |
|
|
<TD> |
174 |
|
|
<span CLASS="font12bold">Global Variable Detail</span> |
175 |
|
|
<A HREF="#top" CLASS="links">^TOP</A> |
176 |
|
|
</TD> |
177 |
|
|
</TR> |
178 |
|
|
</TABLE> |
179 |
|
|
|
180 |
|
|
<br> |
181 |
|
|
<!-- ============ CONSTANT DETAIL =========== --> |
182 |
|
|
|
183 |
|
|
<A NAME='constant_detail'></A> |
184 |
jonen |
1.2 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="bordernobottom"> |
185 |
|
|
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
186 |
jonen |
1.1 |
<TD> |
187 |
|
|
<span CLASS="font12bold">Constant Detail</span> |
188 |
|
|
<A HREF="#top" CLASS="links">^TOP</A> |
189 |
|
|
</TD> |
190 |
|
|
</TR> |
191 |
|
|
</TABLE> |
192 |
|
|
|
193 |
|
|
<br> |
194 |
|
|
<!-- ============ FUNCTION DETAIL =========== --> |
195 |
|
|
|
196 |
|
|
<A NAME='function_detail'></A> |
197 |
jonen |
1.2 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="bordernobottom"> |
198 |
jonen |
1.1 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
199 |
|
|
<TD> |
200 |
|
|
<span class="font12bold">Function Detail</span> |
201 |
|
|
<A HREF="#top" CLASS="links">^TOP</A> |
202 |
|
|
</TD> |
203 |
|
|
</TR> |
204 |
|
|
</TABLE> |
205 |
|
|
<BR> |
206 |
|
|
|
207 |
|
|
<DIV CLASS="function"> |
208 |
jonen |
1.2 |
<A NAME="functionbuild_spacergif_imgtag"><!-- --></A> |
209 |
|
|
<SPAN CLASS="font12bold">build_spacergif_imgtag</SPAN> (line <span class="linenumber">28</span>) |
210 |
jonen |
1.1 |
<BR> |
211 |
jonen |
1.2 |
<SPAN CLASS="font10bold">Usage : </SPAN> |
212 |
jonen |
1.1 |
<span class="font10bold" style="color: #FF0000"><a href="../phpHtmlLib/IMGtag.html">IMGtag</a></SPAN> |
213 |
jonen |
1.2 |
<span class="font10bold" style="color: #0000FF">build_spacergif_imgtag( |
214 |
|
|
[int $width = 1], [int $height = 1], [string $img_path = "/images"])</SPAN> |
215 |
jonen |
1.1 |
<BR> |
216 |
|
|
<BR> |
217 |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
218 |
jonen |
1.2 |
This builds an IMG tag object that is used to show a spacer image. |
219 |
|
|
<br /> |
220 |
|
|
<p><img src="spacer.gif" width="$width" height="$height"></p> |
221 |
jonen |
1.1 |
<DL> |
222 |
jonen |
1.2 |
<DT class="font10bold">Function Parameters:</DT> |
223 |
|
|
<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">$width</SPAN></SPAN> - the width of the img ( DEFAULT : 1)</DD> |
224 |
|
|
<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">$height</SPAN></SPAN> - the height of the img ( DEFAULT : 1)</DD> |
225 |
|
|
<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">$img_path</SPAN></SPAN> - The dir that holds the spacer.gif file. ( DEFAULT = "/images" )</DD> |
226 |
|
|
|
227 |
|
|
<DT class="font10bold">Function Info:</DT> |
228 |
|
|
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>return</b> - object.</DD> |
229 |
|
|
</DL> |
230 |
jonen |
1.1 |
</DIV> |
231 |
|
|
<BR> |
232 |
|
|
|
233 |
|
|
<DIV CLASS="function"> |
234 |
jonen |
1.2 |
<A NAME="functioncdata_wrapper"><!-- --></A> |
235 |
|
|
<SPAN CLASS="font12bold">cdata_wrapper</SPAN> (line <span class="linenumber">81</span>) |
236 |
jonen |
1.1 |
<BR> |
237 |
jonen |
1.2 |
<SPAN CLASS="font10bold">Usage : </SPAN> |
238 |
jonen |
1.1 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
239 |
jonen |
1.2 |
<span class="font10bold" style="color: #0000FF">cdata_wrapper( |
240 |
|
|
string $content)</SPAN> |
241 |
jonen |
1.1 |
<BR> |
242 |
|
|
<BR> |
243 |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
244 |
|
|
This function is used to wrap |
245 |
jonen |
1.2 |
<br /> |
246 |
|
|
<p>a string in the standard CDATA section wrapper for a tag content</p><p><![CDATA[ CONTENT ]]></p> |
247 |
jonen |
1.1 |
<DL> |
248 |
jonen |
1.2 |
<DT class="font10bold">Function Parameters:</DT> |
249 |
|
|
<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">$content</SPAN></SPAN> the content to wrap</DD> |
250 |
|
|
|
251 |
|
|
<DT class="font10bold">Function Info:</DT> |
252 |
|
|
</DL> |
253 |
jonen |
1.1 |
</DIV> |
254 |
|
|
<BR> |
255 |
|
|
|
256 |
|
|
<DIV CLASS="function"> |
257 |
jonen |
1.2 |
<A NAME="functioncontainer"><!-- --></A> |
258 |
|
|
<SPAN CLASS="font12bold">container</SPAN> (line <span class="linenumber">60</span>) |
259 |
jonen |
1.1 |
<BR> |
260 |
jonen |
1.2 |
<SPAN CLASS="font10bold">Usage : </SPAN> |
261 |
jonen |
1.1 |
<span class="font10bold" style="color: #FF0000"><a href="../phpHtmlLib/ContainerWidget.html">ContainerWidget</a></SPAN> |
262 |
jonen |
1.2 |
<span class="font10bold" style="color: #0000FF">container( |
263 |
|
|
[mixed 0 = - variable # of args])</SPAN> |
264 |
jonen |
1.1 |
<BR> |
265 |
|
|
<BR> |
266 |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
267 |
jonen |
1.2 |
This function creates a new container widget and stuffs all the args into it. |
268 |
|
|
<br /> |
269 |
jonen |
1.1 |
|
270 |
|
|
<DL> |
271 |
jonen |
1.2 |
<DT class="font10bold">Function Parameters:</DT> |
272 |
|
|
<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> - variable # of args</DD> |
273 |
|
|
|
274 |
|
|
<DT class="font10bold">Function Info:</DT> |
275 |
|
|
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>return</b> - object</DD> |
276 |
|
|
</DL> |
277 |
jonen |
1.1 |
</DIV> |
278 |
|
|
<BR> |
279 |
|
|
|
280 |
|
|
<DIV CLASS="function"> |
281 |
jonen |
1.2 |
<A NAME="functionpush_args"><!-- --></A> |
282 |
|
|
<SPAN CLASS="font12bold">push_args</SPAN> (line <span class="linenumber">44</span>) |
283 |
jonen |
1.1 |
<BR> |
284 |
jonen |
1.2 |
<SPAN CLASS="font10bold">Usage : </SPAN> |
285 |
jonen |
1.1 |
<span class="font10bold" style="color: #FF0000"><a href="../phpHtmlLib/HTMLTagClass.html">HTMLTagClass</a></SPAN> |
286 |
jonen |
1.2 |
<span class="font10bold" style="color: #0000FF">push_args( |
287 |
|
|
object $tag_object, array $args)</SPAN> |
288 |
jonen |
1.1 |
<BR> |
289 |
|
|
<BR> |
290 |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
291 |
jonen |
1.2 |
This function pushes an array of keys into an HTMLTagObject |
292 |
|
|
<br /> |
293 |
jonen |
1.1 |
|
294 |
|
|
<DL> |
295 |
jonen |
1.2 |
<DT class="font10bold">Function Parameters:</DT> |
296 |
|
|
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">object</SPAN> <span style="color: #0000FF;font-weight:bold">$tag_object</SPAN></SPAN> - the HTMLTagClass object.</DD> |
297 |
|
|
<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">$args</SPAN></SPAN> - the array of data to push array("blah", "foo", "bar");</DD> |
298 |
|
|
|
299 |
|
|
<DT class="font10bold">Function Info:</DT> |
300 |
|
|
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>return</b> - object.</DD> |
301 |
|
|
</DL> |
302 |
jonen |
1.1 |
</DIV> |
303 |
|
|
<BR> |
304 |
|
|
<br> |
305 |
jonen |
1.2 |
<div id="credit"> |
306 |
|
|
<hr> |
307 |
|
|
Documention generated on Thu, 20 Feb 2003 16:23:05 -0800 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.0rc1</a> |
308 |
|
|
</div> |
309 |
|
|
</body> |
310 |
|
|
</html> |
311 |
|
|
</HTML> |