| 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 page misc_utils.inc</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="file-name">Program_Root/tag_utils/misc_utils.inc</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-functions">Functions</a> |
| 20 |
</div> |
| 21 |
<div class="info-box-body"> |
| 22 |
<!-- ========== Info from phpDoc block ========= --> |
| 23 |
<p class="short-description">This file contains miscellaneous functions used by the phpHtmllibs that don't seem to fit in the other files.</p> |
| 24 |
<p class="description"><p>$Id: _tag_utils_misc_utils_inc.html,v 1.34 2003/08/01 01:37:37 hemna Exp $</p></p> |
| 25 |
<ul class="tags"> |
| 26 |
<li><span class="field">author:</span> <p>Walter A. Boring IV <<a href="mailto:waboring@buildabetterweb.com">mailto:waboring@buildabetterweb.com</a>></p></li> |
| 27 |
</ul> |
| 28 |
|
| 29 |
</div> |
| 30 |
</div> |
| 31 |
|
| 32 |
|
| 33 |
|
| 34 |
|
| 35 |
|
| 36 |
<a name="sec-functions"></a> |
| 37 |
<div class="info-box"> |
| 38 |
<div class="info-box-title">Functions</div> |
| 39 |
<div class="nav-bar"> |
| 40 |
<a href="#sec-description">Description</a> | |
| 41 |
<span class="disabled">Functions</span> |
| 42 |
</div> |
| 43 |
<div class="info-box-body"> |
| 44 |
<a name="functionbuild_spacergif_imgtag" id="functionbuild_spacergif_imgtag"><!-- --></a> |
| 45 |
<div class="oddrow"> |
| 46 |
|
| 47 |
<div> |
| 48 |
<span class="method-title">build_spacergif_imgtag</span> (line <span class="line-number">28</span>) |
| 49 |
</div> |
| 50 |
|
| 51 |
<!-- ========== Info from phpDoc block ========= --> |
| 52 |
<p class="short-description">This builds an IMG tag object that is used to show a spacer image.</p> |
| 53 |
<p class="description"><p><img src="spacer.gif" width="$width" height="$height"></p></p> |
| 54 |
<ul class="tags"> |
| 55 |
<li><span class="field">return:</span> <p>object.</p></li> |
| 56 |
</ul> |
| 57 |
|
| 58 |
<div class="method-signature"> |
| 59 |
<span class="method-result"><a href="../phpHtmlLib/IMGtag.html">IMGtag</a></span> |
| 60 |
<span class="method-name"> |
| 61 |
build_spacergif_imgtag |
| 62 |
</span> |
| 63 |
([<span class="var-type">int</span> <span class="var-name">$width</span> = <span class="var-default">1</span>], [<span class="var-type">int</span> <span class="var-name">$height</span> = <span class="var-default">1</span>], [<span class="var-type">string</span> <span class="var-name">$img_path</span> = <span class="var-default">"/images"</span>]) |
| 64 |
</div> |
| 65 |
|
| 66 |
<ul class="parameters"> |
| 67 |
<li> |
| 68 |
<span class="var-type">int</span> |
| 69 |
<span class="var-name">$width</span><span class="var-description">: <p>- the width of the img ( DEFAULT : 1)</p></span> </li> |
| 70 |
<li> |
| 71 |
<span class="var-type">int</span> |
| 72 |
<span class="var-name">$height</span><span class="var-description">: <p>- the height of the img ( DEFAULT : 1)</p></span> </li> |
| 73 |
<li> |
| 74 |
<span class="var-type">string</span> |
| 75 |
<span class="var-name">$img_path</span><span class="var-description">: <p>- The dir that holds the spacer.gif file. ( DEFAULT = "/images" )</p></span> </li> |
| 76 |
</ul> |
| 77 |
|
| 78 |
|
| 79 |
</div> |
| 80 |
<a name="functioncdata_wrapper" id="functioncdata_wrapper"><!-- --></a> |
| 81 |
<div class="evenrow"> |
| 82 |
|
| 83 |
<div> |
| 84 |
<span class="method-title">cdata_wrapper</span> (line <span class="line-number">81</span>) |
| 85 |
</div> |
| 86 |
|
| 87 |
<!-- ========== Info from phpDoc block ========= --> |
| 88 |
<p class="short-description">This function is used to wrap</p> |
| 89 |
<p class="description"><p>a string in the standard CDATA section wrapper for a tag content</p><p><![CDATA[ CONTENT ]]></p></p> |
| 90 |
|
| 91 |
<div class="method-signature"> |
| 92 |
<span class="method-result">void</span> |
| 93 |
<span class="method-name"> |
| 94 |
cdata_wrapper |
| 95 |
</span> |
| 96 |
(<span class="var-type">string</span> <span class="var-name">$content</span>) |
| 97 |
</div> |
| 98 |
|
| 99 |
<ul class="parameters"> |
| 100 |
<li> |
| 101 |
<span class="var-type">string</span> |
| 102 |
<span class="var-name">$content</span><span class="var-description">: <p>the content to wrap</p></span> </li> |
| 103 |
</ul> |
| 104 |
|
| 105 |
|
| 106 |
</div> |
| 107 |
<a name="functioncontainer" id="functioncontainer"><!-- --></a> |
| 108 |
<div class="oddrow"> |
| 109 |
|
| 110 |
<div> |
| 111 |
<span class="method-title">container</span> (line <span class="line-number">60</span>) |
| 112 |
</div> |
| 113 |
|
| 114 |
<!-- ========== Info from phpDoc block ========= --> |
| 115 |
<p class="short-description">This function creates a new container widget and stuffs all the args into it.</p> |
| 116 |
<ul class="tags"> |
| 117 |
<li><span class="field">return:</span> <p>object</p></li> |
| 118 |
</ul> |
| 119 |
|
| 120 |
<div class="method-signature"> |
| 121 |
<span class="method-result"><a href="../phpHtmlLib/ContainerWidget.html">ContainerWidget</a></span> |
| 122 |
<span class="method-name"> |
| 123 |
container |
| 124 |
</span> |
| 125 |
([<span class="var-type">mixed</span> <span class="var-name">0</span> = <span class="var-default">- variable # of args</span>]) |
| 126 |
</div> |
| 127 |
|
| 128 |
<ul class="parameters"> |
| 129 |
<li> |
| 130 |
<span class="var-type">mixed</span> |
| 131 |
<span class="var-name">0</span><span class="var-description">: <p>- variable # of args</p></span> </li> |
| 132 |
</ul> |
| 133 |
|
| 134 |
|
| 135 |
</div> |
| 136 |
<a name="functionpush_args" id="functionpush_args"><!-- --></a> |
| 137 |
<div class="evenrow"> |
| 138 |
|
| 139 |
<div> |
| 140 |
<span class="method-title">push_args</span> (line <span class="line-number">44</span>) |
| 141 |
</div> |
| 142 |
|
| 143 |
<!-- ========== Info from phpDoc block ========= --> |
| 144 |
<p class="short-description">This function pushes an array of keys into an HTMLTagObject</p> |
| 145 |
<ul class="tags"> |
| 146 |
<li><span class="field">return:</span> <p>object.</p></li> |
| 147 |
</ul> |
| 148 |
|
| 149 |
<div class="method-signature"> |
| 150 |
<span class="method-result"><a href="../phpHtmlLib/HTMLTagClass.html">HTMLTagClass</a></span> |
| 151 |
<span class="method-name"> |
| 152 |
push_args |
| 153 |
</span> |
| 154 |
(<span class="var-type">object -</span> <span class="var-name">$tag_object</span>, <span class="var-type">array</span> <span class="var-name">$args</span>) |
| 155 |
</div> |
| 156 |
|
| 157 |
<ul class="parameters"> |
| 158 |
<li> |
| 159 |
<span class="var-type">object -</span> |
| 160 |
<span class="var-name">$tag_object</span><span class="var-description">: <p>the HTMLTagClass object.</p></span> </li> |
| 161 |
<li> |
| 162 |
<span class="var-type">array</span> |
| 163 |
<span class="var-name">$args</span><span class="var-description">: <p>- the array of data to push array("blah", "foo", "bar");</p></span> </li> |
| 164 |
</ul> |
| 165 |
|
| 166 |
|
| 167 |
</div> |
| 168 |
</div> |
| 169 |
</div> |
| 170 |
|
| 171 |
<p class="notes" id="credit"> |
| 172 |
Documention generated on Thu, 31 Jul 2003 18:32:55 -0700 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.0</a> |
| 173 |
</p> |
| 174 |
</div></body> |
| 175 |
</html> |
Parent Directory
| 
Revision Log
