/[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.2 - (hide annotations)
Sat Feb 22 20:56:31 2003 UTC (21 years, 6 months ago) by jonen
Branch: MAIN
Changes since 1.1: +371 -574 lines
File MIME type: text/html 
+ updated whole lib to version 2.2.1 (new FormProcessing since 2.2.0!)
1 jonen 1.2 <!DOCTYPE HTML PUBLIC '-//W3C//DTD HTML 4.0 Transitional//EN' 'http://www.w3.org/TR/REC-html40/loose.dtd'>
2 jonen 1.1 <!--NewPage-->
3     <HTML>
4     <HEAD>
5 jonen 1.2 <!-- Generated by PhpDoc date: 'Thu, 20 Feb 2003 16:23:06 -0800' -->
6 jonen 1.1 <TITLE>Docs For Class PEARSQLDataListSource</TITLE>
7 jonen 1.2 <LINK REL ='stylesheet' TYPE='text/css' HREF='../media/stylesheet.css' TITLE='Style'>
8 jonen 1.1 </HEAD>
9     <BODY style="background-color: #eeeeee; font-family: arial; font-size: .9em;">
10     <!-- Links -->
11     <a NAME="top"></A>
12     <table WIDTH="100%" class="links">
13     <TR>
14     <TD class="font10">
15     Links:
16     <A HREF="#children_summary" class="links" title="Classes extended from PEARSQLDataListSource">Child Classes</A>
17     <A HREF="#var_summary" class="links" title="Class Variable Summary">Variables</A>
18     <A HREF="#var_inherited_summary" class="links" title="Inherited Class Variable Summary">Inherited Variables</A>
19 jonen 1.2 <A HREF="#functions_inherited" class="links" title="Inherited Method Summary">Inherited Methods</A>
20     <A HREF="#method_summary" class="links" title="Method Summary">Methods</A>
21 jonen 1.1 <A HREF="#variable_detail" class="links" title="Variable Detail">Variable Detail</A>
22 jonen 1.2 <A HREF="#method_detail" class="links" title="Method Detail">Method Detail</A>
23 jonen 1.1 </TD>
24     </TR>
25     </TABLE>
26     <BR>
27     <!-- Start of Class Data -->
28     <H2>
29     Class PEARSQLDataListSource
30 jonen 1.2 </H2> (line <span class="linenumber">40</span>)
31 jonen 1.1 <pre>
32 jonen 1.2 <a href="../phpHtmlLib/DataListSource.html">DataListSource</a>
33 jonen 1.1 |
34     --<a href="../phpHtmlLib/SQLDataListSource.html">SQLDataListSource</a>
35     |
36     --PEARSQLDataListSource</pre>
37     <p>
38     <b><i>Located in File: Program_Root/widgets/data_list/PEARSQLDataListSource.inc</i></b><br>
39     </p>
40     <hr>
41 jonen 1.2 This SQLDataListSource child class interacts with with the specific DB via the php PEAR DB abstraction objects.
42     <br />
43     <p>How to use? in the DataList child's get_data_source() method you pass in the already connected PEAR DB object in to the constructor. PEARSQLDataListSource takes care of the rest.</p>
44 jonen 1.1 <UL>
45 jonen 1.2 <LI><b>author</b> - <CODE>Walter A. Boring IV &lt;<a href="mailto:waboring@buildabetterweb.com">mailto:waboring@buildabetterweb.com</a>&gt;</CODE></LI>
46     </UL>
47 jonen 1.1 <hr>
48     <!-- =========== VAR SUMMARY =========== -->
49     <A NAME='var_summary'><!-- --></A>
50     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
51     <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
52     <TD>
53     <span CLASS="font12bold">Class Variable Summary</span>
54     <A HREF="#top" CLASS="links">^TOP</A>
55     </TD>
56     </TR>
57    
58 jonen 1.2 <!-- =========== Summary =========== -->
59 jonen 1.1 <TR BGCOLOR='white' CLASS='TableRowColor'>
60     <TD>
61 jonen 1.2 <CODE><B><A HREF="../phpHtmlLib/PEARSQLDataListSource.html#var$_db">$_db</A></B></CODE>
62 jonen 1.1 <BR>
63     <blockquote> This var holds the Database object </blockquote>
64 jonen 1.2 <blockquote> Default Value: <CODE>->&nbsp;NULL<-</CODE> </blockquote>
65 jonen 1.1 </TD>
66     </TR>
67 jonen 1.2 <!-- =========== Summary =========== -->
68 jonen 1.1 <TR BGCOLOR='white' CLASS='TableRowColor'>
69     <TD>
70 jonen 1.2 <CODE><B><A HREF="../phpHtmlLib/PEARSQLDataListSource.html#var$_result">$_result</A></B></CODE>
71 jonen 1.1 <BR>
72 jonen 1.2 <blockquote> this holds the query result from the </blockquote>
73     <blockquote> Default Value: <CODE>->&nbsp;NULL<-</CODE> </blockquote>
74 jonen 1.1 </TD>
75     </TR>
76 jonen 1.2 </TABLE>
77 jonen 1.1 <hr>
78     <!-- =========== VAR INHERITED SUMMARY =========== -->
79     <A NAME='var_inherited_summary'><!-- --></A>
80     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
81 jonen 1.2 <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
82 jonen 1.1 <TD>
83     <span CLASS="font12bold">Inherited Class Variable Summary</span>
84     <A HREF="#top" CLASS="links">^TOP</A>
85     </TD>
86     </TR>
87    
88 jonen 1.2 <!-- =========== Summary =========== -->
89 jonen 1.1 <TR BGCOLOR='white'>
90     <TD>
91     <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/SQLDataListSource.html">SQLDataListSource</a></span>
92     <table CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">
93     <tr CLASS="tableheadingcolor">
94     <th>Variable</th>
95     <th>Default Value</th>
96     <th>Description</th>
97     </tr>
98 jonen 1.2 <tr>
99     <td CLASS="font10bold"><a href="../phpHtmlLib/SQLDataListSource.html#var$_db_options">SQLDataListSource::$_db_options</a></td>
100     <td CLASS="font10" STYLE="white-space: nowrap">->array("values" =&gt; "",
101     "tables" =&gt; "",
102     "where_clause" =&gt; "",
103     "groupby_clause" =&gt; "",
104     "count_column" =&gt; "*")<-</td>
105     <td CLASS="font10">this holds all of the options</td>
106 jonen 1.1 </tr>
107 jonen 1.2 <tr>
108     <td CLASS="font10bold"><a href="../phpHtmlLib/SQLDataListSource.html#var$_query">SQLDataListSource::$_query</a></td>
109     <td CLASS="font10" STYLE="white-space: nowrap">-> ""<-</td>
110 jonen 1.1 <td CLASS="font10">The entire query built by</td>
111     </tr>
112 jonen 1.2 </table>
113 jonen 1.1 <BR>
114     </TD>
115     </TR>
116 jonen 1.2 <!-- =========== Summary =========== -->
117 jonen 1.1 <TR BGCOLOR='white'>
118     <TD>
119     <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/DataListSource.html">DataListSource</a></span>
120     <table CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">
121     <tr CLASS="tableheadingcolor">
122     <th>Variable</th>
123     <th>Default Value</th>
124     <th>Description</th>
125     </tr>
126 jonen 1.2 <tr>
127     <td CLASS="font10bold"><a href="../phpHtmlLib/DataListSource.html#var$_columns">DataListSource::$_columns</a></td>
128 jonen 1.1 <td CLASS="font10" STYLE="white-space: nowrap">->array()<-</td>
129 jonen 1.2 <td CLASS="font10">The column descriptions for the data we are working on</td>
130 jonen 1.1 </tr>
131 jonen 1.2 <tr>
132     <td CLASS="font10bold"><a href="../phpHtmlLib/DataListSource.html#var$_data">DataListSource::$_data</a></td>
133 jonen 1.1 <td CLASS="font10" STYLE="white-space: nowrap">->array()<-</td>
134 jonen 1.2 <td CLASS="font10">A placeholder for data that is read/built and stored locally. Not all data sources have to use this.</td>
135 jonen 1.1 </tr>
136 jonen 1.2 <tr>
137     <td CLASS="font10bold"><a href="../phpHtmlLib/DataListSource.html#var$_data_index">DataListSource::$_data_index</a></td>
138     <td CLASS="font10" STYLE="white-space: nowrap">-> 0<-</td>
139 jonen 1.1 <td CLASS="font10">Holds the index into the array of data</td>
140     </tr>
141 jonen 1.2 <tr>
142     <td CLASS="font10bold"><a href="../phpHtmlLib/DataListSource.html#var$_not_found_message">DataListSource::$_not_found_message</a></td>
143     <td CLASS="font10" STYLE="white-space: nowrap">-> "No data was found"<-</td>
144 jonen 1.1 <td CLASS="font10">This is the message displayed when no data</td>
145     </tr>
146 jonen 1.2 <tr>
147     <td CLASS="font10bold"><a href="../phpHtmlLib/DataListSource.html#var$_query_params">DataListSource::$_query_params</a></td>
148     <td CLASS="font10" STYLE="white-space: nowrap">->array("num_total_rows" =&gt; 0,
149     "offset" =&gt; 0,
150     "limit" =&gt; -1,
151     "orderby" =&gt; '',
152     "reverseorder" =&gt; '',
153     "searchby" =&gt; '',
154     "searchvalue" =&gt; '',
155     "searchmodifier" =&gt; '',
156     "searchtype" =&gt; 'simple')<-</td>
157     <td CLASS="font10">This holds various parameters relating</td>
158 jonen 1.1 </tr>
159 jonen 1.2 </table>
160 jonen 1.1 <BR>
161     </TD>
162     </TR>
163 jonen 1.2 </TABLE>
164 jonen 1.1
165     <hr>
166 jonen 1.2 <!-- =========== METHOD SUMMARY =========== -->
167     <A NAME='method_summary'><!-- --></A>
168     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' Class="border">
169     <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
170     <TD>
171     <span class="font12bold">Method Summary</span>
172     <A HREF="#top" CLASS="links">^TOP</A>
173     </TD>
174     </TR>
175    
176     <!-- =========== Summary =========== -->
177     <TR BGCOLOR='white' CLASS='TableRowColor'>
178     <TD>
179     <CODE><B><A HREF='../phpHtmlLib/PEARSQLDataListSource.html#methodPEARSQLDataListSource'>void constructor PEARSQLDataListSource ( &$db )</A></B></CODE>
180     <BR>
181     <blockquote> The constructor is used to pass in the PEAR DB object that has already been created and connected to the db. </blockquote>
182     </TD>
183     </TR>
184     <!-- =========== Summary =========== -->
185     <TR BGCOLOR='white' CLASS='TableRowColor'>
186     <TD>
187     <CODE><B><A HREF='../phpHtmlLib/PEARSQLDataListSource.html#methodbuild_limit_clause'>string build_limit_clause ( $offset, $limit )</A></B></CODE>
188     <BR>
189     <blockquote> This function builds the limit clause portion of a DB query. </blockquote>
190     </TD>
191     </TR>
192     <!-- =========== Summary =========== -->
193     <TR BGCOLOR='white' CLASS='TableRowColor'>
194     <TD>
195     <CODE><B><A HREF='../phpHtmlLib/PEARSQLDataListSource.html#methodcount'>int count ( $tables, [$where_clause = ''], [$count_clause = '*'] )</A></B></CODE>
196     <BR>
197     <blockquote> find the number of rows to be returned from a query from a table and where clause </blockquote>
198     </TD>
199     </TR>
200     <!-- =========== Summary =========== -->
201     <TR BGCOLOR='white' CLASS='TableRowColor'>
202     <TD>
203     <CODE><B><A HREF='../phpHtmlLib/PEARSQLDataListSource.html#methoddo_query'>void do_query ( )</A></B></CODE>
204     <BR>
205     <blockquote> </blockquote>
206     </TD>
207     </TR>
208     <!-- =========== Summary =========== -->
209     <TR BGCOLOR='white' CLASS='TableRowColor'>
210     <TD>
211     <CODE><B><A HREF='../phpHtmlLib/PEARSQLDataListSource.html#methodget_next_data_row'>array() get_next_data_row ( )</A></B></CODE>
212     <BR>
213     <blockquote> This function gets the next data row from the query() </blockquote>
214     </TD>
215     </TR>
216     <!-- =========== Summary =========== -->
217     <TR BGCOLOR='white' CLASS='TableRowColor'>
218     <TD>
219     <CODE><B><A HREF='../phpHtmlLib/PEARSQLDataListSource.html#methodset_db_object'>void set_db_object ( &$db )</A></B></CODE>
220     <BR>
221     <blockquote> Set the DB object we will use to talk to the DB. </blockquote>
222     </TD>
223     </TR>
224     </TABLE>
225 jonen 1.1 <!-- =========== INHERITED METHOD SUMMARY =========== -->
226     <A NAME='functions_inherited'><!-- --></A>
227     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
228 jonen 1.2 <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
229 jonen 1.1 <TD>
230     <span CLASS="font12bold">Inherited Method Summary</span>
231     <A HREF="#top" CLASS="links">^TOP</A>
232     </TD>
233     </TR>
234    
235 jonen 1.2 <!-- =========== Summary =========== -->
236 jonen 1.1 <TR BGCOLOR='white' CLASS='TableRowColor'>
237     <TD>
238     <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/SQLDataListSource.html">SQLDataListSource</a></span>
239     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">
240     <tr CLASS="tableheadingcolor">
241     <th>Function</th>
242     <th>Description</th>
243     </tr>
244 jonen 1.2 <tr>
245     <td CLASS="font10bold"><a href="../phpHtmlLib/SQLDataListSource.html#methodadvanced_search_where_clause">SQLDataListSource::advanced_search_where_clause()</a></td>
246     <td CLASS="font10">This function is responsible for building the portion of the where clause for doing an advanced search.</td>
247     <tr>
248     <td CLASS="font10bold"><a href="../phpHtmlLib/SQLDataListSource.html#methodbuild_groupby_clause">SQLDataListSource::build_groupby_clause()</a></td>
249 jonen 1.1 <td CLASS="font10">this builds the groupby clause of the query</td>
250 jonen 1.2 <tr>
251     <td CLASS="font10bold"><a href="../phpHtmlLib/SQLDataListSource.html#methodbuild_limit_clause">SQLDataListSource::build_limit_clause()</a></td>
252     <td CLASS="font10">This function builds the limit clause portion of a DB query.</td>
253     <tr>
254     <td CLASS="font10bold"><a href="../phpHtmlLib/SQLDataListSource.html#methodbuild_order_clause">SQLDataListSource::build_order_clause()</a></td>
255     <td CLASS="font10">This builds the db query ORDER BY clause used to sort the data from the DB.</td>
256     <tr>
257     <td CLASS="font10bold"><a href="../phpHtmlLib/SQLDataListSource.html#methodbuild_query">SQLDataListSource::build_query()</a></td>
258 jonen 1.1 <td CLASS="font10">build the entire DB query</td>
259 jonen 1.2 <tr>
260     <td CLASS="font10bold"><a href="../phpHtmlLib/SQLDataListSource.html#methodbuild_search_clause">SQLDataListSource::build_search_clause()</a></td>
261 jonen 1.1 <td CLASS="font10">This method builds the where clause.</td>
262 jonen 1.2 <tr>
263     <td CLASS="font10bold"><a href="../phpHtmlLib/SQLDataListSource.html#methodbuild_where_clause">SQLDataListSource::build_where_clause()</a></td>
264     <td CLASS="font10">This builds the where clause for the query</td>
265     <tr>
266     <td CLASS="font10bold"><a href="../phpHtmlLib/SQLDataListSource.html#methodcount">SQLDataListSource::count()</a></td>
267     <td CLASS="font10">find the number of rows to be returned from a query from a table and where clause</td>
268     <tr>
269     <td CLASS="font10bold"><a href="../phpHtmlLib/SQLDataListSource.html#methoddo_prequery">SQLDataListSource::do_prequery()</a></td>
270 jonen 1.1 <td CLASS="font10"></td>
271 jonen 1.2 <tr>
272     <td CLASS="font10bold"><a href="../phpHtmlLib/SQLDataListSource.html#methoddo_query">SQLDataListSource::do_query()</a></td>
273     <td CLASS="font10">Do the query to the DB and pull in all of the records locally.</td>
274     <tr>
275     <td CLASS="font10bold"><a href="../phpHtmlLib/SQLDataListSource.html#methodget_count_column">SQLDataListSource::get_count_column()</a></td>
276 jonen 1.1 <td CLASS="font10">this returns the current count column</td>
277 jonen 1.2 <tr>
278     <td CLASS="font10bold"><a href="../phpHtmlLib/SQLDataListSource.html#methodget_db_tables">SQLDataListSource::get_db_tables()</a></td>
279 jonen 1.1 <td CLASS="font10">returns the table(s) used in the query</td>
280 jonen 1.2 <tr>
281     <td CLASS="font10bold"><a href="../phpHtmlLib/SQLDataListSource.html#methodget_db_values">SQLDataListSource::get_db_values()</a></td>
282     <td CLASS="font10">This function returns the values we need to search for in the sql query</td>
283     <tr>
284     <td CLASS="font10bold"><a href="../phpHtmlLib/SQLDataListSource.html#methodget_next_data_row">SQLDataListSource::get_next_data_row()</a></td>
285     <td CLASS="font10">This function gets the next data row from the query()</td>
286     <tr>
287     <td CLASS="font10bold"><a href="../phpHtmlLib/SQLDataListSource.html#methodjoin_clauses">SQLDataListSource::join_clauses()</a></td>
288 jonen 1.1 <td CLASS="font10"></td>
289 jonen 1.2 <tr>
290     <td CLASS="font10bold"><a href="../phpHtmlLib/SQLDataListSource.html#methodsearch_value_filter">SQLDataListSource::search_value_filter()</a></td>
291     <td CLASS="font10">This function does the variable cleaning that is required to use a search value in a sql query</td>
292     <tr>
293     <td CLASS="font10bold"><a href="../phpHtmlLib/SQLDataListSource.html#methodsetup_db_options">SQLDataListSource::setup_db_options()</a></td>
294     <td CLASS="font10">Set which DB options to use for this list.</td>
295     <tr>
296     <td CLASS="font10bold"><a href="../phpHtmlLib/SQLDataListSource.html#methodsetup_order">SQLDataListSource::setup_order()</a></td>
297     <td CLASS="font10">This function builds the orderby clause for the DB query.</td>
298     <tr>
299     <td CLASS="font10bold"><a href="../phpHtmlLib/SQLDataListSource.html#methodset_count_column">SQLDataListSource::set_count_column()</a></td>
300 jonen 1.1 <td CLASS="font10">This function changes the counted column.</td>
301 jonen 1.2 <tr>
302     <td CLASS="font10bold"><a href="../phpHtmlLib/SQLDataListSource.html#methodset_db_groupby_clause">SQLDataListSource::set_db_groupby_clause()</a></td>
303 jonen 1.1 <td CLASS="font10">Sets the groupby clause for the query</td>
304 jonen 1.2 <tr>
305     <td CLASS="font10bold"><a href="../phpHtmlLib/SQLDataListSource.html#methodset_db_tables">SQLDataListSource::set_db_tables()</a></td>
306     <td CLASS="font10">Set the tables from the DB you want to select on.</td>
307     <tr>
308     <td CLASS="font10bold"><a href="../phpHtmlLib/SQLDataListSource.html#methodset_db_values">SQLDataListSource::set_db_values()</a></td>
309     <td CLASS="font10">Set the values we want to select from the db.</td>
310     <tr>
311     <td CLASS="font10bold"><a href="../phpHtmlLib/SQLDataListSource.html#methodset_db_where_clause">SQLDataListSource::set_db_where_clause()</a></td>
312     <td CLASS="font10">Set the user portion of the where clause.</td>
313     <tr>
314     <td CLASS="font10bold"><a href="../phpHtmlLib/SQLDataListSource.html#methodsimple_search_where_clause">SQLDataListSource::simple_search_where_clause()</a></td>
315 jonen 1.1 <td CLASS="font10">this builds the search clause</td>
316 jonen 1.2 <tr>
317     <td CLASS="font10bold"><a href="../phpHtmlLib/SQLDataListSource.html#methodsql_varchar_filter">SQLDataListSource::sql_varchar_filter()</a></td>
318 jonen 1.1 <td CLASS="font10">Clean up the string so it can work in a db</td>
319 jonen 1.2 </table>
320 jonen 1.1 <br>
321     </TD>
322     </TR>
323 jonen 1.2 <!-- =========== Summary =========== -->
324 jonen 1.1 <TR BGCOLOR='white' CLASS='TableRowColor'>
325     <TD>
326     <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/DataListSource.html">DataListSource</a></span>
327     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">
328     <tr CLASS="tableheadingcolor">
329     <th>Function</th>
330     <th>Description</th>
331     </tr>
332 jonen 1.2 <tr>
333     <td CLASS="font10bold"><a href="../phpHtmlLib/DataListSource.html#methodDataListSource">DataListSource::DataListSource()</a></td>
334 jonen 1.1 <td CLASS="font10">The constructor</td>
335 jonen 1.2 <tr>
336     <td CLASS="font10bold"><a href="../phpHtmlLib/DataListSource.html#methodadd_column">DataListSource::add_column()</a></td>
337 jonen 1.1 <td CLASS="font10">Add a column of data to manage</td>
338 jonen 1.2 <tr>
339     <td CLASS="font10bold"><a href="../phpHtmlLib/DataListSource.html#methoddo_prequery">DataListSource::do_prequery()</a></td>
340     <td CLASS="font10">This is a method that should be defined by the child class to do any pre-query type of things.</td>
341     <tr>
342     <td CLASS="font10bold"><a href="../phpHtmlLib/DataListSource.html#methoddo_query">DataListSource::do_query()</a></td>
343     <td CLASS="font10">This is the function that does the data fetching, and sorting if needed.</td>
344     <tr>
345     <td CLASS="font10bold"><a href="../phpHtmlLib/DataListSource.html#methodget_data_index">DataListSource::get_data_index()</a></td>
346     <td CLASS="font10">This function returns the data_index value and increments it</td>
347     <tr>
348     <td CLASS="font10bold"><a href="../phpHtmlLib/DataListSource.html#methodget_limit">DataListSource::get_limit()</a></td>
349     <td CLASS="font10">This function gets the current value of the limit value</td>
350     <tr>
351     <td CLASS="font10bold"><a href="../phpHtmlLib/DataListSource.html#methodget_next_data_row">DataListSource::get_next_data_row()</a></td>
352     <td CLASS="font10">This function gets the next data row from the query()</td>
353     <tr>
354     <td CLASS="font10bold"><a href="../phpHtmlLib/DataListSource.html#methodget_not_found_message">DataListSource::get_not_found_message()</a></td>
355     <td CLASS="font10">This function is used to get the message displayed when no data is found</td>
356     <tr>
357     <td CLASS="font10bold"><a href="../phpHtmlLib/DataListSource.html#methodget_offset">DataListSource::get_offset()</a></td>
358     <td CLASS="font10">This function returns the value of the offset</td>
359     <tr>
360     <td CLASS="font10bold"><a href="../phpHtmlLib/DataListSource.html#methodget_orderby">DataListSource::get_orderby()</a></td>
361     <td CLASS="font10">This function returns the value of the orderby</td>
362     <tr>
363     <td CLASS="font10bold"><a href="../phpHtmlLib/DataListSource.html#methodget_reverseorder">DataListSource::get_reverseorder()</a></td>
364     <td CLASS="font10">This function returns the value of the reverseorder</td>
365     <tr>
366     <td CLASS="font10bold"><a href="../phpHtmlLib/DataListSource.html#methodget_searchby">DataListSource::get_searchby()</a></td>
367     <td CLASS="font10">This function returns the value of the searchby</td>
368     <tr>
369     <td CLASS="font10bold"><a href="../phpHtmlLib/DataListSource.html#methodget_searchby_value">DataListSource::get_searchby_value()</a></td>
370     <td CLASS="font10">This function returns the value of the search value</td>
371     <tr>
372     <td CLASS="font10bold"><a href="../phpHtmlLib/DataListSource.html#methodget_search_type">DataListSource::get_search_type()</a></td>
373     <td CLASS="font10">this function returns the current search type for the DataList query</td>
374     <tr>
375     <td CLASS="font10bold"><a href="../phpHtmlLib/DataListSource.html#methodget_simplesearch_modifier">DataListSource::get_simplesearch_modifier()</a></td>
376     <td CLASS="font10">This function returns the value of the search value</td>
377     <tr>
378     <td CLASS="font10bold"><a href="../phpHtmlLib/DataListSource.html#methodget_total_rows">DataListSource::get_total_rows()</a></td>
379     <td CLASS="font10">This returns the total number of rows in our entire data set</td>
380     <tr>
381     <td CLASS="font10bold"><a href="../phpHtmlLib/DataListSource.html#methodquery">DataListSource::query()</a></td>
382 jonen 1.1 <td CLASS="font10">The main Query function.</td>
383 jonen 1.2 <tr>
384     <td CLASS="font10bold"><a href="../phpHtmlLib/DataListSource.html#methodset_limit">DataListSource::set_limit()</a></td>
385 jonen 1.1 <td CLASS="font10">This function is used to set</td>
386 jonen 1.2 <tr>
387     <td CLASS="font10bold"><a href="../phpHtmlLib/DataListSource.html#methodset_not_found_message">DataListSource::set_not_found_message()</a></td>
388     <td CLASS="font10">This function is used to set the message displayed when no data is found</td>
389     <tr>
390     <td CLASS="font10bold"><a href="../phpHtmlLib/DataListSource.html#methodset_offset">DataListSource::set_offset()</a></td>
391     <td CLASS="font10">This sets the offset value and resets the index into the data array (in non DB children)</td>
392     <tr>
393     <td CLASS="font10bold"><a href="../phpHtmlLib/DataListSource.html#methodset_orderby">DataListSource::set_orderby()</a></td>
394 jonen 1.1 <td CLASS="font10">This sets the orderby column name.</td>
395 jonen 1.2 <tr>
396     <td CLASS="font10bold"><a href="../phpHtmlLib/DataListSource.html#methodset_reverseorder">DataListSource::set_reverseorder()</a></td>
397     <td CLASS="font10">This sets the flag that tells us the direction in which to order the orderby column.</td>
398     <tr>
399     <td CLASS="font10bold"><a href="../phpHtmlLib/DataListSource.html#methodset_searchby">DataListSource::set_searchby()</a></td>
400     <td CLASS="font10">This sets the column that we want to search from.</td>
401     <tr>
402     <td CLASS="font10bold"><a href="../phpHtmlLib/DataListSource.html#methodset_searchby_value">DataListSource::set_searchby_value()</a></td>
403     <td CLASS="font10">This sets the data that we want to search for.</td>
404     <tr>
405     <td CLASS="font10bold"><a href="../phpHtmlLib/DataListSource.html#methodset_search_type">DataListSource::set_search_type()</a></td>
406     <td CLASS="font10">This function sets the search type (simple or advanced)</td>
407     <tr>
408     <td CLASS="font10bold"><a href="../phpHtmlLib/DataListSource.html#methodset_simplesearch_modifier">DataListSource::set_simplesearch_modifier()</a></td>
409 jonen 1.1 <td CLASS="font10">This sets the simple search modifier</td>
410 jonen 1.2 <tr>
411     <td CLASS="font10bold"><a href="../phpHtmlLib/DataListSource.html#methodset_total_rows">DataListSource::set_total_rows()</a></td>
412     <td CLASS="font10">This is used to set the total # of rows we have in our data set</td>
413     <tr>
414     <td CLASS="font10bold"><a href="../phpHtmlLib/DataListSource.html#methodsort">DataListSource::sort()</a></td>
415     <td CLASS="font10">A generic method API that can be used at the bottom half of the do_query() method to sort data that is stored locally. This is only needed when the source is a non database.</td>
416     <tr>
417     <td CLASS="font10bold"><a href="../phpHtmlLib/DataListSource.html#method_is_column_sortable">DataListSource::_is_column_sortable()</a></td>
418     <td CLASS="font10">This function determines if the column associated w/ a data_name is sortable or not</td>
419     </table>
420 jonen 1.1 <br>
421     </TD>
422     </TR>
423 jonen 1.2 </TABLE>
424 jonen 1.1 <hr>
425     <!-- ============ VARIABLE DETAIL =========== -->
426    
427     <A NAME='variable_detail'></A>
428     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
429     <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
430     <TD>
431     <span CLASS="font12bold">Variable Detail</span>
432     <A HREF="#top" CLASS="links">^TOP</A>
433     </TD>
434     </TR>
435     </TABLE>
436    
437 jonen 1.2 <A NAME='var$_db'><!-- --></A><H3>$_db</H3> (line <span class="linenumber">50</span>)<br />
438     <b>Data type:</b> mixed<br>This var holds the Database object
439     <br />
440     <p>that is used to do the sql queries It is assumed that the db is already connected to, and the object provides 2 methods: query() - execute a sql query</p>
441 jonen 1.1 <UL>
442 jonen 1.2 </UL>
443 jonen 1.1 <HR>
444 jonen 1.2 <A NAME='var$_result'><!-- --></A><H3>$_result</H3> (line <span class="linenumber">57</span>)<br />
445     <b>Data type:</b> mixed<br>this holds the query result from the
446     <br />
447     <p>PEAR::DB-&gt;query() call</p>
448 jonen 1.1 <UL>
449 jonen 1.2 </UL>
450 jonen 1.1 <HR>
451     <hr>
452 jonen 1.2 <!-- ============ METHOD DETAIL =========== -->
453 jonen 1.1
454 jonen 1.2 <A NAME='method_detail'></A>
455 jonen 1.1 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
456     <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
457     <TD>
458     <span class="font12bold">Method Detail</span>
459     <A HREF="#top" CLASS="links">^TOP</A>
460     </TD>
461     </TR>
462     </TABLE>
463     <BR>
464     <DIV CLASS="function">
465 jonen 1.2 <A NAME='methodPEARSQLDataListSource'><!-- --></A>
466     <SPAN CLASS="font12bold">Constructor PEARSQLDataListSource</SPAN> (line <span class="linenumber">67</span>)
467 jonen 1.1 <BR>
468 jonen 1.2 <SPAN CLASS="font10bold">Usage : </SPAN>
469 jonen 1.1 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
470 jonen 1.2 <span class="font10bold" style="color: #0000FF">PEARSQLDataListSource(
471     PEAR::DB
472     &$db)</SPAN>
473 jonen 1.1 <BR>
474    
475     <BR>
476     <SPAN CLASS="font10bold">Description : </SPAN>
477 jonen 1.2 The constructor is used to pass in the PEAR DB object that has already been created and connected to the db.
478     <br />
479 jonen 1.1
480     <DL>
481 jonen 1.2 <DT class="font10bold">Function Parameters:</DT>
482     <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>
483    
484     <DT class="font10bold">Function Info:</DT>
485     </DL>
486 jonen 1.1 </DIV>
487     <BR>
488     <DIV CLASS="function">
489 jonen 1.2 <A NAME='methodbuild_limit_clause'><!-- --></A>
490     <SPAN CLASS="font12bold">build_limit_clause</SPAN> (line <span class="linenumber">109</span>)
491 jonen 1.1 <BR>
492 jonen 1.2 <SPAN CLASS="font10bold">Usage : </SPAN>
493 jonen 1.1 <span class="font10bold" style="color: #FF0000">string</SPAN>&nbsp;
494 jonen 1.2 <span class="font10bold" style="color: #0000FF">build_limit_clause(
495     mixed
496     $offset, mixed
497     $limit)</SPAN>
498 jonen 1.1 <BR>
499 jonen 1.2
500     <span class="font10bold" style="padding-left: 10px;">Overrides :</span> <a href="../phpHtmlLib/SQLDataListSource.html#methodbuild_limit_clause">SQLDataListSource::build_limit_clause()</a> This function builds the limit clause portion of a DB query.
501 jonen 1.1 <BR>
502     <SPAN CLASS="font10bold">Description : </SPAN>
503 jonen 1.2 This function builds the limit clause portion of a DB query.
504     <br />
505 jonen 1.1
506     <DL>
507    
508 jonen 1.2 <DT class="font10bold">Function Info:</DT>
509     <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>return</b> - - the limit portion of the query.</DD>
510     </DL>
511 jonen 1.1 </DIV>
512     <BR>
513     <DIV CLASS="function">
514 jonen 1.2 <A NAME='methodcount'><!-- --></A>
515     <SPAN CLASS="font12bold">count</SPAN> (line <span class="linenumber">140</span>)
516 jonen 1.1 <BR>
517 jonen 1.2 <SPAN CLASS="font10bold">Usage : </SPAN>
518 jonen 1.1 <span class="font10bold" style="color: #FF0000">int</SPAN>&nbsp;
519 jonen 1.2 <span class="font10bold" style="color: #0000FF">count(
520     mixed
521     $tables, [string
522     $where_clause = ''], [mixed
523     $count_clause = '*'], string
524     $table)</SPAN>
525 jonen 1.1 <BR>
526 jonen 1.2
527     <span class="font10bold" style="padding-left: 10px;">Overrides :</span> <a href="../phpHtmlLib/SQLDataListSource.html#methodcount">SQLDataListSource::count()</a> find the number of rows to be returned from a query from a table and where clause
528 jonen 1.1 <BR>
529     <SPAN CLASS="font10bold">Description : </SPAN>
530 jonen 1.2 find the number of rows to be returned from a query from a table and where clause
531     <br />
532 jonen 1.1
533     <DL>
534 jonen 1.2 <DT class="font10bold">Function Parameters:</DT>
535     <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>
536     <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>
537    
538     <DT class="font10bold">Function Info:</DT>
539     <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>return</b> - the # of rows</DD>
540     </DL>
541 jonen 1.1 </DIV>
542     <BR>
543     <DIV CLASS="function">
544 jonen 1.2 <A NAME='methoddo_query'><!-- --></A>
545     <SPAN CLASS="font12bold">do_query</SPAN> (line <span class="linenumber">82</span>)
546 jonen 1.1 <BR>
547 jonen 1.2 <SPAN CLASS="font10bold">Usage : </SPAN>
548 jonen 1.1 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
549 jonen 1.2 <span class="font10bold" style="color: #0000FF">do_query(
550     )</SPAN>
551 jonen 1.1 <BR>
552 jonen 1.2
553     <span class="font10bold" style="padding-left: 10px;">Overrides :</span> <a href="../phpHtmlLib/SQLDataListSource.html#methoddo_query">SQLDataListSource::do_query()</a> Do the query to the DB and pull in all of the records locally.
554 jonen 1.1 <BR>
555     <SPAN CLASS="font10bold">Description : </SPAN>
556    
557 jonen 1.2 <br />
558 jonen 1.1
559     <DL>
560    
561 jonen 1.2 <DT class="font10bold">Function Info:</DT>
562     </DL>
563 jonen 1.1 </DIV>
564     <BR>
565     <DIV CLASS="function">
566 jonen 1.2 <A NAME='methodget_next_data_row'><!-- --></A>
567     <SPAN CLASS="font12bold">get_next_data_row</SPAN> (line <span class="linenumber">98</span>)
568 jonen 1.1 <BR>
569 jonen 1.2 <SPAN CLASS="font10bold">Usage : </SPAN>
570 jonen 1.1 <span class="font10bold" style="color: #FF0000">array()</SPAN>&nbsp;
571 jonen 1.2 <span class="font10bold" style="color: #0000FF">get_next_data_row(
572     )</SPAN>
573 jonen 1.1 <BR>
574 jonen 1.2
575     <span class="font10bold" style="padding-left: 10px;">Overrides :</span> <a href="../phpHtmlLib/SQLDataListSource.html#methodget_next_data_row">SQLDataListSource::get_next_data_row()</a> This function gets the next data row from the query()
576 jonen 1.1 <BR>
577     <SPAN CLASS="font10bold">Description : </SPAN>
578 jonen 1.2 This function gets the next data row from the query()
579     <br />
580 jonen 1.1
581     <DL>
582    
583 jonen 1.2 <DT class="font10bold">Function Info:</DT>
584     </DL>
585 jonen 1.1 </DIV>
586     <BR>
587     <DIV CLASS="function">
588 jonen 1.2 <A NAME='methodset_db_object'><!-- --></A>
589     <SPAN CLASS="font12bold">set_db_object</SPAN> (line <span class="linenumber">78</span>)
590 jonen 1.1 <BR>
591 jonen 1.2 <SPAN CLASS="font10bold">Usage : </SPAN>
592 jonen 1.1 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
593 jonen 1.2 <span class="font10bold" style="color: #0000FF">set_db_object(
594     object
595     &$db)</SPAN>
596 jonen 1.1 <BR>
597    
598     <BR>
599     <SPAN CLASS="font10bold">Description : </SPAN>
600 jonen 1.2 Set the DB object we will use to talk to the DB.
601     <br />
602 jonen 1.1
603     <DL>
604 jonen 1.2 <DT class="font10bold">Function Parameters:</DT>
605     <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> - $db the babw_db object.</DD>
606    
607     <DT class="font10bold">Function Info:</DT>
608     </DL>
609 jonen 1.1 </DIV>
610     <BR>
611 jonen 1.2 <div id="credit">
612     <hr>
613     Documention generated on Thu, 20 Feb 2003 16:23:06 -0800 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.0rc1</a>
614     </div>
615     </body>
616     </html>
MailToCvsAdmin">MailToCvsAdmin
 ViewVC Help
Powered by ViewVC 1.1.26 RSS 2.0 feed