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