| 1 |
<!DOCTYPE HTML PUBLIC '-//W3C//DTD HTML 4.0 Frameset//EN''http://www.w3.org/TR/REC-html40/frameset.dtd'> |
| 2 |
<!--NewPage--> |
| 3 |
<HTML> |
| 4 |
<HEAD> |
| 5 |
<!-- Generated by PhpDoc date: 'Mon, 25 Nov 2002 09:21:32 -0800' --> |
| 6 |
<TITLE>Docs for page misc_utils.inc</TITLE> |
| 7 |
<LINK REL ='stylesheet' TYPE='text/css' HREF='stylesheet.css' TITLE='Style'> |
| 8 |
</HEAD> |
| 9 |
<BODY style="background-color: #eeeeee; font-family: arial; font-size: .9em;"> |
| 10 |
|
| 11 |
|
| 12 |
<!-- Links --> |
| 13 |
<a NAME="top"></A> |
| 14 |
<table WIDTH="100%" class="links"> |
| 15 |
<TR> |
| 16 |
<TD class="font10"> |
| 17 |
Links: |
| 18 |
<A HREF="#classes_summary" class="links" title="Classes created in this file">Classes</A> |
| 19 |
<A HREF="#includes_summary" class="links" title="Include Statements Summary">Includes</A> |
| 20 |
<A HREF="#globals_summary" class="links" title="Global Variable Summary">Globals</A> |
| 21 |
<A HREF="#constant_summary" class="links" title="Constant Summary">Constants</A> |
| 22 |
<A HREF="#functions_summary" class="links" title="Function Summary">Functions</A> |
| 23 |
<A HREF="#includes_detail" class="links" title="Include Statements Detail">Includes Detail</A> |
| 24 |
<A HREF="#global_detail" class="links" title="Global Variable Detail">Globals Detail</A> |
| 25 |
<A HREF="#constant_detail" class="links" title="Constant Detail">Constants Detail</A> |
| 26 |
<A HREF="#function_detail" class="links" title="Function Detail">Functions Detail</A> |
| 27 |
</TD> |
| 28 |
</TR> |
| 29 |
</TABLE> |
| 30 |
<BR> |
| 31 |
|
| 32 |
<h2>File: Program_Root/tag_utils/misc_utils.inc</h2> |
| 33 |
<!-- ========== Info from phpDoc block ========= --> |
| 34 |
This file contains miscellaneous functions |
| 35 |
used by the phpHtmllibs that don't seem to |
| 36 |
fit in the other files. |
| 37 |
<BR> |
| 38 |
$Id: _tag_utils_misc_utils_inc.html,v 1.20 2002/11/25 17:56:10 hemna Exp $ |
| 39 |
|
| 40 |
<UL> |
| 41 |
|
| 42 |
<LI><b>Package</b> - <CODE>phpHtmlLib</CODE></LI> |
| 43 |
|
| 44 |
<LI><b>Author</b> - <CODE>Walter A. Boring IV <<a href="mailto:waboring@buildabetterweb.com">waboring@buildabetterweb.com</a>></CODE></LI> |
| 45 |
|
| 46 |
</UL> |
| 47 |
|
| 48 |
<br> |
| 49 |
<!-- =========== Used Classes =========== --> |
| 50 |
<A NAME='classes_summary'><!-- --></A> |
| 51 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="bordernobottom"> |
| 52 |
<TR CLASS='TableHeadingColor'> |
| 53 |
<TD> |
| 54 |
<span class="font12bold">Classes defined in this file</span> |
| 55 |
<A HREF="#top" CLASS="links">^TOP</A> |
| 56 |
</TD> |
| 57 |
</TR> |
| 58 |
</TABLE> |
| 59 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
| 60 |
<THEAD> |
| 61 |
<TR><TD STYLE="width:20%"><h4>CLASS NAME</h4></TD><TD STYLE="width: 80%"><h4>DESCRIPTION</h4></TD></TR> |
| 62 |
</THEAD> |
| 63 |
<TBODY> |
| 64 |
|
| 65 |
</TBODY> |
| 66 |
</TABLE> |
| 67 |
<br> |
| 68 |
<br> |
| 69 |
<!-- =========== Includes SUMMARY =========== --> |
| 70 |
<A NAME='includes_summary'><!-- --></A> |
| 71 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="bordernobottom"> |
| 72 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
| 73 |
<TD> |
| 74 |
<span CLASS="font12bold">Include Statements Summary</span> |
| 75 |
<A HREF="#top" CLASS="links">^TOP</A> |
| 76 |
</TD> |
| 77 |
</TR> |
| 78 |
</TABLE> |
| 79 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
| 80 |
<THEAD> |
| 81 |
<TR><TH>INCLUDE TYPE</TH><TH>INCLUDED FILENAME</TH><TH>DESCRIPTION</TH></TR> |
| 82 |
</THEAD> |
| 83 |
<TBODY> |
| 84 |
|
| 85 |
</TBODY> |
| 86 |
</TABLE> |
| 87 |
<br> |
| 88 |
|
| 89 |
<br> |
| 90 |
<!-- =========== CONSTANT SUMMARY =========== --> |
| 91 |
<A NAME='global_summary'><!-- --></A> |
| 92 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="bordernobottom"> |
| 93 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
| 94 |
<TD> |
| 95 |
<FONT SIZE='+2'><B>Global Variable Summary</B></FONT> |
| 96 |
<A HREF="#top" CLASS="links">^TOP</A> |
| 97 |
</TD> |
| 98 |
</TR> |
| 99 |
</TABLE> |
| 100 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
| 101 |
<THEAD> |
| 102 |
<TR><TH>VARIABLE NAME</TH><TH>VARIABLE VALUE</TH><TH>DESCRIPTION</TH></TR> |
| 103 |
</THEAD> |
| 104 |
<TBODY> |
| 105 |
|
| 106 |
</TBODY> |
| 107 |
</TABLE> |
| 108 |
<br> |
| 109 |
|
| 110 |
|
| 111 |
<br> |
| 112 |
<!-- =========== CONSTANT SUMMARY =========== --> |
| 113 |
<A NAME='constant_summary'><!-- --></A> |
| 114 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="bordernobottom"> |
| 115 |
<TR CLASS='TableHeadingColor'> |
| 116 |
<TD> |
| 117 |
<span CLASS="font12bold">Constant Summary</span> |
| 118 |
<A HREF="#top" CLASS="links">^TOP</A> |
| 119 |
</TD> |
| 120 |
</TR> |
| 121 |
</TABLE> |
| 122 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
| 123 |
<THEAD> |
| 124 |
<TR><TH>CONSTANT NAME</TH><TH>CONSTANT VALUE</TH><TH>DESCRIPTION</TH></TR> |
| 125 |
</THEAD> |
| 126 |
<TBODY> |
| 127 |
|
| 128 |
</TBODY> |
| 129 |
</TABLE> |
| 130 |
<br> |
| 131 |
|
| 132 |
<br> |
| 133 |
<!-- =========== Function SUMMARY =========== --> |
| 134 |
<A NAME='Function_summary'><!-- --></A> |
| 135 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' Class="border"> |
| 136 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
| 137 |
<TD> |
| 138 |
<span class="font12bold">Function Summary</span> |
| 139 |
<A HREF="#top" CLASS="links">^TOP</A> |
| 140 |
</TD> |
| 141 |
</TR> |
| 142 |
|
| 143 |
|
| 144 |
<!-- =========== Summary =========== --> |
| 145 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
| 146 |
<TD> |
| 147 |
<CODE><B><A HREF='_tag_utils_misc_utils_inc.html#build_spacergif_imgtag'>IMGtag build_spacergif_imgtag ( [$width = 1], [$height = 1], [$img_path = "/images"] )</A></B></CODE> |
| 148 |
<BR> |
| 149 |
<blockquote> This builds an IMG tag object that is used |
| 150 |
to show a spacer image. </blockquote> |
| 151 |
</TD> |
| 152 |
</TR> |
| 153 |
|
| 154 |
<!-- =========== Summary =========== --> |
| 155 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
| 156 |
<TD> |
| 157 |
<CODE><B><A HREF='_tag_utils_misc_utils_inc.html#cdata_wrapper'> cdata_wrapper ( $content )</A></B></CODE> |
| 158 |
<BR> |
| 159 |
<blockquote> This function is used to wrap </blockquote> |
| 160 |
</TD> |
| 161 |
</TR> |
| 162 |
|
| 163 |
<!-- =========== Summary =========== --> |
| 164 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
| 165 |
<TD> |
| 166 |
<CODE><B><A HREF='_tag_utils_misc_utils_inc.html#container'>ContainerWidget container ( [0 = - variable # of args] )</A></B></CODE> |
| 167 |
<BR> |
| 168 |
<blockquote> This function creates a new container widget |
| 169 |
and stuffs all the args into it. </blockquote> |
| 170 |
</TD> |
| 171 |
</TR> |
| 172 |
|
| 173 |
<!-- =========== Summary =========== --> |
| 174 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
| 175 |
<TD> |
| 176 |
<CODE><B><A HREF='_tag_utils_misc_utils_inc.html#push_args'>HTMLTagClass push_args ( $tag_object, $args )</A></B></CODE> |
| 177 |
<BR> |
| 178 |
<blockquote> This function pushes an array of keys |
| 179 |
into an HTMLTagObject </blockquote> |
| 180 |
</TD> |
| 181 |
</TR> |
| 182 |
|
| 183 |
</TABLE> |
| 184 |
|
| 185 |
<br> |
| 186 |
<!-- ============ Includes DETAIL =========== --> |
| 187 |
|
| 188 |
<A NAME='includes_detail'></A> |
| 189 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
| 190 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
| 191 |
<TD> |
| 192 |
<span CLASS="font12bold">Include Statements Detail</span> |
| 193 |
<A HREF="#top" CLASS="links">^TOP</A> |
| 194 |
</TD> |
| 195 |
</TR> |
| 196 |
</TABLE> |
| 197 |
|
| 198 |
|
| 199 |
|
| 200 |
<br> |
| 201 |
<!-- ============ GLOBALS DETAIL =========== --> |
| 202 |
|
| 203 |
<A NAME='global_detail'></A> |
| 204 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
| 205 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
| 206 |
<TD> |
| 207 |
<span CLASS="font12bold">Global Variable Detail</span> |
| 208 |
<A HREF="#top" CLASS="links">^TOP</A> |
| 209 |
</TD> |
| 210 |
</TR> |
| 211 |
</TABLE> |
| 212 |
|
| 213 |
|
| 214 |
|
| 215 |
<br> |
| 216 |
<!-- ============ CONSTANT DETAIL =========== --> |
| 217 |
|
| 218 |
<A NAME='constant_detail'></A> |
| 219 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
| 220 |
<TR CLASS='TableHeadingColor'> |
| 221 |
<TD> |
| 222 |
<span CLASS="font12bold">Constant Detail</span> |
| 223 |
<A HREF="#top" CLASS="links">^TOP</A> |
| 224 |
</TD> |
| 225 |
</TR> |
| 226 |
</TABLE> |
| 227 |
|
| 228 |
|
| 229 |
|
| 230 |
<br> |
| 231 |
<!-- ============ FUNCTION DETAIL =========== --> |
| 232 |
|
| 233 |
<A NAME='function_detail'></A> |
| 234 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
| 235 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
| 236 |
<TD> |
| 237 |
<span class="font12bold">Function Detail</span> |
| 238 |
<A HREF="#top" CLASS="links">^TOP</A> |
| 239 |
</TD> |
| 240 |
</TR> |
| 241 |
</TABLE> |
| 242 |
<BR> |
| 243 |
|
| 244 |
<DIV CLASS="function"> |
| 245 |
<A NAME='build_spacergif_imgtag'><!-- --></A> |
| 246 |
<SPAN CLASS="font12bold">build_spacergif_imgtag</SPAN> |
| 247 |
<BR> |
| 248 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
| 249 |
<span class="font10bold" style="color: #FF0000"><a href="../phpHtmlLib/IMGtag.html">IMGtag</a></SPAN> |
| 250 |
<span class="font10bold" style="color: #0000FF">build_spacergif_imgtag ( [$width = 1], [$height = 1], [$img_path = "/images"] )</SPAN> |
| 251 |
<BR> |
| 252 |
|
| 253 |
<BR> |
| 254 |
<SPAN CLASS="font10bold">Description : </SPAN> |
| 255 |
<!-- ========== Info from phpDoc block ========= --> |
| 256 |
This builds an IMG tag object that is used |
| 257 |
to show a spacer image. |
| 258 |
<BR> |
| 259 |
<img src="spacer.gif" width="$width" height="$height"> |
| 260 |
<DL> |
| 261 |
<DT class="font10bold">Function Parameters:</DT> |
| 262 |
|
| 263 |
<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 |
| 264 |
( DEFAULT : 1)</DD> |
| 265 |
|
| 266 |
<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 |
| 267 |
( DEFAULT : 1)</DD> |
| 268 |
|
| 269 |
<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. |
| 270 |
( DEFAULT = "/images" )</DD> |
| 271 |
|
| 272 |
|
| 273 |
<DT class="font10bold">Function Info:</DT> |
| 274 |
|
| 275 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - object.</DD> |
| 276 |
|
| 277 |
</DL> |
| 278 |
|
| 279 |
</DIV> |
| 280 |
<BR> |
| 281 |
|
| 282 |
<DIV CLASS="function"> |
| 283 |
<A NAME='cdata_wrapper'><!-- --></A> |
| 284 |
<SPAN CLASS="font12bold">cdata_wrapper</SPAN> |
| 285 |
<BR> |
| 286 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
| 287 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
| 288 |
<span class="font10bold" style="color: #0000FF">cdata_wrapper ( $content )</SPAN> |
| 289 |
<BR> |
| 290 |
|
| 291 |
<BR> |
| 292 |
<SPAN CLASS="font10bold">Description : </SPAN> |
| 293 |
<!-- ========== Info from phpDoc block ========= --> |
| 294 |
This function is used to wrap |
| 295 |
<BR> |
| 296 |
a string in the standard |
| 297 |
CDATA section wrapper for a |
| 298 |
tag content |
| 299 |
|
| 300 |
<![CDATA[ CONTENT ]]> |
| 301 |
<DL> |
| 302 |
<DT class="font10bold">Function Parameters:</DT> |
| 303 |
|
| 304 |
<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> |
| 305 |
|
| 306 |
|
| 307 |
<DT class="font10bold">Function Info:</DT> |
| 308 |
|
| 309 |
</DL> |
| 310 |
|
| 311 |
</DIV> |
| 312 |
<BR> |
| 313 |
|
| 314 |
<DIV CLASS="function"> |
| 315 |
<A NAME='container'><!-- --></A> |
| 316 |
<SPAN CLASS="font12bold">container</SPAN> |
| 317 |
<BR> |
| 318 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
| 319 |
<span class="font10bold" style="color: #FF0000"><a href="../phpHtmlLib/ContainerWidget.html">ContainerWidget</a></SPAN> |
| 320 |
<span class="font10bold" style="color: #0000FF">container ( [0 = - variable # of args] )</SPAN> |
| 321 |
<BR> |
| 322 |
|
| 323 |
<BR> |
| 324 |
<SPAN CLASS="font10bold">Description : </SPAN> |
| 325 |
<!-- ========== Info from phpDoc block ========= --> |
| 326 |
This function creates a new container widget |
| 327 |
and stuffs all the args into it. |
| 328 |
<BR> |
| 329 |
|
| 330 |
<DL> |
| 331 |
<DT class="font10bold">Function Parameters:</DT> |
| 332 |
|
| 333 |
<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> |
| 334 |
|
| 335 |
|
| 336 |
<DT class="font10bold">Function Info:</DT> |
| 337 |
|
| 338 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - object</DD> |
| 339 |
|
| 340 |
</DL> |
| 341 |
|
| 342 |
</DIV> |
| 343 |
<BR> |
| 344 |
|
| 345 |
<DIV CLASS="function"> |
| 346 |
<A NAME='push_args'><!-- --></A> |
| 347 |
<SPAN CLASS="font12bold">push_args</SPAN> |
| 348 |
<BR> |
| 349 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
| 350 |
<span class="font10bold" style="color: #FF0000"><a href="../phpHtmlLib/HTMLTagClass.html">HTMLTagClass</a></SPAN> |
| 351 |
<span class="font10bold" style="color: #0000FF">push_args ( $tag_object, $args )</SPAN> |
| 352 |
<BR> |
| 353 |
|
| 354 |
<BR> |
| 355 |
<SPAN CLASS="font10bold">Description : </SPAN> |
| 356 |
<!-- ========== Info from phpDoc block ========= --> |
| 357 |
This function pushes an array of keys |
| 358 |
into an HTMLTagObject |
| 359 |
<BR> |
| 360 |
|
| 361 |
<DL> |
| 362 |
<DT class="font10bold">Function Parameters:</DT> |
| 363 |
|
| 364 |
<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> |
| 365 |
|
| 366 |
<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 |
| 367 |
array("blah", "foo", "bar");</DD> |
| 368 |
|
| 369 |
|
| 370 |
<DT class="font10bold">Function Info:</DT> |
| 371 |
|
| 372 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - object.</DD> |
| 373 |
|
| 374 |
</DL> |
| 375 |
|
| 376 |
</DIV> |
| 377 |
<BR> |
| 378 |
|
| 379 |
|
| 380 |
<br> |
| 381 |
</HTML> |
Parent Directory
| 
Revision Log
