| 1 |
<?xml version="1.0" encoding="iso-8859-1"?> |
| 2 |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| 3 |
<html xmlns="http://www.w3.org/1999/xhtml"> |
| 4 |
<head> |
| 5 |
<!-- template designed by Marco Von Ballmoos --> |
| 6 |
<title>Docs For Class pearmysqllist</title> |
| 7 |
<link rel="stylesheet" href="../../media/stylesheet.css" /> |
| 8 |
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/> |
| 9 |
</head> |
| 10 |
<body> |
| 11 |
<div class="page-body"> |
| 12 |
|
| 13 |
<h2 class="class-name">Class pearmysqllist</h2> |
| 14 |
|
| 15 |
<a name="sec-description"></a> |
| 16 |
<div class="info-box"> |
| 17 |
<div class="info-box-title">Description</div> |
| 18 |
<div class="nav-bar"> |
| 19 |
<span class="disabled">Description</span> | |
| 20 |
<a href="#sec-descendents">Descendents</a> |
| 21 |
| <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) |
| 22 |
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
| 23 |
|
| 24 |
</div> |
| 25 |
<div class="info-box-body"> |
| 26 |
<!-- ========== Info from phpDoc block ========= --> |
| 27 |
<p class="short-description">This is an example that shows how to use a PEAR db object as the source for the data to show.</p> |
| 28 |
<ul class="tags"> |
| 29 |
<li><span class="field">version:</span> 2.0</li> |
| 30 |
<li><span class="field">author:</span> Walter A. Boring IV <<a href="mailto:waboring@buildabetterweb.com">waboring@buildabetterweb.com</a>></li> |
| 31 |
</ul> |
| 32 |
<p class="notes"> |
| 33 |
Located in <a class="field" href="_examples_widget6_php.html">/examples/widget6.php</a> (line <span class="field">52</span>) |
| 34 |
</p> |
| 35 |
|
| 36 |
|
| 37 |
<pre>DefaultGUIDataList |
| 38 |
| |
| 39 |
--pearmysqllist</pre> |
| 40 |
|
| 41 |
</div> |
| 42 |
</div> |
| 43 |
|
| 44 |
<a name="sec-descendents"></a> |
| 45 |
<div class="info-box"> |
| 46 |
<div class="info-box-title">Direct descendents</div> |
| 47 |
<div class="nav-bar"> |
| 48 |
<a href="#sec-description">Description</a> | |
| 49 |
<span class="disabled">Descendents</span> |
| 50 |
| <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) |
| 51 |
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
| 52 |
|
| 53 |
</div> |
| 54 |
<div class="info-box-body"> |
| 55 |
<table cellpadding="2" cellspacing="0" class="class-table"> |
| 56 |
<tr> |
| 57 |
<th class="class-table-header">Class</th> |
| 58 |
<th class="class-table-header">Description</th> |
| 59 |
</tr> |
| 60 |
<tr> |
| 61 |
<td style="padding-right: 2em"><a href="../../phpHtmlLib/widget-examples/adodbmysqllist.html">adodbmysqllist</a></td> |
| 62 |
<td> |
| 63 |
This is a subclass of the pear mysql list object. |
| 64 |
</td> |
| 65 |
</tr> |
| 66 |
</table> |
| 67 |
</div> |
| 68 |
</div> |
| 69 |
|
| 70 |
|
| 71 |
<a name="sec-var-summary"></a> |
| 72 |
<div class="info-box"> |
| 73 |
<div class="info-box-title">Variable Summary</span></div> |
| 74 |
<div class="nav-bar"> |
| 75 |
<a href="#sec-description">Description</a> | |
| 76 |
<a href="#sec-descendents">Descendents</a> | |
| 77 |
<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>) |
| 78 |
| |
| 79 |
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
| 80 |
|
| 81 |
</div> |
| 82 |
<div class="info-box-body"> |
| 83 |
<div class="var-summary"> |
| 84 |
<div class="var-title"> |
| 85 |
<span class="var-type">mixed</span> |
| 86 |
<a href="#$_default_rows_per_page" title="details" class="var-name">$_default_rows_per_page</a> |
| 87 |
</div> |
| 88 |
</div> |
| 89 |
</div> |
| 90 |
</div> |
| 91 |
|
| 92 |
<a name="sec-method-summary"></a> |
| 93 |
<div class="info-box"> |
| 94 |
<div class="info-box-title">Method Summary</span></div> |
| 95 |
<div class="nav-bar"> |
| 96 |
<a href="#sec-description">Description</a> | |
| 97 |
<a href="#sec-descendents">Descendents</a> | |
| 98 |
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) |
| 99 |
|
| 100 |
| |
| 101 |
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>) |
| 102 |
</div> |
| 103 |
<div class="info-box-body"> |
| 104 |
<div class="method-summary"> |
| 105 |
|
| 106 |
<div class="method-definition"> |
| 107 |
<span class="method-result">mixed</span> |
| 108 |
<a href="#build_column_item" title="details" class="method-name">build_column_item</a> |
| 109 |
(<span class="var-type">array</span> <span class="var-name">$row_data</span>, <span class="var-type">string</span> <span class="var-name">$col_name</span>) |
| 110 |
</div> |
| 111 |
|
| 112 |
<div class="method-definition"> |
| 113 |
<span class="method-result">void</span> |
| 114 |
<a href="#get_data_source" title="details" class="method-name">get_data_source</a> |
| 115 |
() |
| 116 |
</div> |
| 117 |
|
| 118 |
<div class="method-definition"> |
| 119 |
<span class="method-result">void</span> |
| 120 |
<a href="#user_setup" title="details" class="method-name">user_setup</a> |
| 121 |
() |
| 122 |
</div> |
| 123 |
</div> |
| 124 |
</div> |
| 125 |
</div> |
| 126 |
|
| 127 |
<a name="sec-vars"></a> |
| 128 |
<div class="info-box"> |
| 129 |
<div class="info-box-title">Variables</div> |
| 130 |
<div class="nav-bar"> |
| 131 |
<a href="#sec-description">Description</a> | |
| 132 |
<a href="#sec-descendents">Descendents</a> | |
| 133 |
<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>) |
| 134 |
|
| 135 |
|
| 136 |
| |
| 137 |
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
| 138 |
|
| 139 |
</div> |
| 140 |
<div class="info-box-body"> |
| 141 |
<a name="var$_default_rows_per_page" id="$_default_rows_per_page"><!-- --></A> |
| 142 |
<div class="evenrow"> |
| 143 |
|
| 144 |
<div class="var-header"> |
| 145 |
<span class="var-title"> |
| 146 |
<span class="var-type">mixed</span> |
| 147 |
<span class="var-name">$_default_rows_per_page</span> |
| 148 |
= <span class="var-default"> 20</span> (line <span class="line-number">54</span>) |
| 149 |
</span> |
| 150 |
</div> |
| 151 |
|
| 152 |
<!-- ========== Info from phpDoc block ========= --> |
| 153 |
|
| 154 |
|
| 155 |
|
| 156 |
|
| 157 |
|
| 158 |
</div> |
| 159 |
|
| 160 |
|
| 161 |
</div> |
| 162 |
</div> |
| 163 |
|
| 164 |
<a name="sec-methods"></a> |
| 165 |
<div class="info-box"> |
| 166 |
<div class="info-box-title">Methods</div> |
| 167 |
<div class="nav-bar"> |
| 168 |
<a href="#sec-description">Description</a> | |
| 169 |
<a href="#sec-descendents">Descendents</a> | |
| 170 |
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) |
| 171 |
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>) |
| 172 |
|
| 173 |
</div> |
| 174 |
<div class="info-box-body"> |
| 175 |
<A NAME='method_detail'></A> |
| 176 |
<a name="methodbuild_column_item" id="build_column_item"><!-- --></a> |
| 177 |
<div class="oddrow"> |
| 178 |
|
| 179 |
<div class="method-header"> |
| 180 |
<span class="method-title">build_column_item</span> (line <span class="line-number">130</span>) |
| 181 |
</div> |
| 182 |
|
| 183 |
<!-- ========== Info from phpDoc block ========= --> |
| 184 |
<p class="short-description">This is the basic function for letting us do a mapping between the column name in the header, to the value found in the DataListSource.</p> |
| 185 |
<p class="description"><p>NOTE: this function is can be overridden so that you can return whatever you want for any given column.</p></p> |
| 186 |
<ul class="tags"> |
| 187 |
<li><span class="field">return:</span> - either a HTMLTag object, or raw text.</li> |
| 188 |
</ul> |
| 189 |
|
| 190 |
<div class="method-signature"> |
| 191 |
<span class="method-result">mixed</span> |
| 192 |
<span class="method-name"> |
| 193 |
build_column_item |
| 194 |
</span> |
| 195 |
(<span class="var-type">array</span> <span class="var-name">$row_data</span>, <span class="var-type">string</span> <span class="var-name">$col_name</span>) |
| 196 |
</div> |
| 197 |
|
| 198 |
<ul class="parameters"> |
| 199 |
<li> |
| 200 |
<span class="var-type">array</span> |
| 201 |
<span class="var-name">$row_data</span><span class="var-description">: - $row_data - the entire data for the row</span> </li> |
| 202 |
<li> |
| 203 |
<span class="var-type">string</span> |
| 204 |
<span class="var-name">$col_name</span><span class="var-description">: - $col_name - the name of the column header for this row to render.</span> </li> |
| 205 |
</ul> |
| 206 |
|
| 207 |
|
| 208 |
</div> |
| 209 |
<a name="methodget_data_source" id="get_data_source"><!-- --></a> |
| 210 |
<div class="evenrow"> |
| 211 |
|
| 212 |
<div class="method-header"> |
| 213 |
<span class="method-title">get_data_source</span> (line <span class="line-number">64</span>) |
| 214 |
</div> |
| 215 |
|
| 216 |
<!-- ========== Info from phpDoc block ========= --> |
| 217 |
<p class="short-description">This function is called automatically by the DataList constructor. It must be extended by the child class to actually set the DataListSource object.</p> |
| 218 |
|
| 219 |
<div class="method-signature"> |
| 220 |
<span class="method-result">void</span> |
| 221 |
<span class="method-name"> |
| 222 |
get_data_source |
| 223 |
</span> |
| 224 |
() |
| 225 |
</div> |
| 226 |
|
| 227 |
|
| 228 |
|
| 229 |
<hr class="separator" /> |
| 230 |
<div class="notes">Redefined in descendants as:</div> |
| 231 |
<ul class="redefinitions"> |
| 232 |
<li> |
| 233 |
<a href="../../phpHtmlLib/widget-examples/adodbmysqllist.html#methodget_data_source">adodbmysqllist::get_data_source()</a> |
| 234 |
: This function is called automatically by the DataList constructor. It must be extended by the child class to actually set the DataListSource object. |
| 235 |
</li> |
| 236 |
</ul> |
| 237 |
</div> |
| 238 |
<a name="methoduser_setup" id="user_setup"><!-- --></a> |
| 239 |
<div class="oddrow"> |
| 240 |
|
| 241 |
<div class="method-header"> |
| 242 |
<span class="method-title">user_setup</span> (line <span class="line-number">97</span>) |
| 243 |
</div> |
| 244 |
|
| 245 |
<!-- ========== Info from phpDoc block ========= --> |
| 246 |
<p class="short-description">This method is used to setup the options for the DataList object's display.</p> |
| 247 |
<p class="description"><p>Which columns to show, their respective source column name, width, etc. etc.</p><p>The constructor automatically calls this function.</p></p> |
| 248 |
|
| 249 |
<div class="method-signature"> |
| 250 |
<span class="method-result">void</span> |
| 251 |
<span class="method-name"> |
| 252 |
user_setup |
| 253 |
</span> |
| 254 |
() |
| 255 |
</div> |
| 256 |
|
| 257 |
|
| 258 |
|
| 259 |
</div> |
| 260 |
|
| 261 |
</div> |
| 262 |
</div> |
| 263 |
|
| 264 |
|
| 265 |
<p class="notes" id="credit"> |
| 266 |
Documentation generated on Thu, 1 Apr 2004 09:40:14 -0800 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0RC2</a> |
| 267 |
</p> |
| 268 |
</div></body> |
| 269 |
</html> |
Parent Directory
| 
Revision Log
