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

Annotation of /nfo/php/libs/com.newsblob.phphtmllib/doc/phpHtmlLib/SQLDataListSource.html

Parent Directory Parent Directory | Revision Log Revision Log

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