| 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 DataListSource</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 DataListSource</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 the base class for managing data for the DataList class. This abstracts away the underlying data layer from the DataList, so the data can come from multiple sources.</p> |
| 27 |
<p class="description"><p>Most of the time the data will come from a data base such as Mysql or Oracle. This abstraction enables the data to also come from a tab delimited file, xml, php array</p></p> |
| 28 |
<ul class="tags"> |
| 29 |
<li><span class="field">author:</span> <p>Walter A. Boring IV <<a href="mailto:waboring@buildabetterweb.com">mailto:waboring@buildabetterweb.com</a>></p></li> |
| 30 |
</ul> |
| 31 |
<p class="notes"> |
| 32 |
Located in <a class="field" href="_widgets_data_list_DataListSource_inc.html">Program_Root/widgets/data_list/DataListSource.inc</a> (line <span class="field">31</span>) |
| 33 |
</p> |
| 34 |
|
| 35 |
|
| 36 |
<pre></pre> |
| 37 |
|
| 38 |
</div> |
| 39 |
</div> |
| 40 |
|
| 41 |
<a name="sec-descendents"></a> |
| 42 |
<div class="info-box"> |
| 43 |
<div class="info-box-title">Direct descendents</div> |
| 44 |
<div class="nav-bar"> |
| 45 |
<a href="#sec-description">Description</a> | |
| 46 |
<span class="disabled">Descendents</span> |
| 47 |
| <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) |
| 48 |
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
| 49 |
|
| 50 |
</div> |
| 51 |
<div class="info-box-body"> |
| 52 |
<table cellpadding="2" cellspacing="0" class="class-table"> |
| 53 |
<tr> |
| 54 |
<th class="class-table-header">Class</th> |
| 55 |
<th class="class-table-header">Description</th> |
| 56 |
</tr> |
| 57 |
<tr> |
| 58 |
<td style="padding-right: 2em"><a href="../phpHtmlLib/SQLDataListSource.html">SQLDataListSource</a></td> |
| 59 |
<td> |
| 60 |
|
| 61 |
</td> |
| 62 |
</tr> |
| 63 |
<tr> |
| 64 |
<td style="padding-right: 2em"><a href="../phpHtmlLib/CSVFILEDataListSource.html">CSVFILEDataListSource</a></td> |
| 65 |
<td> |
| 66 |
This DataListSource child class gets the data from a CSV (comma seperated values) file on disk. |
| 67 |
</td> |
| 68 |
</tr> |
| 69 |
<tr> |
| 70 |
<td style="padding-right: 2em"><a href="../phpHtmlLib/ArrayDataListSource.html">ArrayDataListSource</a></td> |
| 71 |
<td> |
| 72 |
This DataListSource child class gets the data from an external array |
| 73 |
</td> |
| 74 |
</tr> |
| 75 |
</table> |
| 76 |
</div> |
| 77 |
</div> |
| 78 |
|
| 79 |
<a name="sec-var-summary"></a> |
| 80 |
<div class="info-box"> |
| 81 |
<div class="info-box-title">Variable Summary</span></div> |
| 82 |
<div class="nav-bar"> |
| 83 |
<a href="#sec-description">Description</a> | |
| 84 |
<a href="#sec-descendents">Descendents</a> | |
| 85 |
<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>) |
| 86 |
| |
| 87 |
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
| 88 |
|
| 89 |
</div> |
| 90 |
<div class="info-box-body"> |
| 91 |
<div class="var-summary"> |
| 92 |
<div class="var-title"> |
| 93 |
<span class="var-type">array</span> |
| 94 |
<a href="#$_columns" title="details" class="var-name">$_columns</a> |
| 95 |
</div> |
| 96 |
<div class="var-title"> |
| 97 |
<span class="var-type">mixed</span> |
| 98 |
<a href="#$_data" title="details" class="var-name">$_data</a> |
| 99 |
</div> |
| 100 |
<div class="var-title"> |
| 101 |
<span class="var-type">mixed</span> |
| 102 |
<a href="#$_data_index" title="details" class="var-name">$_data_index</a> |
| 103 |
</div> |
| 104 |
<div class="var-title"> |
| 105 |
<span class="var-type">mixed</span> |
| 106 |
<a href="#$_not_found_message" title="details" class="var-name">$_not_found_message</a> |
| 107 |
</div> |
| 108 |
<div class="var-title"> |
| 109 |
<span class="var-type">mixed</span> |
| 110 |
<a href="#$_query_params" title="details" class="var-name">$_query_params</a> |
| 111 |
</div> |
| 112 |
</div> |
| 113 |
</div> |
| 114 |
</div> |
| 115 |
|
| 116 |
<a name="sec-method-summary"></a> |
| 117 |
<div class="info-box"> |
| 118 |
<div class="info-box-title">Method Summary</span></div> |
| 119 |
<div class="nav-bar"> |
| 120 |
<a href="#sec-description">Description</a> | |
| 121 |
<a href="#sec-descendents">Descendents</a> | |
| 122 |
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) |
| 123 |
|
| 124 |
| |
| 125 |
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>) |
| 126 |
</div> |
| 127 |
<div class="info-box-body"> |
| 128 |
<div class="method-summary"> |
| 129 |
|
| 130 |
<div class="method-definition"> |
| 131 |
<span class="method-result">void</span> |
| 132 |
<a href="#DataListSource" title="details" class="method-name">DataListSource</a> |
| 133 |
() |
| 134 |
</div> |
| 135 |
|
| 136 |
<div class="method-definition"> |
| 137 |
<span class="method-result">void</span> |
| 138 |
<a href="#add_column" title="details" class="method-name">add_column</a> |
| 139 |
(<span class="var-type">string</span> <span class="var-name">$title</span>, <span class="var-type">string</span> <span class="var-name">$data_name</span>, [<span class="var-type">boolean</span> <span class="var-name">$sortable</span> = <span class="var-default">FALSE</span>], [<span class="var-type">boolean</span> <span class="var-name">$searchable</span> = <span class="var-default">FALSE</span>], [<span class="var-type">string</span> <span class="var-name">$sortorder</span> = <span class="var-default">"ASC"</span>]) |
| 140 |
</div> |
| 141 |
|
| 142 |
<div class="method-definition"> |
| 143 |
<span class="method-result">void</span> |
| 144 |
<a href="#do_prequery" title="details" class="method-name">do_prequery</a> |
| 145 |
() |
| 146 |
</div> |
| 147 |
|
| 148 |
<div class="method-definition"> |
| 149 |
<span class="method-result">boolean</span> |
| 150 |
<a href="#do_query" title="details" class="method-name">do_query</a> |
| 151 |
() |
| 152 |
</div> |
| 153 |
|
| 154 |
<div class="method-definition"> |
| 155 |
<span class="method-result">int</span> |
| 156 |
<a href="#get_data_index" title="details" class="method-name">get_data_index</a> |
| 157 |
() |
| 158 |
</div> |
| 159 |
|
| 160 |
<div class="method-definition"> |
| 161 |
<span class="method-result">int</span> |
| 162 |
<a href="#get_limit" title="details" class="method-name">get_limit</a> |
| 163 |
() |
| 164 |
</div> |
| 165 |
|
| 166 |
<div class="method-definition"> |
| 167 |
<span class="method-result">array()</span> |
| 168 |
<a href="#get_next_data_row" title="details" class="method-name">get_next_data_row</a> |
| 169 |
() |
| 170 |
</div> |
| 171 |
|
| 172 |
<div class="method-definition"> |
| 173 |
<span class="method-result">string</span> |
| 174 |
<a href="#get_not_found_message" title="details" class="method-name">get_not_found_message</a> |
| 175 |
() |
| 176 |
</div> |
| 177 |
|
| 178 |
<div class="method-definition"> |
| 179 |
<span class="method-result">int</span> |
| 180 |
<a href="#get_offset" title="details" class="method-name">get_offset</a> |
| 181 |
() |
| 182 |
</div> |
| 183 |
|
| 184 |
<div class="method-definition"> |
| 185 |
<span class="method-result">int</span> |
| 186 |
<a href="#get_orderby" title="details" class="method-name">get_orderby</a> |
| 187 |
() |
| 188 |
</div> |
| 189 |
|
| 190 |
<div class="method-definition"> |
| 191 |
<span class="method-result">int</span> |
| 192 |
<a href="#get_reverseorder" title="details" class="method-name">get_reverseorder</a> |
| 193 |
() |
| 194 |
</div> |
| 195 |
|
| 196 |
<div class="method-definition"> |
| 197 |
<span class="method-result">int</span> |
| 198 |
<a href="#get_searchby" title="details" class="method-name">get_searchby</a> |
| 199 |
() |
| 200 |
</div> |
| 201 |
|
| 202 |
<div class="method-definition"> |
| 203 |
<span class="method-result">int</span> |
| 204 |
<a href="#get_searchby_value" title="details" class="method-name">get_searchby_value</a> |
| 205 |
() |
| 206 |
</div> |
| 207 |
|
| 208 |
<div class="method-definition"> |
| 209 |
<span class="method-result">string</span> |
| 210 |
<a href="#get_search_type" title="details" class="method-name">get_search_type</a> |
| 211 |
() |
| 212 |
</div> |
| 213 |
|
| 214 |
<div class="method-definition"> |
| 215 |
<span class="method-result">int</span> |
| 216 |
<a href="#get_simplesearch_modifier" title="details" class="method-name">get_simplesearch_modifier</a> |
| 217 |
() |
| 218 |
</div> |
| 219 |
|
| 220 |
<div class="method-definition"> |
| 221 |
<span class="method-result">int</span> |
| 222 |
<a href="#get_total_rows" title="details" class="method-name">get_total_rows</a> |
| 223 |
() |
| 224 |
</div> |
| 225 |
|
| 226 |
<div class="method-definition"> |
| 227 |
<span class="method-result">void</span> |
| 228 |
<a href="#query" title="details" class="method-name">query</a> |
| 229 |
(<span class="var-type">int</span> <span class="var-name">$offset</span>, <span class="var-type">int</span> <span class="var-name">$limit</span>, <span class="var-type">string</span> <span class="var-name">$orderby</span>, <span class="var-type">string</span> <span class="var-name">$reverseorder</span>, <span class="var-type">string</span> <span class="var-name">$searchby</span>, <span class="var-type">string</span> <span class="var-name">$searchby_value</span>, <span class="var-type">string</span> <span class="var-name">$simplesearch_modifier</span>, <span class="var-type">mixed</span> <span class="var-name">$search_type</span>) |
| 230 |
</div> |
| 231 |
|
| 232 |
<div class="method-definition"> |
| 233 |
<span class="method-result">boolean</span> |
| 234 |
<a href="#row_filter" title="details" class="method-name">row_filter</a> |
| 235 |
(<span class="var-type">array</span> <span class="var-name">&$row_data</span>) |
| 236 |
</div> |
| 237 |
|
| 238 |
<div class="method-definition"> |
| 239 |
<span class="method-result">void</span> |
| 240 |
<a href="#set_limit" title="details" class="method-name">set_limit</a> |
| 241 |
(<span class="var-type">mixed</span> <span class="var-name">$limit</span>) |
| 242 |
</div> |
| 243 |
|
| 244 |
<div class="method-definition"> |
| 245 |
<span class="method-result">void</span> |
| 246 |
<a href="#set_not_found_message" title="details" class="method-name">set_not_found_message</a> |
| 247 |
(<span class="var-type">string</span> <span class="var-name">$mesg</span>) |
| 248 |
</div> |
| 249 |
|
| 250 |
<div class="method-definition"> |
| 251 |
<span class="method-result">void</span> |
| 252 |
<a href="#set_offset" title="details" class="method-name">set_offset</a> |
| 253 |
(<span class="var-type">int</span> <span class="var-name">$offset</span>) |
| 254 |
</div> |
| 255 |
|
| 256 |
<div class="method-definition"> |
| 257 |
<span class="method-result">void</span> |
| 258 |
<a href="#set_orderby" title="details" class="method-name">set_orderby</a> |
| 259 |
(<span class="var-type">int</span> <span class="var-name">$orderby</span>) |
| 260 |
</div> |
| 261 |
|
| 262 |
<div class="method-definition"> |
| 263 |
<span class="method-result">void</span> |
| 264 |
<a href="#set_reverseorder" title="details" class="method-name">set_reverseorder</a> |
| 265 |
(<span class="var-type">int</span> <span class="var-name">$order</span>) |
| 266 |
</div> |
| 267 |
|
| 268 |
<div class="method-definition"> |
| 269 |
<span class="method-result">void</span> |
| 270 |
<a href="#set_searchby" title="details" class="method-name">set_searchby</a> |
| 271 |
(<span class="var-type">int</span> <span class="var-name">$search_col</span>) |
| 272 |
</div> |
| 273 |
|
| 274 |
<div class="method-definition"> |
| 275 |
<span class="method-result">void</span> |
| 276 |
<a href="#set_searchby_value" title="details" class="method-name">set_searchby_value</a> |
| 277 |
(<span class="var-type">int</span> <span class="var-name">$search_value</span>) |
| 278 |
</div> |
| 279 |
|
| 280 |
<div class="method-definition"> |
| 281 |
<span class="method-result">void</span> |
| 282 |
<a href="#set_search_type" title="details" class="method-name">set_search_type</a> |
| 283 |
(<span class="var-type">string</span> <span class="var-name">$search_type</span>) |
| 284 |
</div> |
| 285 |
|
| 286 |
<div class="method-definition"> |
| 287 |
<span class="method-result">void</span> |
| 288 |
<a href="#set_simplesearch_modifier" title="details" class="method-name">set_simplesearch_modifier</a> |
| 289 |
(<span class="var-type">int</span> <span class="var-name">$search_modifier</span>) |
| 290 |
</div> |
| 291 |
|
| 292 |
<div class="method-definition"> |
| 293 |
<span class="method-result">void</span> |
| 294 |
<a href="#set_total_rows" title="details" class="method-name">set_total_rows</a> |
| 295 |
(<span class="var-type">int</span> <span class="var-name">$num</span>) |
| 296 |
</div> |
| 297 |
|
| 298 |
<div class="method-definition"> |
| 299 |
<span class="method-result">void</span> |
| 300 |
<a href="#sort" title="details" class="method-name">sort</a> |
| 301 |
() |
| 302 |
</div> |
| 303 |
|
| 304 |
<div class="method-definition"> |
| 305 |
<span class="method-result">boolean</span> |
| 306 |
<a href="#_is_column_sortable" title="details" class="method-name">_is_column_sortable</a> |
| 307 |
(<span class="var-type">string</span> <span class="var-name">$data_name</span>) |
| 308 |
</div> |
| 309 |
</div> |
| 310 |
</div> |
| 311 |
</div> |
| 312 |
|
| 313 |
<a name="sec-vars"></a> |
| 314 |
<div class="info-box"> |
| 315 |
<div class="info-box-title">Variables</div> |
| 316 |
<div class="nav-bar"> |
| 317 |
<a href="#sec-description">Description</a> | |
| 318 |
<a href="#sec-descendents">Descendents</a> | |
| 319 |
<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>) |
| 320 |
|
| 321 |
|
| 322 |
| |
| 323 |
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
| 324 |
|
| 325 |
</div> |
| 326 |
<div class="info-box-body"> |
| 327 |
<a name="var$_columns" id="$_columns"><!-- --></A> |
| 328 |
<div class="oddrow"> |
| 329 |
|
| 330 |
<div class="var-header"> |
| 331 |
<span class="var-title"> |
| 332 |
<span class="var-type">array</span> |
| 333 |
<span class="var-name">$_columns</span> |
| 334 |
= <span class="var-default">array()</span> (line <span class="line-number">39</span>) |
| 335 |
</span> |
| 336 |
</div> |
| 337 |
|
| 338 |
<!-- ========== Info from phpDoc block ========= --> |
| 339 |
<p class="short-description">The column descriptions for the data we are working on</p> |
| 340 |
|
| 341 |
|
| 342 |
|
| 343 |
|
| 344 |
|
| 345 |
</div> |
| 346 |
<a name="var$_data" id="$_data"><!-- --></A> |
| 347 |
<div class="evenrow"> |
| 348 |
|
| 349 |
<div class="var-header"> |
| 350 |
<span class="var-title"> |
| 351 |
<span class="var-type">mixed</span> |
| 352 |
<span class="var-name">$_data</span> |
| 353 |
= <span class="var-default">array()</span> (line <span class="line-number">79</span>) |
| 354 |
</span> |
| 355 |
</div> |
| 356 |
|
| 357 |
<!-- ========== Info from phpDoc block ========= --> |
| 358 |
<p class="short-description">A placeholder for data that is read/built and stored locally. Not all data sources have to use this.</p> |
| 359 |
<p class="description"><p>Each entry in the array corresponds to 1 row of data.</p></p> |
| 360 |
|
| 361 |
|
| 362 |
|
| 363 |
|
| 364 |
|
| 365 |
</div> |
| 366 |
<a name="var$_data_index" id="$_data_index"><!-- --></A> |
| 367 |
<div class="oddrow"> |
| 368 |
|
| 369 |
<div class="var-header"> |
| 370 |
<span class="var-title"> |
| 371 |
<span class="var-type">mixed</span> |
| 372 |
<span class="var-name">$_data_index</span> |
| 373 |
= <span class="var-default"> 0</span> (line <span class="line-number">70</span>) |
| 374 |
</span> |
| 375 |
</div> |
| 376 |
|
| 377 |
<!-- ========== Info from phpDoc block ========= --> |
| 378 |
<p class="short-description">Holds the index into the array of data</p> |
| 379 |
<p class="description"><p>so we can keep track of where we are when we are walking the array (only usefull for non DB children)</p></p> |
| 380 |
|
| 381 |
|
| 382 |
|
| 383 |
|
| 384 |
|
| 385 |
</div> |
| 386 |
<a name="var$_not_found_message" id="$_not_found_message"><!-- --></A> |
| 387 |
<div class="evenrow"> |
| 388 |
|
| 389 |
<div class="var-header"> |
| 390 |
<span class="var-title"> |
| 391 |
<span class="var-type">mixed</span> |
| 392 |
<span class="var-name">$_not_found_message</span> |
| 393 |
= <span class="var-default"> "No data was found"</span> (line <span class="line-number">45</span>) |
| 394 |
</span> |
| 395 |
</div> |
| 396 |
|
| 397 |
<!-- ========== Info from phpDoc block ========= --> |
| 398 |
<p class="short-description">This is the message displayed when no data</p> |
| 399 |
<p class="description"><p>was retrieved from the database</p></p> |
| 400 |
|
| 401 |
|
| 402 |
|
| 403 |
|
| 404 |
|
| 405 |
</div> |
| 406 |
<a name="var$_query_params" id="$_query_params"><!-- --></A> |
| 407 |
<div class="oddrow"> |
| 408 |
|
| 409 |
<div class="var-header"> |
| 410 |
<span class="var-title"> |
| 411 |
<span class="var-type">mixed</span> |
| 412 |
<span class="var-name">$_query_params</span> |
| 413 |
= <span class="var-default">array("num_total_rows" => 0,<br /> "offset" => 0,<br /> "limit" => -1,<br /> "orderby" => '',<br /> "reverseorder" => '',<br /> "searchby" => '',<br /> "searchvalue" => '',<br /> "searchmodifier" => '',<br /> "searchtype" => 'simple')</span> (line <span class="line-number">53</span>) |
| 414 |
</span> |
| 415 |
</div> |
| 416 |
|
| 417 |
<!-- ========== Info from phpDoc block ========= --> |
| 418 |
<p class="short-description">This holds various parameters relating</p> |
| 419 |
<p class="description"><p>to the query of the data</p></p> |
| 420 |
|
| 421 |
|
| 422 |
|
| 423 |
|
| 424 |
|
| 425 |
</div> |
| 426 |
|
| 427 |
</div> |
| 428 |
</div> |
| 429 |
|
| 430 |
<a name="sec-methods"></a> |
| 431 |
<div class="info-box"> |
| 432 |
<div class="info-box-title">Methods</div> |
| 433 |
<div class="nav-bar"> |
| 434 |
<a href="#sec-description">Description</a> | |
| 435 |
<a href="#sec-descendents">Descendents</a> | |
| 436 |
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) |
| 437 |
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>) |
| 438 |
|
| 439 |
</div> |
| 440 |
<div class="info-box-body"> |
| 441 |
<A NAME='method_detail'></A> |
| 442 |
<a name="methodDataListSource" id="DataListSource"><!-- --></a> |
| 443 |
<div class="evenrow"> |
| 444 |
|
| 445 |
<div class="method-header"> |
| 446 |
<span class="method-title">Constructor DataListSource</span> (line <span class="line-number">85</span>) |
| 447 |
</div> |
| 448 |
|
| 449 |
<!-- ========== Info from phpDoc block ========= --> |
| 450 |
<p class="short-description">The constructor</p> |
| 451 |
|
| 452 |
<div class="method-signature"> |
| 453 |
<span class="method-result">void</span> |
| 454 |
<span class="method-name"> |
| 455 |
DataListSource |
| 456 |
</span> |
| 457 |
() |
| 458 |
</div> |
| 459 |
|
| 460 |
|
| 461 |
|
| 462 |
</div> |
| 463 |
<a name="methodadd_column" id="add_column"><!-- --></a> |
| 464 |
<div class="oddrow"> |
| 465 |
|
| 466 |
<div class="method-header"> |
| 467 |
<span class="method-title">add_column</span> (line <span class="line-number">108</span>) |
| 468 |
</div> |
| 469 |
|
| 470 |
<!-- ========== Info from phpDoc block ========= --> |
| 471 |
<p class="short-description">Add a column of data to manage</p> |
| 472 |
|
| 473 |
<div class="method-signature"> |
| 474 |
<span class="method-result">void</span> |
| 475 |
<span class="method-name"> |
| 476 |
add_column |
| 477 |
</span> |
| 478 |
(<span class="var-type">string</span> <span class="var-name">$title</span>, <span class="var-type">string</span> <span class="var-name">$data_name</span>, [<span class="var-type">boolean</span> <span class="var-name">$sortable</span> = <span class="var-default">FALSE</span>], [<span class="var-type">boolean</span> <span class="var-name">$searchable</span> = <span class="var-default">FALSE</span>], [<span class="var-type">string</span> <span class="var-name">$sortorder</span> = <span class="var-default">"ASC"</span>]) |
| 479 |
</div> |
| 480 |
|
| 481 |
<ul class="parameters"> |
| 482 |
<li> |
| 483 |
<span class="var-type">string</span> |
| 484 |
<span class="var-name">$title</span><span class="var-description">: <p>- the title of the column</p></span> </li> |
| 485 |
<li> |
| 486 |
<span class="var-type">string</span> |
| 487 |
<span class="var-name">$data_name</span><span class="var-description">: <p>- the data value name</p></span> </li> |
| 488 |
<li> |
| 489 |
<span class="var-type">boolean</span> |
| 490 |
<span class="var-name">$sortable</span><span class="var-description">: <p>- is the column sortable? default: FALSE</p></span> </li> |
| 491 |
<li> |
| 492 |
<span class="var-type">boolean</span> |
| 493 |
<span class="var-name">$searchable</span><span class="var-description">: <p>- is the column searchable default: FALSE</p></span> </li> |
| 494 |
<li> |
| 495 |
<span class="var-type">string</span> |
| 496 |
<span class="var-name">$sortorder</span><span class="var-description">: <p>- the sort order (ASC, DESC) default: ASC</p></span> </li> |
| 497 |
</ul> |
| 498 |
|
| 499 |
|
| 500 |
</div> |
| 501 |
<a name="methoddo_prequery" id="do_prequery"><!-- --></a> |
| 502 |
<div class="evenrow"> |
| 503 |
|
| 504 |
<div class="method-header"> |
| 505 |
<span class="method-title">do_prequery</span> (line <span class="line-number">197</span>) |
| 506 |
</div> |
| 507 |
|
| 508 |
<!-- ========== Info from phpDoc block ========= --> |
| 509 |
<p class="short-description">This is a method that should be defined by the child class to do any pre-query type of things.</p> |
| 510 |
<p class="description"><p>Such as building a sql query string for a DB, or checking to make sure the file on disk exists if the source is a file on disk.</p></p> |
| 511 |
|
| 512 |
<div class="method-signature"> |
| 513 |
<span class="method-result">void</span> |
| 514 |
<span class="method-name"> |
| 515 |
do_prequery |
| 516 |
</span> |
| 517 |
() |
| 518 |
</div> |
| 519 |
|
| 520 |
|
| 521 |
|
| 522 |
<hr class="separator" /> |
| 523 |
<div class="notes">Redefined in descendants as:</div> |
| 524 |
<ul class="redefinitions"> |
| 525 |
<li> |
| 526 |
<a href="../phpHtmlLib/SQLDataListSource.html#methoddo_prequery">SQLDataListSource::do_prequery()</a> |
| 527 |
</li> |
| 528 |
<li> |
| 529 |
<a href="../phpHtmlLib/CSVFILEDataListSource.html#methoddo_prequery">CSVFILEDataListSource::do_prequery()</a> |
| 530 |
: The prequery. We use this to read the file |
| 531 |
</li> |
| 532 |
<li> |
| 533 |
<a href="../phpHtmlLib/ArrayDataListSource.html#methoddo_prequery">ArrayDataListSource::do_prequery()</a> |
| 534 |
: This is a method that should be defined by the child class to do any pre-query type of things. |
| 535 |
</li> |
| 536 |
</ul> |
| 537 |
</div> |
| 538 |
<a name="methoddo_query" id="do_query"><!-- --></a> |
| 539 |
<div class="oddrow"> |
| 540 |
|
| 541 |
<div class="method-header"> |
| 542 |
<span class="method-title">do_query</span> (line <span class="line-number">212</span>) |
| 543 |
</div> |
| 544 |
|
| 545 |
<!-- ========== Info from phpDoc block ========= --> |
| 546 |
<p class="short-description">This is the function that does the data fetching, and sorting if needed.</p> |
| 547 |
<p class="description"><p>If the source is a sql database, this is where the query gets called. This function doesn't actually read the data from the DB yet. That is what get_next_data_row() does.</p></p> |
| 548 |
<ul class="tags"> |
| 549 |
<li><span class="field">return:</span> <p>- the query passed/failed.</p></li> |
| 550 |
</ul> |
| 551 |
|
| 552 |
<div class="method-signature"> |
| 553 |
<span class="method-result">boolean</span> |
| 554 |
<span class="method-name"> |
| 555 |
do_query |
| 556 |
</span> |
| 557 |
() |
| 558 |
</div> |
| 559 |
|
| 560 |
|
| 561 |
|
| 562 |
<hr class="separator" /> |
| 563 |
<div class="notes">Redefined in descendants as:</div> |
| 564 |
<ul class="redefinitions"> |
| 565 |
<li> |
| 566 |
<a href="../phpHtmlLib/SQLDataListSource.html#methoddo_query">SQLDataListSource::do_query()</a> |
| 567 |
: Do the query to the DB and pull in all of the records locally. |
| 568 |
</li> |
| 569 |
<li> |
| 570 |
<a href="../phpHtmlLib/PEARSQLDataListSource.html#methoddo_query">PEARSQLDataListSource::do_query()</a> |
| 571 |
: This is the function that does the data fetching, and sorting if needed. |
| 572 |
</li> |
| 573 |
<li> |
| 574 |
<a href="../phpHtmlLib/ADODBSQLDataListSource.html#methoddo_query">ADODBSQLDataListSource::do_query()</a> |
| 575 |
: This is the function that does the data fetching, and sorting if needed. |
| 576 |
</li> |
| 577 |
<li> |
| 578 |
<a href="../phpHtmlLib/PGSQLDataListSource.html#methoddo_query">PGSQLDataListSource::do_query()</a> |
| 579 |
</li> |
| 580 |
<li> |
| 581 |
<a href="../phpHtmlLib/CSVFILEDataListSource.html#methoddo_query">CSVFILEDataListSource::do_query()</a> |
| 582 |
: This function does the query |
| 583 |
</li> |
| 584 |
<li> |
| 585 |
<a href="../phpHtmlLib/ArrayDataListSource.html#methoddo_query">ArrayDataListSource::do_query()</a> |
| 586 |
: This function does the query |
| 587 |
</li> |
| 588 |
</ul> |
| 589 |
</div> |
| 590 |
<a name="methodget_data_index" id="get_data_index"><!-- --></a> |
| 591 |
<div class="evenrow"> |
| 592 |
|
| 593 |
<div class="method-header"> |
| 594 |
<span class="method-title">get_data_index</span> (line <span class="line-number">442</span>) |
| 595 |
</div> |
| 596 |
|
| 597 |
<!-- ========== Info from phpDoc block ========= --> |
| 598 |
<p class="short-description">This function returns the data_index value and increments it</p> |
| 599 |
|
| 600 |
<div class="method-signature"> |
| 601 |
<span class="method-result">int</span> |
| 602 |
<span class="method-name"> |
| 603 |
get_data_index |
| 604 |
</span> |
| 605 |
() |
| 606 |
</div> |
| 607 |
|
| 608 |
|
| 609 |
|
| 610 |
<hr class="separator" /> |
| 611 |
<div class="notes">Redefined in descendants as:</div> |
| 612 |
<ul class="redefinitions"> |
| 613 |
<li> |
| 614 |
<a href="../phpHtmlLib/ArrayDataListSource.html#methodget_data_index">ArrayDataListSource::get_data_index()</a> |
| 615 |
: This function returns the data_index value and increments it |
| 616 |
</li> |
| 617 |
</ul> |
| 618 |
</div> |
| 619 |
<a name="methodget_limit" id="get_limit"><!-- --></a> |
| 620 |
<div class="oddrow"> |
| 621 |
|
| 622 |
<div class="method-header"> |
| 623 |
<span class="method-title">get_limit</span> (line <span class="line-number">411</span>) |
| 624 |
</div> |
| 625 |
|
| 626 |
<!-- ========== Info from phpDoc block ========= --> |
| 627 |
<p class="short-description">This function gets the current value of the limit value</p> |
| 628 |
|
| 629 |
<div class="method-signature"> |
| 630 |
<span class="method-result">int</span> |
| 631 |
<span class="method-name"> |
| 632 |
get_limit |
| 633 |
</span> |
| 634 |
() |
| 635 |
</div> |
| 636 |
|
| 637 |
|
| 638 |
|
| 639 |
</div> |
| 640 |
<a name="methodget_next_data_row" id="get_next_data_row"><!-- --></a> |
| 641 |
<div class="evenrow"> |
| 642 |
|
| 643 |
<div class="method-header"> |
| 644 |
<span class="method-title">get_next_data_row</span> (line <span class="line-number">173</span>) |
| 645 |
</div> |
| 646 |
|
| 647 |
<!-- ========== Info from phpDoc block ========= --> |
| 648 |
<p class="short-description">This function gets the next data row from the query()</p> |
| 649 |
|
| 650 |
<div class="method-signature"> |
| 651 |
<span class="method-result">array()</span> |
| 652 |
<span class="method-name"> |
| 653 |
get_next_data_row |
| 654 |
</span> |
| 655 |
() |
| 656 |
</div> |
| 657 |
|
| 658 |
|
| 659 |
|
| 660 |
<hr class="separator" /> |
| 661 |
<div class="notes">Redefined in descendants as:</div> |
| 662 |
<ul class="redefinitions"> |
| 663 |
<li> |
| 664 |
<a href="../phpHtmlLib/SQLDataListSource.html#methodget_next_data_row">SQLDataListSource::get_next_data_row()</a> |
| 665 |
: This function gets the next data row from the query() |
| 666 |
</li> |
| 667 |
<li> |
| 668 |
<a href="../phpHtmlLib/PEARSQLDataListSource.html#methodget_next_data_row">PEARSQLDataListSource::get_next_data_row()</a> |
| 669 |
: This function gets the next data row from the query() |
| 670 |
</li> |
| 671 |
<li> |
| 672 |
<a href="../phpHtmlLib/ADODBSQLDataListSource.html#methodget_next_data_row">ADODBSQLDataListSource::get_next_data_row()</a> |
| 673 |
: This function gets the next data row from the query() |
| 674 |
</li> |
| 675 |
<li> |
| 676 |
<a href="../phpHtmlLib/PGSQLDataListSource.html#methodget_next_data_row">PGSQLDataListSource::get_next_data_row()</a> |
| 677 |
: This function gets the next data row from the query() |
| 678 |
</li> |
| 679 |
<li> |
| 680 |
<a href="../phpHtmlLib/CSVFILEDataListSource.html#methodget_next_data_row">CSVFILEDataListSource::get_next_data_row()</a> |
| 681 |
: This function returns the next row of valid data. |
| 682 |
</li> |
| 683 |
<li> |
| 684 |
<a href="../phpHtmlLib/ArrayDataListSource.html#methodget_next_data_row">ArrayDataListSource::get_next_data_row()</a> |
| 685 |
: This function returns the next row of valid data. |
| 686 |
</li> |
| 687 |
</ul> |
| 688 |
</div> |
| 689 |
<a name="methodget_not_found_message" id="get_not_found_message"><!-- --></a> |
| 690 |
<div class="oddrow"> |
| 691 |
|
| 692 |
<div class="method-header"> |
| 693 |
<span class="method-title">get_not_found_message</span> (line <span class="line-number">245</span>) |
| 694 |
</div> |
| 695 |
|
| 696 |
<!-- ========== Info from phpDoc block ========= --> |
| 697 |
<p class="short-description">This function is used to get the message displayed when no data is found</p> |
| 698 |
|
| 699 |
<div class="method-signature"> |
| 700 |
<span class="method-result">string</span> |
| 701 |
<span class="method-name"> |
| 702 |
get_not_found_message |
| 703 |
</span> |
| 704 |
() |
| 705 |
</div> |
| 706 |
|
| 707 |
|
| 708 |
|
| 709 |
</div> |
| 710 |
<a name="methodget_offset" id="get_offset"><!-- --></a> |
| 711 |
<div class="evenrow"> |
| 712 |
|
| 713 |
<div class="method-header"> |
| 714 |
<span class="method-title">get_offset</span> (line <span class="line-number">288</span>) |
| 715 |
</div> |
| 716 |
|
| 717 |
<!-- ========== Info from phpDoc block ========= --> |
| 718 |
<p class="short-description">This function returns the value of the offset</p> |
| 719 |
|
| 720 |
<div class="method-signature"> |
| 721 |
<span class="method-result">int</span> |
| 722 |
<span class="method-name"> |
| 723 |
get_offset |
| 724 |
</span> |
| 725 |
() |
| 726 |
</div> |
| 727 |
|
| 728 |
|
| 729 |
|
| 730 |
</div> |
| 731 |
<a name="methodget_orderby" id="get_orderby"><!-- --></a> |
| 732 |
<div class="oddrow"> |
| 733 |
|
| 734 |
<div class="method-header"> |
| 735 |
<span class="method-title">get_orderby</span> (line <span class="line-number">310</span>) |
| 736 |
</div> |
| 737 |
|
| 738 |
<!-- ========== Info from phpDoc block ========= --> |
| 739 |
<p class="short-description">This function returns the value of the orderby</p> |
| 740 |
|
| 741 |
<div class="method-signature"> |
| 742 |
<span class="method-result">int</span> |
| 743 |
<span class="method-name"> |
| 744 |
get_orderby |
| 745 |
</span> |
| 746 |
() |
| 747 |
</div> |
| 748 |
|
| 749 |
|
| 750 |
|
| 751 |
</div> |
| 752 |
<a name="methodget_reverseorder" id="get_reverseorder"><!-- --></a> |
| 753 |
<div class="evenrow"> |
| 754 |
|
| 755 |
<div class="method-header"> |
| 756 |
<span class="method-title">get_reverseorder</span> (line <span class="line-number">331</span>) |
| 757 |
</div> |
| 758 |
|
| 759 |
<!-- ========== Info from phpDoc block ========= --> |
| 760 |
<p class="short-description">This function returns the value of the reverseorder</p> |
| 761 |
|
| 762 |
<div class="method-signature"> |
| 763 |
<span class="method-result">int</span> |
| 764 |
<span class="method-name"> |
| 765 |
get_reverseorder |
| 766 |
</span> |
| 767 |
() |
| 768 |
</div> |
| 769 |
|
| 770 |
|
| 771 |
|
| 772 |
</div> |
| 773 |
<a name="methodget_searchby" id="get_searchby"><!-- --></a> |
| 774 |
<div class="oddrow"> |
| 775 |
|
| 776 |
<div class="method-header"> |
| 777 |
<span class="method-title">get_searchby</span> (line <span class="line-number">351</span>) |
| 778 |
</div> |
| 779 |
|
| 780 |
<!-- ========== Info from phpDoc block ========= --> |
| 781 |
<p class="short-description">This function returns the value of the searchby</p> |
| 782 |
|
| 783 |
<div class="method-signature"> |
| 784 |
<span class="method-result">int</span> |
| 785 |
<span class="method-name"> |
| 786 |
get_searchby |
| 787 |
</span> |
| 788 |
() |
| 789 |
</div> |
| 790 |
|
| 791 |
|
| 792 |
|
| 793 |
</div> |
| 794 |
<a name="methodget_searchby_value" id="get_searchby_value"><!-- --></a> |
| 795 |
<div class="evenrow"> |
| 796 |
|
| 797 |
<div class="method-header"> |
| 798 |
<span class="method-title">get_searchby_value</span> (line <span class="line-number">371</span>) |
| 799 |
</div> |
| 800 |
|
| 801 |
<!-- ========== Info from phpDoc block ========= --> |
| 802 |
<p class="short-description">This function returns the value of the search value</p> |
| 803 |
|
| 804 |
<div class="method-signature"> |
| 805 |
<span class="method-result">int</span> |
| 806 |
<span class="method-name"> |
| 807 |
get_searchby_value |
| 808 |
</span> |
| 809 |
() |
| 810 |
</div> |
| 811 |
|
| 812 |
|
| 813 |
|
| 814 |
</div> |
| 815 |
<a name="methodget_search_type" id="get_search_type"><!-- --></a> |
| 816 |
<div class="oddrow"> |
| 817 |
|
| 818 |
<div class="method-header"> |
| 819 |
<span class="method-title">get_search_type</span> (line <span class="line-number">432</span>) |
| 820 |
</div> |
| 821 |
|
| 822 |
<!-- ========== Info from phpDoc block ========= --> |
| 823 |
<p class="short-description">this function returns the current search type for the DataList query</p> |
| 824 |
|
| 825 |
<div class="method-signature"> |
| 826 |
<span class="method-result">string</span> |
| 827 |
<span class="method-name"> |
| 828 |
get_search_type |
| 829 |
</span> |
| 830 |
() |
| 831 |
</div> |
| 832 |
|
| 833 |
|
| 834 |
|
| 835 |
</div> |
| 836 |
<a name="methodget_simplesearch_modifier" id="get_simplesearch_modifier"><!-- --></a> |
| 837 |
<div class="evenrow"> |
| 838 |
|
| 839 |
<div class="method-header"> |
| 840 |
<span class="method-title">get_simplesearch_modifier</span> (line <span class="line-number">391</span>) |
| 841 |
</div> |
| 842 |
|
| 843 |
<!-- ========== Info from phpDoc block ========= --> |
| 844 |
<p class="short-description">This function returns the value of the search value</p> |
| 845 |
|
| 846 |
<div class="method-signature"> |
| 847 |
<span class="method-result">int</span> |
| 848 |
<span class="method-name"> |
| 849 |
get_simplesearch_modifier |
| 850 |
</span> |
| 851 |
() |
| 852 |
</div> |
| 853 |
|
| 854 |
|
| 855 |
|
| 856 |
</div> |
| 857 |
<a name="methodget_total_rows" id="get_total_rows"><!-- --></a> |
| 858 |
<div class="oddrow"> |
| 859 |
|
| 860 |
<div class="method-header"> |
| 861 |
<span class="method-title">get_total_rows</span> (line <span class="line-number">255</span>) |
| 862 |
</div> |
| 863 |
|
| 864 |
<!-- ========== Info from phpDoc block ========= --> |
| 865 |
<p class="short-description">This returns the total number of rows in our entire data set</p> |
| 866 |
|
| 867 |
<div class="method-signature"> |
| 868 |
<span class="method-result">int</span> |
| 869 |
<span class="method-name"> |
| 870 |
get_total_rows |
| 871 |
</span> |
| 872 |
() |
| 873 |
</div> |
| 874 |
|
| 875 |
|
| 876 |
|
| 877 |
</div> |
| 878 |
<a name="methodquery" id="query"><!-- --></a> |
| 879 |
<div class="evenrow"> |
| 880 |
|
| 881 |
<div class="method-header"> |
| 882 |
<span class="method-title">query</span> (line <span class="line-number">139</span>) |
| 883 |
</div> |
| 884 |
|
| 885 |
<!-- ========== Info from phpDoc block ========= --> |
| 886 |
<p class="short-description">The main Query function.</p> |
| 887 |
<p class="description"><p>This function is responsible for doing any data prefetching from a db,file and doing any sorting and searching on it depending on the values passed in from the DataList object</p></p> |
| 888 |
|
| 889 |
<div class="method-signature"> |
| 890 |
<span class="method-result">void</span> |
| 891 |
<span class="method-name"> |
| 892 |
query |
| 893 |
</span> |
| 894 |
(<span class="var-type">int</span> <span class="var-name">$offset</span>, <span class="var-type">int</span> <span class="var-name">$limit</span>, <span class="var-type">string</span> <span class="var-name">$orderby</span>, <span class="var-type">string</span> <span class="var-name">$reverseorder</span>, <span class="var-type">string</span> <span class="var-name">$searchby</span>, <span class="var-type">string</span> <span class="var-name">$searchby_value</span>, <span class="var-type">string</span> <span class="var-name">$simplesearch_modifier</span>, <span class="var-type">mixed</span> <span class="var-name">$search_type</span>) |
| 895 |
</div> |
| 896 |
|
| 897 |
<ul class="parameters"> |
| 898 |
<li> |
| 899 |
<span class="var-type">int</span> |
| 900 |
<span class="var-name">$offset</span><span class="var-description">: <p>- the offset into the data set</p></span> </li> |
| 901 |
<li> |
| 902 |
<span class="var-type">int</span> |
| 903 |
<span class="var-name">$limit</span><span class="var-description">: <p>- the # of rows to get</p></span> </li> |
| 904 |
<li> |
| 905 |
<span class="var-type">string</span> |
| 906 |
<span class="var-name">$orderby</span><span class="var-description">: <p>- the column to order the data by</p></span> </li> |
| 907 |
<li> |
| 908 |
<span class="var-type">string</span> |
| 909 |
<span class="var-name">$reverseorder</span><span class="var-description">: <p>- order in asc or reverse?</p></span> </li> |
| 910 |
<li> |
| 911 |
<span class="var-type">string</span> |
| 912 |
<span class="var-name">$searchby</span><span class="var-description">: <p>- the column in the dataset to search by</p></span> </li> |
| 913 |
<li> |
| 914 |
<span class="var-type">string</span> |
| 915 |
<span class="var-name">$searchby_value</span><span class="var-description">: <p>- the value to look for</p></span> </li> |
| 916 |
<li> |
| 917 |
<span class="var-type">string</span> |
| 918 |
<span class="var-name">$simplesearch_modifier</span><span class="var-description">: <p>- the simple search modifier.</p></span> </li> |
| 919 |
</ul> |
| 920 |
|
| 921 |
|
| 922 |
</div> |
| 923 |
<a name="methodrow_filter" id="row_filter"><!-- --></a> |
| 924 |
<div class="oddrow"> |
| 925 |
|
| 926 |
<div class="method-header"> |
| 927 |
<span class="method-title">row_filter</span> (line <span class="line-number">184</span>) |
| 928 |
</div> |
| 929 |
|
| 930 |
<!-- ========== Info from phpDoc block ========= --> |
| 931 |
<p class="short-description">This is called by the DataList object to allow us a chance to run the next row through a filter</p> |
| 932 |
<ul class="tags"> |
| 933 |
<li><span class="field">return:</span> <p>- TRUE = allow the row. FALSE = drop it.</p></li> |
| 934 |
</ul> |
| 935 |
|
| 936 |
<div class="method-signature"> |
| 937 |
<span class="method-result">boolean</span> |
| 938 |
<span class="method-name"> |
| 939 |
row_filter |
| 940 |
</span> |
| 941 |
(<span class="var-type">array</span> <span class="var-name">&$row_data</span>) |
| 942 |
</div> |
| 943 |
|
| 944 |
<ul class="parameters"> |
| 945 |
<li> |
| 946 |
<span class="var-type">array</span> |
| 947 |
<span class="var-name">&$row_data</span><span class="var-description">: <p>- the row to run through the filter</p></span> </li> |
| 948 |
</ul> |
| 949 |
|
| 950 |
|
| 951 |
</div> |
| 952 |
<a name="methodset_limit" id="set_limit"><!-- --></a> |
| 953 |
<div class="evenrow"> |
| 954 |
|
| 955 |
<div class="method-header"> |
| 956 |
<span class="method-title">set_limit</span> (line <span class="line-number">401</span>) |
| 957 |
</div> |
| 958 |
|
| 959 |
<!-- ========== Info from phpDoc block ========= --> |
| 960 |
<p class="short-description">This function is used to set</p> |
| 961 |
<p class="description"><p>the limit value, which limits the # of rows of data to allow to return</p></p> |
| 962 |
|
| 963 |
<div class="method-signature"> |
| 964 |
<span class="method-result">void</span> |
| 965 |
<span class="method-name"> |
| 966 |
set_limit |
| 967 |
</span> |
| 968 |
(<span class="var-type">mixed</span> <span class="var-name">$limit</span>) |
| 969 |
</div> |
| 970 |
|
| 971 |
|
| 972 |
|
| 973 |
</div> |
| 974 |
<a name="methodset_not_found_message" id="set_not_found_message"><!-- --></a> |
| 975 |
<div class="oddrow"> |
| 976 |
|
| 977 |
<div class="method-header"> |
| 978 |
<span class="method-title">set_not_found_message</span> (line <span class="line-number">235</span>) |
| 979 |
</div> |
| 980 |
|
| 981 |
<!-- ========== Info from phpDoc block ========= --> |
| 982 |
<p class="short-description">This function is used to set the message displayed when no data is found</p> |
| 983 |
|
| 984 |
<div class="method-signature"> |
| 985 |
<span class="method-result">void</span> |
| 986 |
<span class="method-name"> |
| 987 |
set_not_found_message |
| 988 |
</span> |
| 989 |
(<span class="var-type">string</span> <span class="var-name">$mesg</span>) |
| 990 |
</div> |
| 991 |
|
| 992 |
<ul class="parameters"> |
| 993 |
<li> |
| 994 |
<span class="var-type">string</span> |
| 995 |
<span class="var-name">$mesg</span> </li> |
| 996 |
</ul> |
| 997 |
|
| 998 |
|
| 999 |
</div> |
| 1000 |
<a name="methodset_offset" id="set_offset"><!-- --></a> |
| 1001 |
<div class="evenrow"> |
| 1002 |
|
| 1003 |
<div class="method-header"> |
| 1004 |
<span class="method-title">set_offset</span> (line <span class="line-number">277</span>) |
| 1005 |
</div> |
| 1006 |
|
| 1007 |
<!-- ========== Info from phpDoc block ========= --> |
| 1008 |
<p class="short-description">This sets the offset value and resets the index into the data array (in non DB children)</p> |
| 1009 |
|
| 1010 |
<div class="method-signature"> |
| 1011 |
<span class="method-result">void</span> |
| 1012 |
<span class="method-name"> |
| 1013 |
set_offset |
| 1014 |
</span> |
| 1015 |
(<span class="var-type">int</span> <span class="var-name">$offset</span>) |
| 1016 |
</div> |
| 1017 |
|
| 1018 |
<ul class="parameters"> |
| 1019 |
<li> |
| 1020 |
<span class="var-type">int</span> |
| 1021 |
<span class="var-name">$offset</span><span class="var-description">: <p>offset</p></span> </li> |
| 1022 |
</ul> |
| 1023 |
|
| 1024 |
|
| 1025 |
</div> |
| 1026 |
<a name="methodset_orderby" id="set_orderby"><!-- --></a> |
| 1027 |
<div class="oddrow"> |
| 1028 |
|
| 1029 |
<div class="method-header"> |
| 1030 |
<span class="method-title">set_orderby</span> (line <span class="line-number">300</span>) |
| 1031 |
</div> |
| 1032 |
|
| 1033 |
<!-- ========== Info from phpDoc block ========= --> |
| 1034 |
<p class="short-description">This sets the orderby column name.</p> |
| 1035 |
<p class="description"><p>This corresponds to the column that wants to be sorted/ordered, but not the actual direction (asc, desc)</p></p> |
| 1036 |
|
| 1037 |
<div class="method-signature"> |
| 1038 |
<span class="method-result">void</span> |
| 1039 |
<span class="method-name"> |
| 1040 |
set_orderby |
| 1041 |
</span> |
| 1042 |
(<span class="var-type">int</span> <span class="var-name">$orderby</span>) |
| 1043 |
</div> |
| 1044 |
|
| 1045 |
<ul class="parameters"> |
| 1046 |
<li> |
| 1047 |
<span class="var-type">int</span> |
| 1048 |
<span class="var-name">$orderby</span><span class="var-description">: <p>offset</p></span> </li> |
| 1049 |
</ul> |
| 1050 |
|
| 1051 |
|
| 1052 |
</div> |
| 1053 |
<a name="methodset_reverseorder" id="set_reverseorder"><!-- --></a> |
| 1054 |
<div class="evenrow"> |
| 1055 |
|
| 1056 |
<div class="method-header"> |
| 1057 |
<span class="method-title">set_reverseorder</span> (line <span class="line-number">321</span>) |
| 1058 |
</div> |
| 1059 |
|
| 1060 |
<!-- ========== Info from phpDoc block ========= --> |
| 1061 |
<p class="short-description">This sets the flag that tells us the direction in which to order the orderby column.</p> |
| 1062 |
|
| 1063 |
<div class="method-signature"> |
| 1064 |
<span class="method-result">void</span> |
| 1065 |
<span class="method-name"> |
| 1066 |
set_reverseorder |
| 1067 |
</span> |
| 1068 |
(<span class="var-type">int</span> <span class="var-name">$order</span>) |
| 1069 |
</div> |
| 1070 |
|
| 1071 |
<ul class="parameters"> |
| 1072 |
<li> |
| 1073 |
<span class="var-type">int</span> |
| 1074 |
<span class="var-name">$order</span><span class="var-description">: <p>offset</p></span> </li> |
| 1075 |
</ul> |
| 1076 |
|
| 1077 |
|
| 1078 |
</div> |
| 1079 |
<a name="methodset_searchby" id="set_searchby"><!-- --></a> |
| 1080 |
<div class="oddrow"> |
| 1081 |
|
| 1082 |
<div class="method-header"> |
| 1083 |
<span class="method-title">set_searchby</span> (line <span class="line-number">341</span>) |
| 1084 |
</div> |
| 1085 |
|
| 1086 |
<!-- ========== Info from phpDoc block ========= --> |
| 1087 |
<p class="short-description">This sets the column that we want to search from.</p> |
| 1088 |
|
| 1089 |
<div class="method-signature"> |
| 1090 |
<span class="method-result">void</span> |
| 1091 |
<span class="method-name"> |
| 1092 |
set_searchby |
| 1093 |
</span> |
| 1094 |
(<span class="var-type">int</span> <span class="var-name">$search_col</span>) |
| 1095 |
</div> |
| 1096 |
|
| 1097 |
<ul class="parameters"> |
| 1098 |
<li> |
| 1099 |
<span class="var-type">int</span> |
| 1100 |
<span class="var-name">$search_col</span><span class="var-description">: <p>offset</p></span> </li> |
| 1101 |
</ul> |
| 1102 |
|
| 1103 |
|
| 1104 |
</div> |
| 1105 |
<a name="methodset_searchby_value" id="set_searchby_value"><!-- --></a> |
| 1106 |
<div class="evenrow"> |
| 1107 |
|
| 1108 |
<div class="method-header"> |
| 1109 |
<span class="method-title">set_searchby_value</span> (line <span class="line-number">361</span>) |
| 1110 |
</div> |
| 1111 |
|
| 1112 |
<!-- ========== Info from phpDoc block ========= --> |
| 1113 |
<p class="short-description">This sets the data that we want to search for.</p> |
| 1114 |
|
| 1115 |
<div class="method-signature"> |
| 1116 |
<span class="method-result">void</span> |
| 1117 |
<span class="method-name"> |
| 1118 |
set_searchby_value |
| 1119 |
</span> |
| 1120 |
(<span class="var-type">int</span> <span class="var-name">$search_value</span>) |
| 1121 |
</div> |
| 1122 |
|
| 1123 |
<ul class="parameters"> |
| 1124 |
<li> |
| 1125 |
<span class="var-type">int</span> |
| 1126 |
<span class="var-name">$search_value</span><span class="var-description">: <p>offset</p></span> </li> |
| 1127 |
</ul> |
| 1128 |
|
| 1129 |
|
| 1130 |
</div> |
| 1131 |
<a name="methodset_search_type" id="set_search_type"><!-- --></a> |
| 1132 |
<div class="oddrow"> |
| 1133 |
|
| 1134 |
<div class="method-header"> |
| 1135 |
<span class="method-title">set_search_type</span> (line <span class="line-number">422</span>) |
| 1136 |
</div> |
| 1137 |
|
| 1138 |
<!-- ========== Info from phpDoc block ========= --> |
| 1139 |
<p class="short-description">This function sets the search type (simple or advanced)</p> |
| 1140 |
|
| 1141 |
<div class="method-signature"> |
| 1142 |
<span class="method-result">void</span> |
| 1143 |
<span class="method-name"> |
| 1144 |
set_search_type |
| 1145 |
</span> |
| 1146 |
(<span class="var-type">string</span> <span class="var-name">$search_type</span>) |
| 1147 |
</div> |
| 1148 |
|
| 1149 |
<ul class="parameters"> |
| 1150 |
<li> |
| 1151 |
<span class="var-type">string</span> |
| 1152 |
<span class="var-name">$search_type</span> </li> |
| 1153 |
</ul> |
| 1154 |
|
| 1155 |
|
| 1156 |
</div> |
| 1157 |
<a name="methodset_simplesearch_modifier" id="set_simplesearch_modifier"><!-- --></a> |
| 1158 |
<div class="evenrow"> |
| 1159 |
|
| 1160 |
<div class="method-header"> |
| 1161 |
<span class="method-title">set_simplesearch_modifier</span> (line <span class="line-number">381</span>) |
| 1162 |
</div> |
| 1163 |
|
| 1164 |
<!-- ========== Info from phpDoc block ========= --> |
| 1165 |
<p class="short-description">This sets the simple search modifier</p> |
| 1166 |
|
| 1167 |
<div class="method-signature"> |
| 1168 |
<span class="method-result">void</span> |
| 1169 |
<span class="method-name"> |
| 1170 |
set_simplesearch_modifier |
| 1171 |
</span> |
| 1172 |
(<span class="var-type">int</span> <span class="var-name">$search_modifier</span>) |
| 1173 |
</div> |
| 1174 |
|
| 1175 |
<ul class="parameters"> |
| 1176 |
<li> |
| 1177 |
<span class="var-type">int</span> |
| 1178 |
<span class="var-name">$search_modifier</span><span class="var-description">: <p>offset</p></span> </li> |
| 1179 |
</ul> |
| 1180 |
|
| 1181 |
|
| 1182 |
</div> |
| 1183 |
<a name="methodset_total_rows" id="set_total_rows"><!-- --></a> |
| 1184 |
<div class="oddrow"> |
| 1185 |
|
| 1186 |
<div class="method-header"> |
| 1187 |
<span class="method-title">set_total_rows</span> (line <span class="line-number">265</span>) |
| 1188 |
</div> |
| 1189 |
|
| 1190 |
<!-- ========== Info from phpDoc block ========= --> |
| 1191 |
<p class="short-description">This is used to set the total # of rows we have in our data set</p> |
| 1192 |
|
| 1193 |
<div class="method-signature"> |
| 1194 |
<span class="method-result">void</span> |
| 1195 |
<span class="method-name"> |
| 1196 |
set_total_rows |
| 1197 |
</span> |
| 1198 |
(<span class="var-type">int</span> <span class="var-name">$num</span>) |
| 1199 |
</div> |
| 1200 |
|
| 1201 |
<ul class="parameters"> |
| 1202 |
<li> |
| 1203 |
<span class="var-type">int</span> |
| 1204 |
<span class="var-name">$num</span> </li> |
| 1205 |
</ul> |
| 1206 |
|
| 1207 |
|
| 1208 |
</div> |
| 1209 |
<a name="methodsort" id="sort"><!-- --></a> |
| 1210 |
<div class="evenrow"> |
| 1211 |
|
| 1212 |
<div class="method-header"> |
| 1213 |
<span class="method-title">sort</span> (line <span class="line-number">225</span>) |
| 1214 |
</div> |
| 1215 |
|
| 1216 |
<!-- ========== Info from phpDoc block ========= --> |
| 1217 |
<p class="short-description">A generic method API that can be used at the bottom half of the do_query() method to sort data that is stored locally. This is only needed when the source is a non database.</p> |
| 1218 |
<p class="description"><p>It should operate on the $this->_data array</p></p> |
| 1219 |
|
| 1220 |
<div class="method-signature"> |
| 1221 |
<span class="method-result">void</span> |
| 1222 |
<span class="method-name"> |
| 1223 |
sort |
| 1224 |
</span> |
| 1225 |
() |
| 1226 |
</div> |
| 1227 |
|
| 1228 |
|
| 1229 |
|
| 1230 |
<hr class="separator" /> |
| 1231 |
<div class="notes">Redefined in descendants as:</div> |
| 1232 |
<ul class="redefinitions"> |
| 1233 |
<li> |
| 1234 |
<a href="../phpHtmlLib/CSVFILEDataListSource.html#methodsort">CSVFILEDataListSource::sort()</a> |
| 1235 |
</li> |
| 1236 |
<li> |
| 1237 |
<a href="../phpHtmlLib/ArrayDataListSource.html#methodsort">ArrayDataListSource::sort()</a> |
| 1238 |
</li> |
| 1239 |
</ul> |
| 1240 |
</div> |
| 1241 |
<a name="method_is_column_sortable" id="_is_column_sortable"><!-- --></a> |
| 1242 |
<div class="oddrow"> |
| 1243 |
|
| 1244 |
<div class="method-header"> |
| 1245 |
<span class="method-title">_is_column_sortable</span> (line <span class="line-number">456</span>) |
| 1246 |
</div> |
| 1247 |
|
| 1248 |
<!-- ========== Info from phpDoc block ========= --> |
| 1249 |
<p class="short-description">This function determines if the column associated w/ a data_name is sortable or not</p> |
| 1250 |
<ul class="tags"> |
| 1251 |
<li><span class="field">return:</span> <p>- is that column sortable?</p></li> |
| 1252 |
</ul> |
| 1253 |
|
| 1254 |
<div class="method-signature"> |
| 1255 |
<span class="method-result">boolean</span> |
| 1256 |
<span class="method-name"> |
| 1257 |
_is_column_sortable |
| 1258 |
</span> |
| 1259 |
(<span class="var-type">string</span> <span class="var-name">$data_name</span>) |
| 1260 |
</div> |
| 1261 |
|
| 1262 |
<ul class="parameters"> |
| 1263 |
<li> |
| 1264 |
<span class="var-type">string</span> |
| 1265 |
<span class="var-name">$data_name</span><span class="var-description">: <p>- the data_name filed in the _columns array to look for</p></span> </li> |
| 1266 |
</ul> |
| 1267 |
|
| 1268 |
|
| 1269 |
</div> |
| 1270 |
|
| 1271 |
</div> |
| 1272 |
</div> |
| 1273 |
|
| 1274 |
<p class="notes" id="credit"> |
| 1275 |
Documention generated on Thu, 31 Jul 2003 18:32:23 -0700 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.0</a> |
| 1276 |
</p> |
| 1277 |
</div></body> |
| 1278 |
</html> |
Parent Directory
| 
Revision Log
