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

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

Parent Directory Parent Directory | Revision Log Revision Log

Revision 1.1 - (hide annotations)
Thu Jan 30 03:29:19 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 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 PEARSQLDataListSource</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 PEARSQLDataListSource">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 PEARSQLDataListSource
33     </H2>
34    
35     <pre>
36     <pre><a href="../phpHtmlLib/DataListSource.html">DataListSource</a>
37     |
38     --<a href="../phpHtmlLib/SQLDataListSource.html">SQLDataListSource</a>
39     |
40     --PEARSQLDataListSource</pre>
41     </pre>
42    
43     <A NAME="children_summary"</A>
44     <H3>
45     Classes extended from PEARSQLDataListSource: <A HREF="#top" CLASS="links">^TOP</A>
46     </H3>
47    
48     <p>
49     <b><i>Located in File: Program_Root/widgets/data_list/PEARSQLDataListSource.inc</i></b><br>
50     </p>
51     <hr>
52     <!-- ========== Info from phpDoc block ========= -->
53     This SQLDataListSource child class interacts with
54     <BR>
55     with the specific DB via the php PEAR DB abstraction
56     objects.
57    
58     How to use?
59     in the DataList child's get_data_source() method
60     you pass in the already connected PEAR DB object
61     in to the constructor. PEARSQLDataListSource
62     takes care of the rest.
63    
64     <UL>
65    
66     <LI><b>Package</b> - <CODE>phpHtmlLib</CODE></LI>
67    
68     </UL>
69    
70     <hr>
71     <!-- =========== VAR SUMMARY =========== -->
72     <A NAME='var_summary'><!-- --></A>
73     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
74     <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
75     <TD>
76     <span CLASS="font12bold">Class Variable Summary</span>
77     <A HREF="#top" CLASS="links">^TOP</A>
78     </TD>
79     </TR>
80    
81    
82     <!-- =========== Summary =========== -->
83     <TR BGCOLOR='white' CLASS='TableRowColor'>
84     <TD>
85     <CODE><B><A HREF='PEARSQLDataListSource.html#$_db'>$_db</A></B></CODE>
86     <BR>
87     <blockquote> This var holds the Database object </blockquote>
88     <blockquote> Default Value: <CODE>->NULL<-</CODE> </blockquote>
89     </TD>
90     </TR>
91    
92     <!-- =========== Summary =========== -->
93     <TR BGCOLOR='white' CLASS='TableRowColor'>
94     <TD>
95     <CODE><B><A HREF='PEARSQLDataListSource.html#$_result'>$_result</A></B></CODE>
96     <BR>
97     <blockquote> this holds the query result from the
98     PEAR::DB-&gt;query() call </blockquote>
99     <blockquote> Default Value: <CODE>->NULL<-</CODE> </blockquote>
100     </TD>
101     </TR>
102    
103     </TABLE>
104    
105     <hr>
106     <!-- =========== VAR INHERITED SUMMARY =========== -->
107     <A NAME='var_inherited_summary'><!-- --></A>
108     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
109     <TR CLASS='TableHeadingColor'>
110     <TD>
111     <span CLASS="font12bold">Inherited Class Variable Summary</span>
112     <A HREF="#top" CLASS="links">^TOP</A>
113     </TD>
114     </TR>
115    
116    
117     <!-- =========== Summary =========== -->
118     <TR BGCOLOR='white'>
119     <TD>
120     <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/SQLDataListSource.html">SQLDataListSource</a></span>
121     <table CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">
122     <tr CLASS="tableheadingcolor">
123     <th>Variable</th>
124     <th>Default Value</th>
125     <th>Description</th>
126     </tr>
127    
128     <tr>
129     <td CLASS="font10bold"><A HREF='../phpHtmlLib/SQLDataListSource.html#$_db_options'>$_db_options</A></td>
130     <td CLASS="font10" STYLE="white-space: nowrap">->array(&quot;values&quot; =&gt; &quot;&quot;,
131     &quot;tables&quot; =&gt; &quot;&quot;,
132     &quot;where_clause&quot; =&gt; &quot;&quot;,
133     &quot;groupby_clause&quot; =&gt; &quot;&quot;,
134     &quot;count_column&quot; =&gt; &quot;*&quot;)<-</td>
135     <td CLASS="font10">this holds all of the options
136     that make up the sql query</td>
137     </tr>
138    
139     <tr>
140     <td CLASS="font10bold"><A HREF='../phpHtmlLib/SQLDataListSource.html#$_query'>$_query</A></td>
141     <td CLASS="font10" STYLE="white-space: nowrap">-><-</td>
142     <td CLASS="font10">The entire query built by</td>
143     </tr>
144    
145     </table>
146     <BR>
147     </TD>
148     </TR>
149    
150     <!-- =========== Summary =========== -->
151     <TR BGCOLOR='white'>
152     <TD>
153     <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/DataListSource.html">DataListSource</a></span>
154     <table CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">
155     <tr CLASS="tableheadingcolor">
156     <th>Variable</th>
157     <th>Default Value</th>
158     <th>Description</th>
159     </tr>
160    
161     <tr>
162     <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#$_columns'>$_columns</A></td>
163     <td CLASS="font10" STYLE="white-space: nowrap">->array()<-</td>
164     <td CLASS="font10">The column descriptions
165     for the data we are working on</td>
166     </tr>
167    
168     <tr>
169     <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#$_data'>$_data</A></td>
170     <td CLASS="font10" STYLE="white-space: nowrap">->array()<-</td>
171     <td CLASS="font10">A placeholder for data that is read/built</td>
172     </tr>
173    
174     <tr>
175     <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#$_data_index'>$_data_index</A></td>
176     <td CLASS="font10" STYLE="white-space: nowrap">->0<-</td>
177     <td CLASS="font10">Holds the index into the array of data</td>
178     </tr>
179    
180     <tr>
181     <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#$_not_found_message'>$_not_found_message</A></td>
182     <td CLASS="font10" STYLE="white-space: nowrap">->No data was found<-</td>
183     <td CLASS="font10">This is the message displayed when no data</td>
184     </tr>
185    
186     <tr>
187     <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#$_query_params'>$_query_params</A></td>
188     <td CLASS="font10" STYLE="white-space: nowrap">->array(&quot;num_total_rows&quot; =&gt; 0,
189     &quot;offset&quot; =&gt; 0,
190     &quot;limit&quot; =&gt; -1,
191     &quot;orderby&quot; =&gt; '',
192     &quot;reverseorder&quot; =&gt; '',
193     &quot;searchby&quot; =&gt; '',
194     &quot;searchvalue&quot; =&gt; '',
195     &quot;searchmodifier&quot; =&gt; '',
196     &quot;searchtype&quot; =&gt; 'simple')<-</td>
197     <td CLASS="font10">This holds various parameters relating
198     to the query of the data</td>
199     </tr>
200    
201     </table>
202     <BR>
203     </TD>
204     </TR>
205    
206     </TABLE>
207    
208     <hr>
209     <!-- =========== INHERITED METHOD SUMMARY =========== -->
210     <A NAME='functions_inherited'><!-- --></A>
211     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
212     <TR CLASS='TableHeadingColor'>
213     <TD>
214     <span CLASS="font12bold">Inherited Method Summary</span>
215     <A HREF="#top" CLASS="links">^TOP</A>
216     </TD>
217     </TR>
218    
219    
220     <!-- =========== Summary =========== -->
221     <TR BGCOLOR='white' CLASS='TableRowColor'>
222     <TD>
223     <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/SQLDataListSource.html">SQLDataListSource</a></span>
224     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">
225     <tr CLASS="tableheadingcolor">
226     <th>Function</th>
227     <th>Description</th>
228     </tr>
229    
230     <tr>
231     <td CLASS="font10bold"><A HREF='../phpHtmlLib/SQLDataListSource.html#advanced_search_where_clause'>advanced_search_where_clause ( )</A></td>
232     <td CLASS="font10">This function is responsible for
233     building the portion of the where clause
234     for doing an advanced search.</td>
235    
236     <tr>
237     <td CLASS="font10bold"><A HREF='../phpHtmlLib/SQLDataListSource.html#build_groupby_clause'>build_groupby_clause ( )</A></td>
238     <td CLASS="font10">this builds the groupby clause of the query</td>
239    
240     <tr>
241     <td CLASS="font10bold"><A HREF='../phpHtmlLib/SQLDataListSource.html#build_limit_clause'>build_limit_clause ( $offset, $limit )</A></td>
242     <td CLASS="font10">This function builds the limit</td>
243    
244     <tr>
245     <td CLASS="font10bold"><A HREF='../phpHtmlLib/SQLDataListSource.html#build_order_clause'>build_order_clause ( )</A></td>
246     <td CLASS="font10">This builds the db query ORDER BY
247     clause used to sort the data from the DB.</td>
248    
249     <tr>
250     <td CLASS="font10bold"><A HREF='../phpHtmlLib/SQLDataListSource.html#build_query'>build_query ( [$limit_flag = TRUE] )</A></td>
251     <td CLASS="font10">build the entire DB query</td>
252    
253     <tr>
254     <td CLASS="font10bold"><A HREF='../phpHtmlLib/SQLDataListSource.html#build_search_clause'>build_search_clause ( )</A></td>
255     <td CLASS="font10">This method builds the where clause.</td>
256    
257     <tr>
258     <td CLASS="font10bold"><A HREF='../phpHtmlLib/SQLDataListSource.html#build_where_clause'>build_where_clause ( )</A></td>
259     <td CLASS="font10">This builds the where clause for
260     the query</td>
261    
262     <tr>
263     <td CLASS="font10bold"><A HREF='../phpHtmlLib/SQLDataListSource.html#count'>count ( $tables, [$where_clause = ''], [$count_clause = '*'] )</A></td>
264     <td CLASS="font10">find the number of rows to be returned
265     from a query from a table and where clause</td>
266    
267     <tr>
268     <td CLASS="font10bold"><A HREF='../phpHtmlLib/SQLDataListSource.html#do_prequery'>do_prequery ( )</A></td>
269     <td CLASS="font10"></td>
270    
271     <tr>
272     <td CLASS="font10bold"><A HREF='../phpHtmlLib/SQLDataListSource.html#do_query'>do_query ( )</A></td>
273     <td CLASS="font10">Do the query to the DB and pull in all of
274     the records locally.</td>
275    
276     <tr>
277     <td CLASS="font10bold"><A HREF='../phpHtmlLib/SQLDataListSource.html#get_count_column'>get_count_column ( )</A></td>
278     <td CLASS="font10">this returns the current count column</td>
279    
280     <tr>
281     <td CLASS="font10bold"><A HREF='../phpHtmlLib/SQLDataListSource.html#get_count_column'>get_count_column ( )</A></td>
282     <td CLASS="font10">this gets the count column</td>
283    
284     <tr>
285     <td CLASS="font10bold"><A HREF='../phpHtmlLib/SQLDataListSource.html#get_db_tables'>get_db_tables ( )</A></td>
286     <td CLASS="font10">returns the table(s) used in the query</td>
287    
288     <tr>
289     <td CLASS="font10bold"><A HREF='../phpHtmlLib/SQLDataListSource.html#get_db_values'>get_db_values ( )</A></td>
290     <td CLASS="font10">This function returns the</td>
291    
292     <tr>
293     <td CLASS="font10bold"><A HREF='../phpHtmlLib/SQLDataListSource.html#get_next_data_row'>get_next_data_row ( )</A></td>
294     <td CLASS="font10">This function gets the next data row
295     from the query()</td>
296    
297     <tr>
298     <td CLASS="font10bold"><A HREF='../phpHtmlLib/SQLDataListSource.html#join_clauses'>join_clauses ( )</A></td>
299     <td CLASS="font10"></td>
300    
301     <tr>
302     <td CLASS="font10bold"><A HREF='../phpHtmlLib/SQLDataListSource.html#search_value_filter'>search_value_filter ( $value )</A></td>
303     <td CLASS="font10">This function does the variable cleaning</td>
304    
305     <tr>
306     <td CLASS="font10bold"><A HREF='../phpHtmlLib/SQLDataListSource.html#setup_db_options'>setup_db_options ( [$values = ], $tables, [$where_clause = ''], [$groupby_clause = ''] )</A></td>
307     <td CLASS="font10">Set which DB options
308     to use for this list.</td>
309    
310     <tr>
311     <td CLASS="font10bold"><A HREF='../phpHtmlLib/SQLDataListSource.html#setup_order'>setup_order ( $orderby, $reverseorder )</A></td>
312     <td CLASS="font10">This function builds the orderby clause
313     for the DB query.</td>
314    
315     <tr>
316     <td CLASS="font10bold"><A HREF='../phpHtmlLib/SQLDataListSource.html#set_count_column'>set_count_column ( $var )</A></td>
317     <td CLASS="font10">This function changes the counted column.</td>
318    
319     <tr>
320     <td CLASS="font10bold"><A HREF='../phpHtmlLib/SQLDataListSource.html#set_db_groupby_clause'>set_db_groupby_clause ( $clause )</A></td>
321     <td CLASS="font10">Sets the groupby clause for the query</td>
322    
323     <tr>
324     <td CLASS="font10bold"><A HREF='../phpHtmlLib/SQLDataListSource.html#set_db_tables'>set_db_tables ( $tables )</A></td>
325     <td CLASS="font10">Set the tables from the DB you
326     want to select on.</td>
327    
328     <tr>
329     <td CLASS="font10bold"><A HREF='../phpHtmlLib/SQLDataListSource.html#set_db_values'>set_db_values ( $values )</A></td>
330     <td CLASS="font10">Set the values we want to select
331     from the db.</td>
332    
333     <tr>
334     <td CLASS="font10bold"><A HREF='../phpHtmlLib/SQLDataListSource.html#set_db_where_clause'>set_db_where_clause ( $where_clause )</A></td>
335     <td CLASS="font10">Set the user portion of the where
336     clause.</td>
337    
338     <tr>
339     <td CLASS="font10bold"><A HREF='../phpHtmlLib/SQLDataListSource.html#simple_search_where_clause'>simple_search_where_clause ( )</A></td>
340     <td CLASS="font10">this builds the search clause</td>
341    
342     <tr>
343     <td CLASS="font10bold"><A HREF='../phpHtmlLib/SQLDataListSource.html#sql_varchar_filter'>sql_varchar_filter ( $value )</A></td>
344     <td CLASS="font10">Clean up the string so it can work in a db</td>
345    
346     </table>
347     <br>
348     </TD>
349     </TR>
350    
351     <!-- =========== Summary =========== -->
352     <TR BGCOLOR='white' CLASS='TableRowColor'>
353     <TD>
354     <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/DataListSource.html">DataListSource</a></span>
355     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">
356     <tr CLASS="tableheadingcolor">
357     <th>Function</th>
358     <th>Description</th>
359     </tr>
360    
361     <tr>
362     <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#constructor DataListSource'>constructor DataListSource ( )</A></td>
363     <td CLASS="font10">The constructor</td>
364    
365     <tr>
366     <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#add_column'>add_column ( [$title = ], $data_name, [$sortable = FALSE], [$searchable = FALSE], [$sortorder = "ASC"] )</A></td>
367     <td CLASS="font10">Add a column of data to manage</td>
368    
369     <tr>
370     <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#do_prequery'>do_prequery ( )</A></td>
371     <td CLASS="font10">This is a method that should be defined by the
372     child class to do any pre-query type of things.</td>
373    
374     <tr>
375     <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#do_query'>do_query ( )</A></td>
376     <td CLASS="font10">This is the function that does the data fetching,
377     and sorting if needed.</td>
378    
379     <tr>
380     <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#get_data_index'>get_data_index ( )</A></td>
381     <td CLASS="font10">This function returns the
382     data_index value and increments it</td>
383    
384     <tr>
385     <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#get_limit'>get_limit ( )</A></td>
386     <td CLASS="font10">This function gets the current
387     value of the limit value</td>
388    
389     <tr>
390     <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#get_next_data_row'>get_next_data_row ( )</A></td>
391     <td CLASS="font10">This function gets the next data row
392     from the query()</td>
393    
394     <tr>
395     <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#get_not_found_message'>get_not_found_message ( )</A></td>
396     <td CLASS="font10">This function is used to get the
397     message displayed when no data is found</td>
398    
399     <tr>
400     <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#get_offset'>get_offset ( )</A></td>
401     <td CLASS="font10">This function returns the value of the
402     offset</td>
403    
404     <tr>
405     <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#get_orderby'>get_orderby ( )</A></td>
406     <td CLASS="font10">This function returns the value of the
407     orderby</td>
408    
409     <tr>
410     <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#get_reverseorder'>get_reverseorder ( )</A></td>
411     <td CLASS="font10">This function returns the value of the
412     reverseorder</td>
413    
414     <tr>
415     <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#get_searchby'>get_searchby ( )</A></td>
416     <td CLASS="font10">This function returns the value of the
417     searchby</td>
418    
419     <tr>
420     <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#get_searchby_value'>get_searchby_value ( )</A></td>
421     <td CLASS="font10">This function returns the value of the
422     search value</td>
423    
424     <tr>
425     <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#get_search_type'>get_search_type ( )</A></td>
426     <td CLASS="font10">this function returns the current search type
427     for the DataList query</td>
428    
429     <tr>
430     <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#get_simplesearch_modifier'>get_simplesearch_modifier ( )</A></td>
431     <td CLASS="font10">This function returns the value of the
432     search value</td>
433    
434     <tr>
435     <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#get_total_rows'>get_total_rows ( )</A></td>
436     <td CLASS="font10">This returns the total number of rows
437     in our entire data set</td>
438    
439     <tr>
440     <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#query'>query ( $offset, $limit, $orderby, $reverseorder, $searchby, $searchby_value, $simplesearch_modifier, $search_type )</A></td>
441     <td CLASS="font10">The main Query function.</td>
442    
443     <tr>
444     <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#set_limit'>set_limit ( $limit )</A></td>
445     <td CLASS="font10">This function is used to set</td>
446    
447     <tr>
448     <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#set_not_found_message'>set_not_found_message ( $mesg )</A></td>
449     <td CLASS="font10">This function is used to set the
450     message displayed when no data is found</td>
451    
452     <tr>
453     <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#set_offset'>set_offset ( $offset )</A></td>
454     <td CLASS="font10">This sets the offset value</td>
455    
456     <tr>
457     <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#set_orderby'>set_orderby ( $orderby )</A></td>
458     <td CLASS="font10">This sets the orderby column name.</td>
459    
460     <tr>
461     <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#set_reverseorder'>set_reverseorder ( $order )</A></td>
462     <td CLASS="font10">This sets the flag that tells us the
463     direction in which to order the orderby
464     column.</td>
465    
466     <tr>
467     <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#set_searchby'>set_searchby ( $search_col )</A></td>
468     <td CLASS="font10">This sets the column that we want to search
469     from.</td>
470    
471     <tr>
472     <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#set_searchby_value'>set_searchby_value ( $search_value )</A></td>
473     <td CLASS="font10">This sets the data that we want to search
474     for.</td>
475    
476     <tr>
477     <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#set_search_type'>set_search_type ( $search_type )</A></td>
478     <td CLASS="font10">This function sets the search type
479     (simple or advanced)</td>
480    
481     <tr>
482     <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#set_simplesearch_modifier'>set_simplesearch_modifier ( $search_modifier )</A></td>
483     <td CLASS="font10">This sets the simple search modifier</td>
484    
485     <tr>
486     <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#set_total_rows'>set_total_rows ( $num )</A></td>
487     <td CLASS="font10">This is used to set the total # of
488     rows we have in our data set</td>
489    
490     <tr>
491     <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#sort'>sort ( )</A></td>
492     <td CLASS="font10">A generic method API that can be used at the bottom
493     half of the do_query() method to sort data that is
494     stored locally.</td>
495    
496     <tr>
497     <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataListSource.html#_is_column_sortable'>_is_column_sortable ( $data_name )</A></td>
498     <td CLASS="font10">This function determines if the column</td>
499    
500     </table>
501     <br>
502     </TD>
503     </TR>
504    
505     </TABLE>
506    
507     <hr>
508     <!-- should have constructor at some point -->
509     <!-- =========== Method SUMMARY =========== -->
510     <A NAME='Method_summary'><!-- --></A>
511     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' Class="border">
512     <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
513     <TD>
514     <span class="font12bold">Method Summary</span>
515     <A HREF="#top" CLASS="links">^TOP</A>
516     </TD>
517     </TR>
518    
519    
520     <!-- =========== Summary =========== -->
521     <TR BGCOLOR='white' CLASS='TableRowColor'>
522     <TD>
523     <CODE><B><A HREF='PEARSQLDataListSource.html#constructor PEARSQLDataListSource'>void constructor PEARSQLDataListSource ( &$db )</A></B></CODE>
524     <BR>
525     <blockquote> The constructor is used to pass in the
526     PEAR DB object that has already been
527     created and connected to the db. </blockquote>
528     </TD>
529     </TR>
530    
531     <!-- =========== Summary =========== -->
532     <TR BGCOLOR='white' CLASS='TableRowColor'>
533     <TD>
534     <CODE><B><A HREF='PEARSQLDataListSource.html#build_limit_clause'>string build_limit_clause ( $offset, $limit )</A></B></CODE>
535     <BR>
536     <blockquote> This function builds the limit
537     clause portion of a DB query. </blockquote>
538     </TD>
539     </TR>
540    
541     <!-- =========== Summary =========== -->
542     <TR BGCOLOR='white' CLASS='TableRowColor'>
543     <TD>
544     <CODE><B><A HREF='PEARSQLDataListSource.html#count'>int count ( $tables, [$where_clause = ''], [$count_clause = '*'] )</A></B></CODE>
545     <BR>
546     <blockquote> find the number of rows to be returned
547     from a query from a table and where clause </blockquote>
548     </TD>
549     </TR>
550    
551     <!-- =========== Summary =========== -->
552     <TR BGCOLOR='white' CLASS='TableRowColor'>
553     <TD>
554     <CODE><B><A HREF='PEARSQLDataListSource.html#do_query'>void do_query ( )</A></B></CODE>
555     <BR>
556     <blockquote> </blockquote>
557     </TD>
558     </TR>
559    
560     <!-- =========== Summary =========== -->
561     <TR BGCOLOR='white' CLASS='TableRowColor'>
562     <TD>
563     <CODE><B><A HREF='PEARSQLDataListSource.html#get_next_data_row'>array() get_next_data_row ( )</A></B></CODE>
564     <BR>
565     <blockquote> This function gets the next data row
566     from the query() </blockquote>
567     </TD>
568     </TR>
569    
570     <!-- =========== Summary =========== -->
571     <TR BGCOLOR='white' CLASS='TableRowColor'>
572     <TD>
573     <CODE><B><A HREF='PEARSQLDataListSource.html#set_db_object'>void set_db_object ( &$db )</A></B></CODE>
574     <BR>
575     <blockquote> Set the DB object we will use
576     to talk to the DB. </blockquote>
577     </TD>
578     </TR>
579    
580     </TABLE>
581    
582     <hr>
583     <!-- ============ VARIABLE DETAIL =========== -->
584    
585     <A NAME='variable_detail'></A>
586     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
587     <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
588     <TD>
589     <span CLASS="font12bold">Variable Detail</span>
590     <A HREF="#top" CLASS="links">^TOP</A>
591     </TD>
592     </TR>
593     </TABLE>
594    
595    
596     <A NAME='$_db'><!-- --></A><H3>$_db</H3>
597     <b>Data type:</b> mixed<br>
598     <!-- ========== Info from phpDoc block ========= -->
599     This var holds the Database object
600     <BR>
601     that is used to do the sql queries
602     It is assumed that the db is already
603     connected to, and the object provides
604     2 methods:
605     query() - execute a sql query
606    
607     <UL>
608    
609     </UL>
610    
611     <HR>
612    
613     <A NAME='$_result'><!-- --></A><H3>$_result</H3>
614     <b>Data type:</b> mixed<br>
615     <!-- ========== Info from phpDoc block ========= -->
616     this holds the query result from the
617     PEAR::DB-&gt;query() call
618     <BR>
619    
620    
621     <UL>
622    
623     </UL>
624    
625     <HR>
626    
627    
628     <hr>
629     <!-- ============ FUNCTION DETAIL =========== -->
630    
631     <A NAME='function_detail'></A>
632     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
633     <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
634     <TD>
635     <span class="font12bold">Method Detail</span>
636     <A HREF="#top" CLASS="links">^TOP</A>
637     </TD>
638     </TR>
639     </TABLE>
640     <BR>
641    
642     <DIV CLASS="function">
643     <A NAME='constructor PEARSQLDataListSource'><!-- --></A>
644     <SPAN CLASS="font12bold">constructor PEARSQLDataListSource</SPAN>
645     <BR>
646     <SPAN CLASS="font10bold">Useage : </SPAN>
647     <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
648     <span class="font10bold" style="color: #0000FF">constructor PEARSQLDataListSource ( &$db )</SPAN>
649     <BR>
650    
651     <BR>
652     <SPAN CLASS="font10bold">Description : </SPAN>
653     <!-- ========== Info from phpDoc block ========= -->
654     The constructor is used to pass in the
655     PEAR DB object that has already been
656     created and connected to the db.
657     <BR>
658    
659     <DL>
660     <DT class="font10bold">Function Parameters:</DT>
661    
662     <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">PEAR::DB</SPAN> <span style="color: #0000FF;font-weight:bold">&$db</SPAN></SPAN> object - MUST BE CONNECTED</DD>
663    
664    
665     <DT class="font10bold">Function Info:</DT>
666    
667     </DL>
668    
669     </DIV>
670     <BR>
671    
672     <DIV CLASS="function">
673     <A NAME='build_limit_clause'><!-- --></A>
674     <SPAN CLASS="font12bold">build_limit_clause</SPAN>
675     <BR>
676     <SPAN CLASS="font10bold">Useage : </SPAN>
677     <span class="font10bold" style="color: #FF0000">string</SPAN>&nbsp;
678     <span class="font10bold" style="color: #0000FF">build_limit_clause ( $offset, $limit )</SPAN>
679     <BR>
680     <span class="font10bold" style="padding-left: 10px;">Overrides :</span> <a href="../phpHtmlLib/SQLDataListSource.html#build_limit_clause">SQLDataListSource::build_limit_clause()</a>
681     <BR>
682     <SPAN CLASS="font10bold">Description : </SPAN>
683     <!-- ========== Info from phpDoc block ========= -->
684     This function builds the limit
685     clause portion of a DB query.
686     <BR>
687    
688     <DL>
689     <DT class="font10bold">Function Parameters:</DT>
690    
691    
692     <DT class="font10bold">Function Info:</DT>
693    
694     <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - - the limit portion of
695     the query.</DD>
696    
697     </DL>
698    
699     </DIV>
700     <BR>
701    
702     <DIV CLASS="function">
703     <A NAME='count'><!-- --></A>
704     <SPAN CLASS="font12bold">count</SPAN>
705     <BR>
706     <SPAN CLASS="font10bold">Useage : </SPAN>
707     <span class="font10bold" style="color: #FF0000">int</SPAN>&nbsp;
708     <span class="font10bold" style="color: #0000FF">count ( $tables, [$where_clause = ''], [$count_clause = '*'] )</SPAN>
709     <BR>
710     <span class="font10bold" style="padding-left: 10px;">Overrides :</span> <a href="../phpHtmlLib/SQLDataListSource.html#count">SQLDataListSource::count()</a>
711     <BR>
712     <SPAN CLASS="font10bold">Description : </SPAN>
713     <!-- ========== Info from phpDoc block ========= -->
714     find the number of rows to be returned
715     from a query from a table and where clause
716     <BR>
717    
718     <DL>
719     <DT class="font10bold">Function Parameters:</DT>
720    
721     <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>
722    
723     <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>
724    
725    
726     <DT class="font10bold">Function Info:</DT>
727    
728     <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - the # of rows</DD>
729    
730     </DL>
731    
732     </DIV>
733     <BR>
734    
735     <DIV CLASS="function">
736     <A NAME='do_query'><!-- --></A>
737     <SPAN CLASS="font12bold">do_query</SPAN>
738     <BR>
739     <SPAN CLASS="font10bold">Useage : </SPAN>
740     <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
741     <span class="font10bold" style="color: #0000FF">do_query ( )</SPAN>
742     <BR>
743     <span class="font10bold" style="padding-left: 10px;">Overrides :</span> <a href="../phpHtmlLib/SQLDataListSource.html#do_query">SQLDataListSource::do_query()</a>
744     <BR>
745     <SPAN CLASS="font10bold">Description : </SPAN>
746     <!-- ========== Info from phpDoc block ========= -->
747    
748     <BR>
749    
750     <DL>
751     <DT class="font10bold">Function Parameters:</DT>
752    
753    
754     <DT class="font10bold">Function Info:</DT>
755    
756     </DL>
757    
758     </DIV>
759     <BR>
760    
761     <DIV CLASS="function">
762     <A NAME='get_next_data_row'><!-- --></A>
763     <SPAN CLASS="font12bold">get_next_data_row</SPAN>
764     <BR>
765     <SPAN CLASS="font10bold">Useage : </SPAN>
766     <span class="font10bold" style="color: #FF0000">array()</SPAN>&nbsp;
767     <span class="font10bold" style="color: #0000FF">get_next_data_row ( )</SPAN>
768     <BR>
769     <span class="font10bold" style="padding-left: 10px;">Overrides :</span> <a href="../phpHtmlLib/SQLDataListSource.html#get_next_data_row">SQLDataListSource::get_next_data_row()</a>
770     <BR>
771     <SPAN CLASS="font10bold">Description : </SPAN>
772     <!-- ========== Info from phpDoc block ========= -->
773     This function gets the next data row
774     from the query()
775     <BR>
776    
777     <DL>
778     <DT class="font10bold">Function Parameters:</DT>
779    
780    
781     <DT class="font10bold">Function Info:</DT>
782    
783     </DL>
784    
785     </DIV>
786     <BR>
787    
788     <DIV CLASS="function">
789     <A NAME='set_db_object'><!-- --></A>
790     <SPAN CLASS="font12bold">set_db_object</SPAN>
791     <BR>
792     <SPAN CLASS="font10bold">Useage : </SPAN>
793     <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
794     <span class="font10bold" style="color: #0000FF">set_db_object ( &$db )</SPAN>
795     <BR>
796    
797     <BR>
798     <SPAN CLASS="font10bold">Description : </SPAN>
799     <!-- ========== Info from phpDoc block ========= -->
800     Set the DB object we will use
801     to talk to the DB.
802     <BR>
803    
804     <DL>
805     <DT class="font10bold">Function Parameters:</DT>
806    
807     <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">object</SPAN> <span style="color: #0000FF;font-weight:bold">$db</SPAN></SPAN> - the babw_db object.</DD>
808    
809    
810     <DT class="font10bold">Function Info:</DT>
811    
812     </DL>
813    
814     </DIV>
815     <BR>
816    
817    
818     <hr>
819     </HTML>
MailToCvsAdmin">MailToCvsAdmin
 ViewVC Help
Powered by ViewVC 1.1.26 RSS 2.0 feed