/[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.1 - (show annotations)
Thu Jan 30 03:29:35 2003 UTC (21 years, 6 months ago) by jonen
Branch: MAIN
Branch point for: no_vendor_tag
File MIME type: text/html 
Initial revision
1 <!DOCTYPE HTML PUBLIC '-//W3C//DTD HTML 4.0 Frameset//EN''http://www.w3.org/TR/REC-html40/frameset.dtd'>
2 <!--NewPage-->
3 <HTML>
4 <HEAD>
5 <!-- Generated by PhpDoc date: 'Mon, 25 Nov 2002 09:21:30 -0800' -->
6 <TITLE>Docs For Class DataListSource</TITLE>
7 <LINK REL ='stylesheet' TYPE='text/css' HREF='stylesheet.css' TITLE='Style'>
8 </HEAD>
9 <BODY style="background-color: #eeeeee; font-family: arial; font-size: .9em;">
10
11
12 <!-- Links -->
13 <a NAME="top"></A>
14 <table WIDTH="100%" class="links">
15 <TR>
16 <TD class="font10">
17 Links:
18 <A HREF="#children_summary" class="links" title="Classes extended from DataListSource">Child Classes</A>
19 <A HREF="#var_summary" class="links" title="Class Variable Summary">Variables</A>
20 <A HREF="#var_inherited_summary" class="links" title="Inherited Class Variable Summary">Inherited Variables</A>
21 <A HREF="#functions_inherited" class="links" title="Inherited Method Summary">Inerited Methods</A>
22 <A HREF="#functions_summary" class="links" title="Method Summary">Methods</A>
23 <A HREF="#variable_detail" class="links" title="Variable Detail">Variable Detail</A>
24 <A HREF="#function_detail" class="links" title="Method Detail">Method Detail</A>
25 </TD>
26 </TR>
27 </TABLE>
28 <BR>
29
30 <!-- Start of Class Data -->
31 <H2>
32 Class DataListSource
33 </H2>
34
35 <pre>
36 DataListSource
37 </pre>
38
39 <A NAME="children_summary"</A>
40 <H3>
41 Classes extended from DataListSource: <A HREF="#top" CLASS="links">^TOP</A>
42 </H3>
43 <a href="../phpHtmlLib/SQLDataListSource.html">SQLDataListSource</a>, <a href="../phpHtmlLib/CSVFILEDataListSource.html">CSVFILEDataListSource</a>
44 <p>
45 <b><i>Located in File: Program_Root/widgets/data_list/DataListSource.inc</i></b><br>
46 </p>
47 <hr>
48 <!-- ========== Info from phpDoc block ========= -->
49 This is the base class for managing data for
50 <BR>
51 the DataList class. This abstracts away the
52 underlying data layer from the DataList, so
53 the data can come from multiple sources.
54 Most of the time the data will come from a
55 data base such as Mysql or Oracle. This
56 abstraction enables the data to also come from
57 a tab delimited file, xml, php array
58
59 <UL>
60
61 <LI><b>Package</b> - <CODE>phpHtmlLib</CODE></LI>
62
63 <LI><b>Author</b> - <CODE>Walter A. Boring IV &lt;<a href="mailto:waboring@buildabetterweb.com">waboring@buildabetterweb.com</a>&gt;</CODE></LI>
64
65 </UL>
66
67 <hr>
68 <!-- =========== VAR SUMMARY =========== -->
69 <A NAME='var_summary'><!-- --></A>
70 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
71 <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
72 <TD>
73 <span CLASS="font12bold">Class Variable Summary</span>
74 <A HREF="#top" CLASS="links">^TOP</A>
75 </TD>
76 </TR>
77
78
79 <!-- =========== Summary =========== -->
80 <TR BGCOLOR='white' CLASS='TableRowColor'>
81 <TD>
82 <CODE><B><A HREF='DataListSource.html#$_columns'>$_columns</A></B></CODE>
83 <BR>
84 <blockquote> The column descriptions
85 for the data we are working on </blockquote>
86 <blockquote> Default Value: <CODE>->array()<-</CODE> </blockquote>
87 </TD>
88 </TR>
89
90 <!-- =========== Summary =========== -->
91 <TR BGCOLOR='white' CLASS='TableRowColor'>
92 <TD>
93 <CODE><B><A HREF='DataListSource.html#$_data'>$_data</A></B></CODE>
94 <BR>
95 <blockquote> A placeholder for data that is read/built </blockquote>
96 <blockquote> Default Value: <CODE>->array()<-</CODE> </blockquote>
97 </TD>
98 </TR>
99
100 <!-- =========== Summary =========== -->
101 <TR BGCOLOR='white' CLASS='TableRowColor'>
102 <TD>
103 <CODE><B><A HREF='DataListSource.html#$_data_index'>$_data_index</A></B></CODE>
104 <BR>
105 <blockquote> Holds the index into the array of data </blockquote>
106 <blockquote> Default Value: <CODE>->0<-</CODE> </blockquote>
107 </TD>
108 </TR>
109
110 <!-- =========== Summary =========== -->
111 <TR BGCOLOR='white' CLASS='TableRowColor'>
112 <TD>
113 <CODE><B><A HREF='DataListSource.html#$_not_found_message'>$_not_found_message</A></B></CODE>
114 <BR>
115 <blockquote> This is the message displayed when no data </blockquote>
116 <blockquote> Default Value: <CODE>->No data was found<-</CODE> </blockquote>
117 </TD>
118 </TR>
119
120 <!-- =========== Summary =========== -->
121 <TR BGCOLOR='white' CLASS='TableRowColor'>
122 <TD>
123 <CODE><B><A HREF='DataListSource.html#$_query_params'>$_query_params</A></B></CODE>
124 <BR>
125 <blockquote> This holds various parameters relating
126 to the query of the data </blockquote>
127 <blockquote> Default Value: <CODE>->array(&quot;num_total_rows&quot; =&gt; 0,
128 &quot;offset&quot; =&gt; 0,
129 &quot;limit&quot; =&gt; -1,
130 &quot;orderby&quot; =&gt; '',
131 &quot;reverseorder&quot; =&gt; '',
132 &quot;searchby&quot; =&gt; '',
133 &quot;searchvalue&quot; =&gt; '',
134 &quot;searchmodifier&quot; =&gt; '',
135 &quot;searchtype&quot; =&gt; 'simple')<-</CODE> </blockquote>
136 </TD>
137 </TR>
138
139 </TABLE>
140
141 <hr>
142 <!-- =========== VAR INHERITED SUMMARY =========== -->
143 <A NAME='var_inherited_summary'><!-- --></A>
144 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
145 <TR CLASS='TableHeadingColor'>
146 <TD>
147 <span CLASS="font12bold">Inherited Class Variable Summary</span>
148 <A HREF="#top" CLASS="links">^TOP</A>
149 </TD>
150 </TR>
151
152
153 </TABLE>
154
155 <hr>
156 <!-- =========== INHERITED METHOD SUMMARY =========== -->
157 <A NAME='functions_inherited'><!-- --></A>
158 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
159 <TR CLASS='TableHeadingColor'>
160 <TD>
161 <span CLASS="font12bold">Inherited Method Summary</span>
162 <A HREF="#top" CLASS="links">^TOP</A>
163 </TD>
164 </TR>
165
166
167 </TABLE>
168
169 <hr>
170 <!-- should have constructor at some point -->
171 <!-- =========== Method SUMMARY =========== -->
172 <A NAME='Method_summary'><!-- --></A>
173 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' Class="border">
174 <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
175 <TD>
176 <span class="font12bold">Method Summary</span>
177 <A HREF="#top" CLASS="links">^TOP</A>
178 </TD>
179 </TR>
180
181
182 <!-- =========== Summary =========== -->
183 <TR BGCOLOR='white' CLASS='TableRowColor'>
184 <TD>
185 <CODE><B><A HREF='DataListSource.html#constructor DataListSource'>void constructor DataListSource ( )</A></B></CODE>
186 <BR>
187 <blockquote> The constructor </blockquote>
188 </TD>
189 </TR>
190
191 <!-- =========== Summary =========== -->
192 <TR BGCOLOR='white' CLASS='TableRowColor'>
193 <TD>
194 <CODE><B><A HREF='DataListSource.html#add_column'>void add_column ( $title, $data_name, [$sortable = FALSE], [$searchable = FALSE], [$sortorder = "ASC"] )</A></B></CODE>
195 <BR>
196 <blockquote> Add a column of data to manage </blockquote>
197 </TD>
198 </TR>
199
200 <!-- =========== Summary =========== -->
201 <TR BGCOLOR='white' CLASS='TableRowColor'>
202 <TD>
203 <CODE><B><A HREF='DataListSource.html#do_prequery'>void do_prequery ( )</A></B></CODE>
204 <BR>
205 <blockquote> This is a method that should be defined by the
206 child class to do any pre-query type of things. </blockquote>
207 </TD>
208 </TR>
209
210 <!-- =========== Summary =========== -->
211 <TR BGCOLOR='white' CLASS='TableRowColor'>
212 <TD>
213 <CODE><B><A HREF='DataListSource.html#do_query'>void do_query ( )</A></B></CODE>
214 <BR>
215 <blockquote> This is the function that does the data fetching,
216 and sorting if needed. </blockquote>
217 </TD>
218 </TR>
219
220 <!-- =========== Summary =========== -->
221 <TR BGCOLOR='white' CLASS='TableRowColor'>
222 <TD>
223 <CODE><B><A HREF='DataListSource.html#get_data_index'>int get_data_index ( )</A></B></CODE>
224 <BR>
225 <blockquote> This function returns the
226 data_index value and increments it </blockquote>
227 </TD>
228 </TR>
229
230 <!-- =========== Summary =========== -->
231 <TR BGCOLOR='white' CLASS='TableRowColor'>
232 <TD>
233 <CODE><B><A HREF='DataListSource.html#get_limit'>int get_limit ( )</A></B></CODE>
234 <BR>
235 <blockquote> This function gets the current
236 value of the limit value </blockquote>
237 </TD>
238 </TR>
239
240 <!-- =========== Summary =========== -->
241 <TR BGCOLOR='white' CLASS='TableRowColor'>
242 <TD>
243 <CODE><B><A HREF='DataListSource.html#get_next_data_row'>array() get_next_data_row ( )</A></B></CODE>
244 <BR>
245 <blockquote> This function gets the next data row
246 from the query() </blockquote>
247 </TD>
248 </TR>
249
250 <!-- =========== Summary =========== -->
251 <TR BGCOLOR='white' CLASS='TableRowColor'>
252 <TD>
253 <CODE><B><A HREF='DataListSource.html#get_not_found_message'>string get_not_found_message ( )</A></B></CODE>
254 <BR>
255 <blockquote> This function is used to get the
256 message displayed when no data is found </blockquote>
257 </TD>
258 </TR>
259
260 <!-- =========== Summary =========== -->
261 <TR BGCOLOR='white' CLASS='TableRowColor'>
262 <TD>
263 <CODE><B><A HREF='DataListSource.html#get_offset'>int get_offset ( )</A></B></CODE>
264 <BR>
265 <blockquote> This function returns the value of the
266 offset </blockquote>
267 </TD>
268 </TR>
269
270 <!-- =========== Summary =========== -->
271 <TR BGCOLOR='white' CLASS='TableRowColor'>
272 <TD>
273 <CODE><B><A HREF='DataListSource.html#get_orderby'>int get_orderby ( )</A></B></CODE>
274 <BR>
275 <blockquote> This function returns the value of the
276 orderby </blockquote>
277 </TD>
278 </TR>
279
280 <!-- =========== Summary =========== -->
281 <TR BGCOLOR='white' CLASS='TableRowColor'>
282 <TD>
283 <CODE><B><A HREF='DataListSource.html#get_reverseorder'>int get_reverseorder ( )</A></B></CODE>
284 <BR>
285 <blockquote> This function returns the value of the
286 reverseorder </blockquote>
287 </TD>
288 </TR>
289
290 <!-- =========== Summary =========== -->
291 <TR BGCOLOR='white' CLASS='TableRowColor'>
292 <TD>
293 <CODE><B><A HREF='DataListSource.html#get_searchby'>int get_searchby ( )</A></B></CODE>
294 <BR>
295 <blockquote> This function returns the value of the
296 searchby </blockquote>
297 </TD>
298 </TR>
299
300 <!-- =========== Summary =========== -->
301 <TR BGCOLOR='white' CLASS='TableRowColor'>
302 <TD>
303 <CODE><B><A HREF='DataListSource.html#get_searchby_value'>int get_searchby_value ( )</A></B></CODE>
304 <BR>
305 <blockquote> This function returns the value of the
306 search value </blockquote>
307 </TD>
308 </TR>
309
310 <!-- =========== Summary =========== -->
311 <TR BGCOLOR='white' CLASS='TableRowColor'>
312 <TD>
313 <CODE><B><A HREF='DataListSource.html#get_search_type'>string get_search_type ( )</A></B></CODE>
314 <BR>
315 <blockquote> this function returns the current search type
316 for the DataList query </blockquote>
317 </TD>
318 </TR>
319
320 <!-- =========== Summary =========== -->
321 <TR BGCOLOR='white' CLASS='TableRowColor'>
322 <TD>
323 <CODE><B><A HREF='DataListSource.html#get_simplesearch_modifier'>int get_simplesearch_modifier ( )</A></B></CODE>
324 <BR>
325 <blockquote> This function returns the value of the
326 search value </blockquote>
327 </TD>
328 </TR>
329
330 <!-- =========== Summary =========== -->
331 <TR BGCOLOR='white' CLASS='TableRowColor'>
332 <TD>
333 <CODE><B><A HREF='DataListSource.html#get_total_rows'>int get_total_rows ( )</A></B></CODE>
334 <BR>
335 <blockquote> This returns the total number of rows
336 in our entire data set </blockquote>
337 </TD>
338 </TR>
339
340 <!-- =========== Summary =========== -->
341 <TR BGCOLOR='white' CLASS='TableRowColor'>
342 <TD>
343 <CODE><B><A HREF='DataListSource.html#query'>void query ( $offset, $limit, $orderby, $reverseorder, $searchby, $searchby_value, $simplesearch_modifier, $search_type )</A></B></CODE>
344 <BR>
345 <blockquote> The main Query function. </blockquote>
346 </TD>
347 </TR>
348
349 <!-- =========== Summary =========== -->
350 <TR BGCOLOR='white' CLASS='TableRowColor'>
351 <TD>
352 <CODE><B><A HREF='DataListSource.html#set_limit'>void set_limit ( $limit )</A></B></CODE>
353 <BR>
354 <blockquote> This function is used to set </blockquote>
355 </TD>
356 </TR>
357
358 <!-- =========== Summary =========== -->
359 <TR BGCOLOR='white' CLASS='TableRowColor'>
360 <TD>
361 <CODE><B><A HREF='DataListSource.html#set_not_found_message'>void set_not_found_message ( $mesg )</A></B></CODE>
362 <BR>
363 <blockquote> This function is used to set the
364 message displayed when no data is found </blockquote>
365 </TD>
366 </TR>
367
368 <!-- =========== Summary =========== -->
369 <TR BGCOLOR='white' CLASS='TableRowColor'>
370 <TD>
371 <CODE><B><A HREF='DataListSource.html#set_offset'>void set_offset ( $offset )</A></B></CODE>
372 <BR>
373 <blockquote> This sets the offset value </blockquote>
374 </TD>
375 </TR>
376
377 <!-- =========== Summary =========== -->
378 <TR BGCOLOR='white' CLASS='TableRowColor'>
379 <TD>
380 <CODE><B><A HREF='DataListSource.html#set_orderby'>void set_orderby ( $orderby )</A></B></CODE>
381 <BR>
382 <blockquote> This sets the orderby column name. </blockquote>
383 </TD>
384 </TR>
385
386 <!-- =========== Summary =========== -->
387 <TR BGCOLOR='white' CLASS='TableRowColor'>
388 <TD>
389 <CODE><B><A HREF='DataListSource.html#set_reverseorder'>void set_reverseorder ( $order )</A></B></CODE>
390 <BR>
391 <blockquote> This sets the flag that tells us the
392 direction in which to order the orderby
393 column. </blockquote>
394 </TD>
395 </TR>
396
397 <!-- =========== Summary =========== -->
398 <TR BGCOLOR='white' CLASS='TableRowColor'>
399 <TD>
400 <CODE><B><A HREF='DataListSource.html#set_searchby'>void set_searchby ( $search_col )</A></B></CODE>
401 <BR>
402 <blockquote> This sets the column that we want to search
403 from. </blockquote>
404 </TD>
405 </TR>
406
407 <!-- =========== Summary =========== -->
408 <TR BGCOLOR='white' CLASS='TableRowColor'>
409 <TD>
410 <CODE><B><A HREF='DataListSource.html#set_searchby_value'>void set_searchby_value ( $search_value )</A></B></CODE>
411 <BR>
412 <blockquote> This sets the data that we want to search
413 for. </blockquote>
414 </TD>
415 </TR>
416
417 <!-- =========== Summary =========== -->
418 <TR BGCOLOR='white' CLASS='TableRowColor'>
419 <TD>
420 <CODE><B><A HREF='DataListSource.html#set_search_type'>void set_search_type ( $search_type )</A></B></CODE>
421 <BR>
422 <blockquote> This function sets the search type
423 (simple or advanced) </blockquote>
424 </TD>
425 </TR>
426
427 <!-- =========== Summary =========== -->
428 <TR BGCOLOR='white' CLASS='TableRowColor'>
429 <TD>
430 <CODE><B><A HREF='DataListSource.html#set_simplesearch_modifier'>void set_simplesearch_modifier ( $search_modifier )</A></B></CODE>
431 <BR>
432 <blockquote> This sets the simple search modifier </blockquote>
433 </TD>
434 </TR>
435
436 <!-- =========== Summary =========== -->
437 <TR BGCOLOR='white' CLASS='TableRowColor'>
438 <TD>
439 <CODE><B><A HREF='DataListSource.html#set_total_rows'>void set_total_rows ( $num )</A></B></CODE>
440 <BR>
441 <blockquote> This is used to set the total # of
442 rows we have in our data set </blockquote>
443 </TD>
444 </TR>
445
446 <!-- =========== Summary =========== -->
447 <TR BGCOLOR='white' CLASS='TableRowColor'>
448 <TD>
449 <CODE><B><A HREF='DataListSource.html#sort'>void sort ( )</A></B></CODE>
450 <BR>
451 <blockquote> A generic method API that can be used at the bottom
452 half of the do_query() method to sort data that is
453 stored locally. </blockquote>
454 </TD>
455 </TR>
456
457 <!-- =========== Summary =========== -->
458 <TR BGCOLOR='white' CLASS='TableRowColor'>
459 <TD>
460 <CODE><B><A HREF='DataListSource.html#_is_column_sortable'>boolean _is_column_sortable ( $data_name )</A></B></CODE>
461 <BR>
462 <blockquote> This function determines if the column </blockquote>
463 </TD>
464 </TR>
465
466 </TABLE>
467
468 <hr>
469 <!-- ============ VARIABLE DETAIL =========== -->
470
471 <A NAME='variable_detail'></A>
472 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
473 <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
474 <TD>
475 <span CLASS="font12bold">Variable Detail</span>
476 <A HREF="#top" CLASS="links">^TOP</A>
477 </TD>
478 </TR>
479 </TABLE>
480
481
482 <A NAME='$_columns'><!-- --></A><H3>$_columns</H3>
483 <b>Data type:</b> array<br>
484 <!-- ========== Info from phpDoc block ========= -->
485 The column descriptions
486 for the data we are working on
487 <BR>
488
489
490 <UL>
491
492 </UL>
493
494 <HR>
495
496 <A NAME='$_data'><!-- --></A><H3>$_data</H3>
497 <b>Data type:</b> mixed<br>
498 <!-- ========== Info from phpDoc block ========= -->
499 A placeholder for data that is read/built
500 <BR>
501 and stored locally. Not all data sources
502 have to use this.
503 Each entry in the array corresponds to 1 row
504 of data.
505
506 <UL>
507
508 </UL>
509
510 <HR>
511
512 <A NAME='$_data_index'><!-- --></A><H3>$_data_index</H3>
513 <b>Data type:</b> mixed<br>
514 <!-- ========== Info from phpDoc block ========= -->
515 Holds the index into the array of data
516 <BR>
517 so we can keep track of where we are
518 when we are walking the array
519 (only usefull for non DB children)
520
521 <UL>
522
523 </UL>
524
525 <HR>
526
527 <A NAME='$_not_found_message'><!-- --></A><H3>$_not_found_message</H3>
528 <b>Data type:</b> mixed<br>
529 <!-- ========== Info from phpDoc block ========= -->
530 This is the message displayed when no data
531 <BR>
532 was retrieved from the database
533
534 <UL>
535
536 </UL>
537
538 <HR>
539
540 <A NAME='$_query_params'><!-- --></A><H3>$_query_params</H3>
541 <b>Data type:</b> mixed<br>
542 <!-- ========== Info from phpDoc block ========= -->
543 This holds various parameters relating
544 to the query of the data
545 <BR>
546
547
548 <UL>
549
550 </UL>
551
552 <HR>
553
554
555 <hr>
556 <!-- ============ FUNCTION DETAIL =========== -->
557
558 <A NAME='function_detail'></A>
559 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
560 <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
561 <TD>
562 <span class="font12bold">Method Detail</span>
563 <A HREF="#top" CLASS="links">^TOP</A>
564 </TD>
565 </TR>
566 </TABLE>
567 <BR>
568
569 <DIV CLASS="function">
570 <A NAME='constructor DataListSource'><!-- --></A>
571 <SPAN CLASS="font12bold">constructor DataListSource</SPAN>
572 <BR>
573 <SPAN CLASS="font10bold">Useage : </SPAN>
574 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
575 <span class="font10bold" style="color: #0000FF">constructor DataListSource ( )</SPAN>
576 <BR>
577
578 <BR>
579 <SPAN CLASS="font10bold">Description : </SPAN>
580 <!-- ========== Info from phpDoc block ========= -->
581 The constructor
582 <BR>
583
584 <DL>
585 <DT class="font10bold">Function Parameters:</DT>
586
587
588 <DT class="font10bold">Function Info:</DT>
589
590 </DL>
591
592 </DIV>
593 <BR>
594
595 <DIV CLASS="function">
596 <A NAME='add_column'><!-- --></A>
597 <SPAN CLASS="font12bold">add_column</SPAN>
598 <BR>
599 <SPAN CLASS="font10bold">Useage : </SPAN>
600 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
601 <span class="font10bold" style="color: #0000FF">add_column ( $title, $data_name, [$sortable = FALSE], [$searchable = FALSE], [$sortorder = "ASC"] )</SPAN>
602 <BR>
603
604 <BR>
605 <SPAN CLASS="font10bold">Description : </SPAN>
606 <!-- ========== Info from phpDoc block ========= -->
607 Add a column of data to manage
608 <BR>
609
610 <DL>
611 <DT class="font10bold">Function Parameters:</DT>
612
613 <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">string</SPAN> <span style="color: #0000FF;font-weight:bold">$title</SPAN></SPAN> - the title of the column</DD>
614
615 <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">string</SPAN> <span style="color: #0000FF;font-weight:bold">$data_name</SPAN></SPAN> - the data value name</DD>
616
617 <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">boolean</SPAN> <span style="color: #0000FF;font-weight:bold">$sortable</SPAN></SPAN> - is the column sortable?
618 default: FALSE</DD>
619
620 <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">boolean</SPAN> <span style="color: #0000FF;font-weight:bold">$searchable</SPAN></SPAN> - is the column searchable
621 default: FALSE</DD>
622
623 <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">string</SPAN> <span style="color: #0000FF;font-weight:bold">$sortorder</SPAN></SPAN> - the sort order (ASC, DESC)
624 default: ASC</DD>
625
626
627 <DT class="font10bold">Function Info:</DT>
628
629 </DL>
630
631 </DIV>
632 <BR>
633
634 <DIV CLASS="function">
635 <A NAME='do_prequery'><!-- --></A>
636 <SPAN CLASS="font12bold">do_prequery</SPAN>
637 <BR>
638 <SPAN CLASS="font10bold">Useage : </SPAN>
639 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
640 <span class="font10bold" style="color: #0000FF">do_prequery ( )</SPAN>
641 <BR>
642 Overridden in child class(es) as: <a href="../phpHtmlLib/SQLDataListSource.html#do_prequery">SQLDataListSource::do_prequery()</a>, <a href="../phpHtmlLib/CSVFILEDataListSource.html#do_prequery">CSVFILEDataListSource::do_prequery()</a><br>
643 <BR>
644 <SPAN CLASS="font10bold">Description : </SPAN>
645 <!-- ========== Info from phpDoc block ========= -->
646 This is a method that should be defined by the
647 child class to do any pre-query type of things.
648 <BR>
649 Such as building a sql query string for a DB,
650 or checking to make sure the file on disk exists
651 if the source is a file on disk.
652 <DL>
653 <DT class="font10bold">Function Parameters:</DT>
654
655
656 <DT class="font10bold">Function Info:</DT>
657
658 </DL>
659
660 </DIV>
661 <BR>
662
663 <DIV CLASS="function">
664 <A NAME='do_query'><!-- --></A>
665 <SPAN CLASS="font12bold">do_query</SPAN>
666 <BR>
667 <SPAN CLASS="font10bold">Useage : </SPAN>
668 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
669 <span class="font10bold" style="color: #0000FF">do_query ( )</SPAN>
670 <BR>
671 Overridden in child class(es) as: <a href="../phpHtmlLib/SQLDataListSource.html#do_query">SQLDataListSource::do_query()</a>, <a href="../phpHtmlLib/CSVFILEDataListSource.html#do_query">CSVFILEDataListSource::do_query()</a><br>
672 <BR>
673 <SPAN CLASS="font10bold">Description : </SPAN>
674 <!-- ========== Info from phpDoc block ========= -->
675 This is the function that does the data fetching,
676 and sorting if needed.
677 <BR>
678 If the source is a sql database, this is where the
679 query gets called. This function doesn't actually read the
680 data from the DB yet. That is what get_next_data_row()
681 does.
682 <DL>
683 <DT class="font10bold">Function Parameters:</DT>
684
685
686 <DT class="font10bold">Function Info:</DT>
687
688 </DL>
689
690 </DIV>
691 <BR>
692
693 <DIV CLASS="function">
694 <A NAME='get_data_index'><!-- --></A>
695 <SPAN CLASS="font12bold">get_data_index</SPAN>
696 <BR>
697 <SPAN CLASS="font10bold">Useage : </SPAN>
698 <span class="font10bold" style="color: #FF0000">int</SPAN>&nbsp;
699 <span class="font10bold" style="color: #0000FF">get_data_index ( )</SPAN>
700 <BR>
701
702 <BR>
703 <SPAN CLASS="font10bold">Description : </SPAN>
704 <!-- ========== Info from phpDoc block ========= -->
705 This function returns the
706 data_index value and increments it
707 <BR>
708
709 <DL>
710 <DT class="font10bold">Function Parameters:</DT>
711
712
713 <DT class="font10bold">Function Info:</DT>
714
715 </DL>
716
717 </DIV>
718 <BR>
719
720 <DIV CLASS="function">
721 <A NAME='get_limit'><!-- --></A>
722 <SPAN CLASS="font12bold">get_limit</SPAN>
723 <BR>
724 <SPAN CLASS="font10bold">Useage : </SPAN>
725 <span class="font10bold" style="color: #FF0000">int</SPAN>&nbsp;
726 <span class="font10bold" style="color: #0000FF">get_limit ( )</SPAN>
727 <BR>
728
729 <BR>
730 <SPAN CLASS="font10bold">Description : </SPAN>
731 <!-- ========== Info from phpDoc block ========= -->
732 This function gets the current
733 value of the limit value
734 <BR>
735
736 <DL>
737 <DT class="font10bold">Function Parameters:</DT>
738
739
740 <DT class="font10bold">Function Info:</DT>
741
742 </DL>
743
744 </DIV>
745 <BR>
746
747 <DIV CLASS="function">
748 <A NAME='get_next_data_row'><!-- --></A>
749 <SPAN CLASS="font12bold">get_next_data_row</SPAN>
750 <BR>
751 <SPAN CLASS="font10bold">Useage : </SPAN>
752 <span class="font10bold" style="color: #FF0000">array()</SPAN>&nbsp;
753 <span class="font10bold" style="color: #0000FF">get_next_data_row ( )</SPAN>
754 <BR>
755 Overridden in child class(es) as: <a href="../phpHtmlLib/SQLDataListSource.html#get_next_data_row">SQLDataListSource::get_next_data_row()</a>, <a href="../phpHtmlLib/CSVFILEDataListSource.html#get_next_data_row">CSVFILEDataListSource::get_next_data_row()</a><br>
756 <BR>
757 <SPAN CLASS="font10bold">Description : </SPAN>
758 <!-- ========== Info from phpDoc block ========= -->
759 This function gets the next data row
760 from the query()
761 <BR>
762
763 <DL>
764 <DT class="font10bold">Function Parameters:</DT>
765
766
767 <DT class="font10bold">Function Info:</DT>
768
769 </DL>
770
771 </DIV>
772 <BR>
773
774 <DIV CLASS="function">
775 <A NAME='get_not_found_message'><!-- --></A>
776 <SPAN CLASS="font12bold">get_not_found_message</SPAN>
777 <BR>
778 <SPAN CLASS="font10bold">Useage : </SPAN>
779 <span class="font10bold" style="color: #FF0000">string</SPAN>&nbsp;
780 <span class="font10bold" style="color: #0000FF">get_not_found_message ( )</SPAN>
781 <BR>
782
783 <BR>
784 <SPAN CLASS="font10bold">Description : </SPAN>
785 <!-- ========== Info from phpDoc block ========= -->
786 This function is used to get the
787 message displayed when no data is found
788 <BR>
789
790 <DL>
791 <DT class="font10bold">Function Parameters:</DT>
792
793
794 <DT class="font10bold">Function Info:</DT>
795
796 </DL>
797
798 </DIV>
799 <BR>
800
801 <DIV CLASS="function">
802 <A NAME='get_offset'><!-- --></A>
803 <SPAN CLASS="font12bold">get_offset</SPAN>
804 <BR>
805 <SPAN CLASS="font10bold">Useage : </SPAN>
806 <span class="font10bold" style="color: #FF0000">int</SPAN>&nbsp;
807 <span class="font10bold" style="color: #0000FF">get_offset ( )</SPAN>
808 <BR>
809
810 <BR>
811 <SPAN CLASS="font10bold">Description : </SPAN>
812 <!-- ========== Info from phpDoc block ========= -->
813 This function returns the value of the
814 offset
815 <BR>
816
817 <DL>
818 <DT class="font10bold">Function Parameters:</DT>
819
820
821 <DT class="font10bold">Function Info:</DT>
822
823 </DL>
824
825 </DIV>
826 <BR>
827
828 <DIV CLASS="function">
829 <A NAME='get_orderby'><!-- --></A>
830 <SPAN CLASS="font12bold">get_orderby</SPAN>
831 <BR>
832 <SPAN CLASS="font10bold">Useage : </SPAN>
833 <span class="font10bold" style="color: #FF0000">int</SPAN>&nbsp;
834 <span class="font10bold" style="color: #0000FF">get_orderby ( )</SPAN>
835 <BR>
836
837 <BR>
838 <SPAN CLASS="font10bold">Description : </SPAN>
839 <!-- ========== Info from phpDoc block ========= -->
840 This function returns the value of the
841 orderby
842 <BR>
843
844 <DL>
845 <DT class="font10bold">Function Parameters:</DT>
846
847
848 <DT class="font10bold">Function Info:</DT>
849
850 </DL>
851
852 </DIV>
853 <BR>
854
855 <DIV CLASS="function">
856 <A NAME='get_reverseorder'><!-- --></A>
857 <SPAN CLASS="font12bold">get_reverseorder</SPAN>
858 <BR>
859 <SPAN CLASS="font10bold">Useage : </SPAN>
860 <span class="font10bold" style="color: #FF0000">int</SPAN>&nbsp;
861 <span class="font10bold" style="color: #0000FF">get_reverseorder ( )</SPAN>
862 <BR>
863
864 <BR>
865 <SPAN CLASS="font10bold">Description : </SPAN>
866 <!-- ========== Info from phpDoc block ========= -->
867 This function returns the value of the
868 reverseorder
869 <BR>
870
871 <DL>
872 <DT class="font10bold">Function Parameters:</DT>
873
874
875 <DT class="font10bold">Function Info:</DT>
876
877 </DL>
878
879 </DIV>
880 <BR>
881
882 <DIV CLASS="function">
883 <A NAME='get_searchby'><!-- --></A>
884 <SPAN CLASS="font12bold">get_searchby</SPAN>
885 <BR>
886 <SPAN CLASS="font10bold">Useage : </SPAN>
887 <span class="font10bold" style="color: #FF0000">int</SPAN>&nbsp;
888 <span class="font10bold" style="color: #0000FF">get_searchby ( )</SPAN>
889 <BR>
890
891 <BR>
892 <SPAN CLASS="font10bold">Description : </SPAN>
893 <!-- ========== Info from phpDoc block ========= -->
894 This function returns the value of the
895 searchby
896 <BR>
897
898 <DL>
899 <DT class="font10bold">Function Parameters:</DT>
900
901
902 <DT class="font10bold">Function Info:</DT>
903
904 </DL>
905
906 </DIV>
907 <BR>
908
909 <DIV CLASS="function">
910 <A NAME='get_searchby_value'><!-- --></A>
911 <SPAN CLASS="font12bold">get_searchby_value</SPAN>
912 <BR>
913 <SPAN CLASS="font10bold">Useage : </SPAN>
914 <span class="font10bold" style="color: #FF0000">int</SPAN>&nbsp;
915 <span class="font10bold" style="color: #0000FF">get_searchby_value ( )</SPAN>
916 <BR>
917
918 <BR>
919 <SPAN CLASS="font10bold">Description : </SPAN>
920 <!-- ========== Info from phpDoc block ========= -->
921 This function returns the value of the
922 search value
923 <BR>
924
925 <DL>
926 <DT class="font10bold">Function Parameters:</DT>
927
928
929 <DT class="font10bold">Function Info:</DT>
930
931 </DL>
932
933 </DIV>
934 <BR>
935
936 <DIV CLASS="function">
937 <A NAME='get_search_type'><!-- --></A>
938 <SPAN CLASS="font12bold">get_search_type</SPAN>
939 <BR>
940 <SPAN CLASS="font10bold">Useage : </SPAN>
941 <span class="font10bold" style="color: #FF0000">string</SPAN>&nbsp;
942 <span class="font10bold" style="color: #0000FF">get_search_type ( )</SPAN>
943 <BR>
944
945 <BR>
946 <SPAN CLASS="font10bold">Description : </SPAN>
947 <!-- ========== Info from phpDoc block ========= -->
948 this function returns the current search type
949 for the DataList query
950 <BR>
951
952 <DL>
953 <DT class="font10bold">Function Parameters:</DT>
954
955
956 <DT class="font10bold">Function Info:</DT>
957
958 </DL>
959
960 </DIV>
961 <BR>
962
963 <DIV CLASS="function">
964 <A NAME='get_simplesearch_modifier'><!-- --></A>
965 <SPAN CLASS="font12bold">get_simplesearch_modifier</SPAN>
966 <BR>
967 <SPAN CLASS="font10bold">Useage : </SPAN>
968 <span class="font10bold" style="color: #FF0000">int</SPAN>&nbsp;
969 <span class="font10bold" style="color: #0000FF">get_simplesearch_modifier ( )</SPAN>
970 <BR>
971
972 <BR>
973 <SPAN CLASS="font10bold">Description : </SPAN>
974 <!-- ========== Info from phpDoc block ========= -->
975 This function returns the value of the
976 search value
977 <BR>
978
979 <DL>
980 <DT class="font10bold">Function Parameters:</DT>
981
982
983 <DT class="font10bold">Function Info:</DT>
984
985 </DL>
986
987 </DIV>
988 <BR>
989
990 <DIV CLASS="function">
991 <A NAME='get_total_rows'><!-- --></A>
992 <SPAN CLASS="font12bold">get_total_rows</SPAN>
993 <BR>
994 <SPAN CLASS="font10bold">Useage : </SPAN>
995 <span class="font10bold" style="color: #FF0000">int</SPAN>&nbsp;
996 <span class="font10bold" style="color: #0000FF">get_total_rows ( )</SPAN>
997 <BR>
998
999 <BR>
1000 <SPAN CLASS="font10bold">Description : </SPAN>
1001 <!-- ========== Info from phpDoc block ========= -->
1002 This returns the total number of rows
1003 in our entire data set
1004 <BR>
1005
1006 <DL>
1007 <DT class="font10bold">Function Parameters:</DT>
1008
1009
1010 <DT class="font10bold">Function Info:</DT>
1011
1012 </DL>
1013
1014 </DIV>
1015 <BR>
1016
1017 <DIV CLASS="function">
1018 <A NAME='query'><!-- --></A>
1019 <SPAN CLASS="font12bold">query</SPAN>
1020 <BR>
1021 <SPAN CLASS="font10bold">Useage : </SPAN>
1022 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
1023 <span class="font10bold" style="color: #0000FF">query ( $offset, $limit, $orderby, $reverseorder, $searchby, $searchby_value, $simplesearch_modifier, $search_type )</SPAN>
1024 <BR>
1025
1026 <BR>
1027 <SPAN CLASS="font10bold">Description : </SPAN>
1028 <!-- ========== Info from phpDoc block ========= -->
1029 The main Query function.
1030 <BR>
1031 This function is responsible for doing
1032 any data prefetching from a db,file
1033 and doing any sorting and searching
1034 on it depending on the values passed
1035 in from the DataList object
1036 <DL>
1037 <DT class="font10bold">Function Parameters:</DT>
1038
1039 <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">int</SPAN> <span style="color: #0000FF;font-weight:bold">$offset</SPAN></SPAN> - the offset into the data set</DD>
1040
1041 <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">int</SPAN> <span style="color: #0000FF;font-weight:bold">$limit</SPAN></SPAN> - the # of rows to get</DD>
1042
1043 <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">string</SPAN> <span style="color: #0000FF;font-weight:bold">$orderby</SPAN></SPAN> - the column to order the data by</DD>
1044
1045 <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">string</SPAN> <span style="color: #0000FF;font-weight:bold">$reverseorder</SPAN></SPAN> - order in asc or reverse?</DD>
1046
1047 <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">string</SPAN> <span style="color: #0000FF;font-weight:bold">$searchby</SPAN></SPAN> - the column in the dataset
1048 to search by</DD>
1049
1050 <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">string</SPAN> <span style="color: #0000FF;font-weight:bold">$searchby_value</SPAN></SPAN> - the value to look for</DD>
1051
1052 <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">string</SPAN> <span style="color: #0000FF;font-weight:bold">$simplesearch_modifier</SPAN></SPAN> - the simple search modifier.</DD>
1053
1054
1055 <DT class="font10bold">Function Info:</DT>
1056
1057 </DL>
1058
1059 </DIV>
1060 <BR>
1061
1062 <DIV CLASS="function">
1063 <A NAME='set_limit'><!-- --></A>
1064 <SPAN CLASS="font12bold">set_limit</SPAN>
1065 <BR>
1066 <SPAN CLASS="font10bold">Useage : </SPAN>
1067 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
1068 <span class="font10bold" style="color: #0000FF">set_limit ( $limit )</SPAN>
1069 <BR>
1070
1071 <BR>
1072 <SPAN CLASS="font10bold">Description : </SPAN>
1073 <!-- ========== Info from phpDoc block ========= -->
1074 This function is used to set
1075 <BR>
1076 the limit value, which limits
1077 the # of rows of data to allow
1078 to return
1079 <DL>
1080 <DT class="font10bold">Function Parameters:</DT>
1081
1082
1083 <DT class="font10bold">Function Info:</DT>
1084
1085 </DL>
1086
1087 </DIV>
1088 <BR>
1089
1090 <DIV CLASS="function">
1091 <A NAME='set_not_found_message'><!-- --></A>
1092 <SPAN CLASS="font12bold">set_not_found_message</SPAN>
1093 <BR>
1094 <SPAN CLASS="font10bold">Useage : </SPAN>
1095 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
1096 <span class="font10bold" style="color: #0000FF">set_not_found_message ( $mesg )</SPAN>
1097 <BR>
1098
1099 <BR>
1100 <SPAN CLASS="font10bold">Description : </SPAN>
1101 <!-- ========== Info from phpDoc block ========= -->
1102 This function is used to set the
1103 message displayed when no data is found
1104 <BR>
1105
1106 <DL>
1107 <DT class="font10bold">Function Parameters:</DT>
1108
1109 <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">string</SPAN> <span style="color: #0000FF;font-weight:bold">$mesg</SPAN></SPAN> </DD>
1110
1111
1112 <DT class="font10bold">Function Info:</DT>
1113
1114 </DL>
1115
1116 </DIV>
1117 <BR>
1118
1119 <DIV CLASS="function">
1120 <A NAME='set_offset'><!-- --></A>
1121 <SPAN CLASS="font12bold">set_offset</SPAN>
1122 <BR>
1123 <SPAN CLASS="font10bold">Useage : </SPAN>
1124 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
1125 <span class="font10bold" style="color: #0000FF">set_offset ( $offset )</SPAN>
1126 <BR>
1127
1128 <BR>
1129 <SPAN CLASS="font10bold">Description : </SPAN>
1130 <!-- ========== Info from phpDoc block ========= -->
1131 This sets the offset value
1132 <BR>
1133 and resets the index into the data
1134 array (in non DB children)
1135 <DL>
1136 <DT class="font10bold">Function Parameters:</DT>
1137
1138 <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">int</SPAN> <span style="color: #0000FF;font-weight:bold">$offset</SPAN></SPAN> offset</DD>
1139
1140
1141 <DT class="font10bold">Function Info:</DT>
1142
1143 </DL>
1144
1145 </DIV>
1146 <BR>
1147
1148 <DIV CLASS="function">
1149 <A NAME='set_orderby'><!-- --></A>
1150 <SPAN CLASS="font12bold">set_orderby</SPAN>
1151 <BR>
1152 <SPAN CLASS="font10bold">Useage : </SPAN>
1153 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
1154 <span class="font10bold" style="color: #0000FF">set_orderby ( $orderby )</SPAN>
1155 <BR>
1156
1157 <BR>
1158 <SPAN CLASS="font10bold">Description : </SPAN>
1159 <!-- ========== Info from phpDoc block ========= -->
1160 This sets the orderby column name.
1161 <BR>
1162 This corresponds to the column
1163 that wants to be sorted/ordered, but
1164 not the actual direction (asc, desc)
1165 <DL>
1166 <DT class="font10bold">Function Parameters:</DT>
1167
1168 <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">int</SPAN> <span style="color: #0000FF;font-weight:bold">$orderby</SPAN></SPAN> offset</DD>
1169
1170
1171 <DT class="font10bold">Function Info:</DT>
1172
1173 </DL>
1174
1175 </DIV>
1176 <BR>
1177
1178 <DIV CLASS="function">
1179 <A NAME='set_reverseorder'><!-- --></A>
1180 <SPAN CLASS="font12bold">set_reverseorder</SPAN>
1181 <BR>
1182 <SPAN CLASS="font10bold">Useage : </SPAN>
1183 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
1184 <span class="font10bold" style="color: #0000FF">set_reverseorder ( $order )</SPAN>
1185 <BR>
1186
1187 <BR>
1188 <SPAN CLASS="font10bold">Description : </SPAN>
1189 <!-- ========== Info from phpDoc block ========= -->
1190 This sets the flag that tells us the
1191 direction in which to order the orderby
1192 column.
1193 <BR>
1194
1195 <DL>
1196 <DT class="font10bold">Function Parameters:</DT>
1197
1198 <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">int</SPAN> <span style="color: #0000FF;font-weight:bold">$order</SPAN></SPAN> offset</DD>
1199
1200
1201 <DT class="font10bold">Function Info:</DT>
1202
1203 </DL>
1204
1205 </DIV>
1206 <BR>
1207
1208 <DIV CLASS="function">
1209 <A NAME='set_searchby'><!-- --></A>
1210 <SPAN CLASS="font12bold">set_searchby</SPAN>
1211 <BR>
1212 <SPAN CLASS="font10bold">Useage : </SPAN>
1213 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
1214 <span class="font10bold" style="color: #0000FF">set_searchby ( $search_col )</SPAN>
1215 <BR>
1216
1217 <BR>
1218 <SPAN CLASS="font10bold">Description : </SPAN>
1219 <!-- ========== Info from phpDoc block ========= -->
1220 This sets the column that we want to search
1221 from.
1222 <BR>
1223
1224 <DL>
1225 <DT class="font10bold">Function Parameters:</DT>
1226
1227 <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">int</SPAN> <span style="color: #0000FF;font-weight:bold">$search_col</SPAN></SPAN> offset</DD>
1228
1229
1230 <DT class="font10bold">Function Info:</DT>
1231
1232 </DL>
1233
1234 </DIV>
1235 <BR>
1236
1237 <DIV CLASS="function">
1238 <A NAME='set_searchby_value'><!-- --></A>
1239 <SPAN CLASS="font12bold">set_searchby_value</SPAN>
1240 <BR>
1241 <SPAN CLASS="font10bold">Useage : </SPAN>
1242 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
1243 <span class="font10bold" style="color: #0000FF">set_searchby_value ( $search_value )</SPAN>
1244 <BR>
1245
1246 <BR>
1247 <SPAN CLASS="font10bold">Description : </SPAN>
1248 <!-- ========== Info from phpDoc block ========= -->
1249 This sets the data that we want to search
1250 for.
1251 <BR>
1252
1253 <DL>
1254 <DT class="font10bold">Function Parameters:</DT>
1255
1256 <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">int</SPAN> <span style="color: #0000FF;font-weight:bold">$search_value</SPAN></SPAN> offset</DD>
1257
1258
1259 <DT class="font10bold">Function Info:</DT>
1260
1261 </DL>
1262
1263 </DIV>
1264 <BR>
1265
1266 <DIV CLASS="function">
1267 <A NAME='set_search_type'><!-- --></A>
1268 <SPAN CLASS="font12bold">set_search_type</SPAN>
1269 <BR>
1270 <SPAN CLASS="font10bold">Useage : </SPAN>
1271 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
1272 <span class="font10bold" style="color: #0000FF">set_search_type ( $search_type )</SPAN>
1273 <BR>
1274
1275 <BR>
1276 <SPAN CLASS="font10bold">Description : </SPAN>
1277 <!-- ========== Info from phpDoc block ========= -->
1278 This function sets the search type
1279 (simple or advanced)
1280 <BR>
1281
1282 <DL>
1283 <DT class="font10bold">Function Parameters:</DT>
1284
1285 <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">string</SPAN> <span style="color: #0000FF;font-weight:bold">$search_type</SPAN></SPAN> </DD>
1286
1287
1288 <DT class="font10bold">Function Info:</DT>
1289
1290 </DL>
1291
1292 </DIV>
1293 <BR>
1294
1295 <DIV CLASS="function">
1296 <A NAME='set_simplesearch_modifier'><!-- --></A>
1297 <SPAN CLASS="font12bold">set_simplesearch_modifier</SPAN>
1298 <BR>
1299 <SPAN CLASS="font10bold">Useage : </SPAN>
1300 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
1301 <span class="font10bold" style="color: #0000FF">set_simplesearch_modifier ( $search_modifier )</SPAN>
1302 <BR>
1303
1304 <BR>
1305 <SPAN CLASS="font10bold">Description : </SPAN>
1306 <!-- ========== Info from phpDoc block ========= -->
1307 This sets the simple search modifier
1308 <BR>
1309
1310 <DL>
1311 <DT class="font10bold">Function Parameters:</DT>
1312
1313 <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">int</SPAN> <span style="color: #0000FF;font-weight:bold">$search_modifier</SPAN></SPAN> offset</DD>
1314
1315
1316 <DT class="font10bold">Function Info:</DT>
1317
1318 </DL>
1319
1320 </DIV>
1321 <BR>
1322
1323 <DIV CLASS="function">
1324 <A NAME='set_total_rows'><!-- --></A>
1325 <SPAN CLASS="font12bold">set_total_rows</SPAN>
1326 <BR>
1327 <SPAN CLASS="font10bold">Useage : </SPAN>
1328 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
1329 <span class="font10bold" style="color: #0000FF">set_total_rows ( $num )</SPAN>
1330 <BR>
1331
1332 <BR>
1333 <SPAN CLASS="font10bold">Description : </SPAN>
1334 <!-- ========== Info from phpDoc block ========= -->
1335 This is used to set the total # of
1336 rows we have in our data set
1337 <BR>
1338
1339 <DL>
1340 <DT class="font10bold">Function Parameters:</DT>
1341
1342 <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">int</SPAN> <span style="color: #0000FF;font-weight:bold">$num</SPAN></SPAN> </DD>
1343
1344
1345 <DT class="font10bold">Function Info:</DT>
1346
1347 </DL>
1348
1349 </DIV>
1350 <BR>
1351
1352 <DIV CLASS="function">
1353 <A NAME='sort'><!-- --></A>
1354 <SPAN CLASS="font12bold">sort</SPAN>
1355 <BR>
1356 <SPAN CLASS="font10bold">Useage : </SPAN>
1357 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
1358 <span class="font10bold" style="color: #0000FF">sort ( )</SPAN>
1359 <BR>
1360 Overridden in child class(es) as: <a href="../phpHtmlLib/CSVFILEDataListSource.html#sort">CSVFILEDataListSource::sort()</a><br>
1361 <BR>
1362 <SPAN CLASS="font10bold">Description : </SPAN>
1363 <!-- ========== Info from phpDoc block ========= -->
1364 A generic method API that can be used at the bottom
1365 half of the do_query() method to sort data that is
1366 stored locally.
1367 <BR>
1368 This is only needed when the source
1369 is a non database.
1370
1371 It should operate on the $this-&gt;_data array
1372 <DL>
1373 <DT class="font10bold">Function Parameters:</DT>
1374
1375
1376 <DT class="font10bold">Function Info:</DT>
1377
1378 </DL>
1379
1380 </DIV>
1381 <BR>
1382
1383 <DIV CLASS="function">
1384 <A NAME='_is_column_sortable'><!-- --></A>
1385 <SPAN CLASS="font12bold">_is_column_sortable</SPAN>
1386 <BR>
1387 <SPAN CLASS="font10bold">Useage : </SPAN>
1388 <span class="font10bold" style="color: #FF0000">boolean</SPAN>&nbsp;
1389 <span class="font10bold" style="color: #0000FF">_is_column_sortable ( $data_name )</SPAN>
1390 <BR>
1391
1392 <BR>
1393 <SPAN CLASS="font10bold">Description : </SPAN>
1394 <!-- ========== Info from phpDoc block ========= -->
1395 This function determines if the column
1396 <BR>
1397 associated w/ a data_name is sortable
1398 or not
1399 <DL>
1400 <DT class="font10bold">Function Parameters:</DT>
1401
1402 <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">string</SPAN> <span style="color: #0000FF;font-weight:bold">$data_name</SPAN></SPAN> - the data_name filed in the
1403 _columns array to look for</DD>
1404
1405
1406 <DT class="font10bold">Function Info:</DT>
1407
1408 <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - - is that column sortable?</DD>
1409
1410 </DL>
1411
1412 </DIV>
1413 <BR>
1414
1415
1416 <hr>
1417 </HTML>
MailToCvsAdmin">MailToCvsAdmin
 ViewVC Help
Powered by ViewVC 1.1.26 RSS 2.0 feed