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

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

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

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