/[cvs]/nfo/php/libs/com.newsblob.phphtmllib/doc/phpHtmlLib/DataListSource.html
ViewVC logotype

Contents of /nfo/php/libs/com.newsblob.phphtmllib/doc/phpHtmlLib/DataListSource.html

Parent Directory Parent Directory | Revision Log Revision Log

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