| 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 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 |
|
|
<h2 class="class-name">Class pearmysqllist</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">This is an example that shows how to use a PEAR db object as the source for the data to show.</p>
|
| 27 |
|
|
<ul class="tags">
|
| 28 |
|
|
<li><span class="field">version:</span> 2.0</li>
|
| 29 |
|
|
<li><span class="field">author:</span> Walter A. Boring IV <<a href="mailto:waboring@buildabetterweb.com">waboring@buildabetterweb.com</a>></li>
|
| 30 |
|
|
</ul>
|
| 31 |
|
|
<p class="notes">
|
| 32 |
|
|
Located in <a class="field" href="_examples_widget6_php.html">/examples/widget6.php</a> (line <span class="field">52</span>)
|
| 33 |
|
|
</p>
|
| 34 |
|
|
|
| 35 |
|
|
|
| 36 |
jonen |
1.3 |
<pre>DefaultGUIDataList |
| 37 |
jonen |
1.1 |
| |
| 38 |
jonen |
1.4 |
--pearmysqllist</pre>
|
| 39 |
|
|
|
| 40 |
|
|
</div>
|
| 41 |
|
|
</div>
|
| 42 |
|
|
|
| 43 |
|
|
<a name="sec-descendents"></a>
|
| 44 |
|
|
<div class="info-box">
|
| 45 |
|
|
<div class="info-box-title">Direct descendents</div>
|
| 46 |
|
|
<div class="nav-bar">
|
| 47 |
|
|
<a href="#sec-description">Description</a> |
|
| 48 |
|
|
<span class="disabled">Descendents</span>
|
| 49 |
|
|
| <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
|
| 50 |
|
|
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
|
| 51 |
|
|
|
| 52 |
|
|
</div>
|
| 53 |
|
|
<div class="info-box-body">
|
| 54 |
|
|
<table cellpadding="2" cellspacing="0" class="class-table">
|
| 55 |
|
|
<tr>
|
| 56 |
|
|
<th class="class-table-header">Class</th>
|
| 57 |
|
|
<th class="class-table-header">Description</th>
|
| 58 |
|
|
</tr>
|
| 59 |
|
|
<tr>
|
| 60 |
|
|
<td style="padding-right: 2em"><a href="../../phpHtmlLib/widget-examples/adodbmysqllist.html">adodbmysqllist</a></td>
|
| 61 |
|
|
<td>
|
| 62 |
|
|
This is a subclass of the pear mysql list object.
|
| 63 |
|
|
</td>
|
| 64 |
|
|
</tr>
|
| 65 |
|
|
</table>
|
| 66 |
|
|
</div>
|
| 67 |
|
|
</div>
|
| 68 |
|
|
|
| 69 |
|
|
|
| 70 |
|
|
<a name="sec-var-summary"></a>
|
| 71 |
|
|
<div class="info-box">
|
| 72 |
|
|
<div class="info-box-title">Variable Summary</span></div>
|
| 73 |
|
|
<div class="nav-bar">
|
| 74 |
|
|
<a href="#sec-description">Description</a> |
|
| 75 |
|
|
<a href="#sec-descendents">Descendents</a> |
|
| 76 |
|
|
<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
|
| 77 |
|
|
|
|
| 78 |
|
|
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
|
| 79 |
|
|
|
| 80 |
|
|
</div>
|
| 81 |
|
|
<div class="info-box-body">
|
| 82 |
|
|
<div class="var-summary">
|
| 83 |
|
|
<div class="var-title">
|
| 84 |
|
|
<span class="var-type">mixed</span>
|
| 85 |
|
|
<a href="#$_default_rows_per_page" title="details" class="var-name">$_default_rows_per_page</a>
|
| 86 |
|
|
</div>
|
| 87 |
|
|
</div>
|
| 88 |
|
|
</div>
|
| 89 |
|
|
</div>
|
| 90 |
|
|
|
| 91 |
|
|
<a name="sec-method-summary"></a>
|
| 92 |
|
|
<div class="info-box">
|
| 93 |
|
|
<div class="info-box-title">Method Summary</span></div>
|
| 94 |
|
|
<div class="nav-bar">
|
| 95 |
|
|
<a href="#sec-description">Description</a> |
|
| 96 |
|
|
<a href="#sec-descendents">Descendents</a> |
|
| 97 |
|
|
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
|
| 98 |
|
|
|
| 99 |
|
|
|
|
| 100 |
|
|
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
|
| 101 |
|
|
</div>
|
| 102 |
|
|
<div class="info-box-body">
|
| 103 |
|
|
<div class="method-summary">
|
| 104 |
|
|
|
| 105 |
|
|
<div class="method-definition">
|
| 106 |
|
|
<span class="method-result">mixed</span>
|
| 107 |
|
|
<a href="#build_column_item" title="details" class="method-name">build_column_item</a>
|
| 108 |
|
|
(<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>)
|
| 109 |
|
|
</div>
|
| 110 |
|
|
|
| 111 |
|
|
<div class="method-definition">
|
| 112 |
|
|
<span class="method-result">void</span>
|
| 113 |
|
|
<a href="#get_data_source" title="details" class="method-name">get_data_source</a>
|
| 114 |
|
|
()
|
| 115 |
|
|
</div>
|
| 116 |
|
|
|
| 117 |
|
|
<div class="method-definition">
|
| 118 |
|
|
<span class="method-result">void</span>
|
| 119 |
|
|
<a href="#user_setup" title="details" class="method-name">user_setup</a>
|
| 120 |
|
|
()
|
| 121 |
|
|
</div>
|
| 122 |
|
|
</div>
|
| 123 |
|
|
</div>
|
| 124 |
|
|
</div>
|
| 125 |
|
|
|
| 126 |
|
|
<a name="sec-vars"></a>
|
| 127 |
|
|
<div class="info-box">
|
| 128 |
|
|
<div class="info-box-title">Variables</div>
|
| 129 |
|
|
<div class="nav-bar">
|
| 130 |
|
|
<a href="#sec-description">Description</a> |
|
| 131 |
|
|
<a href="#sec-descendents">Descendents</a> |
|
| 132 |
|
|
<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
|
| 133 |
|
|
|
| 134 |
|
|
|
| 135 |
|
|
|
|
| 136 |
|
|
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
|
| 137 |
|
|
|
| 138 |
|
|
</div>
|
| 139 |
|
|
<div class="info-box-body">
|
| 140 |
|
|
<a name="var$_default_rows_per_page" id="$_default_rows_per_page"><!-- --></A>
|
| 141 |
|
|
<div class="evenrow">
|
| 142 |
|
|
|
| 143 |
|
|
<div class="var-header">
|
| 144 |
|
|
<span class="var-title">
|
| 145 |
|
|
<span class="var-type">mixed</span>
|
| 146 |
|
|
<span class="var-name">$_default_rows_per_page</span>
|
| 147 |
|
|
= <span class="var-default"> 20</span> (line <span class="line-number">54</span>)
|
| 148 |
|
|
</span>
|
| 149 |
|
|
</div>
|
| 150 |
|
|
|
| 151 |
|
|
<!-- ========== Info from phpDoc block ========= -->
|
| 152 |
|
|
|
| 153 |
|
|
|
| 154 |
|
|
|
| 155 |
|
|
|
| 156 |
|
|
|
| 157 |
|
|
</div>
|
| 158 |
|
|
|
| 159 |
|
|
</div>
|
| 160 |
|
|
</div>
|
| 161 |
|
|
|
| 162 |
|
|
<a name="sec-methods"></a>
|
| 163 |
|
|
<div class="info-box">
|
| 164 |
|
|
<div class="info-box-title">Methods</div>
|
| 165 |
|
|
<div class="nav-bar">
|
| 166 |
|
|
<a href="#sec-description">Description</a> |
|
| 167 |
|
|
<a href="#sec-descendents">Descendents</a> |
|
| 168 |
|
|
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
|
| 169 |
|
|
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
|
| 170 |
|
|
|
| 171 |
|
|
</div>
|
| 172 |
|
|
<div class="info-box-body">
|
| 173 |
|
|
<A NAME='method_detail'></A>
|
| 174 |
|
|
<a name="methodbuild_column_item" id="build_column_item"><!-- --></a>
|
| 175 |
|
|
<div class="oddrow">
|
| 176 |
|
|
|
| 177 |
|
|
<div class="method-header">
|
| 178 |
|
|
<span class="method-title">build_column_item</span> (line <span class="line-number">130</span>)
|
| 179 |
|
|
</div>
|
| 180 |
|
|
|
| 181 |
|
|
<!-- ========== Info from phpDoc block ========= -->
|
| 182 |
|
|
<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>
|
| 183 |
|
|
<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>
|
| 184 |
|
|
<ul class="tags">
|
| 185 |
|
|
<li><span class="field">return:</span> - either a HTMLTag object, or raw text.</li>
|
| 186 |
|
|
</ul>
|
| 187 |
|
|
|
| 188 |
|
|
<div class="method-signature">
|
| 189 |
|
|
<span class="method-result">mixed</span>
|
| 190 |
|
|
<span class="method-name">
|
| 191 |
|
|
build_column_item
|
| 192 |
|
|
</span>
|
| 193 |
|
|
(<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>)
|
| 194 |
|
|
</div>
|
| 195 |
|
|
|
| 196 |
|
|
<ul class="parameters">
|
| 197 |
|
|
<li>
|
| 198 |
|
|
<span class="var-type">array</span>
|
| 199 |
|
|
<span class="var-name">$row_data</span><span class="var-description">: - $row_data - the entire data for the row</span> </li>
|
| 200 |
|
|
<li>
|
| 201 |
|
|
<span class="var-type">string</span>
|
| 202 |
|
|
<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>
|
| 203 |
|
|
</ul>
|
| 204 |
|
|
|
| 205 |
|
|
|
| 206 |
|
|
</div>
|
| 207 |
|
|
<a name="methodget_data_source" id="get_data_source"><!-- --></a>
|
| 208 |
|
|
<div class="evenrow">
|
| 209 |
|
|
|
| 210 |
|
|
<div class="method-header">
|
| 211 |
|
|
<span class="method-title">get_data_source</span> (line <span class="line-number">64</span>)
|
| 212 |
|
|
</div>
|
| 213 |
|
|
|
| 214 |
|
|
<!-- ========== Info from phpDoc block ========= -->
|
| 215 |
|
|
<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>
|
| 216 |
|
|
|
| 217 |
|
|
<div class="method-signature">
|
| 218 |
|
|
<span class="method-result">void</span>
|
| 219 |
|
|
<span class="method-name">
|
| 220 |
|
|
get_data_source
|
| 221 |
|
|
</span>
|
| 222 |
|
|
()
|
| 223 |
|
|
</div>
|
| 224 |
|
|
|
| 225 |
|
|
|
| 226 |
|
|
|
| 227 |
|
|
<hr class="separator" />
|
| 228 |
|
|
<div class="notes">Redefined in descendants as:</div>
|
| 229 |
|
|
<ul class="redefinitions">
|
| 230 |
|
|
<li>
|
| 231 |
|
|
<a href="../../phpHtmlLib/widget-examples/adodbmysqllist.html#methodget_data_source">adodbmysqllist::get_data_source()</a>
|
| 232 |
|
|
: This function is called automatically by the DataList constructor. It must be extended by the child class to actually set the DataListSource object.
|
| 233 |
|
|
</li>
|
| 234 |
|
|
</ul>
|
| 235 |
|
|
</div>
|
| 236 |
|
|
<a name="methoduser_setup" id="user_setup"><!-- --></a>
|
| 237 |
|
|
<div class="oddrow">
|
| 238 |
|
|
|
| 239 |
|
|
<div class="method-header">
|
| 240 |
|
|
<span class="method-title">user_setup</span> (line <span class="line-number">97</span>)
|
| 241 |
|
|
</div>
|
| 242 |
|
|
|
| 243 |
|
|
<!-- ========== Info from phpDoc block ========= -->
|
| 244 |
|
|
<p class="short-description">This method is used to setup the options for the DataList object's display.</p>
|
| 245 |
|
|
<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>
|
| 246 |
|
|
|
| 247 |
|
|
<div class="method-signature">
|
| 248 |
|
|
<span class="method-result">void</span>
|
| 249 |
|
|
<span class="method-name">
|
| 250 |
|
|
user_setup
|
| 251 |
|
|
</span>
|
| 252 |
|
|
()
|
| 253 |
|
|
</div>
|
| 254 |
|
|
|
| 255 |
|
|
|
| 256 |
|
|
|
| 257 |
|
|
</div>
|
| 258 |
|
|
|
| 259 |
|
|
</div>
|
| 260 |
|
|
</div>
|
| 261 |
|
|
|
| 262 |
|
|
|
| 263 |
|
|
<p class="notes" id="credit">
|
| 264 |
|
|
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>
|
| 265 |
|
|
</p>
|
| 266 |
|
|
</div></body>
|
| 267 |
|
|
</html>
|
Parent Directory
| 
Revision Log
