| 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 ArrayDataListSource</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 ArrayDataListSource</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-vars">Vars</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 DataListSource child class gets the data from an external array</p> |
| 28 |
<p class="description"><p>The array is a 2D array and each sub-array is a set of elements for each row in the list</p></p> |
| 29 |
<ul class="tags"> |
| 30 |
<li><span class="field">author:</span> Suren Markossian <<a href="mailto:suren_markossian@yahoo.com">suren_markossian@yahoo.com</a>></li> |
| 31 |
</ul> |
| 32 |
<p class="notes"> |
| 33 |
Located in <a class="field" href="_widgets_data_list_ArrayDataListSource_inc.html">/widgets/data_list/ArrayDataListSource.inc</a> (line <span class="field">29</span>) |
| 34 |
</p> |
| 35 |
|
| 36 |
|
| 37 |
<pre><a href="../phpHtmlLib/DataListSource.html">DataListSource</a> |
| 38 |
| |
| 39 |
--ArrayDataListSource</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-vars">Vars</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/CSVFILEDataListSource.html">CSVFILEDataListSource</a></td> |
| 62 |
<td> |
| 63 |
This DataListSource child class gets the data from a CSV (comma seperated values) file on disk. |
| 64 |
</td> |
| 65 |
</tr> |
| 66 |
</table> |
| 67 |
</div> |
| 68 |
</div> |
| 69 |
|
| 70 |
|
| 71 |
|
| 72 |
<a name="sec-method-summary"></a> |
| 73 |
<div class="info-box"> |
| 74 |
<div class="info-box-title">Method Summary</span></div> |
| 75 |
<div class="nav-bar"> |
| 76 |
<a href="#sec-description">Description</a> | |
| 77 |
<a href="#sec-descendents">Descendents</a> | |
| 78 |
<a href="#sec-vars">Vars</a> |
| 79 |
|
| 80 |
| |
| 81 |
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>) |
| 82 |
</div> |
| 83 |
<div class="info-box-body"> |
| 84 |
<div class="method-summary"> |
| 85 |
|
| 86 |
<div class="method-definition"> |
| 87 |
<span class="method-result">ArrayDataListSource</span> |
| 88 |
<a href="#ArrayDataListSource" title="details" class="method-name">ArrayDataListSource</a> |
| 89 |
(<span class="var-type">array</span> <span class="var-name">&$data</span>) |
| 90 |
</div> |
| 91 |
|
| 92 |
<div class="method-definition"> |
| 93 |
<span class="method-result">natural</span> |
| 94 |
<a href="#cmp" title="details" class="method-name">cmp</a> |
| 95 |
(<span class="var-type">string</span> <span class="var-name">$data1</span>, <span class="var-type">string</span> <span class="var-name">$data2</span>) |
| 96 |
</div> |
| 97 |
|
| 98 |
<div class="method-definition"> |
| 99 |
<span class="method-result">compare</span> |
| 100 |
<a href="#cmp_numeric" title="details" class="method-name">cmp_numeric</a> |
| 101 |
(<span class="var-type">string</span> <span class="var-name">$data1</span>, <span class="var-type">string</span> <span class="var-name">$data2</span>) |
| 102 |
</div> |
| 103 |
|
| 104 |
<div class="method-definition"> |
| 105 |
<span class="method-result">void</span> |
| 106 |
<a href="#do_prequery" title="details" class="method-name">do_prequery</a> |
| 107 |
() |
| 108 |
</div> |
| 109 |
|
| 110 |
<div class="method-definition"> |
| 111 |
<span class="method-result">void</span> |
| 112 |
<a href="#do_query" title="details" class="method-name">do_query</a> |
| 113 |
() |
| 114 |
</div> |
| 115 |
|
| 116 |
<div class="method-definition"> |
| 117 |
<span class="method-result">int</span> |
| 118 |
<a href="#get_data_index" title="details" class="method-name">get_data_index</a> |
| 119 |
() |
| 120 |
</div> |
| 121 |
|
| 122 |
<div class="method-definition"> |
| 123 |
<span class="method-result">void</span> |
| 124 |
<a href="#get_next_data_row" title="details" class="method-name">get_next_data_row</a> |
| 125 |
() |
| 126 |
</div> |
| 127 |
|
| 128 |
<div class="method-definition"> |
| 129 |
<span class="method-result">boolean</span> |
| 130 |
<a href="#prequery_row_filter" title="details" class="method-name">prequery_row_filter</a> |
| 131 |
(<span class="var-type">array</span> <span class="var-name">&$row_data</span>) |
| 132 |
</div> |
| 133 |
|
| 134 |
<div class="method-definition"> |
| 135 |
<span class="method-result">none</span> |
| 136 |
<a href="#sort" title="details" class="method-name">sort</a> |
| 137 |
() |
| 138 |
</div> |
| 139 |
|
| 140 |
<div class="method-definition"> |
| 141 |
<span class="method-result">boolean</span> |
| 142 |
<a href="#_find_data" title="details" class="method-name">_find_data</a> |
| 143 |
(<span class="var-type">array</span> <span class="var-name">$row_data</span>) |
| 144 |
</div> |
| 145 |
|
| 146 |
<div class="method-definition"> |
| 147 |
<span class="method-result">void</span> |
| 148 |
<a href="#_prequery_filter" title="details" class="method-name">_prequery_filter</a> |
| 149 |
() |
| 150 |
</div> |
| 151 |
</div> |
| 152 |
</div> |
| 153 |
</div> |
| 154 |
|
| 155 |
<a name="sec-vars"></a> |
| 156 |
<div class="info-box"> |
| 157 |
<div class="info-box-title">Variables</div> |
| 158 |
<div class="nav-bar"> |
| 159 |
<a href="#sec-description">Description</a> | |
| 160 |
<a href="#sec-descendents">Descendents</a> | |
| 161 |
<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>) |
| 162 |
|
| 163 |
|
| 164 |
| |
| 165 |
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
| 166 |
|
| 167 |
</div> |
| 168 |
<div class="info-box-body"> |
| 169 |
|
| 170 |
<h4>Inherited Variables</h4> |
| 171 |
<A NAME='inherited_vars'><!-- --></A> |
| 172 |
<p>Inherited from <span class="classname"><a href="../phpHtmlLib/DataListSource.html">DataListSource</a></span></p> |
| 173 |
<blockquote> |
| 174 |
<span class="var-title"> |
| 175 |
<span class="var-name"><a href="../phpHtmlLib/DataListSource.html#var$_columns">DataListSource::$_columns</a></span><br> |
| 176 |
</span> |
| 177 |
<span class="var-title"> |
| 178 |
<span class="var-name"><a href="../phpHtmlLib/DataListSource.html#var$_data">DataListSource::$_data</a></span><br> |
| 179 |
</span> |
| 180 |
<span class="var-title"> |
| 181 |
<span class="var-name"><a href="../phpHtmlLib/DataListSource.html#var$_data_index">DataListSource::$_data_index</a></span><br> |
| 182 |
</span> |
| 183 |
<span class="var-title"> |
| 184 |
<span class="var-name"><a href="../phpHtmlLib/DataListSource.html#var$_not_found_message">DataListSource::$_not_found_message</a></span><br> |
| 185 |
</span> |
| 186 |
<span class="var-title"> |
| 187 |
<span class="var-name"><a href="../phpHtmlLib/DataListSource.html#var$_query_params">DataListSource::$_query_params</a></span><br> |
| 188 |
</span> |
| 189 |
</blockquote> |
| 190 |
|
| 191 |
</div> |
| 192 |
</div> |
| 193 |
|
| 194 |
<a name="sec-methods"></a> |
| 195 |
<div class="info-box"> |
| 196 |
<div class="info-box-title">Methods</div> |
| 197 |
<div class="nav-bar"> |
| 198 |
<a href="#sec-description">Description</a> | |
| 199 |
<a href="#sec-descendents">Descendents</a> | |
| 200 |
<a href="#sec-vars">Vars</a> |
| 201 |
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>) |
| 202 |
|
| 203 |
</div> |
| 204 |
<div class="info-box-body"> |
| 205 |
<A NAME='method_detail'></A> |
| 206 |
<a name="methodArrayDataListSource" id="ArrayDataListSource"><!-- --></a> |
| 207 |
<div class="oddrow"> |
| 208 |
|
| 209 |
<div class="method-header"> |
| 210 |
<span class="method-title">Constructor ArrayDataListSource</span> (line <span class="line-number">37</span>) |
| 211 |
</div> |
| 212 |
|
| 213 |
<!-- ========== Info from phpDoc block ========= --> |
| 214 |
<p class="short-description">The constructor.</p> |
| 215 |
|
| 216 |
<div class="method-signature"> |
| 217 |
<span class="method-result">ArrayDataListSource</span> |
| 218 |
<span class="method-name"> |
| 219 |
ArrayDataListSource |
| 220 |
</span> |
| 221 |
(<span class="var-type">array</span> <span class="var-name">&$data</span>) |
| 222 |
</div> |
| 223 |
|
| 224 |
<ul class="parameters"> |
| 225 |
<li> |
| 226 |
<span class="var-type">array</span> |
| 227 |
<span class="var-name">&$data</span><span class="var-description">: data - an array of array elements for each row</span> </li> |
| 228 |
</ul> |
| 229 |
|
| 230 |
|
| 231 |
</div> |
| 232 |
<a name="methodcmp" id="cmp"><!-- --></a> |
| 233 |
<div class="evenrow"> |
| 234 |
|
| 235 |
<div class="method-header"> |
| 236 |
<span class="method-title">cmp</span> (line <span class="line-number">185</span>) |
| 237 |
</div> |
| 238 |
|
| 239 |
<!-- ========== Info from phpDoc block ========= --> |
| 240 |
<p class="short-description">This method is used for comparing 2 string values</p> |
| 241 |
<ul class="tags"> |
| 242 |
<li><span class="field">return:</span> compare results</li> |
| 243 |
</ul> |
| 244 |
|
| 245 |
<div class="method-signature"> |
| 246 |
<span class="method-result">natural</span> |
| 247 |
<span class="method-name"> |
| 248 |
cmp |
| 249 |
</span> |
| 250 |
(<span class="var-type">string</span> <span class="var-name">$data1</span>, <span class="var-type">string</span> <span class="var-name">$data2</span>) |
| 251 |
</div> |
| 252 |
|
| 253 |
<ul class="parameters"> |
| 254 |
<li> |
| 255 |
<span class="var-type">string</span> |
| 256 |
<span class="var-name">$data1</span><span class="var-description">: first entry to compare</span> </li> |
| 257 |
<li> |
| 258 |
<span class="var-type">string</span> |
| 259 |
<span class="var-name">$data2</span><span class="var-description">: second entry to compare</span> </li> |
| 260 |
</ul> |
| 261 |
|
| 262 |
|
| 263 |
</div> |
| 264 |
<a name="methodcmp_numeric" id="cmp_numeric"><!-- --></a> |
| 265 |
<div class="oddrow"> |
| 266 |
|
| 267 |
<div class="method-header"> |
| 268 |
<span class="method-title">cmp_numeric</span> (line <span class="line-number">204</span>) |
| 269 |
</div> |
| 270 |
|
| 271 |
<!-- ========== Info from phpDoc block ========= --> |
| 272 |
<p class="short-description">This method is used for comparing 2 numerical values</p> |
| 273 |
<ul class="tags"> |
| 274 |
<li><span class="field">return:</span> results</li> |
| 275 |
</ul> |
| 276 |
|
| 277 |
<div class="method-signature"> |
| 278 |
<span class="method-result">compare</span> |
| 279 |
<span class="method-name"> |
| 280 |
cmp_numeric |
| 281 |
</span> |
| 282 |
(<span class="var-type">string</span> <span class="var-name">$data1</span>, <span class="var-type">string</span> <span class="var-name">$data2</span>) |
| 283 |
</div> |
| 284 |
|
| 285 |
<ul class="parameters"> |
| 286 |
<li> |
| 287 |
<span class="var-type">string</span> |
| 288 |
<span class="var-name">$data1</span><span class="var-description">: first entry to compare</span> </li> |
| 289 |
<li> |
| 290 |
<span class="var-type">string</span> |
| 291 |
<span class="var-name">$data2</span><span class="var-description">: second entry to compare</span> </li> |
| 292 |
</ul> |
| 293 |
|
| 294 |
|
| 295 |
</div> |
| 296 |
<a name="methoddo_prequery" id="do_prequery"><!-- --></a> |
| 297 |
<div class="evenrow"> |
| 298 |
|
| 299 |
<div class="method-header"> |
| 300 |
<span class="method-title">do_prequery</span> (line <span class="line-number">71</span>) |
| 301 |
</div> |
| 302 |
|
| 303 |
<!-- ========== Info from phpDoc block ========= --> |
| 304 |
<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> |
| 305 |
<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> |
| 306 |
|
| 307 |
<div class="method-signature"> |
| 308 |
<span class="method-result">void</span> |
| 309 |
<span class="method-name"> |
| 310 |
do_prequery |
| 311 |
</span> |
| 312 |
() |
| 313 |
</div> |
| 314 |
|
| 315 |
|
| 316 |
<hr class="separator" /> |
| 317 |
<div class="notes">Redefinition of:</div> |
| 318 |
<dl> |
| 319 |
<dt><a href="../phpHtmlLib/DataListSource.html#methoddo_prequery">DataListSource::do_prequery()</a></dt> |
| 320 |
<dd>This is a method that should be defined by the child class to do any pre-query type of things.</dd> |
| 321 |
</dl> |
| 322 |
|
| 323 |
<hr class="separator" /> |
| 324 |
<div class="notes">Redefined in descendants as:</div> |
| 325 |
<ul class="redefinitions"> |
| 326 |
<li> |
| 327 |
<a href="../phpHtmlLib/CSVFILEDataListSource.html#methoddo_prequery">CSVFILEDataListSource::do_prequery()</a> |
| 328 |
: The prequery. We use this to read the file |
| 329 |
</li> |
| 330 |
</ul> |
| 331 |
</div> |
| 332 |
<a name="methoddo_query" id="do_query"><!-- --></a> |
| 333 |
<div class="oddrow"> |
| 334 |
|
| 335 |
<div class="method-header"> |
| 336 |
<span class="method-title">do_query</span> (line <span class="line-number">45</span>) |
| 337 |
</div> |
| 338 |
|
| 339 |
<!-- ========== Info from phpDoc block ========= --> |
| 340 |
<p class="short-description">This function does the query</p> |
| 341 |
<p class="description"><p>and search/sort</p></p> |
| 342 |
|
| 343 |
<div class="method-signature"> |
| 344 |
<span class="method-result">void</span> |
| 345 |
<span class="method-name"> |
| 346 |
do_query |
| 347 |
</span> |
| 348 |
() |
| 349 |
</div> |
| 350 |
|
| 351 |
|
| 352 |
<hr class="separator" /> |
| 353 |
<div class="notes">Redefinition of:</div> |
| 354 |
<dl> |
| 355 |
<dt><a href="../phpHtmlLib/DataListSource.html#methoddo_query">DataListSource::do_query()</a></dt> |
| 356 |
<dd>This is the function that does the data fetching, and sorting if needed.</dd> |
| 357 |
</dl> |
| 358 |
|
| 359 |
<hr class="separator" /> |
| 360 |
<div class="notes">Redefined in descendants as:</div> |
| 361 |
<ul class="redefinitions"> |
| 362 |
<li> |
| 363 |
<a href="../phpHtmlLib/CSVFILEDataListSource.html#methoddo_query">CSVFILEDataListSource::do_query()</a> |
| 364 |
: This function does the query |
| 365 |
</li> |
| 366 |
</ul> |
| 367 |
</div> |
| 368 |
<a name="methodget_data_index" id="get_data_index"><!-- --></a> |
| 369 |
<div class="evenrow"> |
| 370 |
|
| 371 |
<div class="method-header"> |
| 372 |
<span class="method-title">get_data_index</span> (line <span class="line-number">141</span>) |
| 373 |
</div> |
| 374 |
|
| 375 |
<!-- ========== Info from phpDoc block ========= --> |
| 376 |
<p class="short-description">This function returns the data_index value and increments it</p> |
| 377 |
|
| 378 |
<div class="method-signature"> |
| 379 |
<span class="method-result">int</span> |
| 380 |
<span class="method-name"> |
| 381 |
get_data_index |
| 382 |
</span> |
| 383 |
() |
| 384 |
</div> |
| 385 |
|
| 386 |
|
| 387 |
<hr class="separator" /> |
| 388 |
<div class="notes">Redefinition of:</div> |
| 389 |
<dl> |
| 390 |
<dt><a href="../phpHtmlLib/DataListSource.html#methodget_data_index">DataListSource::get_data_index()</a></dt> |
| 391 |
<dd>This function returns the data_index value and increments it</dd> |
| 392 |
</dl> |
| 393 |
|
| 394 |
</div> |
| 395 |
<a name="methodget_next_data_row" id="get_next_data_row"><!-- --></a> |
| 396 |
<div class="oddrow"> |
| 397 |
|
| 398 |
<div class="method-header"> |
| 399 |
<span class="method-title">get_next_data_row</span> (line <span class="line-number">80</span>) |
| 400 |
</div> |
| 401 |
|
| 402 |
<!-- ========== Info from phpDoc block ========= --> |
| 403 |
<p class="short-description">This function returns the next row of valid data.</p> |
| 404 |
|
| 405 |
<div class="method-signature"> |
| 406 |
<span class="method-result">void</span> |
| 407 |
<span class="method-name"> |
| 408 |
get_next_data_row |
| 409 |
</span> |
| 410 |
() |
| 411 |
</div> |
| 412 |
|
| 413 |
|
| 414 |
<hr class="separator" /> |
| 415 |
<div class="notes">Redefinition of:</div> |
| 416 |
<dl> |
| 417 |
<dt><a href="../phpHtmlLib/DataListSource.html#methodget_next_data_row">DataListSource::get_next_data_row()</a></dt> |
| 418 |
<dd>This function gets the next data row from the query()</dd> |
| 419 |
</dl> |
| 420 |
|
| 421 |
</div> |
| 422 |
<a name="methodprequery_row_filter" id="prequery_row_filter"><!-- --></a> |
| 423 |
<div class="evenrow"> |
| 424 |
|
| 425 |
<div class="method-header"> |
| 426 |
<span class="method-title">prequery_row_filter</span> (line <span class="line-number">111</span>) |
| 427 |
</div> |
| 428 |
|
| 429 |
<!-- ========== Info from phpDoc block ========= --> |
| 430 |
<p class="short-description">This is used to perform pre-query filtering Gives us a chance to run the next row through a filter before any processing has been done</p> |
| 431 |
<ul class="tags"> |
| 432 |
<li><span class="field">return:</span> - TRUE = allow the row. FALSE = drop it.</li> |
| 433 |
</ul> |
| 434 |
|
| 435 |
<div class="method-signature"> |
| 436 |
<span class="method-result">boolean</span> |
| 437 |
<span class="method-name"> |
| 438 |
prequery_row_filter |
| 439 |
</span> |
| 440 |
(<span class="var-type">array</span> <span class="var-name">&$row_data</span>) |
| 441 |
</div> |
| 442 |
|
| 443 |
<ul class="parameters"> |
| 444 |
<li> |
| 445 |
<span class="var-type">array</span> |
| 446 |
<span class="var-name">&$row_data</span><span class="var-description">: - the row to run through the filter</span> </li> |
| 447 |
</ul> |
| 448 |
|
| 449 |
|
| 450 |
</div> |
| 451 |
<a name="methodsort" id="sort"><!-- --></a> |
| 452 |
<div class="oddrow"> |
| 453 |
|
| 454 |
<div class="method-header"> |
| 455 |
<span class="method-title">sort</span> (line <span class="line-number">154</span>) |
| 456 |
</div> |
| 457 |
|
| 458 |
<!-- ========== Info from phpDoc block ========= --> |
| 459 |
<p class="short-description">This method sorts our data array by the requested column order by. This could be expensive for HUGE arrays.</p> |
| 460 |
|
| 461 |
<div class="method-signature"> |
| 462 |
<span class="method-result">none</span> |
| 463 |
<span class="method-name"> |
| 464 |
sort |
| 465 |
</span> |
| 466 |
() |
| 467 |
</div> |
| 468 |
|
| 469 |
|
| 470 |
<hr class="separator" /> |
| 471 |
<div class="notes">Redefinition of:</div> |
| 472 |
<dl> |
| 473 |
<dt><a href="../phpHtmlLib/DataListSource.html#methodsort">DataListSource::sort()</a></dt> |
| 474 |
<dd>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.</dd> |
| 475 |
</dl> |
| 476 |
|
| 477 |
</div> |
| 478 |
<a name="method_find_data" id="_find_data"><!-- --></a> |
| 479 |
<div class="evenrow"> |
| 480 |
|
| 481 |
<div class="method-header"> |
| 482 |
<span class="method-title">_find_data</span> (line <span class="line-number">227</span>) |
| 483 |
</div> |
| 484 |
|
| 485 |
<!-- ========== Info from phpDoc block ========= --> |
| 486 |
<p class="short-description">This is used to do the default search capability in the DataListSource parent class.</p> |
| 487 |
<p class="description"><p>This is used so we can filter our results to what the user searched for.</p></p> |
| 488 |
<ul class="tags"> |
| 489 |
<li><span class="field">return:</span> found it or not</li> |
| 490 |
</ul> |
| 491 |
|
| 492 |
<div class="method-signature"> |
| 493 |
<span class="method-result">boolean</span> |
| 494 |
<span class="method-name"> |
| 495 |
_find_data |
| 496 |
</span> |
| 497 |
(<span class="var-type">array</span> <span class="var-name">$row_data</span>) |
| 498 |
</div> |
| 499 |
|
| 500 |
<ul class="parameters"> |
| 501 |
<li> |
| 502 |
<span class="var-type">array</span> |
| 503 |
<span class="var-name">$row_data</span><span class="var-description">: the row data entry. We will look for a specific column's value here to test against.</span> </li> |
| 504 |
</ul> |
| 505 |
|
| 506 |
|
| 507 |
</div> |
| 508 |
<a name="method_prequery_filter" id="_prequery_filter"><!-- --></a> |
| 509 |
<div class="oddrow"> |
| 510 |
|
| 511 |
<div class="method-header"> |
| 512 |
<span class="method-title">_prequery_filter</span> (line <span class="line-number">123</span>) |
| 513 |
</div> |
| 514 |
|
| 515 |
<!-- ========== Info from phpDoc block ========= --> |
| 516 |
<p class="short-description">This is called to allow rebuilding the data array to remove elements that have to be filtered</p> |
| 517 |
<p class="description"><p>This is done on pre-processing phase and used for simple and advanced searches</p></p> |
| 518 |
|
| 519 |
<div class="method-signature"> |
| 520 |
<span class="method-result">void</span> |
| 521 |
<span class="method-name"> |
| 522 |
_prequery_filter |
| 523 |
</span> |
| 524 |
() |
| 525 |
</div> |
| 526 |
|
| 527 |
|
| 528 |
|
| 529 |
<hr class="separator" /> |
| 530 |
<div class="notes">Redefined in descendants as:</div> |
| 531 |
<ul class="redefinitions"> |
| 532 |
<li> |
| 533 |
<a href="../phpHtmlLib/CSVFILEDataListSource.html#method_prequery_filter">CSVFILEDataListSource::_prequery_filter()</a> |
| 534 |
: Lets walk the file and read the entry, and filter what we don't want. |
| 535 |
</li> |
| 536 |
</ul> |
| 537 |
</div> |
| 538 |
<h4>Inherited Methods</h4> |
| 539 |
<a name='inherited_methods'><!-- --></a> |
| 540 |
<!-- =========== Summary =========== --> |
| 541 |
<p>Inherited From <span class="classname"><a href="../phpHtmlLib/DataListSource.html">DataListSource</a></span></p> |
| 542 |
<blockquote> |
| 543 |
<span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodDataListSource">DataListSource::DataListSource()</a></span><br> |
| 544 |
<span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodadd_column">DataListSource::add_column()</a></span><br> |
| 545 |
<span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methoddo_prequery">DataListSource::do_prequery()</a></span><br> |
| 546 |
<span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methoddo_query">DataListSource::do_query()</a></span><br> |
| 547 |
<span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodget_data_index">DataListSource::get_data_index()</a></span><br> |
| 548 |
<span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodget_limit">DataListSource::get_limit()</a></span><br> |
| 549 |
<span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodget_next_data_row">DataListSource::get_next_data_row()</a></span><br> |
| 550 |
<span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodget_not_found_message">DataListSource::get_not_found_message()</a></span><br> |
| 551 |
<span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodget_offset">DataListSource::get_offset()</a></span><br> |
| 552 |
<span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodget_orderby">DataListSource::get_orderby()</a></span><br> |
| 553 |
<span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodget_reverseorder">DataListSource::get_reverseorder()</a></span><br> |
| 554 |
<span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodget_searchby">DataListSource::get_searchby()</a></span><br> |
| 555 |
<span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodget_searchby_value">DataListSource::get_searchby_value()</a></span><br> |
| 556 |
<span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodget_search_type">DataListSource::get_search_type()</a></span><br> |
| 557 |
<span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodget_secondary_orderby">DataListSource::get_secondary_orderby()</a></span><br> |
| 558 |
<span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodget_simplesearch_modifier">DataListSource::get_simplesearch_modifier()</a></span><br> |
| 559 |
<span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodget_total_rows">DataListSource::get_total_rows()</a></span><br> |
| 560 |
<span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodquery">DataListSource::query()</a></span><br> |
| 561 |
<span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodrow_filter">DataListSource::row_filter()</a></span><br> |
| 562 |
<span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodset_limit">DataListSource::set_limit()</a></span><br> |
| 563 |
<span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodset_not_found_message">DataListSource::set_not_found_message()</a></span><br> |
| 564 |
<span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodset_offset">DataListSource::set_offset()</a></span><br> |
| 565 |
<span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodset_orderby">DataListSource::set_orderby()</a></span><br> |
| 566 |
<span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodset_reverseorder">DataListSource::set_reverseorder()</a></span><br> |
| 567 |
<span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodset_searchby">DataListSource::set_searchby()</a></span><br> |
| 568 |
<span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodset_searchby_value">DataListSource::set_searchby_value()</a></span><br> |
| 569 |
<span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodset_search_type">DataListSource::set_search_type()</a></span><br> |
| 570 |
<span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodset_secondary_orderby">DataListSource::set_secondary_orderby()</a></span><br> |
| 571 |
<span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodset_simplesearch_modifier">DataListSource::set_simplesearch_modifier()</a></span><br> |
| 572 |
<span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodset_total_rows">DataListSource::set_total_rows()</a></span><br> |
| 573 |
<span class="method-name"><a href="../phpHtmlLib/DataListSource.html#methodsort">DataListSource::sort()</a></span><br> |
| 574 |
<span class="method-name"><a href="../phpHtmlLib/DataListSource.html#method_is_column_sortable">DataListSource::_is_column_sortable()</a></span><br> |
| 575 |
</blockquote> |
| 576 |
|
| 577 |
</div> |
| 578 |
</div> |
| 579 |
|
| 580 |
|
| 581 |
<p class="notes" id="credit"> |
| 582 |
Documentation generated on Thu, 1 Apr 2004 09:38:05 -0800 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0RC2</a> |
| 583 |
</p> |
| 584 |
</div></body> |
| 585 |
</html> |
Parent Directory
| 
Revision Log
